summaryrefslogtreecommitdiff
path: root/girs
diff options
context:
space:
mode:
authorThibault Saunier <tsaunier@igalia.com>2021-09-24 16:16:29 -0300
committerThibault Saunier <tsaunier@igalia.com>2021-09-24 16:16:29 -0300
commit9f659233ea9e59bd93c2497a241025e8073ac894 (patch)
treeb7de900f0319d454a0de1bc90e15feba58bbe6ca /girs
parentd274c90e92716841ea5f820516cf410a48eee4dc (diff)
downloadgstreamer-9f659233ea9e59bd93c2497a241025e8073ac894.tar.gz
Move files from gstreamer-sharp into the "subprojects/gstreamer-sharp/" subdir
Diffstat (limited to 'girs')
-rw-r--r--girs/GES-1.0.gir22193
-rw-r--r--girs/Gst-1.0.gir79314
-rw-r--r--girs/GstApp-1.0.gir2538
-rw-r--r--girs/GstAudio-1.0.gir15495
-rw-r--r--girs/GstBase-1.0.gir18611
-rw-r--r--girs/GstController-1.0.gir1604
-rw-r--r--girs/GstNet-1.0.gir1290
-rw-r--r--girs/GstPbutils-1.0.gir6836
-rw-r--r--girs/GstRtp-1.0.gir8509
-rw-r--r--girs/GstRtsp-1.0.gir7642
-rw-r--r--girs/GstSdp-1.0.gir6619
-rw-r--r--girs/GstTag-1.0.gir2639
-rw-r--r--girs/GstVideo-1.0.gir25578
-rw-r--r--girs/GstWebRTC-1.0.gir1742
14 files changed, 0 insertions, 200610 deletions
diff --git a/girs/GES-1.0.gir b/girs/GES-1.0.gir
deleted file mode 100644
index 60fb24a257..0000000000
--- a/girs/GES-1.0.gir
+++ /dev/null
@@ -1,22193 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="GObject" version="2.0"/>
- <include name="Gio" version="2.0"/>
- <include name="Gst" version="1.0"/>
- <include name="GstPbutils" version="1.0"/>
- <include name="GstVideo" version="1.0"/>
- <package name="gst-editing-services-1.0"/>
- <c:include name="ges/ges.h"/>
- <namespace name="GES"
- version="1.0"
- shared-library="libges-1.0.so.0"
- c:identifier-prefixes="GES"
- c:symbol-prefixes="ges">
- <alias name="FrameNumber" c:type="GESFrameNumber">
- <doc xml:space="preserve"
- filename="ges/ges-types.h"
- line="46">A datatype to hold a frame number.</doc>
- <source-position filename="ges/ges-types.h" line="51"/>
- <type name="gint64" c:type="gint64"/>
- </alias>
- <class name="Asset"
- c:symbol-prefix="asset"
- c:type="GESAsset"
- parent="GObject.Object"
- glib:type-name="GESAsset"
- glib:get-type="ges_asset_get_type"
- glib:type-struct="AssetClass">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="21">A #GESAsset in the GStreamer Editing Services represents a resources
-that can be used. In particular, any class that implements the
-#GESExtractable interface may have some associated assets with a
-corresponding #GESAsset:extractable-type, from which its objects can be
-extracted using ges_asset_extract(). Some examples would be
-#GESClip, #GESFormatter and #GESTrackElement.
-
-All assets that are created within GES are stored in a cache; one per
-each #GESAsset:id and #GESAsset:extractable-type pair. These assets can
-be fetched, and initialized if they do not yet exist in the cache,
-using ges_asset_request().
-
-``` c
-GESAsset *effect_asset;
-GESEffect *effect;
-
-// You create an asset for an effect
-effect_asset = ges_asset_request (GES_TYPE_EFFECT, "agingtv", NULL);
-
-// And now you can extract an instance of GESEffect from that asset
-effect = GES_EFFECT (ges_asset_extract (effect_asset));
-
-```
-
-The advantage of using assets, rather than simply creating the object
-directly, is that the currently loaded resources can be listed with
-ges_list_assets() and displayed to an end user. For example, to show
-which media files have been loaded, and a standard list of effects. In
-fact, the GES library already creates assets for #GESTransitionClip and
-#GESFormatter, which you can use to list all the available transition
-types and supported formats.
-
-The other advantage is that #GESAsset implements #GESMetaContainer, so
-metadata can be set on the asset, with some subclasses automatically
-creating this metadata on initiation.
-
-For example, to display information about the supported formats, you
-could do the following:
-|[
- GList *formatter_assets, *tmp;
-
- // List all the transitions
- formatter_assets = ges_list_assets (GES_TYPE_FORMATTER);
-
- // Print some infos about the formatter GESAsset
- for (tmp = formatter_assets; tmp; tmp = tmp-&gt;next) {
- g_print ("Name of the formatter: %s, file extension it produces: %s",
- ges_meta_container_get_string (
- GES_META_CONTAINER (tmp-&gt;data), GES_META_FORMATTER_NAME),
- ges_meta_container_get_string (
- GES_META_CONTAINER (tmp-&gt;data), GES_META_FORMATTER_EXTENSION));
- }
-
- g_list_free (transition_assets);
-
-]|
-
-## ID
-
-Each asset is uniquely defined in the cache by its
-#GESAsset:extractable-type and #GESAsset:id. Depending on the
-#GESAsset:extractable-type, the #GESAsset:id can be used to parametrise
-the creation of the object upon extraction. By default, a class that
-implements #GESExtractable will only have a single associated asset,
-with an #GESAsset:id set to the type name of its objects. However, this
-is overwritten by some implementations, which allow a class to have
-multiple associated assets. For example, for #GESTransitionClip the
-#GESAsset:id will be a nickname of the #GESTransitionClip:vtype. You
-should check the documentation for each extractable type to see if they
-differ from the default.
-
-Moreover, each #GESAsset:extractable-type may also associate itself
-with a specific asset subclass. In such cases, when their asset is
-requested, an asset of this subclass will be returned instead.
-
-## Managing
-
-You can use a #GESProject to easily manage the assets of a
-#GESTimeline.
-
-## Proxies
-
-Some assets can (temporarily) act as the #GESAsset:proxy of another
-asset. When the original asset is requested from the cache, the proxy
-will be returned in its place. This can be useful if, say, you want
-to substitute a #GESUriClipAsset corresponding to a high resolution
-media file with the asset of a lower resolution stand in.
-
-An asset may even have several proxies, the first of which will act as
-its default and be returned on requests, but the others will be ordered
-to take its place once it is removed. You can add a proxy to an asset,
-or set its default, using ges_asset_set_proxy(), and you can remove
-them with ges_asset_unproxy().</doc>
- <source-position filename="ges/ges-asset.h" line="104"/>
- <implements name="MetaContainer"/>
- <implements name="Gio.AsyncInitable"/>
- <implements name="Gio.Initable"/>
- <function name="needs_reload" c:identifier="ges_asset_needs_reload">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1480">Indicate that an existing #GESAsset in the cache should be reloaded
-upon the next request. This can be used when some condition has
-changed, which may require that an existing asset should be updated.
-For example, if an external resource has changed or now become
-available.
-
-Note, the asset is not immediately changed, but will only actually
-reload on the next call to ges_asset_request() or
-ges_asset_request_async().</doc>
- <source-position filename="ges/ges-asset.h" line="143"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1497">%TRUE if the specified asset exists in the cache and could be
-marked for reloading.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="extractable_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1482">The #GESAsset:extractable-type of the asset that
-needs reloading</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="id"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1484">The #GESAsset:id of the asset asset that needs
-reloading</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="request" c:identifier="ges_asset_request" throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1196">Returns an asset with the given properties. If such an asset already
-exists in the cache (it has been previously created in GES), then a
-reference to the existing asset is returned. Otherwise, a newly created
-asset is returned, and also added to the cache.
-
-If the requested asset has been loaded with an error, then @error is
-set, if given, and %NULL will be returned instead.
-
-Note that the given @id may not be exactly the #GESAsset:id that is
-set on the returned asset. For instance, it may be adjusted into a
-standard format. Or, if a #GESExtractable type does not have its
-extraction parametrised, as is the case by default, then the given @id
-may be ignored entirely and the #GESAsset:id set to some standard, in
-which case a %NULL @id can be given.
-
-Similarly, the given @extractable_type may not be exactly the
-#GESAsset:extractable-type that is set on the returned asset. Instead,
-the actual extractable type may correspond to a subclass of the given
-@extractable_type, depending on the given @id.
-
-Moreover, depending on the given @extractable_type, the returned asset
-may belong to a subclass of #GESAsset.
-
-Finally, if the requested asset has a #GESAsset:proxy, then the proxy
-that is found at the end of the chain of proxies is returned (a proxy's
-proxy will take its place, and so on, unless it has no proxy).
-
-Some asset subclasses only support asynchronous construction of its
-assets, such as #GESUriClip. For such assets this method will fail, and
-you should use ges_asset_request_async() instead. In the case of
-#GESUriClip, you can use ges_uri_clip_asset_request_sync() if you only
-want to wait for the request to finish.</doc>
- <source-position filename="ges/ges-asset.h" line="115"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1236">A reference to the requested
-asset, or %NULL if an error occurred.</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </return-value>
- <parameters>
- <parameter name="extractable_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1198">The #GESAsset:extractable-type of the asset</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="id"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1199">The #GESAsset:id of the asset</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="request_async" c:identifier="ges_asset_request_async">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1336">Requests an asset with the given properties asynchronously (see
-ges_asset_request()). When the asset has been initialized or fetched
-from the cache, the given callback function will be called. The
-asset can then be retrieved in the callback using the
-ges_asset_request_finish() method on the given #GAsyncResult.
-
-Note that the source object passed to the callback will be the
-#GESAsset corresponding to the request, but it may not have loaded
-correctly and therefore can not be used as is. Instead,
-ges_asset_request_finish() should be used to fetch a usable asset, or
-indicate that an error occurred in the asset's creation.
-
-Note that the callback will be called in the #GMainLoop running under
-the same #GMainContext that ges_init() was called in. So, if you wish
-the callback to be invoked outside the default #GMainContext, you can
-call g_main_context_push_thread_default() in a new thread before
-calling ges_init().
-
-Example of an asynchronous asset request:
-``` c
-// The request callback
-static void
-asset_loaded_cb (GESAsset * source, GAsyncResult * res, gpointer user_data)
-{
- GESAsset *asset;
- GError *error = NULL;
-
- asset = ges_asset_request_finish (res, &amp;error);
- if (asset) {
- g_print ("The file: %s is usable as a GESUriClip",
- ges_asset_get_id (asset));
- } else {
- g_print ("The file: %s is *not* usable as a GESUriClip because: %s",
- ges_asset_get_id (source), error-&gt;message);
- }
-
- gst_object_unref (asset);
-}
-
-// The request:
-ges_asset_request_async (GES_TYPE_URI_CLIP, some_uri, NULL,
- (GAsyncReadyCallback) asset_loaded_cb, user_data);
-```</doc>
- <source-position filename="ges/ges-asset.h" line="109"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="extractable_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1338">The #GESAsset:extractable-type of the asset</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="id"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1339">The #GESAsset:id of the asset</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1340">An object to allow cancellation of the
-asset request, or %NULL to ignore</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- <parameter name="callback"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="async"
- closure="4">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1342">A function to call when the initialization is finished</doc>
- <type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1343">Data to be passed to @callback</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="request_finish"
- c:identifier="ges_asset_request_finish"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1585">Fetches an asset requested by ges_asset_request_async(), which
-finalises the request.</doc>
- <source-position filename="ges/ges-asset.h" line="121"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1594">The requested asset, or %NULL if an error
-occurred.</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </return-value>
- <parameters>
- <parameter name="res" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1587">The task result to fetch the asset from</doc>
- <type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="extract" invoker="extract" throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1551">Extracts a new #GESAsset:extractable-type object from the asset. The
-#GESAsset:id of the asset may determine the properties and state of the
-newly created object.</doc>
- <source-position filename="ges/ges-asset.h" line="88"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1561">A newly created object, or %NULL if an
-error occurred.</doc>
- <type name="Extractable" c:type="GESExtractable*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1553">The #GESAsset to extract an object from</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="inform_proxy">
- <source-position filename="ges/ges-asset.h" line="91"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- <parameter name="proxy_id" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="proxied">
- <source-position filename="ges/ges-asset.h" line="94"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- <parameter name="proxy" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="request_id_update">
- <source-position filename="ges/ges-asset.h" line="100"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- <parameter name="proposed_new_id" transfer-ownership="none">
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- <parameter name="error" transfer-ownership="none">
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start_loading" throws="1">
- <source-position filename="ges/ges-asset.h" line="86"/>
- <return-value transfer-ownership="none">
- <type name="AssetLoadingReturn" c:type="GESAssetLoadingReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <method name="extract" c:identifier="ges_asset_extract" throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1551">Extracts a new #GESAsset:extractable-type object from the asset. The
-#GESAsset:id of the asset may determine the properties and state of the
-newly created object.</doc>
- <source-position filename="ges/ges-asset.h" line="126"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1561">A newly created object, or %NULL if an
-error occurred.</doc>
- <type name="Extractable" c:type="GESExtractable*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1553">The #GESAsset to extract an object from</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_error"
- c:identifier="ges_asset_get_error"
- version="1.8">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1661">Retrieve the error that was set on the asset when it was loaded.</doc>
- <source-position filename="ges/ges-asset.h" line="124"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1667">The error set on @asset, or
-%NULL if no error occurred when @asset was loaded.</doc>
- <type name="GLib.Error" c:type="GError*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1663">A #GESAsset</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_extractable_type"
- c:identifier="ges_asset_get_extractable_type">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1180">Gets the #GESAsset:extractable-type of the asset.</doc>
- <source-position filename="ges/ges-asset.h" line="107"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1186">The extractable type of @self.</doc>
- <type name="GType" c:type="GType"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1182">The #GESAsset</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_id" c:identifier="ges_asset_get_id">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1535">Gets the #GESAsset:id of the asset.</doc>
- <source-position filename="ges/ges-asset.h" line="119"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1541">The ID of @self.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1537">A #GESAsset</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_proxy" c:identifier="ges_asset_get_proxy">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1068">Gets the default #GESAsset:proxy of the asset.</doc>
- <source-position filename="ges/ges-asset.h" line="141"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1074">The default proxy of @asset.</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </return-value>
- <parameters>
- <instance-parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1070">A #GESAsset</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_proxy_target"
- c:identifier="ges_asset_get_proxy_target">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1088">Gets the #GESAsset:proxy-target of the asset.
-
-Note that the proxy target may have loaded with an error, so you should
-call ges_asset_get_error() on the returned target.</doc>
- <source-position filename="ges/ges-asset.h" line="139"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1097">The asset that @proxy is a proxy
-of.</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </return-value>
- <parameters>
- <instance-parameter name="proxy" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1090">A #GESAsset</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="list_proxies" c:identifier="ges_asset_list_proxies">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1049">Get all the proxies that the asset has. The first item of the list will
-be the default #GESAsset:proxy. The second will be the proxy that is
-'next in line' to be default, and so on.</doc>
- <source-position filename="ges/ges-asset.h" line="137"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1057">The list of proxies
-that @asset has.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Asset"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1051">A #GESAsset</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_proxy" c:identifier="ges_asset_set_proxy">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="898">Sets the #GESAsset:proxy for the asset.
-
-If @proxy is among the existing proxies of the asset (see
-ges_asset_list_proxies()) it will be moved to become the default
-proxy. Otherwise, if @proxy is not %NULL, it will be added to the list
-of proxies, as the new default. The previous default proxy will become
-'next in line' for if the new one is removed, and so on. As such, this
-will **not** actually remove the previous default proxy (use
-ges_asset_unproxy() for that).
-
-Note that an asset can only act as a proxy for one other asset.
-
-As a special case, if @proxy is %NULL, then this method will actually
-remove **all** proxies from the asset.</doc>
- <source-position filename="ges/ges-asset.h" line="133"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="918">%TRUE if @proxy was successfully set as the default for
-@asset.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="900">The #GESAsset to proxy</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- <parameter name="proxy"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="901">A new default proxy for @asset</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </method>
- <method name="unproxy" c:identifier="ges_asset_unproxy">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="996">Removes the proxy from the available list of proxies for the asset. If
-the given proxy is the default proxy of the list, then the next proxy
-in the available list (see ges_asset_list_proxies()) will become the
-default. If there are no other proxies, then the asset will no longer
-have a default #GESAsset:proxy.</doc>
- <source-position filename="ges/ges-asset.h" line="135"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1007">%TRUE if @proxy was successfully removed from @asset's proxy
-list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="998">The #GESAsset to no longer proxy with @proxy</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </instance-parameter>
- <parameter name="proxy" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="999">An existing proxy of @asset</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </method>
- <property name="extractable-type"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="480">The #GESExtractable object type that can be extracted from the asset.</doc>
- <type name="GType" c:type="GType"/>
- </property>
- <property name="id"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="490">The ID of the asset. This should be unique amongst all assets with
-the same #GESAsset:extractable-type. Depending on the associated
-#GESExtractable implementation, this id may convey some information
-about the #GObject that should be extracted. Note that, as such, the
-ID will have an expected format, and you can not choose this value
-arbitrarily. By default, this will be set to the type name of the
-#GESAsset:extractable-type, but you should check the documentation
-of the extractable type to see whether they differ from the
-default behaviour.</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="proxy" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="508">The default proxy for this asset, or %NULL if it has no proxy. A
-proxy will act as a substitute for the original asset when the
-original is requested (see ges_asset_request()).
-
-Setting this property will not usually remove the existing proxy, but
-will replace it as the default (see ges_asset_set_proxy()).</doc>
- <type name="Asset"/>
- </property>
- <property name="proxy-target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="522">The asset that this asset is a proxy for, or %NULL if it is not a
-proxy for another asset.
-
-Note that even if this asset is acting as a proxy for another asset,
-but this asset is not the default #GESAsset:proxy, then @proxy-target
-will *still* point to this other asset. So you should check the
-#GESAsset:proxy property of @target-proxy before assuming it is the
-current default proxy for the target.
-
-Note that the #GObject::notify for this property is emitted after
-the #GESAsset:proxy #GObject::notify for the corresponding (if any)
-asset it is now the proxy of/no longer the proxy of.</doc>
- <type name="Asset"/>
- </property>
- <field name="parent">
- <type name="GObject.Object" c:type="GObject"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AssetPrivate" c:type="GESAssetPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AssetClass"
- c:type="GESAssetClass"
- glib:is-gtype-struct-for="Asset">
- <source-position filename="ges/ges-asset.h" line="104"/>
- <field name="parent">
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </field>
- <field name="start_loading">
- <callback name="start_loading" throws="1">
- <source-position filename="ges/ges-asset.h" line="86"/>
- <return-value transfer-ownership="none">
- <type name="AssetLoadingReturn" c:type="GESAssetLoadingReturn"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="extract">
- <callback name="extract" throws="1">
- <source-position filename="ges/ges-asset.h" line="88"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1561">A newly created object, or %NULL if an
-error occurred.</doc>
- <type name="Extractable" c:type="GESExtractable*"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1553">The #GESAsset to extract an object from</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="inform_proxy">
- <callback name="inform_proxy">
- <source-position filename="ges/ges-asset.h" line="91"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- <parameter name="proxy_id" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="proxied">
- <callback name="proxied">
- <source-position filename="ges/ges-asset.h" line="94"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- <parameter name="proxy" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="request_id_update">
- <callback name="request_id_update">
- <source-position filename="ges/ges-asset.h" line="100"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- <parameter name="proposed_new_id" transfer-ownership="none">
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- <parameter name="error" transfer-ownership="none">
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <enumeration name="AssetLoadingReturn" c:type="GESAssetLoadingReturn">
- <source-position filename="ges/ges-asset.h" line="48"/>
- <member name="error" value="0" c:identifier="GES_ASSET_LOADING_ERROR">
- <doc xml:space="preserve"
- filename="ges/ges-asset.h"
- line="37">Indicates that an error occurred</doc>
- </member>
- <member name="async" value="1" c:identifier="GES_ASSET_LOADING_ASYNC">
- <doc xml:space="preserve"
- filename="ges/ges-asset.h"
- line="38">Indicates that the loading is being performed
-asynchronously</doc>
- </member>
- <member name="ok" value="2" c:identifier="GES_ASSET_LOADING_OK">
- <doc xml:space="preserve"
- filename="ges/ges-asset.h"
- line="40">Indicates that the loading is complete, without
-error</doc>
- </member>
- </enumeration>
- <record name="AssetPrivate" c:type="GESAssetPrivate" disguised="1">
- <source-position filename="ges/ges-asset.h" line="33"/>
- </record>
- <class name="AudioSource"
- c:symbol-prefix="audio_source"
- c:type="GESAudioSource"
- parent="Source"
- abstract="1"
- glib:type-name="GESAudioSource"
- glib:get-type="ges_audio_source_get_type"
- glib:type-struct="AudioSourceClass">
- <doc xml:space="preserve"
- filename="ges/ges-audio-source.c"
- line="21">## Children Properties
-
-You can use the following children properties through the
-#ges_track_element_set_child_property and alike set of methods:
-
-- #gdouble `volume`: volume factor, 1.0=100%.
-- #gboolean `mute`: mute channel.</doc>
- <source-position filename="ges/ges-audio-source.h" line="67"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <field name="parent" readable="0" private="1">
- <type name="Source" c:type="GESSource"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioSourcePrivate" c:type="GESAudioSourcePrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioSourceClass"
- c:type="GESAudioSourceClass"
- glib:is-gtype-struct-for="AudioSource">
- <source-position filename="ges/ges-audio-source.h" line="67"/>
- <field name="parent_class" readable="0" private="1">
- <type name="SourceClass" c:type="GESSourceClass"/>
- </field>
- <field name="create_source" introspectable="0">
- <callback name="create_source" introspectable="0">
- <source-position filename="ges/ges-audio-source.h" line="62"/>
- <return-value>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AudioSourcePrivate"
- c:type="GESAudioSourcePrivate"
- disguised="1">
- <source-position filename="ges/ges-audio-source.h" line="32"/>
- </record>
- <class name="AudioTestSource"
- c:symbol-prefix="audio_test_source"
- c:type="GESAudioTestSource"
- parent="AudioSource"
- glib:type-name="GESAudioTestSource"
- glib:get-type="ges_audio_test_source_get_type"
- glib:type-struct="AudioTestSourceClass">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="21">Outputs a test audio stream using audiotestsrc. The default property values
-output silence. Useful for testing pipelines, or to fill gaps in an audio
-track.</doc>
- <source-position filename="ges/ges-audio-test-source.h" line="56"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <method name="get_freq" c:identifier="ges_audio_test_source_get_freq">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="167">Get the current frequency of @self.</doc>
- <source-position filename="ges/ges-audio-test-source.h" line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="173">The current frequency of @self.</doc>
- <type name="gdouble" c:type="double"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="169">a #GESAudioTestSource</doc>
- <type name="AudioTestSource" c:type="GESAudioTestSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_volume"
- c:identifier="ges_audio_test_source_get_volume">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="184">Get the current volume of @self.</doc>
- <source-position filename="ges/ges-audio-test-source.h" line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="190">The current volume of @self</doc>
- <type name="gdouble" c:type="double"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="186">a #GESAudioTestSource</doc>
- <type name="AudioTestSource" c:type="GESAudioTestSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_freq" c:identifier="ges_audio_test_source_set_freq">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="119">Lets you set the frequency applied on the track element</doc>
- <source-position filename="ges/ges-audio-test-source.h" line="59"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="121">a #GESAudioTestSource</doc>
- <type name="AudioTestSource" c:type="GESAudioTestSource*"/>
- </instance-parameter>
- <parameter name="freq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="122">The frequency you want to apply on @self</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_volume"
- c:identifier="ges_audio_test_source_set_volume">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="143">Sets the volume of the test audio signal.</doc>
- <source-position filename="ges/ges-audio-test-source.h" line="63"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="145">a #GESAudioTestSource</doc>
- <type name="AudioTestSource" c:type="GESAudioTestSource*"/>
- </instance-parameter>
- <parameter name="volume" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-audio-test-source.c"
- line="146">The volume you want to apply on @self</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <field name="parent">
- <type name="AudioSource" c:type="GESAudioSource"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioTestSourcePrivate"
- c:type="GESAudioTestSourcePrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioTestSourceClass"
- c:type="GESAudioTestSourceClass"
- glib:is-gtype-struct-for="AudioTestSource">
- <source-position filename="ges/ges-audio-test-source.h" line="56"/>
- <field name="parent_class" readable="0" private="1">
- <type name="AudioSourceClass" c:type="GESAudioSourceClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AudioTestSourcePrivate"
- c:type="GESAudioTestSourcePrivate"
- disguised="1">
- <source-position filename="ges/ges-audio-test-source.h" line="30"/>
- </record>
- <class name="AudioTrack"
- c:symbol-prefix="audio_track"
- c:type="GESAudioTrack"
- parent="Track"
- glib:type-name="GESAudioTrack"
- glib:get-type="ges_audio_track_get_type"
- glib:type-struct="AudioTrackClass">
- <doc xml:space="preserve"
- filename="ges/ges-audio-track.c"
- line="20">A #GESAudioTrack is a default audio #GESTrack, with a
-#GES_TRACK_TYPE_AUDIO #GESTrack:track-type and "audio/x-raw(ANY)"
-#GESTrack:caps.
-
-By default, an audio track will have its #GESTrack:restriction-caps
-set to "audio/x-raw" with the following properties:
-
-- format: "S32LE"
-- channels: 2
-- rate: 44100
-- layout: "interleaved"
-
-These fields are needed for negotiation purposes, but you can change
-their values if you wish. It is advised that you do so using
-ges_track_update_restriction_caps() with new values for the fields you
-wish to change, and any additional fields you may want to add. Unlike
-using ges_track_set_restriction_caps(), this will ensure that these
-default fields will at least have some value set.</doc>
- <source-position filename="ges/ges-audio-track.h" line="39"/>
- <implements name="MetaContainer"/>
- <implements name="Gst.ChildProxy"/>
- <constructor name="new" c:identifier="ges_audio_track_new">
- <doc xml:space="preserve"
- filename="ges/ges-audio-track.c"
- line="117">Creates a new audio track, with a #GES_TRACK_TYPE_AUDIO
-#GESTrack:track-type, "audio/x-raw(ANY)" #GESTrack:caps, and
-"audio/x-raw" #GESTrack:restriction-caps with the properties:
-
-- format: "S32LE"
-- channels: 2
-- rate: 44100
-- layout: "interleaved"
-
-You should use ges_track_update_restriction_caps() if you wish to
-modify these fields, or add additional ones.</doc>
- <source-position filename="ges/ges-audio-track.h" line="52"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-audio-track.c"
- line="132">The newly created audio track.</doc>
- <type name="AudioTrack" c:type="GESAudioTrack*"/>
- </return-value>
- </constructor>
- <field name="parent_instance">
- <type name="Track" c:type="GESTrack"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioTrackPrivate" c:type="GESAudioTrackPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioTrackClass"
- c:type="GESAudioTrackClass"
- glib:is-gtype-struct-for="AudioTrack">
- <source-position filename="ges/ges-audio-track.h" line="39"/>
- <field name="parent_class">
- <type name="TrackClass" c:type="GESTrackClass"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AudioTrackPrivate"
- c:type="GESAudioTrackPrivate"
- disguised="1">
- <source-position filename="ges/ges-audio-track.h" line="30"/>
- </record>
- <class name="AudioTransition"
- c:symbol-prefix="audio_transition"
- c:type="GESAudioTransition"
- parent="Transition"
- glib:type-name="GESAudioTransition"
- glib:get-type="ges_audio_transition_get_type"
- glib:type-struct="AudioTransitionClass">
- <source-position filename="ges/ges-audio-transition.h" line="52"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new"
- c:identifier="ges_audio_transition_new"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-audio-transition.c"
- line="287">Creates a new #GESAudioTransition.</doc>
- <doc-deprecated xml:space="preserve">This should never be called by applications as this will
-be created by clips.</doc-deprecated>
- <source-position filename="ges/ges-audio-transition.h" line="55"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-audio-transition.c"
- line="292">The newly created #GESAudioTransition.</doc>
- <type name="AudioTransition" c:type="GESAudioTransition*"/>
- </return-value>
- </constructor>
- <field name="parent">
- <type name="Transition" c:type="GESTransition"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioTransitionPrivate"
- c:type="GESAudioTransitionPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioTransitionClass"
- c:type="GESAudioTransitionClass"
- glib:is-gtype-struct-for="AudioTransition">
- <source-position filename="ges/ges-audio-transition.h" line="52"/>
- <field name="parent_class">
- <type name="TransitionClass" c:type="GESTransitionClass"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AudioTransitionPrivate"
- c:type="GESAudioTransitionPrivate"
- disguised="1">
- <source-position filename="ges/ges-audio-transition.h" line="30"/>
- </record>
- <class name="AudioUriSource"
- c:symbol-prefix="audio_uri_source"
- c:type="GESAudioUriSource"
- parent="AudioSource"
- glib:type-name="GESAudioUriSource"
- glib:get-type="ges_audio_uri_source_get_type"
- glib:type-struct="AudioUriSourceClass">
- <doc xml:space="preserve"
- filename="ges/ges-audio-uri-source.h"
- line="32">### Children Properties
-
- {{ libs/GESVideoUriSource-children-props.md }}</doc>
- <source-position filename="ges/ges-audio-uri-source.h" line="57"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <property name="uri"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-audio-uri-source.c"
- line="183">The location of the file/resource to use.</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <field name="parent" readable="0" private="1">
- <type name="AudioSource" c:type="GESAudioSource"/>
- </field>
- <field name="uri" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioUriSourcePrivate" c:type="GESAudioUriSourcePrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioUriSourceClass"
- c:type="GESAudioUriSourceClass"
- glib:is-gtype-struct-for="AudioUriSource">
- <source-position filename="ges/ges-audio-uri-source.h" line="57"/>
- <field name="parent_class" readable="0" private="1">
- <type name="AudioSourceClass" c:type="GESAudioSourceClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AudioUriSourcePrivate"
- c:type="GESAudioUriSourcePrivate"
- disguised="1">
- <source-position filename="ges/ges-audio-uri-source.h" line="30"/>
- </record>
- <class name="BaseEffect"
- c:symbol-prefix="base_effect"
- c:type="GESBaseEffect"
- parent="Operation"
- abstract="1"
- glib:type-name="GESBaseEffect"
- glib:get-type="ges_base_effect_get_type"
- glib:type-struct="BaseEffectClass">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="20">A #GESBaseEffect is some operation that applies an effect to the data
-it receives.
-
-## Time Effects
-
-Some operations will change the timing of the stream data they receive
-in some way. In particular, the #GstElement that they wrap could alter
-the times of the segment they receive in a #GST_EVENT_SEGMENT event,
-or the times of a seek they receive in a #GST_EVENT_SEEK event. Such
-operations would be considered time effects since they translate the
-times they receive on their source to different times at their sink,
-and vis versa. This introduces two sets of time coordinates for the
-event: (internal) sink coordinates and (internal) source coordinates,
-where segment times are translated from the sink coordinates to the
-source coordinates, and seek times are translated from the source
-coordinates to the sink coordinates.
-
-If you use such an effect in GES, you will need to inform GES of the
-properties that control the timing with
-ges_base_effect_register_time_property(), and the effect's timing
-behaviour using ges_base_effect_set_time_translation_funcs().
-
-Note that a time effect should not have its
-#GESTrackElement:has-internal-source set to %TRUE.
-
-In addition, note that GES only *fully* supports time effects whose
-mapping from the source to sink coordinates (those applied to seeks)
-obeys:
-
-+ Maps the time `0` to `0`. So initial time-shifting effects are
- excluded.
-+ Is monotonically increasing. So reversing effects, and effects that
- jump backwards in the stream are excluded.
-+ Can handle a reasonable #GstClockTime, relative to the project. So
- this would exclude a time effect with an extremely large speed-up
- that would cause the converted #GstClockTime seeks to overflow.
-+ Is 'continuously reversible'. This essentially means that for every
- time in the sink coordinates, we can, to 'good enough' accuracy,
- calculate the corresponding time in the source coordinates. Moreover,
- this should correspond to how segment times are translated from
- sink to source.
-+ Only depends on the registered time properties, rather than the
- state of the #GstElement or the data it receives. This would exclude,
- say, an effect that would speedup if there is more red in the image
- it receives.
-
-Note that a constant-rate-change effect that is not extremely fast or
-slow would satisfy these conditions. For such effects, you may wish to
-use ges_effect_class_register_rate_property().</doc>
- <source-position filename="ges/ges-base-effect.h" line="57"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <method name="is_time_effect"
- c:identifier="ges_base_effect_is_time_effect"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="327">Get whether the effect is considered a time effect or not. An effect
-with registered time properties or set translation functions is
-considered a time effect.</doc>
- <source-position filename="ges/ges-base-effect.h" line="92"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="335">%TRUE if @effect is considered a time effect.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="effect" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="329">A #GESBaseEffect</doc>
- <type name="BaseEffect" c:type="GESBaseEffect*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="register_time_property"
- c:identifier="ges_base_effect_register_time_property"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="187">Register a child property of the effect as a property that, when set,
-can change the timing of its input data. The child property should be
-specified as in ges_timeline_element_lookup_child().
-
-You should also set the corresponding time translation using
-ges_base_effect_set_time_translation_funcs().
-
-Note that @effect must not be part of a clip, nor can it have
-#GESTrackElement:has-internal-source set to %TRUE.</doc>
- <source-position filename="ges/ges-base-effect.h" line="83"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="203">%TRUE if the child property was found and newly registered.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="effect" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="189">A #GESBaseEffect</doc>
- <type name="BaseEffect" c:type="GESBaseEffect*"/>
- </instance-parameter>
- <parameter name="child_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="190">The name of the child property to register as
-a time property</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_time_translation_funcs"
- c:identifier="ges_base_effect_set_time_translation_funcs"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="257">Set the time translation query functions for the time effect. If an
-effect is a time effect, it will have two sets of coordinates: one
-at its sink and one at its source. The given functions should be able
-to translate between these two sets of coordinates. More specifically,
-@source_to_sink_func should *emulate* how the corresponding #GstElement
-would translate the #GstSegment @time field, and @sink_to_source_func
-should emulate how the corresponding #GstElement would translate the
-seek query @start and @stop values, as used in gst_element_seek(). As
-such, @sink_to_source_func should act as an approximate reverse of
-@source_to_sink_func.
-
-Note, these functions will be passed a table of time properties, as
-registered in ges_base_effect_register_time_property(), and their
-values. The functions should emulate what the translation *would* be
-*if* the time properties were set to the given values. They should not
-use the currently set values.
-
-Note that @effect must not be part of a clip, nor can it have
-#GESTrackElement:has-internal-source set to %TRUE.</doc>
- <source-position filename="ges/ges-base-effect.h" line="86"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="291">%TRUE if the translation functions were set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="effect" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="259">A #GESBaseEffect</doc>
- <type name="BaseEffect" c:type="GESBaseEffect*"/>
- </instance-parameter>
- <parameter name="source_to_sink_func"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="notified">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="260">The function to use
-for querying how a time is translated from the source coordinates to
-the sink coordinates of @effect</doc>
- <type name="BaseEffectTimeTranslationFunc"
- c:type="GESBaseEffectTimeTranslationFunc"/>
- </parameter>
- <parameter name="sink_to_source_func"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="notified"
- closure="2"
- destroy="3">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="263">The function to use
-for querying how a time is translated from the sink coordinates to the
-source coordinates of @effect</doc>
- <type name="BaseEffectTimeTranslationFunc"
- c:type="GESBaseEffectTimeTranslationFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="notified">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="266">Data to pass to both @source_to_sink_func and
-@sink_to_source_func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="destroy"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="async"
- destroy="2">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.c"
- line="268">Method to call to destroy
-@user_data, or %NULL</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <field name="parent" readable="0" private="1">
- <type name="Operation" c:type="GESOperation"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="BaseEffectPrivate" c:type="GESBaseEffectPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="BaseEffectClass"
- c:type="GESBaseEffectClass"
- glib:is-gtype-struct-for="BaseEffect">
- <source-position filename="ges/ges-base-effect.h" line="57"/>
- <field name="parent_class" readable="0" private="1">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.h"
- line="46">parent class</doc>
- <type name="OperationClass" c:type="GESOperationClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="BaseEffectClip"
- c:symbol-prefix="base_effect_clip"
- c:type="GESBaseEffectClip"
- parent="OperationClip"
- abstract="1"
- glib:type-name="GESBaseEffectClip"
- glib:get-type="ges_base_effect_clip_get_type"
- glib:type-struct="BaseEffectClipClass">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect-clip.c"
- line="20">#GESBaseEffectClip-s are clips whose core elements are
-#GESBaseEffect-s.
-
-## Effects
-
-#GESBaseEffectClip-s can have **additional** #GESBaseEffect-s added as
-non-core elements. These additional effects are applied to the output
-of the core effects of the clip that they share a #GESTrack with. See
-#GESClip for how to add and move these effects from the clip.
-
-Note that you cannot add time effects to #GESBaseEffectClip, neither
-as core children, nor as additional effects.</doc>
- <source-position filename="ges/ges-base-effect-clip.h" line="54"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <field name="parent" readable="0" private="1">
- <type name="OperationClip" c:type="GESOperationClip"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="BaseEffectClipPrivate" c:type="GESBaseEffectClipPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="BaseEffectClipClass"
- c:type="GESBaseEffectClipClass"
- glib:is-gtype-struct-for="BaseEffectClip">
- <source-position filename="ges/ges-base-effect-clip.h" line="54"/>
- <field name="parent_class" readable="0" private="1">
- <type name="OperationClipClass" c:type="GESOperationClipClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="BaseEffectClipPrivate"
- c:type="GESBaseEffectClipPrivate"
- disguised="1">
- <source-position filename="ges/ges-base-effect-clip.h" line="28"/>
- </record>
- <record name="BaseEffectPrivate"
- c:type="GESBaseEffectPrivate"
- disguised="1">
- <source-position filename="ges/ges-base-effect.h" line="29"/>
- </record>
- <callback name="BaseEffectTimeTranslationFunc"
- c:type="GESBaseEffectTimeTranslationFunc"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.h"
- line="59">A function for querying how an effect would translate a time if it had
-the given child property values set. The keys for @time_properties will
-be the same string that was passed to
-ges_base_effect_register_time_property(), the values will be #GValue*
-values of the corresponding child properties. You should always use the
-values given in @time_properties before using the currently set values.</doc>
- <source-position filename="ges/ges-base-effect.h" line="77"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.h"
- line="74">The translated time.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <parameter name="effect" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.h"
- line="61">The #GESBaseEffect that is doing the time translation</doc>
- <type name="BaseEffect" c:type="GESBaseEffect*"/>
- </parameter>
- <parameter name="time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.h"
- line="62">The #GstClockTime to translation</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="time_property_values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.h"
- line="63">A table of child
-property name/value pairs</doc>
- <type name="GLib.HashTable" c:type="GHashTable*">
- <type name="utf8"/>
- <type name="GObject.Value"/>
- </type>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="3">
- <doc xml:space="preserve"
- filename="ges/ges-base-effect.h"
- line="65">Data passed to ges_base_effect_set_time_translation_funcs()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <class name="BaseTransitionClip"
- c:symbol-prefix="base_transition_clip"
- c:type="GESBaseTransitionClip"
- parent="OperationClip"
- abstract="1"
- glib:type-name="GESBaseTransitionClip"
- glib:get-type="ges_base_transition_clip_get_type"
- glib:type-struct="BaseTransitionClipClass">
- <source-position filename="ges/ges-base-transition-clip.h" line="58"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <field name="parent" readable="0" private="1">
- <type name="OperationClip" c:type="GESOperationClip"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="BaseTransitionClipPrivate"
- c:type="GESBaseTransitionClipPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="BaseTransitionClipClass"
- c:type="GESBaseTransitionClipClass"
- glib:is-gtype-struct-for="BaseTransitionClip">
- <source-position filename="ges/ges-base-transition-clip.h" line="58"/>
- <field name="parent_class" readable="0" private="1">
- <type name="OperationClipClass" c:type="GESOperationClipClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="BaseTransitionClipPrivate"
- c:type="GESBaseTransitionClipPrivate"
- disguised="1">
- <source-position filename="ges/ges-base-transition-clip.h" line="31"/>
- </record>
- <class name="BaseXmlFormatter"
- c:symbol-prefix="base_xml_formatter"
- c:type="GESBaseXmlFormatter"
- parent="Formatter"
- abstract="1"
- glib:type-name="GESBaseXmlFormatter"
- glib:get-type="ges_base_xml_formatter_get_type"
- glib:type-struct="BaseXmlFormatterClass">
- <source-position filename="ges/ges-base-xml-formatter.h" line="60"/>
- <implements name="Extractable"/>
- <field name="parent">
- <type name="Formatter" c:type="GESFormatter"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="BaseXmlFormatterPrivate"
- c:type="GESBaseXmlFormatterPrivate*"/>
- </field>
- <field name="xmlcontent" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="BaseXmlFormatterClass"
- c:type="GESBaseXmlFormatterClass"
- glib:is-gtype-struct-for="BaseXmlFormatter">
- <source-position filename="ges/ges-base-xml-formatter.h" line="60"/>
- <field name="parent">
- <type name="FormatterClass" c:type="GESFormatterClass"/>
- </field>
- <field name="content_parser">
- <type name="GLib.MarkupParser" c:type="GMarkupParser"/>
- </field>
- <field name="save">
- <callback name="save" throws="1">
- <source-position filename="ges/ges-base-xml-formatter.h" line="57"/>
- <return-value transfer-ownership="full">
- <type name="GLib.String" c:type="GString*"/>
- </return-value>
- <parameters>
- <parameter name="formatter" transfer-ownership="none">
- <type name="Formatter" c:type="GESFormatter*"/>
- </parameter>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="BaseXmlFormatterPrivate"
- c:type="GESBaseXmlFormatterPrivate"
- disguised="1">
- <source-position filename="ges/ges-base-xml-formatter.h" line="30"/>
- </record>
- <function-macro name="CLIP_CLASS_CAN_ADD_EFFECTS"
- c:identifier="GES_CLIP_CLASS_CAN_ADD_EFFECTS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="35">Whether the class allows for the user to add additional non-core
-#GESBaseEffect-s to clips from this class.</doc>
- <source-position filename="ges/ges-clip.h" line="42"/>
- <parameters>
- <parameter name="klass">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="37">A #GESClipClass</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CONTAINER_CHILDREN"
- c:identifier="GES_CONTAINER_CHILDREN"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-container.h"
- line="57">The #GList containing the children of @obj.</doc>
- <source-position filename="ges/ges-container.h" line="63"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-container.h"
- line="59">a #GESContainer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CONTAINER_HEIGHT"
- c:identifier="GES_CONTAINER_HEIGHT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-container.h"
- line="49">The #GESContainer:height of @obj.</doc>
- <source-position filename="ges/ges-container.h" line="55"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-container.h"
- line="51">a #GESContainer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <enumeration name="ChildrenControlMode" c:type="GESChildrenControlMode">
- <doc xml:space="preserve"
- filename="ges/ges-container.h"
- line="34">To be used by subclasses only. This indicate how to handle a change in
-a child.</doc>
- <source-position filename="ges/ges-container.h" line="47"/>
- <member name="update" value="0" c:identifier="GES_CHILDREN_UPDATE">
- </member>
- <member name="ignore_notifies"
- value="1"
- c:identifier="GES_CHILDREN_IGNORE_NOTIFIES">
- </member>
- <member name="update_offsets"
- value="2"
- c:identifier="GES_CHILDREN_UPDATE_OFFSETS">
- </member>
- <member name="update_all_values"
- value="3"
- c:identifier="GES_CHILDREN_UPDATE_ALL_VALUES">
- </member>
- <member name="last" value="4" c:identifier="GES_CHILDREN_LAST">
- </member>
- </enumeration>
- <class name="Clip"
- c:symbol-prefix="clip"
- c:type="GESClip"
- parent="Container"
- abstract="1"
- glib:type-name="GESClip"
- glib:get-type="ges_clip_get_type"
- glib:type-struct="ClipClass">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="23">#GESClip-s are the core objects of a #GESLayer. Each clip may exist in
-a single layer but may control several #GESTrackElement-s that span
-several #GESTrack-s. A clip will ensure that all its children share the
-same #GESTimelineElement:start and #GESTimelineElement:duration in
-their tracks, which will match the #GESTimelineElement:start and
-#GESTimelineElement:duration of the clip itself. Therefore, changing
-the timing of the clip will change the timing of the children, and a
-change in the timing of a child will change the timing of the clip and
-subsequently all its siblings. As such, a clip can be treated as a
-singular object in its layer.
-
-For most uses of a #GESTimeline, it is often sufficient to only
-interact with #GESClip-s directly, which will take care of creating and
-organising the elements of the timeline's tracks.
-
-## Core Children
-
-In more detail, clips will usually have some *core* #GESTrackElement
-children, which are created by the clip when it is added to a layer in
-a timeline. The type and form of these core children will depend on the
-clip's subclass. You can use ges_track_element_is_core() to determine
-whether a track element is considered such a core track element. Note,
-if a core track element is part of a clip, it will always be treated as
-a core *child* of the clip. You can connect to the
-#GESContainer::child-added signal to be notified of their creation.
-
-When a child is added to a clip, the timeline will select its tracks
-using #GESTimeline::select-tracks-for-object. Note that it may be the
-case that the child will still have no set #GESTrackElement:track
-after this process. For example, if the timeline does not have a track
-of the corresponding #GESTrack:track-type. A clip can safely contain
-such children, which may have their track set later, although they will
-play no functioning role in the timeline in the meantime.
-
-If a clip may create track elements with various
-#GESTrackElement:track-type(s), such as a #GESUriClip, but you only
-want it to create a subset of these types, you should set the
-#GESClip:supported-formats of the clip to the subset of types. This
-should be done *before* adding the clip to a layer.
-
-If a clip will produce several core elements of the same
-#GESTrackElement:track-type, you should connect to the timeline's
-#GESTimeline::select-tracks-for-object signal to coordinate which
-tracks each element should land in. Note, no two core children within a
-clip can share the same #GESTrack, so you should not select the same
-track for two separate core children. Provided you stick to this rule,
-it is still safe to select several tracks for the same core child, the
-core child will be copied into the additional tracks. You can manually
-add the child to more tracks later using ges_clip_add_child_to_track().
-If you do not wish to use a core child, you can always select no track.
-
-The #GESTimelineElement:in-point of the clip will control the
-#GESTimelineElement:in-point of its core children to be the same
-value if their #GESTrackElement:has-internal-source is set to %TRUE.
-
-The #GESTimelineElement:max-duration of the clip is the minimum
-#GESTimelineElement:max-duration of its core children. If you set its
-value to anything other than its current value, this will also set the
-#GESTimelineElement:max-duration of all its core children to the same
-value if their #GESTrackElement:has-internal-source is set to %TRUE.
-As a special case, whilst a clip does not yet have any core children,
-its #GESTimelineElement:max-duration may be set to indicate what its
-value will be once they are created.
-
-## Effects
-
-Some subclasses (#GESSourceClip and #GESBaseEffectClip) may also allow
-their objects to have additional non-core #GESBaseEffect-s elements as
-children. These are additional effects that are applied to the output
-data of the core elements. They can be added to the clip using
-ges_clip_add_top_effect(), which will take care of adding the effect to
-the timeline's tracks. The new effect will be placed between the clip's
-core track elements and its other effects. As such, the newly added
-effect will be applied to any source data **before** the other existing
-effects. You can change the ordering of effects using
-ges_clip_set_top_effect_index().
-
-Tracks are selected for top effects in the same way as core children.
-If you add a top effect to a clip before it is part of a timeline, and
-later add the clip to a timeline, the track selection for the top
-effects will occur just after the track selection for the core
-children. If you add a top effect to a clip that is already part of a
-timeline, the track selection will occur immediately. Since a top
-effect must be applied on top of a core child, if you use
-#GESTimeline::select-tracks-for-object, you should ensure that the
-added effects are destined for a #GESTrack that already contains a core
-child.
-
-In addition, if the core child in the track is not
-#GESTrackElement:active, then neither can any of its effects be
-#GESTrackElement:active. Therefore, if a core child is made in-active,
-all of the additional effects in the same track will also become
-in-active. Similarly, if an effect is set to be active, then the core
-child will also become active, but other effects will be left alone.
-Finally, if an active effect is added to the track of an in-active core
-child, it will become in-active as well. Note, in contrast, setting a
-core child to be active, or an effect to be in-active will *not* change
-the other children in the same track.
-
-### Time Effects
-
-Some effects also change the timing of their data (see #GESBaseEffect
-for what counts as a time effect). Note that a #GESBaseEffectClip will
-refuse time effects, but a #GESSource will allow them.
-
-When added to a clip, time effects may adjust the timing of other
-children in the same track. Similarly, when changing the order of
-effects, making them (in)-active, setting their time property values
-or removing time effects. These can cause the #GESClip:duration-limit
-to change in value. However, if such an operation would ever cause the
-#GESTimelineElement:duration to shrink such that a clip's #GESSource is
-totally overlapped in the timeline, the operation would be prevented.
-Note that the same can happen when adding non-time effects with a
-finite #GESTimelineElement:max-duration.
-
-Therefore, when working with time effects, you should -- more so than
-usual -- not assume that setting the properties of the clip's children
-will succeed. In particular, you should use
-ges_timeline_element_set_child_property_full() when setting the time
-properties.
-
-If you wish to preserve the *internal* duration of a source in a clip
-during these time effect operations, you can do something like the
-following.
-
-```c
-void
-do_time_effect_change (GESClip * clip)
-{
- GList *tmp, *children;
- GESTrackElement *source;
- GstClockTime source_outpoint;
- GstClockTime new_end;
- GError *error = NULL;
-
- // choose some active source in a track to preserve the internal
- // duration of
- source = ges_clip_get_track_element (clip, NULL, GES_TYPE_SOURCE);
-
- // note its current internal end time
- source_outpoint = ges_clip_get_internal_time_from_timeline_time (
- clip, source, GES_TIMELINE_ELEMENT_END (clip), NULL);
-
- // handle invalid out-point
-
- // stop the children's control sources from clamping when their
- // out-point changes with a change in the time effects
- children = ges_container_get_children (GES_CONTAINER (clip), FALSE);
-
- for (tmp = children; tmp; tmp = tmp-&gt;next)
- ges_track_element_set_auto_clamp_control_source (tmp-&gt;data, FALSE);
-
- // add time effect, or set their children properties, or move them around
- ...
- // user can make sure that if a time effect changes one source, we should
- // also change the time effect for another source. E.g. if
- // "GstVideorate::rate" is set to 2.0, we also set "GstPitch::rate" to
- // 2.0
-
- // Note the duration of the clip may have already changed if the
- // duration-limit of the clip dropped below its current value
-
- new_end = ges_clip_get_timeline_time_from_internal_time (
- clip, source, source_outpoint, &amp;error);
- // handle error
-
- if (!ges_timeline_elemnet_edit_full (GES_TIMELINE_ELEMENT (clip),
- -1, GES_EDIT_MODE_TRIM, GES_EDGE_END, new_end, &amp;error))
- // handle error
-
- for (tmp = children; tmp; tmp = tmp-&gt;next)
- ges_track_element_set_auto_clamp_control_source (tmp-&gt;data, TRUE);
-
- g_list_free_full (children, gst_object_unref);
- gst_object_unref (source);
-}
-```</doc>
- <source-position filename="ges/ges-clip.h" line="140"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <virtual-method name="create_track_element">
- <source-position filename="ges/ges-clip.h" line="78"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="74">The #GESTrackElement created
-by @clip, or %NULL if @clip can not provide a track element for the
-given @type or an error occurred.</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="65">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="66">A #GESTrackType to create a #GESTrackElement for</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="create_track_elements">
- <source-position filename="ges/ges-clip.h" line="92"/>
- <return-value transfer-ownership="container">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="88">A list of
-the #GESTrackElement-s created by @clip for the given @type, or %NULL
-if no track elements are created or an error occurred.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="TrackElement"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="82">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="83">A #GESTrackType to create #GESTrackElement-s for</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add_asset" c:identifier="ges_clip_add_asset">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3588">Extracts a #GESTrackElement from an asset and adds it to the clip.
-This can be used to add effects that derive from the asset to the
-clip, but this method is not intended to be used to create the core
-elements of the clip.</doc>
- <source-position filename="ges/ges-clip.h" line="151"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3599">The newly created element, or
-%NULL if an error occurred.</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3590">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3591">An asset with #GES_TYPE_TRACK_ELEMENT as its
-#GESAsset:extractable-type</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_child_to_track"
- c:identifier="ges_clip_add_child_to_track"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4389">Adds the track element child of the clip to a specific track.
-
-If the given child is already in another track, this will create a copy
-of the child, add it to the clip, and add this copy to the track.
-
-You should only call this whilst a clip is part of a #GESTimeline, and
-for tracks that are in the same timeline.
-
-This method is an alternative to using the
-#GESTimeline::select-tracks-for-object signal, but can be used to
-complement it when, say, you wish to copy a clip's children from one
-track into a new one.
-
-When the child is a core child, it must be added to a track that does
-not already contain another core child of the same clip. If it is not a
-core child (an additional effect), then it must be added to a track
-that already contains one of the core children of the same clip.
-
-This method can also fail if the adding the track element to the track
-would break a configuration rule of the corresponding #GESTimeline,
-such as causing three sources to overlap at a single time, or causing
-a source to completely overlap another in the same track.</doc>
- <source-position filename="ges/ges-clip.h" line="164"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4419">The element that was added to @track, either
-@child or a copy of child, or %NULL if the element could not be added.</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4391">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4392">A child of @clip</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- <parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4393">The track to add @child to</doc>
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_top_effect"
- c:identifier="ges_clip_add_top_effect"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2997">Add a top effect to a clip at the given index.
-
-Unlike using ges_container_add(), this allows you to set the index
-in advance. It will also check that no error occurred during the track
-selection for the effect.
-
-Note, only subclasses of #GESClipClass that have
-#GES_CLIP_CLASS_CAN_ADD_EFFECTS set to %TRUE (such as #GESSourceClip
-and #GESBaseEffectClip) can have additional top effects added.
-
-Note, if the effect is a time effect, this may be refused if the clip
-would not be able to adapt itself once the effect is added.</doc>
- <source-position filename="ges/ges-clip.h" line="186"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3017">%TRUE if @effect was successfully added to @clip at @index.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2999">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="effect" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3000">A top effect to add</doc>
- <type name="BaseEffect" c:type="GESBaseEffect*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3001">The index to add @effect at, or -1 to add at the highest</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="find_track_element"
- c:identifier="ges_clip_find_track_element">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2899">Finds an element controlled by the clip. If @track is given,
-then only the track elements in @track are searched for. If @type is
-given, then this function searches for a track element of the given
-@type.
-
-Note, if multiple track elements in the clip match the given criteria,
-this will return the element amongst them with the highest
-#GESTimelineElement:priority (numerically, the smallest). See
-ges_clip_find_track_elements() if you wish to find all such elements.</doc>
- <source-position filename="ges/ges-clip.h" line="154"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2917">The element controlled by
-@clip, in @track, and of the given @type, or %NULL if no such element
-could be found.</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2901">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="track"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2902">The track to search in, or %NULL to search in
-all tracks</doc>
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2904">The type of track element to search for, or `G_TYPE_NONE` to
-match any type</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="find_track_elements"
- c:identifier="ges_clip_find_track_elements">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3622">Finds the #GESTrackElement-s controlled by the clip that match the
-given criteria. If @track is given as %NULL and @track_type is given as
-#GES_TRACK_TYPE_UNKNOWN, then the search will match all elements in any
-track, including those with no track, and of any
-#GESTrackElement:track-type. Otherwise, if @track is not %NULL, but
-@track_type is #GES_TRACK_TYPE_UNKNOWN, then only the track elements in
-@track are searched for. Otherwise, if @track_type is not
-#GES_TRACK_TYPE_UNKNOWN, but @track is %NULL, then only the track
-elements whose #GESTrackElement:track-type matches @track_type are
-searched for. Otherwise, when both are given, the track elements that
-match **either** criteria are searched for. Therefore, if you wish to
-only find elements in a specific track, you should give the track as
-@track, but you should not give the track's #GESTrack:track-type as
-@track_type because this would also select elements from other tracks
-of the same type.
-
-You may also give @type to _further_ restrict the search to track
-elements of the given @type.</doc>
- <source-position filename="ges/ges-clip.h" line="158"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3651">A list of all
-the #GESTrackElement-s controlled by @clip, in @track or of the given
-@track_type, and of the given @type.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="TrackElement"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3624">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="track"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3625">The track to search in, or %NULL to search in
-all tracks</doc>
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- <parameter name="track_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3627">The track-type of the track element to search for, or
-#GES_TRACK_TYPE_UNKNOWN to match any track type</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3629">The type of track element to search for, or %G_TYPE_NONE to
-match any type</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_duration_limit"
- c:identifier="ges_clip_get_duration_limit"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2969">Gets the #GESClip:duration-limit of the clip.</doc>
- <source-position filename="ges/ges-clip.h" line="243"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2975">The duration-limit of @clip.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2971">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_internal_time_from_timeline_time"
- c:identifier="ges_clip_get_internal_time_from_timeline_time"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4102">Convert the timeline time to an internal source time of the child.
-This will take any time effects placed on the clip into account (see
-#GESBaseEffect for what time effects are supported, and how to
-declare them in GES).
-
-When @timeline_time is above the #GESTimelineElement:start of @clip,
-this will return the internal time at which the content that appears at
-@timeline_time in the output of the timeline is created in @child. For
-example, if @timeline_time corresponds to the current seek position,
-this would let you know which part of a media file is being read.
-
-This will be done assuming the clip has an indefinite end, so the
-internal time may be beyond the current out-point of the child, or even
-its #GESTimelineElement:max-duration.
-
-If, instead, @timeline_time is below the current
-#GESTimelineElement:start of @clip, this will return what you would
-need to set the #GESTimelineElement:in-point of @child to if you set
-the #GESTimelineElement:start of @clip to @timeline_time and wanted
-to keep the content of @child currently found at the current
-#GESTimelineElement:start of @clip at the same timeline position. If
-this would be negative, the conversion fails. This is useful for
-determining what #GESTimelineElement:in-point would result from a
-#GES_EDIT_MODE_TRIM to @timeline_time.
-
-Note that whilst a clip has no time effects, this second return is
-equivalent to finding the internal time at which the content that
-appears at @timeline_time in the timeline can be found in @child if it
-had indefinite extent in both directions. However, with non-linear time
-effects this second return will be more distinct.
-
-In either case, the returned time would be appropriate to use for the
-#GESTimelineElement:in-point or #GESTimelineElement:max-duration of the
-child.
-
-See ges_clip_get_timeline_time_from_internal_time(), which performs the
-reverse.</doc>
- <source-position filename="ges/ges-clip.h" line="228"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4148">The time in the internal coordinates of @child corresponding
-to @timeline_time, or #GST_CLOCK_TIME_NONE if the conversion could not
-be performed.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4104">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4105">An #GESTrackElement:active child of @clip with a
-#GESTrackElement:track</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- <parameter name="timeline_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4107">A time in the timeline time coordinates</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_layer" c:identifier="ges_clip_get_layer">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2949">Gets the #GESClip:layer of the clip.</doc>
- <source-position filename="ges/ges-clip.h" line="173"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2955">The layer @clip is in, or %NULL if
-@clip is not in any layer.</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2951">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_supported_formats"
- c:identifier="ges_clip_get_supported_formats">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3572">Gets the #GESClip:supported-formats of the clip.</doc>
- <source-position filename="ges/ges-clip.h" line="146"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3578">The #GESTrackType-s supported by @clip.</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3574">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_timeline_time_from_internal_time"
- c:identifier="ges_clip_get_timeline_time_from_internal_time"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3951">Convert the internal source time from the child to a timeline time.
-This will take any time effects placed on the clip into account (see
-#GESBaseEffect for what time effects are supported, and how to
-declare them in GES).
-
-When @internal_time is above the #GESTimelineElement:in-point of
-@child, this will return the timeline time at which the internal
-content found at @internal_time appears in the output of the timeline's
-track. For example, this would let you know where in the timeline a
-particular scene in a media file would appear.
-
-This will be done assuming the clip has an indefinite end, so the
-timeline time may be beyond the end of the clip, or even breaking its
-#GESClip:duration-limit.
-
-If, instead, @internal_time is below the current
-#GESTimelineElement:in-point of @child, this will return what you would
-need to set the #GESTimelineElement:start of @clip to if you set the
-#GESTimelineElement:in-point of @child to @internal_time and wanted to
-keep the content of @child currently found at the current
-#GESTimelineElement:start of @clip at the same timeline position. If
-this would be negative, the conversion fails. This is useful for
-determining what position to use in a #GES_EDIT_MODE_TRIM if you wish
-to trim to a specific point in the internal content, such as a
-particular scene in a media file.
-
-Note that whilst a clip has no time effects, this second return is
-equivalent to finding the timeline time at which the content of @child
-at @internal_time would be found in the timeline if it had indefinite
-extent in both directions. However, with non-linear time effects this
-second return will be more distinct.
-
-In either case, the returned time would be appropriate to use in
-ges_timeline_element_edit() for #GES_EDIT_MODE_TRIM, and similar, if
-you wish to use a particular internal point as a reference. For
-example, you could choose to end a clip at a certain internal
-'out-point', similar to the #GESTimelineElement:in-point, by
-translating the desired end time into the timeline coordinates, and
-using this position to trim the end of a clip.
-
-See ges_clip_get_internal_time_from_timeline_time(), which performs the
-reverse, or ges_clip_get_timeline_time_from_source_frame() which does
-the same conversion, but using frame numbers.</doc>
- <source-position filename="ges/ges-clip.h" line="233"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4003">The time in the timeline coordinates corresponding to
-@internal_time, or #GST_CLOCK_TIME_NONE if the conversion could not be
-performed.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3953">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3954">An #GESTrackElement:active child of @clip with a
-#GESTrackElement:track</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- <parameter name="internal_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3956">A time in the internal time coordinates of @child</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_timeline_time_from_source_frame"
- c:identifier="ges_clip_get_timeline_time_from_source_frame"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4335">Convert the source frame number to a timeline time. This acts the same
-as ges_clip_get_timeline_time_from_internal_time() using the core
-children of the clip and using the frame number to specify the internal
-position, rather than a timestamp.
-
-The returned timeline time can be used to seek or edit to a specific
-frame.
-
-Note that you can get the frame timestamp of a particular clip asset
-with ges_clip_asset_get_frame_time().</doc>
- <source-position filename="ges/ges-clip.h" line="238"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4353">The timestamp corresponding to @frame_number in the core
-children of @clip, in the timeline coordinates, or #GST_CLOCK_TIME_NONE
-if the conversion could not be performed.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4337">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="frame_number" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="4338">The frame number to get the corresponding timestamp of
-in the timeline coordinates</doc>
- <type name="FrameNumber" c:type="GESFrameNumber"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_top_effect_index"
- c:identifier="ges_clip_get_top_effect_index">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3167">Gets the internal index of an effect in the clip. The index of effects
-in a clip will run from 0 to n-1, where n is the total number of
-effects. If two effects share the same #GESTrackElement:track, the
-effect with the numerically lower index will be applied to the source
-data **after** the other effect, i.e. output data will always flow from
-a higher index effect to a lower index effect.</doc>
- <source-position filename="ges/ges-clip.h" line="200"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3179">The index of @effect in @clip, or -1 if something went wrong.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3169">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="effect" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3170">The effect we want to get the index of</doc>
- <type name="BaseEffect" c:type="GESBaseEffect*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_top_effect_position"
- c:identifier="ges_clip_get_top_effect_position">
- <source-position filename="ges/ges-clip.h" line="197"/>
- <return-value transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="effect" transfer-ownership="none">
- <type name="BaseEffect" c:type="GESBaseEffect*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_top_effects" c:identifier="ges_clip_get_top_effects">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3136">Gets the #GESBaseEffect-s that have been added to the clip. The
-returned list is ordered by their internal index in the clip. See
-ges_clip_get_top_effect_index().</doc>
- <source-position filename="ges/ges-clip.h" line="195"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3144">A list of all
-#GESBaseEffect-s that have been added to @clip.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="TrackElement"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3138">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="move_to_layer" c:identifier="ges_clip_move_to_layer">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2884">See ges_clip_move_to_layer_full(), which also gives an error.</doc>
- <source-position filename="ges/ges-clip.h" line="175"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2891">%TRUE if @clip was successfully moved to @layer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2886">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2887">The new layer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="move_to_layer_full"
- c:identifier="ges_clip_move_to_layer_full"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2800">Moves a clip to a new layer. If the clip already exists in a layer, it
-is first removed from its current layer before being added to the new
-layer.</doc>
- <source-position filename="ges/ges-clip.h" line="178"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2810">%TRUE if @clip was successfully moved to @layer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2802">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2803">The new layer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_top_effect"
- c:identifier="ges_clip_remove_top_effect"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3101">Remove a top effect from the clip.
-
-Note, if the effect is a time effect, this may be refused if the clip
-would not be able to adapt itself once the effect is removed.</doc>
- <source-position filename="ges/ges-clip.h" line="191"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3112">%TRUE if @effect was successfully added to @clip at @index.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3103">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="effect" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3104">The top effect to remove</doc>
- <type name="BaseEffect" c:type="GESBaseEffect*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_supported_formats"
- c:identifier="ges_clip_set_supported_formats">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3555">Sets the #GESClip:supported-formats of the clip. This should normally
-only be called by subclasses, which should be responsible for updating
-its value, rather than the user.</doc>
- <source-position filename="ges/ges-clip.h" line="148"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3557">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="supportedformats" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3558">The #GESTrackType-s supported by @clip</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_top_effect_index"
- c:identifier="ges_clip_set_top_effect_index">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3321">See ges_clip_set_top_effect_index_full(), which also gives an error.</doc>
- <source-position filename="ges/ges-clip.h" line="207"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3329">%TRUE if @effect was successfully moved to @newindex.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3323">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="effect" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3324">An effect within @clip to move</doc>
- <type name="BaseEffect" c:type="GESBaseEffect*"/>
- </parameter>
- <parameter name="newindex" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3325">The index for @effect in @clip</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_top_effect_index_full"
- c:identifier="ges_clip_set_top_effect_index_full"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3214">Set the index of an effect within the clip. See
-ges_clip_get_top_effect_index(). The new index must be an existing
-index of the clip. The effect is moved to the new index, and the other
-effects may be shifted in index accordingly to otherwise maintain the
-ordering.</doc>
- <source-position filename="ges/ges-clip.h" line="211"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3227">%TRUE if @effect was successfully moved to @newindex.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3216">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="effect" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3217">An effect within @clip to move</doc>
- <type name="BaseEffect" c:type="GESBaseEffect*"/>
- </parameter>
- <parameter name="newindex" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3218">The index for @effect in @clip</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_top_effect_priority"
- c:identifier="ges_clip_set_top_effect_priority">
- <source-position filename="ges/ges-clip.h" line="203"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="effect" transfer-ownership="none">
- <type name="BaseEffect" c:type="GESBaseEffect*"/>
- </parameter>
- <parameter name="newpriority" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="split" c:identifier="ges_clip_split">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3539">See ges_clip_split_full(), which also gives an error.</doc>
- <source-position filename="ges/ges-clip.h" line="220"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3546">The newly created clip resulting
-from the splitting @clip, or %NULL if @clip can't be split.</doc>
- <type name="Clip" c:type="GESClip*"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3541">The #GESClip to split</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3542">The timeline position at which to perform the split</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="split_full"
- c:identifier="ges_clip_split_full"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3338">Splits a clip at the given timeline position into two clips. The clip
-must already have a #GESClip:layer.
-
-The original clip's #GESTimelineElement:duration is reduced such that
-its end point matches the split position. Then a new clip is created in
-the same layer, whose #GESTimelineElement:start matches the split
-position and #GESTimelineElement:duration will be set such that its end
-point matches the old end point of the original clip. Thus, the two
-clips together will occupy the same positions in the timeline as the
-original clip did.
-
-The children of the new clip will be new copies of the original clip's
-children, so it will share the same sources and use the same
-operations.
-
-The new clip will also have its #GESTimelineElement:in-point set so
-that any internal data will appear in the timeline at the same time.
-Thus, when the timeline is played, the playback of data should
-appear the same. This may be complicated by any additional
-#GESEffect-s that have been placed on the original clip that depend on
-the playback time or change the data consumption rate of sources. This
-method will attempt to translate these effects such that the playback
-appears the same. In such complex situations, you may get a better
-result if you place the clip in a separate sub #GESProject, which only
-contains this clip (and its effects), and in the original layer
-create two neighbouring #GESUriClip-s that reference this sub-project,
-but at a different #GESTimelineElement:in-point.</doc>
- <source-position filename="ges/ges-clip.h" line="223"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3373">The newly created clip resulting
-from the splitting @clip, or %NULL if @clip can't be split.</doc>
- <type name="Clip" c:type="GESClip*"/>
- </return-value>
- <parameters>
- <instance-parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3340">The #GESClip to split</doc>
- <type name="Clip" c:type="GESClip*"/>
- </instance-parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="3341">The timeline position at which to perform the split, between
-the start and end of the clip</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <property name="duration-limit" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2576">The maximum #GESTimelineElement:duration that can be *currently* set
-for the clip, taking into account the #GESTimelineElement:in-point,
-#GESTimelineElement:max-duration, #GESTrackElement:active, and
-#GESTrackElement:track properties of its children, as well as any
-time effects. If there is no limit, this will be set to
-#GST_CLOCK_TIME_NONE.
-
-Note that whilst a clip has no children in any tracks, the limit will
-be unknown, and similarly set to #GST_CLOCK_TIME_NONE.
-
-If the duration-limit would ever go below the current
-#GESTimelineElement:duration of the clip due to a change in the above
-variables, its #GESTimelineElement:duration will be set to the new
-limit.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2561">The layer this clip lies in.
-
-If you want to connect to this property's #GObject::notify signal,
-you should connect to it with g_signal_connect_after() since the
-signal emission may be stopped internally.</doc>
- <type name="Layer"/>
- </property>
- <property name="supported-formats"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.c"
- line="2545">The #GESTrackType-s that the clip supports, which it can create
-#GESTrackElement-s for. Note that this can be a combination of
-#GESTrackType flags to indicate support for several
-#GESTrackElement:track-type elements.</doc>
- <type name="TrackType"/>
- </property>
- <field name="parent">
- <type name="Container" c:type="GESContainer"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="ClipPrivate" c:type="GESClipPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <class name="ClipAsset"
- c:symbol-prefix="clip_asset"
- c:type="GESClipAsset"
- parent="Asset"
- glib:type-name="GESClipAsset"
- glib:get-type="ges_clip_asset_get_type"
- glib:type-struct="ClipAssetClass">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="20">The #GESUriClipAsset is a special #GESAsset specilized in #GESClip.
-it is mostly used to get information about the #GESTrackType-s the objects extracted
-from it can potentialy create #GESTrackElement for.</doc>
- <source-position filename="ges/ges-clip-asset.h" line="51"/>
- <implements name="MetaContainer"/>
- <implements name="Gio.AsyncInitable"/>
- <implements name="Gio.Initable"/>
- <virtual-method name="get_natural_framerate"
- invoker="get_natural_framerate">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="178">Result: %TRUE if @self has a natural framerate %FALSE otherwise</doc>
- <source-position filename="ges/ges-clip-asset.h" line="48"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="180">The object from which to retrieve the natural framerate</doc>
- <type name="ClipAsset" c:type="GESClipAsset*"/>
- </instance-parameter>
- <parameter name="framerate_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="181">The framerate numerator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="framerate_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="182">The framerate denominator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="get_frame_time"
- c:identifier="ges_clip_asset_get_frame_time">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="205">Converts the given frame number into a timestamp, using the "natural" frame
-rate of the asset.
-
-You can use this to reference a specific frame in a media file and use this
-as, for example, the `in-point` or `max-duration` of a #GESClip.</doc>
- <source-position filename="ges/ges-clip-asset.h" line="61"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="216">The timestamp corresponding to @frame_number in the element source, given
-in internal time coordinates, or #GST_CLOCK_TIME_NONE if the clip asset does not have a
-natural frame rate.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="207">The object for which to compute timestamp for specifed frame</doc>
- <type name="ClipAsset" c:type="GESClipAsset*"/>
- </instance-parameter>
- <parameter name="frame_number" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="208">The frame number we want the internal time coordinate timestamp of</doc>
- <type name="FrameNumber" c:type="GESFrameNumber"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_natural_framerate"
- c:identifier="ges_clip_asset_get_natural_framerate">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="178">Result: %TRUE if @self has a natural framerate %FALSE otherwise</doc>
- <source-position filename="ges/ges-clip-asset.h" line="59"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="180">The object from which to retrieve the natural framerate</doc>
- <type name="ClipAsset" c:type="GESClipAsset*"/>
- </instance-parameter>
- <parameter name="framerate_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="181">The framerate numerator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="framerate_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="182">The framerate denominator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_supported_formats"
- c:identifier="ges_clip_asset_get_supported_formats">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="161">Gets track types for which objects extracted from @self can create #GESTrackElement</doc>
- <source-position filename="ges/ges-clip-asset.h" line="57"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="167">The track types on which @self will create TrackElement when added to
-a layer</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="163">a #GESClipAsset</doc>
- <type name="ClipAsset" c:type="GESClipAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_supported_formats"
- c:identifier="ges_clip_asset_set_supported_formats">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="145">Sets track types for which objects extracted from @self can create #GESTrackElement</doc>
- <source-position filename="ges/ges-clip-asset.h" line="54"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="147">a #GESClipAsset</doc>
- <type name="ClipAsset" c:type="GESClipAsset*"/>
- </instance-parameter>
- <parameter name="supportedformats" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="148">The track types supported by the GESClipAsset</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- </parameters>
- </method>
- <property name="supported-formats"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="126">The formats supported by the asset.</doc>
- <type name="TrackType"/>
- </property>
- <field name="parent">
- <type name="Asset" c:type="GESAsset"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="ClipAssetPrivate" c:type="GESClipAssetPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="ClipAssetClass"
- c:type="GESClipAssetClass"
- glib:is-gtype-struct-for="ClipAsset">
- <source-position filename="ges/ges-clip-asset.h" line="51"/>
- <field name="parent">
- <type name="AssetClass" c:type="GESAssetClass"/>
- </field>
- <field name="get_natural_framerate">
- <callback name="get_natural_framerate">
- <source-position filename="ges/ges-clip-asset.h" line="48"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="180">The object from which to retrieve the natural framerate</doc>
- <type name="ClipAsset" c:type="GESClipAsset*"/>
- </parameter>
- <parameter name="framerate_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="181">The framerate numerator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="framerate_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip-asset.c"
- line="182">The framerate denominator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="ClipAssetPrivate" c:type="GESClipAssetPrivate" disguised="1">
- <source-position filename="ges/ges-clip-asset.h" line="32"/>
- </record>
- <record name="ClipClass"
- c:type="GESClipClass"
- glib:is-gtype-struct-for="Clip">
- <source-position filename="ges/ges-clip.h" line="140"/>
- <field name="parent_class" readable="0" private="1">
- <type name="ContainerClass" c:type="GESContainerClass"/>
- </field>
- <field name="create_track_element">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="110">Method to create the core #GESTrackElement of
-a clip of this class. If a clip of this class may create several track
-elements per track type, this should be left as %NULL, and
-create_track_elements() should be used instead. Otherwise, you should
-implement this class method and leave create_track_elements() as the
-default implementation</doc>
- <type name="CreateTrackElementFunc"
- c:type="GESCreateTrackElementFunc"/>
- </field>
- <field name="create_track_elements">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="116">Method to create the (multiple) core
-#GESTrackElement-s of a clip of this class. If create_track_element()
-is implemented, this should be kept as the default implementation</doc>
- <type name="CreateTrackElementsFunc"
- c:type="GESCreateTrackElementsFunc"/>
- </field>
- <union name="ABI" c:type="ABI">
- <source-position filename="ges/ges-clip.h" line="139"/>
- <field name="_ges_reserved" writable="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <record name="abi" c:type="abi">
- <source-position filename="ges/ges-clip.h" line="138"/>
- <field name="can_add_effects" writable="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- </record>
- </union>
- </record>
- <record name="ClipPrivate" c:type="GESClipPrivate" disguised="1">
- <source-position filename="ges/ges-clip.h" line="33"/>
- </record>
- <class name="CommandLineFormatter"
- c:symbol-prefix="command_line_formatter"
- c:type="GESCommandLineFormatter"
- parent="Formatter"
- glib:type-name="GESCommandLineFormatter"
- glib:get-type="ges_command_line_formatter_get_type"
- glib:type-struct="CommandLineFormatterClass">
- <source-position filename="ges/ges-command-line-formatter.h" line="37"/>
- <implements name="Extractable"/>
- <function name="get_help"
- c:identifier="ges_command_line_formatter_get_help">
- <source-position filename="ges/ges-command-line-formatter.h"
- line="47"/>
- <return-value transfer-ownership="full">
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="nargs" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="commands" transfer-ownership="none">
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </function>
- <field name="parent_instance">
- <type name="Formatter" c:type="GESFormatter"/>
- </field>
- <field name="priv">
- <type name="CommandLineFormatterPrivate"
- c:type="GESCommandLineFormatterPrivate*"/>
- </field>
- </class>
- <record name="CommandLineFormatterClass"
- c:type="GESCommandLineFormatterClass"
- glib:is-gtype-struct-for="CommandLineFormatter">
- <source-position filename="ges/ges-command-line-formatter.h" line="37"/>
- <field name="parent_class">
- <type name="FormatterClass" c:type="GESFormatterClass"/>
- </field>
- </record>
- <record name="CommandLineFormatterPrivate"
- c:type="GESCommandLineFormatterPrivate"
- disguised="1">
- <source-position filename="ges/ges-command-line-formatter.h" line="32"/>
- </record>
- <class name="Container"
- c:symbol-prefix="container"
- c:type="GESContainer"
- parent="TimelineElement"
- abstract="1"
- glib:type-name="GESContainer"
- glib:get-type="ges_container_get_type"
- glib:type-struct="ContainerClass">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="21">A #GESContainer is a timeline element that controls other
-#GESTimelineElement-s, which are its children. In particular, it is
-responsible for maintaining the relative #GESTimelineElement:start and
-#GESTimelineElement:duration times of its children. Therefore, if a
-container is temporally adjusted or moved to a new layer, it may
-accordingly adjust and move its children. Similarly, a change in one of
-its children may prompt the parent to correspondingly change its
-siblings.</doc>
- <source-position filename="ges/ges-container.h" line="137"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <function name="group" c:identifier="ges_container_group">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="987">Groups the containers into a single container by merging them. The
-containers must all belong to the same #GESTimelineElement:timeline.
-
-If the elements are all #GESClip-s then this method will attempt to
-combine them all into a single #GESClip. This should succeed if they:
-share the same #GESTimelineElement:start, #GESTimelineElement:duration
-and #GESTimelineElement:in-point; exist in the same layer; and all of
-the sources share the same #GESAsset. If this fails, or one of the
-elements is not a #GESClip, this method will try to create a #GESGroup
-instead.</doc>
- <source-position filename="ges/ges-container.h" line="149"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1003">The container created by merging
-@containers, or %NULL if they could not be merged into a single
-container.</doc>
- <type name="Container" c:type="GESContainer*"/>
- </return-value>
- <parameters>
- <parameter name="containers"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="989">
-The #GESContainer-s to group</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Container"/>
- </type>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="add_child">
- <source-position filename="ges/ges-container.h" line="118"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <type name="Container" c:type="GESContainer*"/>
- </instance-parameter>
- <parameter name="element" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="child_added">
- <source-position filename="ges/ges-container.h" line="116"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <type name="Container" c:type="GESContainer*"/>
- </instance-parameter>
- <parameter name="element" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="child_removed">
- <source-position filename="ges/ges-container.h" line="117"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <type name="Container" c:type="GESContainer*"/>
- </instance-parameter>
- <parameter name="element" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="edit"
- invoker="edit"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1062">Edits the container within its timeline.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_edit instead.</doc-deprecated>
- <source-position filename="ges/ges-container.h" line="124"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1077">%TRUE if the edit of @container completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1064">The #GESContainer to edit</doc>
- <type name="Container" c:type="GESContainer*"/>
- </instance-parameter>
- <parameter name="layers"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1065">A whitelist of layers
-where the edit can be performed, %NULL allows all layers in the
-timeline</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Layer"/>
- </type>
- </parameter>
- <parameter name="new_layer_priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1068">The priority/index of the layer @container should
-be moved to. -1 means no move</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1070">The edit mode</doc>
- <type name="EditMode" c:type="GESEditMode"/>
- </parameter>
- <parameter name="edge" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1071">The edge of @container where the edit should occur</doc>
- <type name="Edge" c:type="GESEdge"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1072">The edit position: a new location for the edge of @container
-(in nanoseconds)</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="remove_child">
- <source-position filename="ges/ges-container.h" line="119"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <type name="Container" c:type="GESContainer*"/>
- </instance-parameter>
- <parameter name="element" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="ungroup" invoker="ungroup">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="948">Ungroups the container by splitting it into several containers
-containing various children of the original. The rules for how the
-container splits depends on the subclass. A #GESGroup will simply split
-into its children. A #GESClip will split into one #GESClip per
-#GESTrackType it overlaps with (so an audio-video clip will split into
-an audio clip and a video clip), where each clip contains all the
-#GESTrackElement-s from the original clip with a matching
-#GESTrackElement:track-type.
-
-If @recursive is %TRUE, and the container contains other containers as
-children, then they will also be ungrouped, and so on.</doc>
- <source-position filename="ges/ges-container.h" line="120"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="965">The list of
-new #GESContainer-s created from the splitting of @container.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Container"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="950">The container to ungroup</doc>
- <type name="Container" c:type="GESContainer*"/>
- </instance-parameter>
- <parameter name="recursive" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="951">Whether to recursively ungroup @container</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add" c:identifier="ges_container_add">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="706">Adds a timeline element to the container. The element will now be a
-child of the container (and the container will be the
-#GESTimelineElement:parent of the added element), which means that it
-is now controlled by the container. This may change the properties of
-the child or the container, depending on the subclass.
-
-Additionally, the children properties of the newly added element will
-be shared with the container, meaning they can also be read and set
-using ges_timeline_element_get_child_property() and
-ges_timeline_element_set_child_property() on the container.</doc>
- <source-position filename="ges/ges-container.h" line="143"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="722">%TRUE if @child was successfully added to @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="708">A #GESContainer</doc>
- <type name="Container" c:type="GESContainer*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="709">The element to add as a child</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="edit"
- c:identifier="ges_container_edit"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1062">Edits the container within its timeline.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_edit instead.</doc-deprecated>
- <source-position filename="ges/ges-container.h" line="152"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1077">%TRUE if the edit of @container completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1064">The #GESContainer to edit</doc>
- <type name="Container" c:type="GESContainer*"/>
- </instance-parameter>
- <parameter name="layers"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1065">A whitelist of layers
-where the edit can be performed, %NULL allows all layers in the
-timeline</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Layer"/>
- </type>
- </parameter>
- <parameter name="new_layer_priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1068">The priority/index of the layer @container should
-be moved to. -1 means no move</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1070">The edit mode</doc>
- <type name="EditMode" c:type="GESEditMode"/>
- </parameter>
- <parameter name="edge" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1071">The edge of @container where the edit should occur</doc>
- <type name="Edge" c:type="GESEdge"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1072">The edit position: a new location for the edge of @container
-(in nanoseconds)</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_children" c:identifier="ges_container_get_children">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="920">Get the list of timeline elements contained in the container. If
-@recursive is %TRUE, and the container contains other containers as
-children, then their children will be added to the list, in addition to
-themselves, and so on.</doc>
- <source-position filename="ges/ges-container.h" line="141"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="930">The list of
-#GESTimelineElement-s contained in @container.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="TimelineElement"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="922">A #GESContainer</doc>
- <type name="Container" c:type="GESContainer*"/>
- </instance-parameter>
- <parameter name="recursive" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="923">Whether to recursively get children in @container</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove" c:identifier="ges_container_remove">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="818">Removes a timeline element from the container. The element will no
-longer be controlled by the container.</doc>
- <source-position filename="ges/ges-container.h" line="145"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="826">%TRUE if @child was successfully removed from @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="820">A #GESContainer</doc>
- <type name="Container" c:type="GESContainer*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="821">The child to remove</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="ungroup" c:identifier="ges_container_ungroup">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="948">Ungroups the container by splitting it into several containers
-containing various children of the original. The rules for how the
-container splits depends on the subclass. A #GESGroup will simply split
-into its children. A #GESClip will split into one #GESClip per
-#GESTrackType it overlaps with (so an audio-video clip will split into
-an audio clip and a video clip), where each clip contains all the
-#GESTrackElement-s from the original clip with a matching
-#GESTrackElement:track-type.
-
-If @recursive is %TRUE, and the container contains other containers as
-children, then they will also be ungrouped, and so on.</doc>
- <source-position filename="ges/ges-container.h" line="147"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="965">The list of
-new #GESContainer-s created from the splitting of @container.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Container"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="950">The container to ungroup</doc>
- <type name="Container" c:type="GESContainer*"/>
- </instance-parameter>
- <parameter name="recursive" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="951">Whether to recursively ungroup @container</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <property name="height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="472">The span of the container's children's #GESTimelineElement:priority
-values, which is the number of integers that lie between (inclusive)
-the minimum and maximum priorities found amongst the container's
-children (maximum - minimum + 1).</doc>
- <type name="guint" c:type="guint"/>
- </property>
- <field name="parent">
- <type name="TimelineElement" c:type="GESTimelineElement"/>
- </field>
- <field name="children">
- <doc xml:space="preserve"
- filename="ges/ges-container.h"
- line="67">The list of
-#GESTimelineElement-s controlled by this Container</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="TimelineElement"/>
- </type>
- </field>
- <field name="height">
- <doc xml:space="preserve"
- filename="ges/ges-container.h"
- line="69">The #GESContainer:height of @obj</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="children_control_mode">
- <type name="ChildrenControlMode" c:type="GESChildrenControlMode"/>
- </field>
- <field name="initiated_move">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="ContainerPrivate" c:type="GESContainerPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="child-added" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="486">Will be emitted after a child is added to the container. Usually,
-you should connect with g_signal_connect_after() since the signal
-may be stopped internally.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="489">The child that was added</doc>
- <type name="TimelineElement"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="child-removed" when="last">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="500">Will be emitted after a child is removed from the container.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="503">The child that was removed</doc>
- <type name="TimelineElement"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="ContainerClass"
- c:type="GESContainerClass"
- glib:is-gtype-struct-for="Container">
- <source-position filename="ges/ges-container.h" line="137"/>
- <field name="parent_class" readable="0" private="1">
- <type name="TimelineElementClass" c:type="GESTimelineElementClass"/>
- </field>
- <field name="child_added">
- <callback name="child_added">
- <source-position filename="ges/ges-container.h" line="116"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="container" transfer-ownership="none">
- <type name="Container" c:type="GESContainer*"/>
- </parameter>
- <parameter name="element" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="child_removed">
- <callback name="child_removed">
- <source-position filename="ges/ges-container.h" line="117"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="container" transfer-ownership="none">
- <type name="Container" c:type="GESContainer*"/>
- </parameter>
- <parameter name="element" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="add_child">
- <callback name="add_child">
- <source-position filename="ges/ges-container.h" line="118"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="container" transfer-ownership="none">
- <type name="Container" c:type="GESContainer*"/>
- </parameter>
- <parameter name="element" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="remove_child">
- <callback name="remove_child">
- <source-position filename="ges/ges-container.h" line="119"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="container" transfer-ownership="none">
- <type name="Container" c:type="GESContainer*"/>
- </parameter>
- <parameter name="element" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="ungroup">
- <callback name="ungroup">
- <source-position filename="ges/ges-container.h" line="120"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="965">The list of
-new #GESContainer-s created from the splitting of @container.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Container"/>
- </type>
- </return-value>
- <parameters>
- <parameter name="container" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="950">The container to ungroup</doc>
- <type name="Container" c:type="GESContainer*"/>
- </parameter>
- <parameter name="recursive" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="951">Whether to recursively ungroup @container</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="group" introspectable="0">
- <callback name="group" introspectable="0">
- <source-position filename="ges/ges-container.h" line="121"/>
- <return-value>
- <type name="Container" c:type="GESContainer*"/>
- </return-value>
- <parameters>
- <parameter name="containers" transfer-ownership="none">
- <type name="GLib.List" c:type="GList*">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="edit">
- <callback name="edit">
- <source-position filename="ges/ges-container.h" line="124"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1077">%TRUE if the edit of @container completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1064">The #GESContainer to edit</doc>
- <type name="Container" c:type="GESContainer*"/>
- </parameter>
- <parameter name="layers"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1065">A whitelist of layers
-where the edit can be performed, %NULL allows all layers in the
-timeline</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Layer"/>
- </type>
- </parameter>
- <parameter name="new_layer_priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1068">The priority/index of the layer @container should
-be moved to. -1 means no move</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1070">The edit mode</doc>
- <type name="EditMode" c:type="GESEditMode"/>
- </parameter>
- <parameter name="edge" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1071">The edge of @container where the edit should occur</doc>
- <type name="Edge" c:type="GESEdge"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-container.c"
- line="1072">The edit position: a new location for the edge of @container
-(in nanoseconds)</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="grouping_priority" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="ContainerPrivate" c:type="GESContainerPrivate" disguised="1">
- <source-position filename="ges/ges-container.h" line="32"/>
- </record>
- <callback name="CreateElementForGapFunc"
- c:type="GESCreateElementForGapFunc"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-track.h"
- line="33">A function that creates a #GstElement that can be used as a source to
-fill the gaps of the track. A gap is a timeline region where the track
-has no #GESTrackElement sources.</doc>
- <source-position filename="ges/ges-track.h" line="43"/>
- <return-value>
- <doc xml:space="preserve"
- filename="ges/ges-track.h"
- line="41">A source #GstElement to fill gaps in @track.</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.h"
- line="35">The #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="CreateTrackElementFunc" c:type="GESCreateTrackElementFunc">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="63">A method for creating the core #GESTrackElement of a clip, to be added
-to a #GESTrack of the given track type.
-
-If a clip may produce several track elements per track type,
-#GESCreateTrackElementsFunc is more appropriate.</doc>
- <source-position filename="ges/ges-clip.h" line="78"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="74">The #GESTrackElement created
-by @clip, or %NULL if @clip can not provide a track element for the
-given @type or an error occurred.</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </return-value>
- <parameters>
- <parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="65">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="66">A #GESTrackType to create a #GESTrackElement for</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="CreateTrackElementsFunc"
- c:type="GESCreateTrackElementsFunc">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="80">A method for creating the core #GESTrackElement-s of a clip, to be
-added to #GESTrack-s of the given track type.</doc>
- <source-position filename="ges/ges-clip.h" line="92"/>
- <return-value transfer-ownership="container">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="88">A list of
-the #GESTrackElement-s created by @clip for the given @type, or %NULL
-if no track elements are created or an error occurred.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="TrackElement"/>
- </type>
- </return-value>
- <parameters>
- <parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="82">A #GESClip</doc>
- <type name="Clip" c:type="GESClip*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="83">A #GESTrackType to create #GESTrackElement-s for</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- </parameters>
- </callback>
- <function-macro name="DECLARE_TYPE"
- c:identifier="GES_DECLARE_TYPE"
- introspectable="0">
- <attribute name="doc.skip" value="true"/>
- <source-position filename="ges/ges-types.h" line="237"/>
- <parameters>
- <parameter name="ObjName">
- </parameter>
- <parameter name="obj_name">
- </parameter>
- <parameter name="OBJ_NAME">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEPRECATED_FOR"
- c:identifier="GES_DEPRECATED_FOR"
- introspectable="0">
- <source-position filename="ges/ges-prelude.h" line="35"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="EXTRACTABLE_GET_INTERFACE"
- c:identifier="GES_EXTRACTABLE_GET_INTERFACE"
- introspectable="0">
- <source-position filename="ges/ges-extractable.h" line="35"/>
- <parameters>
- <parameter name="inst">
- </parameter>
- </parameters>
- </function-macro>
- <enumeration name="Edge"
- glib:type-name="GESEdge"
- glib:get-type="ges_edge_get_type"
- c:type="GESEdge">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="542">The edges of an object contain in a #GESTimeline or #GESTrack</doc>
- <member name="edge_start"
- value="0"
- c:identifier="GES_EDGE_START"
- glib:nick="edge_start">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="544">Represents the start of an object.</doc>
- </member>
- <member name="start"
- value="0"
- c:identifier="GES_EDGE_START"
- glib:nick="start">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="544">Represents the start of an object.</doc>
- </member>
- <member name="edge_end"
- value="1"
- c:identifier="GES_EDGE_END"
- glib:nick="edge_end">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="545">Represents the end of an object.</doc>
- </member>
- <member name="end" value="1" c:identifier="GES_EDGE_END" glib:nick="end">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="545">Represents the end of an object.</doc>
- </member>
- <member name="edge_none"
- value="2"
- c:identifier="GES_EDGE_NONE"
- glib:nick="edge_none">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="546">Represent the fact we are not working with any edge of an
- object.</doc>
- </member>
- <member name="none"
- value="2"
- c:identifier="GES_EDGE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="546">Represent the fact we are not working with any edge of an
- object.</doc>
- </member>
- <function name="name" c:identifier="ges_edge_name">
- <source-position filename="ges/ges-enums.h" line="558"/>
- <return-value transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="edge" transfer-ownership="none">
- <type name="Edge" c:type="GESEdge"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <enumeration name="EditMode"
- glib:type-name="GESEditMode"
- glib:get-type="ges_edit_mode_get_type"
- c:type="GESEditMode">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="365">When a single timeline element is edited within its timeline at some
-position, using ges_timeline_element_edit(), depending on the edit
-mode, its #GESTimelineElement:start, #GESTimelineElement:duration or
-#GESTimelineElement:in-point will be adjusted accordingly. In addition,
-any clips may change #GESClip:layer.
-
-Each edit can be broken down into a combination of three basic edits:
-
-+ MOVE: This moves the start of the element to the edit position.
-+ START-TRIM: This cuts or grows the start of the element, whilst
- maintaining the time at which its internal content appears in the
- timeline data output. If the element is made shorter, the data that
- appeared at the edit position will still appear in the timeline at
- the same time. If the element is made longer, the data that appeared
- at the previous start of the element will still appear in the
- timeline at the same time.
-+ END-TRIM: Similar to START-TRIM, but the end of the element is cut or
- grown.
-
-In particular, when editing a #GESClip:
-
-+ MOVE: This will set the #GESTimelineElement:start of the clip to the
- edit position.
-+ START-TRIM: This will set the #GESTimelineElement:start of the clip
- to the edit position. To keep the end time the same, the
- #GESTimelineElement:duration of the clip will be adjusted in the
- opposite direction. In addition, the #GESTimelineElement:in-point of
- the clip will be shifted such that the content that appeared at the
- new or previous start time, whichever is latest, still appears at the
- same timeline time. For example, if a frame appeared at the start of
- the clip, and the start of the clip is reduced, the in-point of the
- clip will also reduce such that the frame will appear later within
- the clip, but at the same timeline position.
-+ END-TRIM: This will set the #GESTimelineElement:duration of the clip
- such that its end time will match the edit position.
-
-When editing a #GESGroup:
-
-+ MOVE: This will set the #GESGroup:start of the clip to the edit
- position by shifting all of its children by the same amount. So each
- child will maintain their relative positions.
-+ START-TRIM: If the group is made shorter, this will START-TRIM any
- clips under the group that start after the edit position to the same
- edit position. If the group is made longer, this will START-TRIM any
- clip under the group whose start matches the start of the group to
- the same edit position.
-+ END-TRIM: If the group is made shorter, this will END-TRIM any clips
- under the group that end after the edit position to the same edit
- position. If the group is made longer, this will END-TRIM any clip
- under the group whose end matches the end of the group to the same
- edit position.
-
-When editing a #GESTrackElement, if it has a #GESClip parent, this
-will be edited instead. Otherwise it is edited in the same way as a
-#GESClip.
-
-The layer priority of a #GESGroup is the lowest layer priority of any
-#GESClip underneath it. When a group is edited to a new layer
-priority, it will shift all clips underneath it by the same amount,
-such that their relative layers stay the same.
-
-If the #GESTimeline has a #GESTimeline:snapping-distance, then snapping
-may occur for some of the edges of the **main** edited element:
-
-+ MOVE: The start or end edge of *any* #GESSource under the element may
- be snapped.
-+ START-TRIM: The start edge of a #GESSource whose start edge touches
- the start edge of the element may snap.
-+ END-TRIM: The end edge of a #GESSource whose end edge touches the end
- edge of the element may snap.
-
-These edges may snap with either the start or end edge of *any* other
-#GESSource in the timeline that is not also being moved by the element,
-including those in different layers, if they are within the
-#GESTimeline:snapping-distance. During an edit, only up to one snap can
-occur. This will shift the edit position such that the snapped edges
-will touch once the edit has completed.
-
-Note that snapping can cause an edit to fail where it would have
-otherwise succeeded because it may push the edit position such that the
-edit would result in an unsupported timeline configuration. Similarly,
-snapping can cause an edit to succeed where it would have otherwise
-failed.
-
-For example, in #GES_EDIT_MODE_RIPPLE acting on #GES_EDGE_NONE, the
-main element is the MOVED toplevel of the edited element. Any source
-under the main MOVED toplevel may have its start or end edge snapped.
-Note, these sources cannot snap with each other. The edit may also
-push other elements, but any sources under these elements cannot snap,
-nor can they be snapped with. If a snap does occur, the MOVE of the
-toplevel *and* all other elements pushed by the ripple will be shifted
-by the same amount such that the snapped edges will touch.
-
-You can also find more explanation about the behaviour of those modes at:
-[trim, ripple and roll](http://pitivi.org/manual/trimming.html)
-and [clip management](http://pitivi.org/manual/usingclips.html).</doc>
- <member name="edit_normal"
- value="0"
- c:identifier="GES_EDIT_MODE_NORMAL"
- glib:nick="edit_normal">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="367">The element is edited the normal way (default).
- If acting on the element as a whole (#GES_EDGE_NONE), this will MOVE
- the element by MOVING its toplevel. When acting on the start of the
- element (#GES_EDGE_START), this will only MOVE the element, but not
- its toplevel parent. This can allow you to move a #GESClip or
- #GESGroup to a new start time or layer within its container group,
- without effecting other members of the group. When acting on the end
- of the element (#GES_EDGE_END), this will END-TRIM the element,
- leaving its toplevel unchanged.</doc>
- </member>
- <member name="normal"
- value="0"
- c:identifier="GES_EDIT_MODE_NORMAL"
- glib:nick="normal">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="367">The element is edited the normal way (default).
- If acting on the element as a whole (#GES_EDGE_NONE), this will MOVE
- the element by MOVING its toplevel. When acting on the start of the
- element (#GES_EDGE_START), this will only MOVE the element, but not
- its toplevel parent. This can allow you to move a #GESClip or
- #GESGroup to a new start time or layer within its container group,
- without effecting other members of the group. When acting on the end
- of the element (#GES_EDGE_END), this will END-TRIM the element,
- leaving its toplevel unchanged.</doc>
- </member>
- <member name="edit_ripple"
- value="1"
- c:identifier="GES_EDIT_MODE_RIPPLE"
- glib:nick="edit_ripple">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="376">The element is edited in ripple mode: moving
- itself as well as later elements, keeping their relative times. This
- edits the element the same as #GES_EDIT_MODE_NORMAL. In addition, if
- acting on the element as a whole, or the start of the element, any
- toplevel element in the same timeline (including different layers)
- whose start time is later than the *current* start time of the MOVED
- element will also be MOVED by the same shift as the edited element.
- If acting on the end of the element, any toplevel element whose start
- time is later than the *current* end time of the edited element will
- also be MOVED by the same shift as the change in the end of the
- edited element. These additional elements will also be shifted by
- the same shift in layers as the edited element.</doc>
- </member>
- <member name="ripple"
- value="1"
- c:identifier="GES_EDIT_MODE_RIPPLE"
- glib:nick="ripple">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="376">The element is edited in ripple mode: moving
- itself as well as later elements, keeping their relative times. This
- edits the element the same as #GES_EDIT_MODE_NORMAL. In addition, if
- acting on the element as a whole, or the start of the element, any
- toplevel element in the same timeline (including different layers)
- whose start time is later than the *current* start time of the MOVED
- element will also be MOVED by the same shift as the edited element.
- If acting on the end of the element, any toplevel element whose start
- time is later than the *current* end time of the edited element will
- also be MOVED by the same shift as the change in the end of the
- edited element. These additional elements will also be shifted by
- the same shift in layers as the edited element.</doc>
- </member>
- <member name="edit_roll"
- value="2"
- c:identifier="GES_EDIT_MODE_ROLL"
- glib:nick="edit_roll">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="388">The element is edited in roll mode: swapping its
- content for its neighbour's, or vis versa, in the timeline output.
- This edits the element the same as #GES_EDIT_MODE_TRIM. In addition,
- any neighbours are also TRIMMED at their opposite edge to the same
- timeline position. When acting on the start of the element, a
- neighbour is any earlier element in the timeline whose end time
- matches the *current* start time of the edited element. When acting on
- the end of the element, a neighbour is any later element in the
- timeline whose start time matches the *current* start time of the
- edited element. In addition, a neighbour have a #GESSource at its
- end/start edge that shares a track with a #GESSource at the start/end
- edge of the edited element. Basically, a neighbour is an element that
- can be extended, or cut, to have its content replace, or be replaced
- by, the content of the edited element. Acting on the element as a
- whole (#GES_EDGE_NONE) is not defined. The element can not shift
- layers under this mode.</doc>
- </member>
- <member name="roll"
- value="2"
- c:identifier="GES_EDIT_MODE_ROLL"
- glib:nick="roll">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="388">The element is edited in roll mode: swapping its
- content for its neighbour's, or vis versa, in the timeline output.
- This edits the element the same as #GES_EDIT_MODE_TRIM. In addition,
- any neighbours are also TRIMMED at their opposite edge to the same
- timeline position. When acting on the start of the element, a
- neighbour is any earlier element in the timeline whose end time
- matches the *current* start time of the edited element. When acting on
- the end of the element, a neighbour is any later element in the
- timeline whose start time matches the *current* start time of the
- edited element. In addition, a neighbour have a #GESSource at its
- end/start edge that shares a track with a #GESSource at the start/end
- edge of the edited element. Basically, a neighbour is an element that
- can be extended, or cut, to have its content replace, or be replaced
- by, the content of the edited element. Acting on the element as a
- whole (#GES_EDGE_NONE) is not defined. The element can not shift
- layers under this mode.</doc>
- </member>
- <member name="edit_trim"
- value="3"
- c:identifier="GES_EDIT_MODE_TRIM"
- glib:nick="edit_trim">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="404">The element is edited in trim mode. When acting
- on the start of the element, this will START-TRIM it. When acting on
- the end of the element, this will END-TRIM it. Acting on the element
- as a whole (#GES_EDGE_NONE) is not defined.</doc>
- </member>
- <member name="trim"
- value="3"
- c:identifier="GES_EDIT_MODE_TRIM"
- glib:nick="trim">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="404">The element is edited in trim mode. When acting
- on the start of the element, this will START-TRIM it. When acting on
- the end of the element, this will END-TRIM it. Acting on the element
- as a whole (#GES_EDGE_NONE) is not defined.</doc>
- </member>
- <member name="edit_slide"
- value="4"
- c:identifier="GES_EDIT_MODE_SLIDE"
- glib:nick="edit_slide">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="408">The element is edited in slide mode (not yet
- implemented): moving the element replacing or consuming content on
- each end. When acting on the element as a whole, this will MOVE the
- element, and TRIM any neighbours on either side. A neighbour is
- defined in the same way as in #GES_EDIT_MODE_ROLL, but they may be on
- either side of the edited elements. Elements at the end with be
- START-TRIMMED to the new end position of the edited element. Elements
- at the start will be END-TRIMMED to the new start position of the
- edited element. Acting on the start or end of the element
- (#GES_EDGE_START and #GES_EDGE_END) is not defined. The element can
- not shift layers under this mode.</doc>
- </member>
- <member name="slide"
- value="4"
- c:identifier="GES_EDIT_MODE_SLIDE"
- glib:nick="slide">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="408">The element is edited in slide mode (not yet
- implemented): moving the element replacing or consuming content on
- each end. When acting on the element as a whole, this will MOVE the
- element, and TRIM any neighbours on either side. A neighbour is
- defined in the same way as in #GES_EDIT_MODE_ROLL, but they may be on
- either side of the edited elements. Elements at the end with be
- START-TRIMMED to the new end position of the edited element. Elements
- at the start will be END-TRIMMED to the new start position of the
- edited element. Acting on the start or end of the element
- (#GES_EDGE_START and #GES_EDGE_END) is not defined. The element can
- not shift layers under this mode.</doc>
- </member>
- <function name="name" c:identifier="ges_edit_mode_name" version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="525">Return a string representation of @mode.</doc>
- <source-position filename="ges/ges-enums.h" line="535"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="531">a string representation of @mode.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="527">a #GESEditMode</doc>
- <type name="EditMode" c:type="GESEditMode"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <class name="Effect"
- c:symbol-prefix="effect"
- c:type="GESEffect"
- parent="BaseEffect"
- glib:type-name="GESEffect"
- glib:get-type="ges_effect_get_type"
- glib:type-struct="EffectClass">
- <doc xml:space="preserve"
- filename="ges/ges-effect.c"
- line="20">Currently we only support effects with N sinkpads and one single srcpad.
-Apart from `gesaudiomixer` and `gescompositor` which can be used as effects
-and where sinkpads will be requested as needed based on the timeline topology
-GES will always request at most one sinkpad per effect (when required).
-
-&gt; Note: GES always adds converters (`audioconvert ! audioresample !
-&gt; audioconvert` for audio effects and `videoconvert` for video effects) to
-&gt; make it simpler for end users.</doc>
- <source-position filename="ges/ges-effect.h" line="59"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new" c:identifier="ges_effect_new">
- <doc xml:space="preserve"
- filename="ges/ges-effect.c"
- line="353">Creates a new #GESEffect from the description of the bin. It should be
-possible to determine the type of the effect through the element
-'klass' metadata of the GstElements that will be created.
-In that corner case, you should use:
-#ges_asset_request (GES_TYPE_EFFECT, "audio your ! bin ! description", NULL);
-and extract that asset to be in full control.</doc>
- <source-position filename="ges/ges-effect.h" line="62"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-effect.c"
- line="364">a newly created #GESEffect, or %NULL if something went
-wrong.</doc>
- <type name="Effect" c:type="GESEffect*"/>
- </return-value>
- <parameters>
- <parameter name="bin_description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-effect.c"
- line="355">The gst-launch like bin description of the effect</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <property name="bin-description"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-effect.c"
- line="191">The description of the effect bin with a gst-launch-style
-pipeline description.
-
-Example: "videobalance saturation=1.5 hue=+0.5"</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <field name="parent" readable="0" private="1">
- <type name="BaseEffect" c:type="GESBaseEffect"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="EffectPrivate" c:type="GESEffectPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <class name="EffectAsset"
- c:symbol-prefix="effect_asset"
- c:type="GESEffectAsset"
- parent="TrackElementAsset"
- glib:type-name="GESEffectAsset"
- glib:get-type="ges_effect_asset_get_type"
- glib:type-struct="EffectAssetClass">
- <doc xml:space="preserve"
- filename="ges/ges-effect-asset.c"
- line="21">This asset has a GStreamer bin-description as ID and is able to determine
-to what track type the effect should be used in.</doc>
- <source-position filename="ges/ges-effect-asset.h" line="36"/>
- <implements name="MetaContainer"/>
- <implements name="Gio.AsyncInitable"/>
- <implements name="Gio.Initable"/>
- <field name="parent_instance">
- <type name="TrackElementAsset" c:type="GESTrackElementAsset"/>
- </field>
- <field name="priv">
- <type name="EffectAssetPrivate" c:type="GESEffectAssetPrivate*"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="EffectAssetClass"
- c:type="GESEffectAssetClass"
- glib:is-gtype-struct-for="EffectAsset">
- <source-position filename="ges/ges-effect-asset.h" line="36"/>
- <field name="parent_class">
- <type name="TrackElementAssetClass"
- c:type="GESTrackElementAssetClass"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="EffectAssetPrivate"
- c:type="GESEffectAssetPrivate"
- disguised="1">
- <source-position filename="ges/ges-effect-asset.h" line="29"/>
- </record>
- <record name="EffectClass"
- c:type="GESEffectClass"
- glib:is-gtype-struct-for="Effect">
- <source-position filename="ges/ges-effect.h" line="59"/>
- <field name="parent_class" readable="0" private="1">
- <doc xml:space="preserve"
- filename="ges/ges-effect.h"
- line="46">parent class</doc>
- <type name="BaseEffectClass" c:type="GESBaseEffectClass"/>
- </field>
- <field name="rate_properties" readable="0" private="1">
- <type name="GLib.List" c:type="GList*">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="register_rate_property"
- c:identifier="ges_effect_class_register_rate_property">
- <doc xml:space="preserve"
- filename="ges/ges-effect.c"
- line="383">Register an element that can change the rate at which media is playing.
-The property type must be float or double, and must be a factor of the
-rate, i.e. a value of 2.0 must mean that the media plays twice as fast.
-Several properties may be registered for a single element type,
-provided they all contribute to the rate as independent factors. For
-example, this is true for the "GstPitch::rate" and "GstPitch::tempo"
-properties. These are already registered by default in GES, along with
-#videorate:rate for #videorate and #scaletempo:rate for #scaletempo.
-
-If such a rate property becomes a child property of a #GESEffect upon
-its creation (the element is part of its #GESEffect:bin-description),
-it will be automatically registered as a time property (see
-ges_base_effect_register_time_property()) and will have its time
-translation functions set (see
-ges_base_effect_set_time_translation_funcs()) to use the overall rate
-of the rate properties. Note that if an effect contains a rate
-property as well as a non-rate time property, you should ensure to set
-the time translation functions to some other methods using
-ges_base_effect_set_time_translation_funcs().
-
-Note, you can obtain a reference to the GESEffectClass using
-
-```
- GES_EFFECT_CLASS (g_type_class_ref (GES_TYPE_EFFECT));
-```</doc>
- <source-position filename="ges/ges-effect.h" line="65"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-effect.c"
- line="416">%TRUE if the rate property was successfully registered. When
-this method returns %FALSE, a warning is emitted with more information.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-effect.c"
- line="385">Instance of the GESEffectClass</doc>
- <type name="EffectClass" c:type="GESEffectClass*"/>
- </instance-parameter>
- <parameter name="element_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-effect.c"
- line="386">The #GstElementFactory name of the element that changes
-the rate</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-effect.c"
- line="388">The name of the property that changes the rate</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <class name="EffectClip"
- c:symbol-prefix="effect_clip"
- c:type="GESEffectClip"
- parent="BaseEffectClip"
- glib:type-name="GESEffectClip"
- glib:get-type="ges_effect_clip_get_type"
- glib:type-struct="EffectClipClass">
- <doc xml:space="preserve"
- filename="ges/ges-effect-clip.c"
- line="20">The effect will be applied on the sources that have lower priorities
-(higher number) between the inpoint and the end of it.
-
-The asset ID of an effect clip is in the form:
-
-```
- "audio ! bin ! description || video ! bin ! description"
-```</doc>
- <source-position filename="ges/ges-effect-clip.h" line="54"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new" c:identifier="ges_effect_clip_new">
- <doc xml:space="preserve"
- filename="ges/ges-effect-clip.c"
- line="252">Creates a new #GESEffectClip from the description of the bin.</doc>
- <source-position filename="ges/ges-effect-clip.h" line="57"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-effect-clip.c"
- line="259">a newly created #GESEffectClip, or
-%NULL if something went wrong.</doc>
- <type name="EffectClip" c:type="GESEffectClip*"/>
- </return-value>
- <parameters>
- <parameter name="video_bin_description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-effect-clip.c"
- line="254">The gst-launch like bin description of the effect</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="audio_bin_description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-effect-clip.c"
- line="255">The gst-launch like bin description of the effect</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <property name="audio-bin-description"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-effect-clip.c"
- line="210">The description of the audio track of the effect bin with a gst-launch-style
-pipeline description. This should be used for test purposes.
-
-Example: "audiopanorama panorama=1.0"</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="video-bin-description"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-effect-clip.c"
- line="196">The description of the video track of the effect bin with a gst-launch-style
-pipeline description. This should be used for test purposes.
-
-Example: "videobalance saturation=1.5 hue=+0.5"</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <field name="parent" readable="0" private="1">
- <type name="BaseEffectClip" c:type="GESBaseEffectClip"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="EffectClipPrivate" c:type="GESEffectClipPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="EffectClipClass"
- c:type="GESEffectClipClass"
- glib:is-gtype-struct-for="EffectClip">
- <source-position filename="ges/ges-effect-clip.h" line="54"/>
- <field name="parent_class" readable="0" private="1">
- <type name="BaseEffectClipClass" c:type="GESBaseEffectClipClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="EffectClipPrivate"
- c:type="GESEffectClipPrivate"
- disguised="1">
- <source-position filename="ges/ges-effect-clip.h" line="28"/>
- </record>
- <record name="EffectPrivate" c:type="GESEffectPrivate" disguised="1">
- <source-position filename="ges/ges-effect.h" line="28"/>
- </record>
- <enumeration name="Error" c:type="GESError">
- <source-position filename="ges/ges-gerror.h" line="64"/>
- <member name="asset_wrong_id"
- value="0"
- c:identifier="GES_ERROR_ASSET_WRONG_ID">
- <doc xml:space="preserve"
- filename="ges/ges-gerror.h"
- line="38">The ID passed is malformed</doc>
- </member>
- <member name="asset_loading"
- value="1"
- c:identifier="GES_ERROR_ASSET_LOADING">
- <doc xml:space="preserve"
- filename="ges/ges-gerror.h"
- line="39">An error happened while loading the asset</doc>
- </member>
- <member name="formatter_malformed_input_file"
- value="2"
- c:identifier="GES_ERROR_FORMATTER_MALFORMED_INPUT_FILE">
- <doc xml:space="preserve"
- filename="ges/ges-gerror.h"
- line="40">The formatted files was malformed</doc>
- </member>
- <member name="invalid_frame_number"
- value="3"
- c:identifier="GES_ERROR_INVALID_FRAME_NUMBER">
- <doc xml:space="preserve"
- filename="ges/ges-gerror.h"
- line="41">The frame number is invalid</doc>
- </member>
- <member name="negative_layer"
- value="4"
- c:identifier="GES_ERROR_NEGATIVE_LAYER">
- <doc xml:space="preserve"
- filename="ges/ges-gerror.h"
- line="42">The operation would lead to a negative
-#GES_TIMELINE_ELEMENT_LAYER_PRIORITY. (Since: 1.18)</doc>
- </member>
- <member name="negative_time"
- value="5"
- c:identifier="GES_ERROR_NEGATIVE_TIME">
- <doc xml:space="preserve"
- filename="ges/ges-gerror.h"
- line="44">The operation would lead to a negative time.
-E.g. for the #GESTimelineElement:start #GESTimelineElement:duration or
-#GESTimelineElement:in-point. (Since: 1.18)</doc>
- </member>
- <member name="not_enough_internal_content"
- value="6"
- c:identifier="GES_ERROR_NOT_ENOUGH_INTERNAL_CONTENT">
- <doc xml:space="preserve"
- filename="ges/ges-gerror.h"
- line="47">Some #GESTimelineElement does
-not have a large enough #GESTimelineElement:max-duration to cover the
-desired operation. (Since: 1.18)</doc>
- </member>
- <member name="invalid_overlap_in_track"
- value="7"
- c:identifier="GES_ERROR_INVALID_OVERLAP_IN_TRACK">
- <doc xml:space="preserve"
- filename="ges/ges-gerror.h"
- line="50">The operation would break one of
-the overlap conditions for the #GESTimeline. (Since: 1.18)</doc>
- </member>
- <member name="invalid_effect_bin_description"
- value="8"
- c:identifier="GES_ERROR_INVALID_EFFECT_BIN_DESCRIPTION">
- </member>
- </enumeration>
- <interface name="Extractable"
- c:symbol-prefix="extractable"
- c:type="GESExtractable"
- glib:type-name="GESExtractable"
- glib:get-type="ges_extractable_get_type"
- glib:type-struct="ExtractableInterface">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="21">A #GObject that implements the #GESExtractable interface can be
-extracted from a #GESAsset using ges_asset_extract().
-
-Each extractable type will have its own way of interpreting the
-#GESAsset:id of an asset (or, if it is associated with a specific
-subclass of #GESAsset, the asset subclass may handle the
-interpretation of the #GESAsset:id). By default, the requested asset
-#GESAsset:id will be ignored by a #GESExtractable and will be set to
-the type name of the extractable instead. Also by default, when the
-requested asset is extracted, the returned object will simply be a
-newly created default object of that extractable type. You should check
-the documentation for each extractable type to see if they differ from
-the default.
-
-After the object is extracted, it will have a reference to the asset it
-came from, which you can retrieve using ges_extractable_get_asset().</doc>
- <source-position filename="ges/ges-extractable.h" line="138"/>
- <prerequisite name="GObject.InitiallyUnowned"/>
- <virtual-method name="get_id" invoker="get_id">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="186">Gets the #GESAsset:id of some associated asset. It may be the case
-that the object has no set asset, or even that such an asset does not
-yet exist in the GES cache. Instead, this will return the asset
-#GESAsset:id that is _compatible_ with the current state of the object,
-as determined by the #GESExtractable implementer. If it was indeed
-extracted from an asset, this should return the same as its
-corresponding asset #GESAsset:id.</doc>
- <source-position filename="ges/ges-extractable.h" line="128"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="198">The #GESAsset:id of some associated #GESAsset
-that is compatible with @self's current state.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="188">A #GESExtractable</doc>
- <type name="Extractable" c:type="GESExtractable*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_asset">
- <source-position filename="ges/ges-extractable.h" line="119"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Extractable" c:type="GESExtractable*"/>
- </instance-parameter>
- <parameter name="asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_asset_full">
- <source-position filename="ges/ges-extractable.h" line="122"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Extractable" c:type="GESExtractable*"/>
- </instance-parameter>
- <parameter name="asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="get_asset" c:identifier="ges_extractable_get_asset">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="108">Get the asset that has been set on the extractable object.</doc>
- <source-position filename="ges/ges-extractable.h" line="142"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="114">The asset set on @self, or %NULL
-if no asset has been set.</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="110">A #GESExtractable</doc>
- <type name="Extractable" c:type="GESExtractable*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_id" c:identifier="ges_extractable_get_id">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="186">Gets the #GESAsset:id of some associated asset. It may be the case
-that the object has no set asset, or even that such an asset does not
-yet exist in the GES cache. Instead, this will return the asset
-#GESAsset:id that is _compatible_ with the current state of the object,
-as determined by the #GESExtractable implementer. If it was indeed
-extracted from an asset, this should return the same as its
-corresponding asset #GESAsset:id.</doc>
- <source-position filename="ges/ges-extractable.h" line="148"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="198">The #GESAsset:id of some associated #GESAsset
-that is compatible with @self's current state.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="188">A #GESExtractable</doc>
- <type name="Extractable" c:type="GESExtractable*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_asset" c:identifier="ges_extractable_set_asset">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="125">Sets the asset for this extractable object.
-
-When an object is extracted from an asset using ges_asset_extract() its
-asset will be automatically set. Note that many classes that implement
-#GESExtractable will automatically create their objects using assets
-when you call their @new methods. However, you can use this method to
-associate an object with a compatible asset if it was created by other
-means and does not yet have an asset. Or, for some implementations of
-#GESExtractable, you can use this to change the asset of the given
-extractable object, which will lead to a change in its state to
-match the new asset #GESAsset:id.</doc>
- <source-position filename="ges/ges-extractable.h" line="144"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="142">%TRUE if @asset could be successfully set on @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="127">A #GESExtractable</doc>
- <type name="Extractable" c:type="GESExtractable*"/>
- </instance-parameter>
- <parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="128">The asset to set</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </method>
- </interface>
- <callback name="ExtractableCheckId"
- c:type="GESExtractableCheckId"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.h"
- line="39">Method for checking that an ID is valid for the given #GESExtractable
-type. If the given ID is considered valid, it can be adjusted into some
-standard and returned to prevent the creation of separate #GESAsset-s,
-with different #GESAsset:id, that would otherwise act the same.
-
-Returns (transfer full) (nullable): The actual #GESAsset:id to set on
-any corresponding assets, based on @id, or %NULL if @id is not valid.</doc>
- <source-position filename="ges/ges-extractable.h" line="54"/>
- <return-value transfer-ownership="full">
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.h"
- line="41">The #GESExtractable type to check @id for</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.h"
- line="42">The ID to check</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="ExtractableInterface"
- c:type="GESExtractableInterface"
- glib:is-gtype-struct-for="Extractable">
- <source-position filename="ges/ges-extractable.h" line="138"/>
- <field name="parent">
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- <field name="asset_type">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.h"
- line="59">The subclass type of #GESAsset that should be created when
-an asset with the corresponding #GESAsset:extractable-type is
-requested.</doc>
- <type name="GType" c:type="GType"/>
- </field>
- <field name="check_id">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.h"
- line="62">The method to call to check whether a given ID is valid as
-an asset #GESAsset:id for the given #GESAsset:extractable-type. The
-returned ID is the actual #GESAsset:id that is set on the asset. The
-default implementation will simply always return the type name of the
-#GESAsset:extractable-type, even if the received ID is %NULL. As such,
-any given ID is considered valid (or is ignored), but only one is
-actually ever set on an asset, which means the given
-#GESAsset:extractable-type can only have one associated asset.</doc>
- <type name="ExtractableCheckId" c:type="GESExtractableCheckId"/>
- </field>
- <field name="can_update_asset">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.h"
- line="70">Whether an object of this class can have its
-#GESAsset change over its lifetime. This should be set to %TRUE if one
-of the object's parameters that is associated with its ID can change
-after construction, which would require an asset with a new ID. Note
-that the subclass is required to handle the requesting and setting of
-the new asset on the object.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="set_asset">
- <callback name="set_asset">
- <source-position filename="ges/ges-extractable.h" line="119"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Extractable" c:type="GESExtractable*"/>
- </parameter>
- <parameter name="asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_asset_full">
- <callback name="set_asset_full">
- <source-position filename="ges/ges-extractable.h" line="122"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Extractable" c:type="GESExtractable*"/>
- </parameter>
- <parameter name="asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_parameters_from_id" introspectable="0">
- <callback name="get_parameters_from_id" introspectable="0">
- <source-position filename="ges/ges-extractable.h" line="125"/>
- <return-value>
- <type name="GObject.Parameter" c:type="GParameter*"/>
- </return-value>
- <parameters>
- <parameter name="id" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="n_params" transfer-ownership="none">
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_id">
- <callback name="get_id">
- <source-position filename="ges/ges-extractable.h" line="128"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="198">The #GESAsset:id of some associated #GESAsset
-that is compatible with @self's current state.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-extractable.c"
- line="188">A #GESExtractable</doc>
- <type name="Extractable" c:type="GESExtractable*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_real_extractable_type">
- <callback name="get_real_extractable_type">
- <source-position filename="ges/ges-extractable.h" line="130"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- <parameters>
- <parameter name="wanted_type" transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="register_metas">
- <callback name="register_metas">
- <source-position filename="ges/ges-extractable.h" line="133"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="ExtractableInterface"
- c:type="GESExtractableInterface*"/>
- </parameter>
- <parameter name="klass" transfer-ownership="none">
- <type name="GObject.ObjectClass" c:type="GObjectClass*"/>
- </parameter>
- <parameter name="asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <function-macro name="FRAME_NUMBER_IS_VALID"
- c:identifier="GES_FRAME_NUMBER_IS_VALID"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-types.h"
- line="60">Tests if a given GESFrameNumber represents a valid frame</doc>
- <source-position filename="ges/ges-types.h" line="64"/>
- <parameters>
- <parameter name="frames">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="FRAME_NUMBER_NONE"
- value="9223372036854775807"
- c:type="GES_FRAME_NUMBER_NONE">
- <doc xml:space="preserve"
- filename="ges/ges-types.h"
- line="53">Constant to define an undefined frame number</doc>
- <source-position filename="ges/ges-types.h" line="58"/>
- <type name="gint64" c:type="gint64"/>
- </constant>
- <callback name="FillTrackElementFunc"
- c:type="GESFillTrackElementFunc"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="44">A function that will be called when the nleobject of a corresponding
-track element needs to be filled.
-
-The implementer of this function shall add the proper #GstElement to @nleobj
-using gst_bin_add().</doc>
- <doc-deprecated xml:space="preserve">This method type is no longer used.</doc-deprecated>
- <source-position filename="ges/ges-clip.h" line="60"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="58">%TRUE if the implementer successfully filled the @nleobj.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="46">The #GESClip controlling the track elements</doc>
- <type name="Clip" c:type="GESClip*"/>
- </parameter>
- <parameter name="track_element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="47">The #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- <parameter name="nleobj" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-clip.h"
- line="48">The nleobject that needs to be filled</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </callback>
- <class name="Formatter"
- c:symbol-prefix="formatter"
- c:type="GESFormatter"
- parent="GObject.InitiallyUnowned"
- abstract="1"
- glib:type-name="GESFormatter"
- glib:get-type="ges_formatter_get_type"
- glib:type-struct="FormatterClass">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.h"
- line="31">Base class for timeline data serialization and deserialization.</doc>
- <source-position filename="ges/ges-formatter.h" line="123"/>
- <implements name="Extractable"/>
- <function name="can_load_uri"
- c:identifier="ges_formatter_can_load_uri"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="221">Checks if there is a #GESFormatter available which can load a #GESTimeline
-from the given URI.</doc>
- <source-position filename="ges/ges-formatter.h" line="135"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="229">TRUE if there is a #GESFormatter that can support the given uri
-or FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="223">a #gchar * pointing to the URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="can_save_uri"
- c:identifier="ges_formatter_can_save_uri"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="292">Returns TRUE if there is a #GESFormatter available which can save a
-#GESTimeline to the given URI.</doc>
- <source-position filename="ges/ges-formatter.h" line="137"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="300">TRUE if the given @uri is supported, else FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="294">a #gchar * pointing to a URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_default" c:identifier="ges_formatter_get_default">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="446">Get the default #GESAsset to use as formatter. It will return
-the asset for the #GESFormatter that has the highest @rank</doc>
- <source-position filename="ges/ges-formatter.h" line="153"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="452">The #GESAsset for the formatter with highest @rank</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </return-value>
- </function>
- <virtual-method name="can_load_uri" throws="1">
- <source-position filename="ges/ges-formatter.h" line="52"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dummy_instance" transfer-ownership="none">
- <type name="Formatter" c:type="GESFormatter*"/>
- </instance-parameter>
- <parameter name="uri" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="load_from_uri"
- invoker="load_from_uri"
- deprecated="1"
- deprecated-version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="371">Load data from the given URI into timeline.</doc>
- <doc-deprecated xml:space="preserve">Use @ges_timeline_load_from_uri</doc-deprecated>
- <source-position filename="ges/ges-formatter.h" line="68"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="380">TRUE if the timeline data was successfully loaded from the URI,
-else FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="formatter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="373">a #GESFormatter</doc>
- <type name="Formatter" c:type="GESFormatter*"/>
- </instance-parameter>
- <parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="374">a #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="375">a #gchar * pointing to a URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="save_to_uri"
- invoker="save_to_uri"
- deprecated="1"
- deprecated-version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="404">Save data from timeline to the given URI.</doc>
- <doc-deprecated xml:space="preserve">Use @ges_timeline_save_to_uri</doc-deprecated>
- <source-position filename="ges/ges-formatter.h" line="88"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="414">TRUE if the timeline data was successfully saved to the URI
-else FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="formatter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="406">a #GESFormatter</doc>
- <type name="Formatter" c:type="GESFormatter*"/>
- </instance-parameter>
- <parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="407">a #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="408">a #gchar * pointing to a URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="overwrite" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="409">%TRUE to overwrite file if it exists</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="load_from_uri"
- c:identifier="ges_formatter_load_from_uri"
- deprecated="1"
- deprecated-version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="371">Load data from the given URI into timeline.</doc>
- <doc-deprecated xml:space="preserve">Use @ges_timeline_load_from_uri</doc-deprecated>
- <source-position filename="ges/ges-formatter.h" line="140"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="380">TRUE if the timeline data was successfully loaded from the URI,
-else FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="formatter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="373">a #GESFormatter</doc>
- <type name="Formatter" c:type="GESFormatter*"/>
- </instance-parameter>
- <parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="374">a #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="375">a #gchar * pointing to a URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="save_to_uri"
- c:identifier="ges_formatter_save_to_uri"
- deprecated="1"
- deprecated-version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="404">Save data from timeline to the given URI.</doc>
- <doc-deprecated xml:space="preserve">Use @ges_timeline_save_to_uri</doc-deprecated>
- <source-position filename="ges/ges-formatter.h" line="146"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="414">TRUE if the timeline data was successfully saved to the URI
-else FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="formatter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="406">a #GESFormatter</doc>
- <type name="Formatter" c:type="GESFormatter*"/>
- </instance-parameter>
- <parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="407">a #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="408">a #gchar * pointing to a URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="overwrite" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="409">%TRUE to overwrite file if it exists</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <field name="parent">
- <type name="GObject.InitiallyUnowned" c:type="GInitiallyUnowned"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="FormatterPrivate" c:type="GESFormatterPrivate*"/>
- </field>
- <field name="project" readable="0" private="1">
- <type name="Project" c:type="GESProject*"/>
- </field>
- <field name="timeline" readable="0" private="1">
- <type name="Timeline" c:type="GESTimeline*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <callback name="FormatterCanLoadURIMethod"
- c:type="GESFormatterCanLoadURIMethod"
- throws="1">
- <source-position filename="ges/ges-formatter.h" line="52"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dummy_instance" transfer-ownership="none">
- <type name="Formatter" c:type="GESFormatter*"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="FormatterClass"
- c:type="GESFormatterClass"
- glib:is-gtype-struct-for="Formatter">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.h"
- line="92">GES Formatter class. Override the vmethods to implement the formatter functionnality.</doc>
- <source-position filename="ges/ges-formatter.h" line="123"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.h"
- line="94">the parent class structure</doc>
- <type name="GObject.InitiallyUnownedClass"
- c:type="GInitiallyUnownedClass"/>
- </field>
- <field name="can_load_uri">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.h"
- line="95">Whether the URI can be loaded</doc>
- <type name="FormatterCanLoadURIMethod"
- c:type="GESFormatterCanLoadURIMethod"/>
- </field>
- <field name="load_from_uri">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.h"
- line="96">class method to deserialize data from a URI</doc>
- <type name="FormatterLoadFromURIMethod"
- c:type="GESFormatterLoadFromURIMethod"/>
- </field>
- <field name="save_to_uri">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.h"
- line="97">class method to serialize data to a URI</doc>
- <type name="FormatterSaveToURIMethod"
- c:type="GESFormatterSaveToURIMethod"/>
- </field>
- <field name="name" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="description" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="extension" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="mimetype" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="version" readable="0" private="1">
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="rank" readable="0" private="1">
- <type name="Gst.Rank" c:type="GstRank"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="register_metas"
- c:identifier="ges_formatter_class_register_metas">
- <source-position filename="ges/ges-formatter.h" line="126"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="479">The class to register metas on</doc>
- <type name="FormatterClass" c:type="GESFormatterClass*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="480">The name of the formatter</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="481">The formatter description</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="extensions" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="482">A list of coma separated file extensions handled
-by the formatter. The order of the extensions should match the
-list of the structures inside @caps</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="485">The caps the formatter handled, they should match what
-gstreamer typefind mechanism will report for the files the formatter
-handles.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="488">The version of the formatter</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="rank" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="489">The rank of the formatter</doc>
- <type name="Gst.Rank" c:type="GstRank"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <callback name="FormatterLoadFromURIMethod"
- c:type="GESFormatterLoadFromURIMethod"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.h"
- line="54">Virtual method for loading a timeline from a given URI.
-
-Every #GESFormatter subclass needs to implement this method.</doc>
- <source-position filename="ges/ges-formatter.h" line="68"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="380">TRUE if the timeline data was successfully loaded from the URI,
-else FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="formatter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="373">a #GESFormatter</doc>
- <type name="Formatter" c:type="GESFormatter*"/>
- </parameter>
- <parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="374">a #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="375">a #gchar * pointing to a URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="FormatterPrivate" c:type="GESFormatterPrivate" disguised="1">
- <source-position filename="ges/ges-formatter.h" line="29"/>
- </record>
- <callback name="FormatterSaveToURIMethod"
- c:type="GESFormatterSaveToURIMethod"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.h"
- line="73">Virtual method for saving a timeline to a uri.
-
-Every #GESFormatter subclass needs to implement this method.</doc>
- <source-position filename="ges/ges-formatter.h" line="88"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="414">TRUE if the timeline data was successfully saved to the URI
-else FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="formatter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="406">a #GESFormatter</doc>
- <type name="Formatter" c:type="GESFormatter*"/>
- </parameter>
- <parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="407">a #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="408">a #gchar * pointing to a URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="overwrite" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="409">%TRUE to overwrite file if it exists</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- <class name="Group"
- c:symbol-prefix="group"
- c:type="GESGroup"
- parent="Container"
- glib:type-name="GESGroup"
- glib:get-type="ges_group_get_type"
- glib:type-struct="GroupClass">
- <doc xml:space="preserve"
- filename="ges/ges-group.c"
- line="20">A #GESGroup controls one or more #GESContainer-s (usually #GESClip-s,
-but it can also control other #GESGroup-s). Its children must share
-the same #GESTimeline, but can otherwise lie in separate #GESLayer-s
-and have different timings.
-
-To initialise a group, you may want to use ges_container_group(),
-and similarly use ges_container_ungroup() to dispose of it.
-
-A group will maintain the relative #GESTimelineElement:start times of
-its children, as well as their relative layer #GESLayer:priority.
-Therefore, if one of its children has its #GESTimelineElement:start
-set, all other children will have their #GESTimelineElement:start
-shifted by the same amount. Similarly, if one of its children moves to
-a new layer, the other children will also change layers to maintain the
-difference in their layer priorities. For example, if a child moves
-from a layer with #GESLayer:priority 1 to a layer with priority 3, then
-another child that was in a layer with priority 0 will move to the
-layer with priority 2.
-
-The #GESGroup:start of a group refers to the earliest start
-time of its children. If the group's #GESGroup:start is set, all the
-children will be shifted equally such that the earliest start time
-will match the set value. The #GESGroup:duration of a group is the
-difference between the earliest start time and latest end time of its
-children. If the group's #GESGroup:duration is increased, the children
-whose end time matches the end of the group will be extended
-accordingly. If it is decreased, then any child whose end time exceeds
-the new end time will also have their duration decreased accordingly.
-
-A group may span several layers, but for methods such as
-ges_timeline_element_get_layer_priority() and
-ges_timeline_element_edit() a group is considered to have a layer
-priority that is the highest #GESLayer:priority (numerically, the
-smallest) of all the layers it spans.</doc>
- <source-position filename="ges/ges-group.h" line="45"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new" c:identifier="ges_group_new">
- <doc xml:space="preserve"
- filename="ges/ges-group.c"
- line="667">Created a new empty group. You may wish to use
-ges_container_group() instead, which can return a different
-#GESContainer subclass if possible.</doc>
- <source-position filename="ges/ges-group.h" line="48"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-group.c"
- line="674">The new empty group.</doc>
- <type name="Group" c:type="GESGroup*"/>
- </return-value>
- </constructor>
- <property name="duration" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-group.c"
- line="598">An overwrite of the #GESTimelineElement:duration property. For a
-#GESGroup, this is the difference between the earliest
-#GESTimelineElement:start time and the latest end time (given by
-#GESTimelineElement:start + #GESTimelineElement:duration) amongst
-its children.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="in-point" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-group.c"
- line="588">An overwrite of the #GESTimelineElement:in-point property. This has
-no meaning for a group and should not be set.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="max-duration"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-group.c"
- line="612">An overwrite of the #GESTimelineElement:max-duration property. This
-has no meaning for a group and should not be set.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="priority" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-group.c"
- line="623">An overwrite of the #GESTimelineElement:priority property.
-Setting #GESTimelineElement priorities is deprecated as all priority
-management is now done by GES itself.</doc>
- <type name="guint" c:type="guint"/>
- </property>
- <property name="start" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-group.c"
- line="577">An overwrite of the #GESTimelineElement:start property. For a
-#GESGroup, this is the earliest #GESTimelineElement:start time
-amongst its children.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <field name="parent">
- <type name="Container" c:type="GESContainer"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="GroupPrivate" c:type="GESGroupPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="GroupClass"
- c:type="GESGroupClass"
- glib:is-gtype-struct-for="Group">
- <source-position filename="ges/ges-group.h" line="45"/>
- <field name="parent_class">
- <type name="ContainerClass" c:type="GESContainerClass"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="GroupPrivate" c:type="GESGroupPrivate" disguised="1">
- <source-position filename="ges/ges-group.h" line="30"/>
- </record>
- <class name="ImageSource"
- c:symbol-prefix="image_source"
- c:type="GESImageSource"
- deprecated="1"
- deprecated-version="1.18"
- parent="VideoSource"
- glib:type-name="GESImageSource"
- glib:get-type="ges_image_source_get_type"
- glib:type-struct="ImageSourceClass">
- <doc xml:space="preserve"
- filename="ges/ges-image-source.c"
- line="21">Outputs the video stream from a given file as a still frame. The frame chosen
-will be determined by the in-point property on the track element. For image
-files, do not set the in-point property.</doc>
- <doc-deprecated xml:space="preserve">This won't be used anymore and has been replaced by
-#GESUriSource instead which now plugs an `imagefreeze` element when
-#ges_uri_source_asset_is_image returns %TRUE.</doc-deprecated>
- <source-position filename="ges/ges-image-source.h" line="52"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <property name="uri"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-image-source.c"
- line="167">The location of the file/resource to use.</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <field name="parent" readable="0" private="1">
- <type name="VideoSource" c:type="GESVideoSource"/>
- </field>
- <field name="uri" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="ImageSourcePrivate" c:type="GESImageSourcePrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="ImageSourceClass"
- c:type="GESImageSourceClass"
- glib:is-gtype-struct-for="ImageSource">
- <source-position filename="ges/ges-image-source.h" line="52"/>
- <field name="parent_class">
- <type name="VideoSourceClass" c:type="GESVideoSourceClass"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="ImageSourcePrivate"
- c:type="GESImageSourcePrivate"
- disguised="1">
- <source-position filename="ges/ges-image-source.h" line="30"/>
- </record>
- <class name="Layer"
- c:symbol-prefix="layer"
- c:type="GESLayer"
- parent="GObject.InitiallyUnowned"
- glib:type-name="GESLayer"
- glib:get-type="ges_layer_get_type"
- glib:type-struct="LayerClass">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="23">#GESLayer-s are responsible for collecting and ordering #GESClip-s.
-
-A layer within a timeline will have an associated priority,
-corresponding to their index within the timeline. A layer with the
-index/priority 0 will have the highest priority and the layer with the
-largest index will have the lowest priority (the order of priorities,
-in this sense, is the _reverse_ of the numerical ordering of the
-indices). ges_timeline_move_layer() should be used if you wish to
-change how layers are prioritised in a timeline.
-
-Layers with higher priorities will have their content priorities
-over content from lower priority layers, similar to how layers are
-used in image editing. For example, if two separate layers both
-display video content, then the layer with the higher priority will
-have its images shown first. The other layer will only have its image
-shown if the higher priority layer has no content at the given
-playtime, or is transparent in some way. Audio content in separate
-layers will simply play in addition.</doc>
- <source-position filename="ges/ges-layer.h" line="73"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new" c:identifier="ges_layer_new">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="929">Creates a new layer.</doc>
- <source-position filename="ges/ges-layer.h" line="76"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="934">A new layer.</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </return-value>
- </constructor>
- <virtual-method name="get_objects" introspectable="0">
- <source-position filename="ges/ges-layer.h" line="64"/>
- <return-value>
- <type name="GLib.List" c:type="GList*">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="object_added">
- <source-position filename="ges/ges-layer.h" line="68"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="object" transfer-ownership="none">
- <type name="Clip" c:type="GESClip*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="object_removed">
- <source-position filename="ges/ges-layer.h" line="69"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="object" transfer-ownership="none">
- <type name="Clip" c:type="GESClip*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add_asset" c:identifier="ges_layer_add_asset">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="902">See ges_layer_add_asset_full(), which also gives an error.</doc>
- <source-position filename="ges/ges-layer.h" line="92"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="918">The newly created clip.</doc>
- <type name="Clip" c:type="GESClip*"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="904">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="905">The asset to extract the new clip from</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="906">The #GESTimelineElement:start value to set on the new clip
-If `start == #GST_CLOCK_TIME_NONE`, it will be added to the end
-of @layer, i.e. it will be set to @layer's duration</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="inpoint" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="909">The #GESTimelineElement:in-point value to set on the new
-clip</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="911">The #GESTimelineElement:duration value to set on the new
-clip</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="track_types" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="913">The #GESClip:supported-formats to set on the the new
-clip, or #GES_TRACK_TYPE_UNKNOWN to use the default</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_asset_full"
- c:identifier="ges_layer_add_asset_full"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="836">Extracts a new clip from an asset and adds it to the layer with
-the given properties.</doc>
- <source-position filename="ges/ges-layer.h" line="99"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="854">The newly created clip.</doc>
- <type name="Clip" c:type="GESClip*"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="838">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="839">The asset to extract the new clip from</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="840">The #GESTimelineElement:start value to set on the new clip
-If `start == #GST_CLOCK_TIME_NONE`, it will be added to the end
-of @layer, i.e. it will be set to @layer's duration</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="inpoint" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="843">The #GESTimelineElement:in-point value to set on the new
-clip</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="845">The #GESTimelineElement:duration value to set on the new
-clip</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="track_types" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="847">The #GESClip:supported-formats to set on the the new
-clip, or #GES_TRACK_TYPE_UNKNOWN to use the default</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_clip" c:identifier="ges_layer_add_clip">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="820">See ges_layer_add_clip_full(), which also gives an error.</doc>
- <source-position filename="ges/ges-layer.h" line="85"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="827">%TRUE if @clip was properly added to @layer, or %FALSE
-if @layer refused to add @clip.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="822">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="823">The clip to add</doc>
- <type name="Clip" c:type="GESClip*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_clip_full"
- c:identifier="ges_layer_add_clip_full"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="653">Adds the given clip to the layer. If the method succeeds, the layer
-will take ownership of the clip.
-
-This method will fail and return %FALSE if @clip already resides in
-some layer. It can also fail if the additional clip breaks some
-compositional rules (see #GESTimelineElement).</doc>
- <source-position filename="ges/ges-layer.h" line="88"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="666">%TRUE if @clip was properly added to @layer, or %FALSE
-if @layer refused to add @clip.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="655">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="656">The clip to add</doc>
- <type name="Clip" c:type="GESClip*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_active_for_track"
- c:identifier="ges_layer_get_active_for_track">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="1020">Gets whether the layer is active for the given track. See
-ges_layer_set_active_for_tracks().</doc>
- <source-position filename="ges/ges-layer.h" line="143"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="1028">%TRUE if @layer is active for @track, or %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="1022">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="1023">The #GESTrack to check if @layer is currently active for</doc>
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_auto_transition"
- c:identifier="ges_layer_get_auto_transition">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="548">Gets the #GESLayer:auto-transition of the layer.</doc>
- <source-position filename="ges/ges-layer.h" line="127"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="554">%TRUE if transitions are automatically added to @layer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="550">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_clips" c:identifier="ges_layer_get_clips">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="607">Get the #GESClip-s contained in this layer.</doc>
- <source-position filename="ges/ges-layer.h" line="134"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="613">A list of clips in
-@layer.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Clip"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="609">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_clips_in_interval"
- c:identifier="ges_layer_get_clips_in_interval">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="976">Gets the clips within the layer that appear between @start and @end.</doc>
- <source-position filename="ges/ges-layer.h" line="119"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="984">A list of #GESClip-s
-that intersect the interval `[start, end)` in @layer.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Clip"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="978">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="979">Start of the interval</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="980">End of the interval</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_duration" c:identifier="ges_layer_get_duration">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="438">Retrieves the duration of the layer, which is the difference
-between the start of the layer (always time 0) and the end (which will
-be the end time of the final clip).</doc>
- <source-position filename="ges/ges-layer.h" line="136"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="446">The duration of @layer.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="440">The layer to get the duration from</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_priority" c:identifier="ges_layer_get_priority">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="590">Get the priority of the layer. When inside a timeline, this is its
-index in the timeline. See ges_timeline_move_layer().</doc>
- <source-position filename="ges/ges-layer.h" line="124"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="597">The priority of @layer within its timeline.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="592">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_timeline" c:identifier="ges_layer_get_timeline">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="942">Gets the timeline that the layer is a part of.</doc>
- <source-position filename="ges/ges-layer.h" line="82"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="948">The timeline that @layer
-is currently part of, or %NULL if it is not associated with any
-timeline.</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="944">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_empty" c:identifier="ges_layer_is_empty">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="635">Convenience method to check if the layer is empty (doesn't contain
-any #GESClip), or not.</doc>
- <source-position filename="ges/ges-layer.h" line="116"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="642">%TRUE if @layer is empty, %FALSE if it contains at least
-one clip.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="637">The #GESLayer to check</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_clip" c:identifier="ges_layer_remove_clip">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="508">Removes the given clip from the layer.</doc>
- <source-position filename="ges/ges-layer.h" line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="515">%TRUE if @clip was removed from @layer, or %FALSE if the
-operation failed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="510">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="511">The clip to remove</doc>
- <type name="Clip" c:type="GESClip*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_active_for_tracks"
- c:identifier="ges_layer_set_active_for_tracks">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="1045">Activate or deactivate track elements in @tracks (or in all tracks if @tracks
-is %NULL).
-
-When a layer is deactivated for a track, all the #GESTrackElement-s in
-the track that belong to a #GESClip in the layer will no longer be
-active in the track, regardless of their individual
-#GESTrackElement:active value.
-
-Note that by default a layer will be active for all of its
-timeline's tracks.</doc>
- <source-position filename="ges/ges-layer.h" line="138"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="1064">%TRUE if the operation worked %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="1047">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="1048">Whether elements in @tracks should be active or not</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="tracks"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="1049">The list of
-tracks @layer should be (de-)active in, or %NULL to include all the tracks
-in the @layer's timeline</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Track"/>
- </type>
- </parameter>
- </parameters>
- </method>
- <method name="set_auto_transition"
- c:identifier="ges_layer_set_auto_transition">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="564">Sets #GESLayer:auto-transition for the layer. Use
-ges_timeline_set_auto_transition() if you want all layers within a
-#GESTimeline to have #GESLayer:auto-transition set to %TRUE. Use this
-method if you want different values for different layers (and make sure
-to keep #GESTimeline:auto-transition as %FALSE for the corresponding
-timeline).</doc>
- <source-position filename="ges/ges-layer.h" line="130"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="566">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="auto_transition" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="567">Whether transitions should be automatically added to
-the layer</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_priority"
- c:identifier="ges_layer_set_priority"
- deprecated="1"
- deprecated-version="1.16.0">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="527">Sets the layer to the given priority. See #GESLayer:priority.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_move_layer instead. This deprecation means
-that you will not need to handle layer priorities at all yourself, GES
-will make sure there is never 'gaps' between layer priorities.</doc-deprecated>
- <source-position filename="ges/ges-layer.h" line="112"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="529">The #GESLayer</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="530">The priority to set</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_timeline" c:identifier="ges_layer_set_timeline">
- <source-position filename="ges/ges-layer.h" line="79"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="layer" transfer-ownership="none">
- <type name="Layer" c:type="GESLayer*"/>
- </instance-parameter>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- </parameters>
- </method>
- <property name="auto-transition" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="236">Whether to automatically create a #GESTransitionClip whenever two
-#GESSource-s that both belong to a #GESClip in the layer overlap.
-See #GESTimeline for what counts as an overlap.
-
-When a layer is added to a #GESTimeline, if this property is left as
-%FALSE, but the timeline's #GESTimeline:auto-transition is %TRUE, it
-will be set to %TRUE as well.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="priority"
- deprecated="1"
- deprecated-version="1.16.0"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="217">The priority of the layer in the #GESTimeline. 0 is the highest
-priority. Conceptually, a timeline is a stack of layers,
-and the priority of the layer represents its position in the stack. Two
-layers should not have the same priority within a given GESTimeline.
-
-Note that the timeline needs to be committed (with #ges_timeline_commit)
-for the change to be taken into account.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_move_layer instead. This deprecation means
-that you will not need to handle layer priorities at all yourself, GES
-will make sure there is never 'gaps' between layer priorities.</doc-deprecated>
- <type name="guint" c:type="guint"/>
- </property>
- <field name="parent">
- <type name="GObject.InitiallyUnowned" c:type="GInitiallyUnowned"/>
- </field>
- <field name="timeline">
- <doc xml:space="preserve"
- filename="ges/ges-layer.h"
- line="33">the #GESTimeline where this layer is being used.</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </field>
- <field name="min_nle_priority">
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="max_nle_priority">
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="priv">
- <type name="LayerPrivate" c:type="GESLayerPrivate*"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="active-changed" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="275">Will be emitted whenever the layer is activated or deactivated
-for some #GESTrack. See ges_layer_set_active_for_tracks().</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="278">Whether @layer has been made active or de-active in the @tracks</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="tracks" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="279">A list of #GESTrack
-which have been activated or deactivated</doc>
- <array name="GLib.PtrArray">
- <type name="Track"/>
- </array>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="clip-added" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="251">Will be emitted after the clip is added to the layer.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="254">The clip that was added</doc>
- <type name="Clip"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="clip-removed" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="263">Will be emitted after the clip is removed from the layer.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-layer.c"
- line="266">The clip that was removed</doc>
- <type name="Clip"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="LayerClass"
- c:type="GESLayerClass"
- glib:is-gtype-struct-for="Layer">
- <doc xml:space="preserve"
- filename="ges/ges-layer.h"
- line="51">Subclasses can override the @get_objects if they can provide a more
-efficient way of providing the list of contained #GESClip-s.</doc>
- <source-position filename="ges/ges-layer.h" line="73"/>
- <field name="parent_class" readable="0" private="1">
- <type name="GObject.InitiallyUnownedClass"
- c:type="GInitiallyUnownedClass"/>
- </field>
- <field name="get_objects" introspectable="0">
- <callback name="get_objects" introspectable="0">
- <source-position filename="ges/ges-layer.h" line="64"/>
- <return-value>
- <type name="GLib.List" c:type="GList*">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </return-value>
- <parameters>
- <parameter name="layer" transfer-ownership="none">
- <type name="Layer" c:type="GESLayer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="object_added">
- <callback name="object_added">
- <source-position filename="ges/ges-layer.h" line="68"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="layer" transfer-ownership="none">
- <type name="Layer" c:type="GESLayer*"/>
- </parameter>
- <parameter name="object" transfer-ownership="none">
- <type name="Clip" c:type="GESClip*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="object_removed">
- <callback name="object_removed">
- <source-position filename="ges/ges-layer.h" line="69"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="layer" transfer-ownership="none">
- <type name="Layer" c:type="GESLayer*"/>
- </parameter>
- <parameter name="object" transfer-ownership="none">
- <type name="Clip" c:type="GESClip*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="LayerPrivate" c:type="GESLayerPrivate" disguised="1">
- <source-position filename="ges/ges-layer.h" line="29"/>
- </record>
- <constant name="META_DESCRIPTION"
- value="description"
- c:type="GES_META_DESCRIPTION">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="41">The description of the object, to be used in various contexts (string).</doc>
- <source-position filename="ges/ges-meta-container.h" line="46"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_FORMATTER_EXTENSION"
- value="extension"
- c:type="GES_META_FORMATTER_EXTENSION">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="55">The file extension of files produced by a #GESFormatter (string).</doc>
- <source-position filename="ges/ges-meta-container.h" line="60"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_FORMATTER_MIMETYPE"
- value="mimetype"
- c:type="GES_META_FORMATTER_MIMETYPE">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="48">The mimetype used for the file produced by a #GESFormatter (string).</doc>
- <source-position filename="ges/ges-meta-container.h" line="53"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_FORMATTER_NAME"
- value="name"
- c:type="GES_META_FORMATTER_NAME">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="33">The name of a formatter, used as the #GESAsset:id for #GESFormatter
-assets (string).</doc>
- <source-position filename="ges/ges-meta-container.h" line="39"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_FORMATTER_RANK"
- value="rank"
- c:type="GES_META_FORMATTER_RANK">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="69">The rank of a #GESFormatter (a #GstRank).</doc>
- <source-position filename="ges/ges-meta-container.h" line="74"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_FORMATTER_VERSION"
- value="version"
- c:type="GES_META_FORMATTER_VERSION">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="62">The version of a #GESFormatter (double).</doc>
- <source-position filename="ges/ges-meta-container.h" line="67"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_FORMAT_VERSION"
- value="format-version"
- c:type="GES_META_FORMAT_VERSION">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="90">The version of the format in which a project is serialized (string).</doc>
- <source-position filename="ges/ges-meta-container.h" line="95"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_MARKER_COLOR"
- value="marker-color"
- c:type="GES_META_MARKER_COLOR">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="97">The ARGB color of a #GESMarker (an AARRGGBB hex as a uint).</doc>
- <source-position filename="ges/ges-meta-container.h" line="102"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_VOLUME" value="volume" c:type="GES_META_VOLUME">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="76">The volume for a #GESTrack or a #GESLayer (float).</doc>
- <source-position filename="ges/ges-meta-container.h" line="81"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_VOLUME_DEFAULT"
- value="1.000000"
- c:type="GES_META_VOLUME_DEFAULT">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="83">The default volume for a #GESTrack or a #GESLayer as a float.</doc>
- <source-position filename="ges/ges-meta-container.h" line="88"/>
- <type name="gdouble" c:type="gdouble"/>
- </constant>
- <constant name="MULTI_FILE_URI_PREFIX"
- value="multifile://"
- c:type="GES_MULTI_FILE_URI_PREFIX">
- <source-position filename="ges/ges-multi-file-source.h" line="57"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <class name="Marker"
- c:symbol-prefix="marker"
- c:type="GESMarker"
- parent="GObject.Object"
- glib:type-name="GESMarker"
- glib:get-type="ges_marker_get_type"
- glib:type-struct="MarkerClass">
- <source-position filename="ges/ges-marker-list.h" line="31"/>
- <implements name="MetaContainer"/>
- <property name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="95">Current position (in nanoseconds) of the #GESMarker</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- </class>
- <record name="MarkerClass"
- c:type="GESMarkerClass"
- glib:is-gtype-struct-for="Marker">
- <source-position filename="ges/ges-marker-list.h" line="31"/>
- <field name="parent_class">
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </field>
- </record>
- <class name="MarkerList"
- c:symbol-prefix="marker_list"
- c:type="GESMarkerList"
- version="1.18"
- parent="GObject.Object"
- glib:type-name="GESMarkerList"
- glib:get-type="ges_marker_list_get_type"
- glib:type-struct="MarkerListClass">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="21">A #GESMarker can be colored by setting the #GES_META_MARKER_COLOR meta.</doc>
- <source-position filename="ges/ges-marker-list.h" line="36"/>
- <constructor name="new"
- c:identifier="ges_marker_list_new"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="225">Creates a new #GESMarkerList.</doc>
- <source-position filename="ges/ges-marker-list.h" line="39"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="230">A new #GESMarkerList</doc>
- <type name="MarkerList" c:type="GESMarkerList*"/>
- </return-value>
- </constructor>
- <method name="add" c:identifier="ges_marker_list_add" version="1.18">
- <source-position filename="ges/ges-marker-list.h" line="42"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="247">The newly-added marker, the list keeps ownership
-of the marker</doc>
- <type name="Marker" c:type="GESMarker*"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <type name="MarkerList" c:type="GESMarkerList*"/>
- </instance-parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="245">The position of the new marker</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_markers"
- c:identifier="ges_marker_list_get_markers"
- version="1.18">
- <source-position filename="ges/ges-marker-list.h" line="52"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="324">a #GList
-of the #GESMarker within the GESMarkerList. The user will have
-to unref each #GESMarker and free the #GList.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Marker"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <type name="MarkerList" c:type="GESMarkerList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="move" c:identifier="ges_marker_list_move" version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="351">Moves a @marker in a @list to a new @position</doc>
- <source-position filename="ges/ges-marker-list.h" line="55"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="356">%TRUE if the marker could be moved, %FALSE otherwise
- (if the marker was not present in the list for example)</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <type name="MarkerList" c:type="GESMarkerList*"/>
- </instance-parameter>
- <parameter name="marker" transfer-ownership="none">
- <type name="Marker" c:type="GESMarker*"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove"
- c:identifier="ges_marker_list_remove"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="286">Removes @marker from @list, this decreases the refcount of the
-marker by 1.</doc>
- <source-position filename="ges/ges-marker-list.h" line="45"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="292">%TRUE if the marker could be removed, %FALSE otherwise
- (if the marker was not present in the list for example)</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <type name="MarkerList" c:type="GESMarkerList*"/>
- </instance-parameter>
- <parameter name="marker" transfer-ownership="none">
- <type name="Marker" c:type="GESMarker*"/>
- </parameter>
- </parameters>
- </method>
- <method name="size" c:identifier="ges_marker_list_size" version="1.18">
- <source-position filename="ges/ges-marker-list.h" line="48"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="275">The number of markers in @list</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <type name="MarkerList" c:type="GESMarkerList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <glib:signal name="marker-added" when="first" version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="169">Will be emitted after the marker was added to the marker-list.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="172">the position of the added marker</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="marker" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="173">the #GESMarker that was added.</doc>
- <type name="Marker"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="marker-moved" when="first" version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="195">Will be emitted after the marker was moved to.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="previous_position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="198">the previous position of the marker</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="new_position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="199">the new position of the marker</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="marker" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="200">the #GESMarker that was moved.</doc>
- <type name="Marker"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="marker-removed" when="first" version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="183">Will be emitted after the marker was removed the marker-list.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="marker" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-marker-list.c"
- line="186">the #GESMarker that was removed.</doc>
- <type name="Marker"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="MarkerListClass"
- c:type="GESMarkerListClass"
- glib:is-gtype-struct-for="MarkerList">
- <source-position filename="ges/ges-marker-list.h" line="36"/>
- <field name="parent_class">
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </field>
- </record>
- <interface name="MetaContainer"
- c:symbol-prefix="meta_container"
- c:type="GESMetaContainer"
- glib:type-name="GESMetaContainer"
- glib:get-type="ges_meta_container_get_type"
- glib:type-struct="MetaContainerInterface">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="30">A #GObject that implements #GESMetaContainer can have metadata set on
-it, that is data that is unimportant to its function within GES, but
-may hold some useful information. In particular,
-ges_meta_container_set_meta() can be used to store any #GValue under
-any generic field (specified by a string key). The same method can also
-be used to remove the field by passing %NULL. A number of convenience
-methods are also provided to make it easier to set common value types.
-The metadata can then be read with ges_meta_container_get_meta() and
-similar convenience methods.
-
-## Registered Fields
-
-By default, any #GValue can be set for a metadata field. However, you
-can register some fields as static, that is they only allow values of a
-specific type to be set under them, using
-ges_meta_container_register_meta() or
-ges_meta_container_register_static_meta(). The set #GESMetaFlag will
-determine whether the value can be changed, but even if it can be
-changed, it must be changed to a value of the same type.
-
-Internally, some GES objects will be initialized with static metadata
-fields. These will correspond to some standard keys, such as
-#GES_META_VOLUME.</doc>
- <source-position filename="ges/ges-meta-container.h" line="111"/>
- <method name="add_metas_from_string"
- c:identifier="ges_meta_container_add_metas_from_string">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="541">Deserializes the given string, and adds and sets the found fields and
-their values on the container. The string should be the return of
-ges_meta_container_metas_to_string().</doc>
- <source-position filename="ges/ges-meta-container.h" line="331"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="550">%TRUE if the fields in @str was successfully deserialized
-and added to @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="543">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="str" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="544">A string to deserialize and add to @container</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="check_meta_registered"
- c:identifier="ges_meta_container_check_meta_registered">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="871">Checks whether the specified field has been registered as static, and
-gets the registered type and flags of the field, as used in
-ges_meta_container_register_meta() and
-ges_meta_container_register_static_meta().</doc>
- <source-position filename="ges/ges-meta-container.h" line="246"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="885">%TRUE if the @meta_item field has been registered on
-@container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="873">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="874">The key for the @container field to check</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="flags"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="875">A destination to get the registered flags of
-the field, or %NULL to ignore</doc>
- <type name="MetaFlag" c:type="GESMetaFlag*"/>
- </parameter>
- <parameter name="type"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="877">A destination to get the registered type of
-the field, or %NULL to ignore</doc>
- <type name="GType" c:type="GType*"/>
- </parameter>
- </parameters>
- </method>
- <method name="foreach" c:identifier="ges_meta_container_foreach">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="172">Calls the given function on each of the meta container's set metadata
-fields.</doc>
- <source-position filename="ges/ges-meta-container.h" line="323"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="174">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="175">A function to call on each of @container's set
-metadata fields</doc>
- <type name="MetaForeachFunc" c:type="GESMetaForeachFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="177">User data to send to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_boolean" c:identifier="ges_meta_container_get_boolean">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="935">Gets the current boolean value of the specified field of the meta
-container. If the field does not have a set value, or it is of the
-wrong type, the method will fail.</doc>
- <source-position filename="ges/ges-meta-container.h" line="252"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="946">%TRUE if the boolean value under @meta_item was copied
-to @dest.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="937">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="938">The key for the @container field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="939">Destination into which the value under @meta_item
-should be copied.</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_date" c:identifier="ges_meta_container_get_date">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1190">Gets the current date value of the specified field of the meta
-container. If the field does not have a set value, or it is of the
-wrong type, the method will fail.</doc>
- <source-position filename="ges/ges-meta-container.h" line="287"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1201">%TRUE if the date value under @meta_item was copied
-to @dest.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1192">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1193">The key for the @container field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1194">Destination into which the value under @meta_item
-should be copied.</doc>
- <type name="GLib.Date" c:type="GDate**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_date_time"
- c:identifier="ges_meta_container_get_date_time">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1206">Gets the current date time value of the specified field of the meta
-container. If the field does not have a set value, or it is of the
-wrong type, the method will fail.</doc>
- <source-position filename="ges/ges-meta-container.h" line="292"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1217">%TRUE if the date time value under @meta_item was copied
-to @dest.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1208">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1209">The key for the @container field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1210">Destination into which the value under @meta_item
-should be copied.</doc>
- <type name="Gst.DateTime" c:type="GstDateTime**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_double" c:identifier="ges_meta_container_get_double">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="983">Gets the current double value of the specified field of the meta
-container. If the field does not have a set value, or it is of the
-wrong type, the method will fail.</doc>
- <source-position filename="ges/ges-meta-container.h" line="282"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="994">%TRUE if the double value under @meta_item was copied
-to @dest.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="985">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="986">The key for the @container field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="987">Destination into which the value under @meta_item
-should be copied.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_float" c:identifier="ges_meta_container_get_float">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1071">Gets the current float value of the specified field of the meta
-container. If the field does not have a set value, or it is of the
-wrong type, the method will fail.</doc>
- <source-position filename="ges/ges-meta-container.h" line="277"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1082">%TRUE if the float value under @meta_item was copied
-to @dest.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1073">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1074">The key for the @container field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1075">Destination into which the value under @meta_item
-should be copied.</doc>
- <type name="gfloat" c:type="gfloat*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int" c:identifier="ges_meta_container_get_int">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="951">Gets the current int value of the specified field of the meta
-container. If the field does not have a set value, or it is of the
-wrong type, the method will fail.</doc>
- <source-position filename="ges/ges-meta-container.h" line="257"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="962">%TRUE if the int value under @meta_item was copied
-to @dest.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="953">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="954">The key for the @container field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="955">Destination into which the value under @meta_item
-should be copied.</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int64" c:identifier="ges_meta_container_get_int64">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="999">Gets the current int64 value of the specified field of the meta
-container. If the field does not have a set value, or it is of the
-wrong type, the method will fail.</doc>
- <source-position filename="ges/ges-meta-container.h" line="267"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1010">%TRUE if the int64 value under @meta_item was copied
-to @dest.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1001">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1002">The key for the @container field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1003">Destination into which the value under @meta_item
-should be copied.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_marker_list"
- c:identifier="ges_meta_container_get_marker_list"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1156">Gets the current marker list value of the specified field of the meta
-container. If the field does not have a set value, or it is of the
-wrong type, the method will fail.</doc>
- <source-position filename="ges/ges-meta-container.h" line="301"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1165">A copy of the marker list value under @key,
-or %NULL if it could not be fetched.</doc>
- <type name="MarkerList" c:type="GESMarkerList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1158">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1159">The key for the @container field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_meta" c:identifier="ges_meta_container_get_meta">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1133">Gets the current value of the specified field of the meta container.</doc>
- <source-position filename="ges/ges-meta-container.h" line="305"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1140">The value under @key, or %NULL if @container
-does not have the field set.</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1135">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1136">The key for the @container field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_string" c:identifier="ges_meta_container_get_string">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1107">Gets the current string value of the specified field of the meta
-container. If the field does not have a set value, or it is of the
-wrong type, the method will fail.</doc>
- <source-position filename="ges/ges-meta-container.h" line="297"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1116">The string value under @meta_item, or %NULL
-if it could not be fetched.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1109">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1110">The key for the @container field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint" c:identifier="ges_meta_container_get_uint">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="967">Gets the current uint value of the specified field of the meta
-container. If the field does not have a set value, or it is of the
-wrong type, the method will fail.</doc>
- <source-position filename="ges/ges-meta-container.h" line="262"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="978">%TRUE if the uint value under @meta_item was copied
-to @dest.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="969">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="970">The key for the @container field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="971">Destination into which the value under @meta_item
-should be copied.</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint64" c:identifier="ges_meta_container_get_uint64">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1035">Gets the current uint64 value of the specified field of the meta
-container. If the field does not have a set value, or it is of the
-wrong type, the method will fail.</doc>
- <source-position filename="ges/ges-meta-container.h" line="272"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1046">%TRUE if the uint64 value under @meta_item was copied
-to @dest.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1037">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1038">The key for the @container field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="1039">Destination into which the value under @meta_item
-should be copied.</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="metas_to_string"
- c:identifier="ges_meta_container_metas_to_string">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="520">Serializes the set metadata fields of the meta container to a string.</doc>
- <source-position filename="ges/ges-meta-container.h" line="328"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="526">A serialized @container, or %NULL if an error
-occurred.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="522">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="register_meta"
- c:identifier="ges_meta_container_register_meta">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="841">Sets the value of the specified field of the meta container to the
-given value, and registers the field to only hold a value of the
-same type. After calling this, only values of the same type as @value
-can be set for this field. The given flags can be set to make this
-field only readable after calling this method.</doc>
- <source-position filename="ges/ges-meta-container.h" line="240"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="854">%TRUE if the @meta_item field was successfully registered on
-@container to only hold @value types, with the given @flags, and the
-field was successfully set to @value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="843">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="844">Flags to be used for the registered field</doc>
- <type name="MetaFlag" c:type="GESMetaFlag"/>
- </parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="845">The key for the @container field to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="846">The value to set for the registered field</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="register_meta_boolean"
- c:identifier="ges_meta_container_register_meta_boolean">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="650">Sets the value of the specified field of the meta container to the
-given boolean value, and registers the field to only hold a boolean
-typed value. After calling this, only boolean values can be set for
-this field. The given flags can be set to make this field only
-readable after calling this method.</doc>
- <source-position filename="ges/ges-meta-container.h" line="180"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="663">%TRUE if the @meta_item field was successfully registered on
-@container to only hold boolean typed values, with the given @flags,
-and the field was successfully set to @value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="652">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="653">Flags to be used for the registered field</doc>
- <type name="MetaFlag" c:type="GESMetaFlag"/>
- </parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="654">The key for the @container field to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="655">The value to set for the registered field</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="register_meta_date"
- c:identifier="ges_meta_container_register_meta_date">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="783">Sets the value of the specified field of the meta container to the
-given date value, and registers the field to only hold a date
-typed value. After calling this, only date values can be set for
-this field. The given flags can be set to make this field only
-readable after calling this method.</doc>
- <source-position filename="ges/ges-meta-container.h" line="222"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="796">%TRUE if the @meta_item field was successfully registered on
-@container to only hold date typed values, with the given @flags,
-and the field was successfully set to @value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="785">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="786">Flags to be used for the registered field</doc>
- <type name="MetaFlag" c:type="GESMetaFlag"/>
- </parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="787">The key for the @container field to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="788">The value to set for the registered field</doc>
- <type name="GLib.Date" c:type="const GDate*"/>
- </parameter>
- </parameters>
- </method>
- <method name="register_meta_date_time"
- c:identifier="ges_meta_container_register_meta_date_time">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="802">Sets the value of the specified field of the meta container to the
-given date time value, and registers the field to only hold a date time
-typed value. After calling this, only date time values can be set for
-this field. The given flags can be set to make this field only
-readable after calling this method.</doc>
- <source-position filename="ges/ges-meta-container.h" line="228"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="815">%TRUE if the @meta_item field was successfully registered on
-@container to only hold date time typed values, with the given @flags,
-and the field was successfully set to @value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="804">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="805">Flags to be used for the registered field</doc>
- <type name="MetaFlag" c:type="GESMetaFlag"/>
- </parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="806">The key for the @container field to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="807">The value to set for the registered field</doc>
- <type name="Gst.DateTime" c:type="const GstDateTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="register_meta_double"
- c:identifier="ges_meta_container_register_meta_double">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="764">Sets the value of the specified field of the meta container to the
-given double value, and registers the field to only hold a double
-typed value. After calling this, only double values can be set for
-this field. The given flags can be set to make this field only
-readable after calling this method.</doc>
- <source-position filename="ges/ges-meta-container.h" line="216"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="777">%TRUE if the @meta_item field was successfully registered on
-@container to only hold double typed values, with the given @flags,
-and the field was successfully set to @value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="766">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="767">Flags to be used for the registered field</doc>
- <type name="MetaFlag" c:type="GESMetaFlag"/>
- </parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="768">The key for the @container field to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="769">The value to set for the registered field</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <method name="register_meta_float"
- c:identifier="ges_meta_container_register_meta_float">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="745">Sets the value of the specified field of the meta container to the
-given float value, and registers the field to only hold a float
-typed value. After calling this, only float values can be set for
-this field. The given flags can be set to make this field only
-readable after calling this method.</doc>
- <source-position filename="ges/ges-meta-container.h" line="210"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="758">%TRUE if the @meta_item field was successfully registered on
-@container to only hold float typed values, with the given @flags,
-and the field was successfully set to @value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="747">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="748">Flags to be used for the registered field</doc>
- <type name="MetaFlag" c:type="GESMetaFlag"/>
- </parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="749">The key for the @container field to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="750">The value to set for the registered field</doc>
- <type name="gfloat" c:type="gfloat"/>
- </parameter>
- </parameters>
- </method>
- <method name="register_meta_int"
- c:identifier="ges_meta_container_register_meta_int">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="669">Sets the value of the specified field of the meta container to the
-given int value, and registers the field to only hold an int
-typed value. After calling this, only int values can be set for
-this field. The given flags can be set to make this field only
-readable after calling this method.</doc>
- <source-position filename="ges/ges-meta-container.h" line="186"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="682">%TRUE if the @meta_item field was successfully registered on
-@container to only hold int typed values, with the given @flags,
-and the field was successfully set to @value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="671">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="672">Flags to be used for the registered field</doc>
- <type name="MetaFlag" c:type="GESMetaFlag"/>
- </parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="673">The key for the @container field to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="674">The value to set for the registered field</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="register_meta_int64"
- c:identifier="ges_meta_container_register_meta_int64">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="707">Sets the value of the specified field of the meta container to the
-given int64 value, and registers the field to only hold an int64
-typed value. After calling this, only int64 values can be set for
-this field. The given flags can be set to make this field only
-readable after calling this method.</doc>
- <source-position filename="ges/ges-meta-container.h" line="198"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="720">%TRUE if the @meta_item field was successfully registered on
-@container to only hold int64 typed values, with the given @flags,
-and the field was successfully set to @value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="709">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="710">Flags to be used for the registered field</doc>
- <type name="MetaFlag" c:type="GESMetaFlag"/>
- </parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="711">The key for the @container field to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="712">The value to set for the registered field</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="register_meta_string"
- c:identifier="ges_meta_container_register_meta_string">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="822">Sets the value of the specified field of the meta container to the
-given string value, and registers the field to only hold a string
-typed value. After calling this, only string values can be set for
-this field. The given flags can be set to make this field only
-readable after calling this method.</doc>
- <source-position filename="ges/ges-meta-container.h" line="234"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="835">%TRUE if the @meta_item field was successfully registered on
-@container to only hold string typed values, with the given @flags,
-and the field was successfully set to @value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="824">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="825">Flags to be used for the registered field</doc>
- <type name="MetaFlag" c:type="GESMetaFlag"/>
- </parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="826">The key for the @container field to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="827">The value to set for the registered field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="register_meta_uint"
- c:identifier="ges_meta_container_register_meta_uint">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="688">Sets the value of the specified field of the meta container to the
-given uint value, and registers the field to only hold a uint
-typed value. After calling this, only uint values can be set for
-this field. The given flags can be set to make this field only
-readable after calling this method.</doc>
- <source-position filename="ges/ges-meta-container.h" line="192"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="701">%TRUE if the @meta_item field was successfully registered on
-@container to only hold uint typed values, with the given @flags,
-and the field was successfully set to @value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="690">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="691">Flags to be used for the registered field</doc>
- <type name="MetaFlag" c:type="GESMetaFlag"/>
- </parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="692">The key for the @container field to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="693">The value to set for the registered field</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="register_meta_uint64"
- c:identifier="ges_meta_container_register_meta_uint64">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="726">Sets the value of the specified field of the meta container to the
-given uint64 value, and registers the field to only hold a uint64
-typed value. After calling this, only uint64 values can be set for
-this field. The given flags can be set to make this field only
-readable after calling this method.</doc>
- <source-position filename="ges/ges-meta-container.h" line="204"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="739">%TRUE if the @meta_item field was successfully registered on
-@container to only hold uint64 typed values, with the given @flags,
-and the field was successfully set to @value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="728">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="729">Flags to be used for the registered field</doc>
- <type name="MetaFlag" c:type="GESMetaFlag"/>
- </parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="730">The key for the @container field to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="731">The value to set for the registered field</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="register_static_meta"
- c:identifier="ges_meta_container_register_static_meta">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="574">Registers a static metadata field on the container to only hold the
-specified type. After calling this, setting a value under this field
-can only succeed if its type matches the registered type of the field.
-
-Unlike ges_meta_container_register_meta(), no (initial) value is set
-for this field, which means you can use this method to reserve the
-space to be _optionally_ set later.
-
-Note that if a value has already been set for the field being
-registered, then its type must match the registering type, and its
-value will be left in place. If the field has no set value, then
-you will likely want to include #GES_META_WRITABLE in @flags to allow
-the value to be set later.</doc>
- <source-position filename="ges/ges-meta-container.h" line="174"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="595">%TRUE if the @meta_item field was successfully registered on
-@container to only hold @type values, with the given @flags.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="576">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="577">Flags to be used for the registered field</doc>
- <type name="MetaFlag" c:type="GESMetaFlag"/>
- </parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="578">The key for the @container field to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="579">The required value type for the registered field</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_boolean" c:identifier="ges_meta_container_set_boolean">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="310">Sets the value of the specified field of the meta container to the
-given boolean value.</doc>
- <source-position filename="ges/ges-meta-container.h" line="114"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="319">%TRUE if @value was set under @meta_item for @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="312">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="313">The key for the @container field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="314">The value to set under @meta_item</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_date" c:identifier="ges_meta_container_set_date">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="401">Sets the value of the specified field of the meta container to the
-given date value.</doc>
- <source-position filename="ges/ges-meta-container.h" line="149"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="410">%TRUE if @value was set under @meta_item for @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="403">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="404">The key for the @container field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="405">The value to set under @meta_item</doc>
- <type name="GLib.Date" c:type="const GDate*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_date_time"
- c:identifier="ges_meta_container_set_date_time">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="414">Sets the value of the specified field of the meta container to the
-given date time value.</doc>
- <source-position filename="ges/ges-meta-container.h" line="154"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="423">%TRUE if @value was set under @meta_item for @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="416">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="417">The key for the @container field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="418">The value to set under @meta_item</doc>
- <type name="Gst.DateTime" c:type="const GstDateTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_double" c:identifier="ges_meta_container_set_double">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="388">Sets the value of the specified field of the meta container to the
-given double value.</doc>
- <source-position filename="ges/ges-meta-container.h" line="144"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="397">%TRUE if @value was set under @meta_item for @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="390">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="391">The key for the @container field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="392">The value to set under @meta_item</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_float" c:identifier="ges_meta_container_set_float">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="375">Sets the value of the specified field of the meta container to the
-given float value.</doc>
- <source-position filename="ges/ges-meta-container.h" line="139"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="384">%TRUE if @value was set under @meta_item for @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="377">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="378">The key for the @container field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="379">The value to set under @meta_item</doc>
- <type name="gfloat" c:type="gfloat"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_int" c:identifier="ges_meta_container_set_int">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="323">Sets the value of the specified field of the meta container to the
-given int value.</doc>
- <source-position filename="ges/ges-meta-container.h" line="119"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="332">%TRUE if @value was set under @meta_item for @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="325">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="326">The key for the @container field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="327">The value to set under @meta_item</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_int64" c:identifier="ges_meta_container_set_int64">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="349">Sets the value of the specified field of the meta container to the
-given int64 value.</doc>
- <source-position filename="ges/ges-meta-container.h" line="129"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="358">%TRUE if @value was set under @meta_item for @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="351">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="352">The key for the @container field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="353">The value to set under @meta_item</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_marker_list"
- c:identifier="ges_meta_container_set_marker_list"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="475">Sets the value of the specified field of the meta container to the
-given marker list value.</doc>
- <source-position filename="ges/ges-meta-container.h" line="169"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="484">%TRUE if @value was set under @meta_item for @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="477">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="478">The key for the @container field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="479">The value to set under @meta_item</doc>
- <type name="MarkerList" c:type="const GESMarkerList*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_meta" c:identifier="ges_meta_container_set_meta">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="440">Sets the value of the specified field of the meta container to a
-copy of the given value. If the given @value is %NULL, the field
-given by @meta_item is removed and %TRUE is returned.</doc>
- <source-position filename="ges/ges-meta-container.h" line="164"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="451">%TRUE if @value was set under @meta_item for @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="442">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="443">The key for the @container field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="444">The value to set under @meta_item, or %NULL to
-remove the corresponding field</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_string" c:identifier="ges_meta_container_set_string">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="427">Sets the value of the specified field of the meta container to the
-given string value.</doc>
- <source-position filename="ges/ges-meta-container.h" line="159"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="436">%TRUE if @value was set under @meta_item for @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="429">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="430">The key for the @container field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="431">The value to set under @meta_item</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_uint" c:identifier="ges_meta_container_set_uint">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="336">Sets the value of the specified field of the meta container to the
-given uint value.</doc>
- <source-position filename="ges/ges-meta-container.h" line="124"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="345">%TRUE if @value was set under @meta_item for @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="338">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="339">The key for the @container field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="340">The value to set under @meta_item</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_uint64" c:identifier="ges_meta_container_set_uint64">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="362">Sets the value of the specified field of the meta container to the
-given uint64 value.</doc>
- <source-position filename="ges/ges-meta-container.h" line="134"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="371">%TRUE if @value was set under @meta_item for @container.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="364">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="GESMetaContainer*"/>
- </instance-parameter>
- <parameter name="meta_item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="365">The key for the @container field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="366">The value to set under @meta_item</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <glib:signal name="notify-meta"
- when="first"
- no-recurse="1"
- detailed="1"
- no-hooks="1">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="90">This is emitted for a meta container whenever the metadata under one
-of its fields changes, is set for the first time, or is removed. In
-the latter case, @value will be %NULL.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="93">The key for the @container field that changed</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- <parameter name="value"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.c"
- line="94">The new value under @key</doc>
- <type name="GObject.Value"/>
- </parameter>
- </parameters>
- </glib:signal>
- </interface>
- <record name="MetaContainerInterface"
- c:type="GESMetaContainerInterface"
- glib:is-gtype-struct-for="MetaContainer">
- <source-position filename="ges/ges-meta-container.h" line="111"/>
- <field name="parent_iface">
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <bitfield name="MetaFlag"
- glib:type-name="GESMetaFlag"
- glib:get-type="ges_meta_flag_get_type"
- c:type="GESMetaFlag">
- <member name="readable"
- value="1"
- c:identifier="GES_META_READABLE"
- glib:nick="readable">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="62">The metadata is readable</doc>
- </member>
- <member name="writable"
- value="2"
- c:identifier="GES_META_WRITABLE"
- glib:nick="writable">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="63">The metadata is writable</doc>
- </member>
- <member name="readwrite"
- value="3"
- c:identifier="GES_META_READ_WRITE"
- glib:nick="readwrite">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="64">The metadata is readable and writable</doc>
- </member>
- </bitfield>
- <callback name="MetaForeachFunc" c:type="GESMetaForeachFunc">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="307">A method to be called on all of a meta container's fields.</doc>
- <source-position filename="ges/ges-meta-container.h" line="317"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="309">A #GESMetaContainer</doc>
- <type name="MetaContainer" c:type="const GESMetaContainer*"/>
- </parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="310">The key for one of @container's fields</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="311">The set value under @key</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="3">
- <doc xml:space="preserve"
- filename="ges/ges-meta-container.h"
- line="312">User data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <class name="MultiFileSource"
- c:symbol-prefix="multi_file_source"
- c:type="GESMultiFileSource"
- deprecated="1"
- deprecated-version="1.18"
- parent="VideoSource"
- glib:type-name="GESMultiFileSource"
- glib:get-type="ges_multi_file_source_get_type"
- glib:type-struct="MultiFileSourceClass">
- <doc xml:space="preserve"
- filename="ges/ges-multi-file-source.c"
- line="20">Outputs the video stream from a given image sequence. The start frame chosen
-will be determined by the in-point property on the track element.
-
-This should not be used anymore, the `imagesequence://` protocol should be
-used instead. Check the #imagesequencesrc GStreamer element for more
-information.</doc>
- <doc-deprecated xml:space="preserve">Use #GESUriSource instead</doc-deprecated>
- <source-position filename="ges/ges-multi-file-source.h" line="52"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new" c:identifier="ges_multi_file_source_new">
- <source-position filename="ges/ges-multi-file-source.h" line="55"/>
- <return-value transfer-ownership="none">
- <type name="MultiFileSource" c:type="GESMultiFileSource*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <property name="uri"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-multi-file-source.c"
- line="239">The uri of the file/resource to use. You can set a start index,
-a stop index and a sequence pattern.
-The format is &amp;lt;multifile://start:stop\@location-pattern&amp;gt;.
-The pattern uses printf string formating.
-
-Example uris:
-
-multifile:///home/you/image\%03d.jpg
-
-multifile://20:50@/home/you/sequence/\%04d.png</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <field name="parent" readable="0" private="1">
- <type name="VideoSource" c:type="GESVideoSource"/>
- </field>
- <field name="uri" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="MultiFileSourcePrivate"
- c:type="GESMultiFileSourcePrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="MultiFileSourceClass"
- c:type="GESMultiFileSourceClass"
- glib:is-gtype-struct-for="MultiFileSource">
- <source-position filename="ges/ges-multi-file-source.h" line="52"/>
- <field name="parent_class">
- <type name="VideoSourceClass" c:type="GESVideoSourceClass"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="MultiFileSourcePrivate"
- c:type="GESMultiFileSourcePrivate"
- disguised="1">
- <source-position filename="ges/ges-multi-file-source.h" line="28"/>
- </record>
- <class name="Operation"
- c:symbol-prefix="operation"
- c:type="GESOperation"
- parent="TrackElement"
- abstract="1"
- glib:type-name="GESOperation"
- glib:get-type="ges_operation_get_type"
- glib:type-struct="OperationClass">
- <doc xml:space="preserve"
- filename="ges/ges-operation.h"
- line="33">Base class for overlays, transitions, and effects</doc>
- <source-position filename="ges/ges-operation.h" line="60"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <field name="parent" readable="0" private="1">
- <type name="TrackElement" c:type="GESTrackElement"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="OperationPrivate" c:type="GESOperationPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="OperationClass"
- c:type="GESOperationClass"
- glib:is-gtype-struct-for="Operation">
- <source-position filename="ges/ges-operation.h" line="60"/>
- <field name="parent_class" readable="0" private="1">
- <type name="TrackElementClass" c:type="GESTrackElementClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="OperationClip"
- c:symbol-prefix="operation_clip"
- c:type="GESOperationClip"
- parent="Clip"
- abstract="1"
- glib:type-name="GESOperationClip"
- glib:get-type="ges_operation_clip_get_type"
- glib:type-struct="OperationClipClass">
- <doc xml:space="preserve"
- filename="ges/ges-operation-clip.c"
- line="21">Operations are any kind of object that both outputs AND consumes data.</doc>
- <source-position filename="ges/ges-operation-clip.h" line="58"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <field name="parent" readable="0" private="1">
- <type name="Clip" c:type="GESClip"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="OperationClipPrivate" c:type="GESOperationClipPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="OperationClipClass"
- c:type="GESOperationClipClass"
- glib:is-gtype-struct-for="OperationClip">
- <source-position filename="ges/ges-operation-clip.h" line="58"/>
- <field name="parent_class" readable="0" private="1">
- <type name="ClipClass" c:type="GESClipClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="OperationClipPrivate"
- c:type="GESOperationClipPrivate"
- disguised="1">
- <source-position filename="ges/ges-operation-clip.h" line="31"/>
- </record>
- <record name="OperationPrivate" c:type="GESOperationPrivate" disguised="1">
- <source-position filename="ges/ges-operation.h" line="31"/>
- </record>
- <class name="OverlayClip"
- c:symbol-prefix="overlay_clip"
- c:type="GESOverlayClip"
- parent="OperationClip"
- abstract="1"
- glib:type-name="GESOverlayClip"
- glib:get-type="ges_overlay_clip_get_type"
- glib:type-struct="OverlayClipClass">
- <doc xml:space="preserve"
- filename="ges/ges-overlay-clip.c"
- line="21">Overlays are objects which modify the underlying layer(s).
-
-Examples of overlays include text, image watermarks, or audio dubbing.
-
-Transitions, which change from one source to another over time, are
-not considered overlays.</doc>
- <source-position filename="ges/ges-overlay-clip.h" line="57"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <field name="parent" readable="0" private="1">
- <type name="OperationClip" c:type="GESOperationClip"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="OverlayClipPrivate" c:type="GESOverlayClipPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="OverlayClipClass"
- c:type="GESOverlayClipClass"
- glib:is-gtype-struct-for="OverlayClip">
- <source-position filename="ges/ges-overlay-clip.h" line="57"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="ges/ges-overlay-clip.h"
- line="48">parent class</doc>
- <type name="OperationClipClass" c:type="GESOperationClipClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="OverlayClipPrivate"
- c:type="GESOverlayClipPrivate"
- disguised="1">
- <source-position filename="ges/ges-overlay-clip.h" line="30"/>
- </record>
- <constant name="PADDING" value="4" c:type="GES_PADDING">
- <attribute name="doc.skip" value="true"/>
- <source-position filename="ges/ges-types.h" line="39"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PADDING_LARGE" value="20" c:type="GES_PADDING_LARGE">
- <attribute name="doc.skip" value="true"/>
- <source-position filename="ges/ges-types.h" line="44"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <class name="Pipeline"
- c:symbol-prefix="pipeline"
- c:type="GESPipeline"
- parent="Gst.Pipeline"
- glib:type-name="GESPipeline"
- glib:get-type="ges_pipeline_get_type"
- glib:type-struct="PipelineClass">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="21">A #GESPipeline can take an audio-video #GESTimeline and conveniently
-link its #GESTrack-s to an internal #playsink element, for
-preview/playback, and an internal #encodebin element, for rendering.
-You can switch between these modes using ges_pipeline_set_mode().
-
-You can choose the specific audio and video sinks used for previewing
-the timeline by setting the #GESPipeline:audio-sink and
-#GESPipeline:video-sink properties.
-
-You can set the encoding and save location used in rendering by calling
-ges_pipeline_set_render_settings().</doc>
- <source-position filename="ges/ges-pipeline.h" line="59"/>
- <implements name="Gst.ChildProxy"/>
- <implements name="GstVideo.VideoOverlay"/>
- <constructor name="new" c:identifier="ges_pipeline_new">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="424">Creates a new pipeline.</doc>
- <source-position filename="ges/ges-pipeline.h" line="62"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="429">The newly created pipeline.</doc>
- <type name="Pipeline" c:type="GESPipeline*"/>
- </return-value>
- </constructor>
- <method name="get_mode" c:identifier="ges_pipeline_get_mode">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1161">Gets the #GESPipeline:mode of the pipeline.</doc>
- <source-position filename="ges/ges-pipeline.h" line="77"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1167">The current mode of @pipeline.</doc>
- <type name="PipelineFlags" c:type="GESPipelineFlags"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1163">A #GESPipeline</doc>
- <type name="Pipeline" c:type="GESPipeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_thumbnail" c:identifier="ges_pipeline_get_thumbnail">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1305">Gets a sample from the pipeline of the currently displayed image in
-preview, in the specified format.
-
-Note that if you use "ANY" caps for @caps, then the current format of
-the image is used. You can retrieve these caps from the returned sample
-with gst_sample_get_caps().</doc>
- <source-position filename="ges/ges-pipeline.h" line="80"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1318">A sample of @self's current image preview in
-the format given by @caps, or %NULL if an error prevented fetching the
-sample.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1307">A #GESPipeline in #GST_STATE_PLAYING or #GST_STATE_PAUSED</doc>
- <type name="Pipeline" c:type="GESPipeline*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1308">Some caps to specifying the desired format, or
-#GST_CAPS_ANY to use the native format</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_thumbnail_rgb24"
- c:identifier="ges_pipeline_get_thumbnail_rgb24">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1402">Gets a sample from the pipeline of the currently displayed image in
-preview, in the 24-bit "RGB" format and of the desired width and
-height.
-
-See ges_pipeline_get_thumbnail().</doc>
- <source-position filename="ges/ges-pipeline.h" line="83"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1416">A sample of @self's current image preview in
-the "RGB" format, scaled to @width and @height, or %NULL if an error
-prevented fetching the sample.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1404">A #GESPipeline in %GST_STATE_PLAYING or %GST_STATE_PAUSED</doc>
- <type name="Pipeline" c:type="GESPipeline*"/>
- </instance-parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1405">The requested pixel width of the image, or -1 to use the native
-size</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1407">The requested pixel height of the image, or -1 to use the
-native size</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="preview_get_audio_sink"
- c:identifier="ges_pipeline_preview_get_audio_sink">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1481">Gets the #GESPipeline:audio-sink of the pipeline.</doc>
- <source-position filename="ges/ges-pipeline.h" line="99"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1487">The audio sink used by @self for preview.</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1483">A #GESPipeline</doc>
- <type name="Pipeline" c:type="GESPipeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="preview_get_video_sink"
- c:identifier="ges_pipeline_preview_get_video_sink">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1444">Gets the #GESPipeline:video-sink of the pipeline.</doc>
- <source-position filename="ges/ges-pipeline.h" line="92"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1450">The video sink used by @self for preview.</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1446">A #GESPipeline</doc>
- <type name="Pipeline" c:type="GESPipeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="preview_set_audio_sink"
- c:identifier="ges_pipeline_preview_set_audio_sink">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1502">Sets the #GESPipeline:audio-sink of the pipeline.</doc>
- <source-position filename="ges/ges-pipeline.h" line="102"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1504">A #GESPipeline in #GST_STATE_NULL</doc>
- <type name="Pipeline" c:type="GESPipeline*"/>
- </instance-parameter>
- <parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1505">A audio sink for @self to use for preview</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="preview_set_video_sink"
- c:identifier="ges_pipeline_preview_set_video_sink">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1465">Sets the #GESPipeline:video-sink of the pipeline.</doc>
- <source-position filename="ges/ges-pipeline.h" line="95"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1467">A #GESPipeline in #GST_STATE_NULL</doc>
- <type name="Pipeline" c:type="GESPipeline*"/>
- </instance-parameter>
- <parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1468">A video sink for @self to use for preview</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="save_thumbnail"
- c:identifier="ges_pipeline_save_thumbnail"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1341">Saves the currently displayed image of the pipeline in preview to the
-given location, in the specified dimensions and format.</doc>
- <source-position filename="ges/ges-pipeline.h" line="87"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1356">%TRUE if @self's current image preview was successfully saved
-to @location using the given @format, @height and @width.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1343">A #GESPipeline in %GST_STATE_PLAYING or %GST_STATE_PAUSED</doc>
- <type name="Pipeline" c:type="GESPipeline*"/>
- </instance-parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1344">The requested pixel width of the image, or -1 to use the native
-size</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1346">The requested pixel height of the image, or -1 to use the
-native size</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1348">The desired mime type (for example, "image/jpeg")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="location" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1349">The path to save the thumbnail to</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_mode" c:identifier="ges_pipeline_set_mode">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1175">Sets the #GESPipeline:mode of the pipeline.
-
-Note that the pipeline will be set to #GST_STATE_NULL during this call to
-perform the necessary changes. You will need to set the state again yourself
-after calling this.
-
-&gt; **NOTE**: [Rendering settings](ges_pipeline_set_render_settings) need to be
-&gt; set before setting @mode to #GES_PIPELINE_MODE_RENDER or
-&gt; #GES_PIPELINE_MODE_SMART_RENDER, the call to this method will fail
-&gt; otherwise.</doc>
- <source-position filename="ges/ges-pipeline.h" line="73"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1191">%TRUE if the mode of @pipeline was successfully set to @mode.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1177">A #GESPipeline</doc>
- <type name="Pipeline" c:type="GESPipeline*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1178">The mode to set for @pipeline</doc>
- <type name="PipelineFlags" c:type="GESPipelineFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_render_settings"
- c:identifier="ges_pipeline_set_render_settings">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1062">Specifies the encoding to be used by the pipeline to render its
-#GESPipeline:timeline, and where the result should be written to.
-
-This method **must** be called before setting the pipeline mode to
-#GES_PIPELINE_MODE_RENDER.</doc>
- <source-position filename="ges/ges-pipeline.h" line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1075">%TRUE if the settings were successfully set on @pipeline.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1064">A #GESPipeline</doc>
- <type name="Pipeline" c:type="GESPipeline*"/>
- </instance-parameter>
- <parameter name="output_uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1065">The URI to save the #GESPipeline:timeline rendering
-result to</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1067">The encoding to use for rendering the #GESPipeline:timeline</doc>
- <type name="GstPbutils.EncodingProfile"
- c:type="GstEncodingProfile*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_timeline" c:identifier="ges_pipeline_set_timeline">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1016">Takes the given timeline and sets it as the #GESPipeline:timeline for
-the pipeline.
-
-Note that you should only call this method once on a given pipeline
-because a pipeline can not have its #GESPipeline:timeline changed after
-it has been set.</doc>
- <source-position filename="ges/ges-pipeline.h" line="65"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1028">%TRUE if @timeline was successfully given to @pipeline.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1018">A #GESPipeline</doc>
- <type name="Pipeline" c:type="GESPipeline*"/>
- </instance-parameter>
- <parameter name="timeline" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="1019">The timeline to set for @pipeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- </parameters>
- </method>
- <property name="audio-filter"
- version="1.6.0"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="354">The audio filter(s) to apply during playback in preview mode,
-immediately before the #GESPipeline:audio-sink. This exposes the
-#playsink:audio-filter property of the internal #playsink.</doc>
- <type name="Gst.Element"/>
- </property>
- <property name="audio-sink" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="308">The audio sink used for preview. This exposes the
-#playsink:audio-sink property of the internal #playsink.</doc>
- <type name="Gst.Element"/>
- </property>
- <property name="mode" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="341">The pipeline's mode. In preview mode (for audio or video, or both)
-the pipeline can display the timeline's content to an end user. In
-rendering mode the pipeline can encode the timeline's content and
-save it to a file.</doc>
- <type name="PipelineFlags"/>
- </property>
- <property name="timeline" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="328">The timeline used by this pipeline, whose content it will play and
-render, or %NULL if the pipeline does not yet have a timeline.
-
-Note that after you set the timeline for the first time, subsequent
-calls to change the timeline will fail.</doc>
- <type name="Timeline"/>
- </property>
- <property name="video-filter"
- version="1.6.0"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="368">The video filter(s) to apply during playback in preview mode,
-immediately before the #GESPipeline:video-sink. This exposes the
-#playsink:video-filter property of the internal #playsink.</doc>
- <type name="Gst.Element"/>
- </property>
- <property name="video-sink" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.c"
- line="318">The video sink used for preview. This exposes the
-#playsink:video-sink property of the internal #playsink.</doc>
- <type name="Gst.Element"/>
- </property>
- <field name="parent" readable="0" private="1">
- <type name="Gst.Pipeline" c:type="GstPipeline"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="PipelinePrivate" c:type="GESPipelinePrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="PipelineClass"
- c:type="GESPipelineClass"
- glib:is-gtype-struct-for="Pipeline">
- <source-position filename="ges/ges-pipeline.h" line="59"/>
- <field name="parent_class" readable="0" private="1">
- <doc xml:space="preserve"
- filename="ges/ges-pipeline.h"
- line="49">parent class</doc>
- <type name="Gst.PipelineClass" c:type="GstPipelineClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <bitfield name="PipelineFlags"
- glib:type-name="GESPipelineFlags"
- glib:get-type="ges_pipeline_flags_get_type"
- c:type="GESPipelineFlags">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="334">The various modes a #GESPipeline can be configured to.</doc>
- <member name="audio_preview"
- value="1"
- c:identifier="GES_PIPELINE_MODE_PREVIEW_AUDIO"
- glib:nick="audio_preview">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="336">Output the #GESPipeline:timeline's
-audio to the soundcard</doc>
- </member>
- <member name="video_preview"
- value="2"
- c:identifier="GES_PIPELINE_MODE_PREVIEW_VIDEO"
- glib:nick="video_preview">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="338">Output the #GESPipeline:timeline's
-video to the screen</doc>
- </member>
- <member name="full_preview"
- value="3"
- c:identifier="GES_PIPELINE_MODE_PREVIEW"
- glib:nick="full_preview">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="340">Output both the #GESPipeline:timeline's
-audio and video to the soundcard and screen (default)</doc>
- </member>
- <member name="render"
- value="4"
- c:identifier="GES_PIPELINE_MODE_RENDER"
- glib:nick="render">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="342">Render the #GESPipeline:timeline with
-forced decoding (the underlying #encodebin has its
-#encodebin:avoid-reencoding property set to %FALSE)</doc>
- </member>
- <member name="smart_render"
- value="8"
- c:identifier="GES_PIPELINE_MODE_SMART_RENDER"
- glib:nick="smart_render">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="345">Render the #GESPipeline:timeline,
-avoiding decoding/reencoding (the underlying #encodebin has its
-#encodebin:avoid-reencoding property set to %TRUE)</doc>
- </member>
- </bitfield>
- <record name="PipelinePrivate" c:type="GESPipelinePrivate" disguised="1">
- <source-position filename="ges/ges-pipeline.h" line="30"/>
- </record>
- <class name="PitiviFormatter"
- c:symbol-prefix="pitivi_formatter"
- c:type="GESPitiviFormatter"
- deprecated="1"
- deprecated-version="1.0"
- parent="Formatter"
- glib:type-name="GESPitiviFormatter"
- glib:get-type="ges_pitivi_formatter_get_type"
- glib:type-struct="PitiviFormatterClass">
- <attribute name="doc.skip" value="true"/>
- <doc xml:space="preserve"
- filename="ges/ges-pitivi-formatter.c"
- line="20">This is a legacy format and you should avoid to use it. The formatter
-is really not in good shape and is deprecated.</doc>
- <source-position filename="ges/ges-pitivi-formatter.h" line="50"/>
- <implements name="Extractable"/>
- <constructor name="new" c:identifier="ges_pitivi_formatter_new">
- <source-position filename="ges/ges-pitivi-formatter.h" line="53"/>
- <return-value transfer-ownership="none">
- <type name="PitiviFormatter" c:type="GESPitiviFormatter*"/>
- </return-value>
- </constructor>
- <field name="parent">
- <type name="Formatter" c:type="GESFormatter"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="PitiviFormatterPrivate"
- c:type="GESPitiviFormatterPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="PitiviFormatterClass"
- c:type="GESPitiviFormatterClass"
- glib:is-gtype-struct-for="PitiviFormatter">
- <source-position filename="ges/ges-pitivi-formatter.h" line="50"/>
- <field name="parent_class" readable="0" private="1">
- <type name="FormatterClass" c:type="GESFormatterClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="PitiviFormatterPrivate"
- c:type="GESPitiviFormatterPrivate"
- disguised="1">
- <source-position filename="ges/ges-pitivi-formatter.h" line="25"/>
- </record>
- <class name="Project"
- c:symbol-prefix="project"
- c:type="GESProject"
- parent="Asset"
- glib:type-name="GESProject"
- glib:get-type="ges_project_get_type"
- glib:type-struct="ProjectClass">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="20">The #GESProject is used to control a set of #GESAsset and is a
-#GESAsset with `GES_TYPE_TIMELINE` as @extractable_type itself. That
-means that you can extract #GESTimeline from a project as followed:
-
-|[
- GESProject *project;
- GESTimeline *timeline;
-
- project = ges_project_new ("file:///path/to/a/valid/project/uri");
-
- // Here you can connect to the various signal to get more infos about
- // what is happening and recover from errors if possible
- ...
-
- timeline = ges_asset_extract (GES_ASSET (project));
-]|
-
-The #GESProject class offers a higher level API to handle #GESAsset-s.
-It lets you request new asset, and it informs you about new assets through
-a set of signals. Also it handles problem such as missing files/missing
-#GstElement and lets you try to recover from those.
-
-## Subprojects
-
-In order to add a subproject, the only thing to do is to add the subproject
-to the main project:
-
-``` c
-ges_project_add_asset (project, GES_ASSET (subproject));
-```
-then the subproject will be serialized in the project files. To use
-the subproject in a timeline, you should use a #GESUriClip with the
-same subproject URI.
-
-When loading a project with subproject, subprojects URIs will be temporary
-writable local files. If you want to edit the subproject timeline,
-you should retrieve the subproject from the parent project asset list and
-extract the timeline with ges_asset_extract() and save it at
-the same temporary location.</doc>
- <source-position filename="ges/ges-project.h" line="68"/>
- <implements name="MetaContainer"/>
- <implements name="Gio.AsyncInitable"/>
- <implements name="Gio.Initable"/>
- <constructor name="new" c:identifier="ges_project_new">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1139">Creates a new #GESProject and sets its uri to @uri if provided. Note that
-if @uri is not valid or %NULL, the uri of the project will then be set
-the first time you save the project. If you then save the project to
-other locations, it will never be updated again and the first valid URI is
-the URI it will keep refering to.</doc>
- <source-position filename="ges/ges-project.h" line="91"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1149">A newly created #GESProject</doc>
- <type name="Project" c:type="GESProject*"/>
- </return-value>
- <parameters>
- <parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1141">The uri to be set after creating the project.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <virtual-method name="asset_added">
- <source-position filename="ges/ges-project.h" line="49"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="asset_loading">
- <source-position filename="ges/ges-project.h" line="51"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="asset_removed">
- <source-position filename="ges/ges-project.h" line="53"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="loaded">
- <source-position filename="ges/ges-project.h" line="62"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="loading">
- <source-position filename="ges/ges-project.h" line="64"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="loading_error">
- <source-position filename="ges/ges-project.h" line="58"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="error" transfer-ownership="none">
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- <parameter name="extractable_type" transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="missing_uri">
- <source-position filename="ges/ges-project.h" line="55"/>
- <return-value transfer-ownership="full">
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="error" transfer-ownership="none">
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- <parameter name="wrong_asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add_asset" c:identifier="ges_project_add_asset">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="935">Adds a #GESAsset to @project, the project will keep a reference on
-@asset.</doc>
- <source-position filename="ges/ges-project.h" line="71"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="943">%TRUE if the asset could be added %FALSE it was already
-in the project</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="937">A #GESProject</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="938">A #GESAsset to add to @project</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_encoding_profile"
- c:identifier="ges_project_add_encoding_profile">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1218">Adds @profile to the project. It lets you save in what format
-the project has been renders and keep a reference to those formats.
-Also, those formats will be saves to the project file when possible.</doc>
- <source-position filename="ges/ges-project.h" line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1228">%TRUE if @profile could be added, %FALSE otherwize</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1220">A #GESProject</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1221">A #GstEncodingProfile to add to the project. If a profile with
-the same name already exists, it will be replaced</doc>
- <type name="GstPbutils.EncodingProfile"
- c:type="GstEncodingProfile*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_formatter"
- c:identifier="ges_project_add_formatter"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="148">Adds a formatter as used to load @project</doc>
- <source-position filename="ges/ges-project.h" line="120"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="150">The project to add a formatter to</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="formatter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="151">A formatter used by @project</doc>
- <type name="Formatter" c:type="GESFormatter*"/>
- </parameter>
- </parameters>
- </method>
- <method name="create_asset" c:identifier="ges_project_create_asset">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="800">Create and add a #GESAsset to @project. You should connect to the
-"asset-added" signal to get the asset when it finally gets added to
-@project</doc>
- <source-position filename="ges/ges-project.h" line="99"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="810">%TRUE if the asset started to be added %FALSE it was already
-in the project</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="802">A #GESProject</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="id"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="803">The id of the asset to create and add to @project</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="extractable_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="804">The #GType of the asset to create</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="create_asset_sync"
- c:identifier="ges_project_create_asset_sync"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="843">Create and add a #GESAsset to @project. You should connect to the
-"asset-added" signal to get the asset when it finally gets added to
-@project</doc>
- <source-position filename="ges/ges-project.h" line="104"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="854">The newly created #GESAsset or %NULL.</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="845">A #GESProject</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="id"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="846">The id of the asset to create and add to @project</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="extractable_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="847">The #GType of the asset to create</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_asset" c:identifier="ges_project_get_asset">
- <source-position filename="ges/ges-project.h" line="95"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="999">The #GESAsset with
-@id or %NULL if no asset with @id as an ID</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="994">A #GESProject</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="995">The id of the asset to retrieve</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="extractable_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="996">The extractable_type of the asset
-to retrieve from @object</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_loading_assets"
- c:identifier="ges_project_get_loading_assets">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1279">Get the assets that are being loaded</doc>
- <source-position filename="ges/ges-project.h" line="109"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1285">A set of loading asset
-that will be added to @project. Note that those Asset are *not* loaded yet,
-and thus can not be used</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Asset"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1281">A #GESProject</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_uri" c:identifier="ges_project_get_uri">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1197">Retrieve the uri that is currently set on @project</doc>
- <source-position filename="ges/ges-project.h" line="93"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1203">a newly allocated string representing uri.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1199">A #GESProject</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="list_assets" c:identifier="ges_project_list_assets">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1023">List all @asset contained in @project filtering per extractable_type
-as defined by @filter. It copies the asset and thus will not be updated
-in time.</doc>
- <source-position filename="ges/ges-project.h" line="77"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1033">The list of
-#GESAsset the object contains</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Asset"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1025">A #GESProject</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="filter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1026">Type of assets to list, `GES_TYPE_EXTRACTABLE` will list
-all assets</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="list_encoding_profiles"
- c:identifier="ges_project_list_encoding_profiles">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1261">Lists the encoding profile that have been set to @project. The first one
-is the latest added.</doc>
- <source-position filename="ges/ges-project.h" line="115"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1268">The
-list of #GstEncodingProfile used in @project</doc>
- <type name="GLib.List" c:type="const GList*">
- <type name="GstPbutils.EncodingProfile"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1263">A #GESProject</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="load" c:identifier="ges_project_load" throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1171">Loads @project into @timeline</doc>
- <source-position filename="ges/ges-project.h" line="87"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1179">%TRUE if the project could be loaded %FALSE otherwize.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1173">A #GESProject that has an @uri set already</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1174">A blank timeline to load @project into</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_asset" c:identifier="ges_project_remove_asset">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="967">remove a @asset to from @project.</doc>
- <source-position filename="ges/ges-project.h" line="74"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="974">%TRUE if the asset could be removed %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="969">A #GESProject</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="970">A #GESAsset to remove from @project</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </method>
- <method name="save" c:identifier="ges_project_save" throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1057">Save the timeline of @project to @uri. You should make sure that @timeline
-is one of the timelines that have been extracted from @project
-(using ges_asset_extract (@project);)</doc>
- <source-position filename="ges/ges-project.h" line="80"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1073">%TRUE if the project could be save, %FALSE otherwize</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="project" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1059">A #GESProject to save</doc>
- <type name="Project" c:type="GESProject*"/>
- </instance-parameter>
- <parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1060">The #GESTimeline to save, it must have been extracted from @project</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1061">The uri where to save @project and @timeline</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="formatter_asset"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1062">The formatter asset to
-use or %NULL. If %NULL, will try to save in the same format as the one
-from which the timeline as been loaded or default to the best formatter
-as defined in #ges_find_formatter_for_uri</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- <parameter name="overwrite" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="1066">%TRUE to overwrite file if it exists</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <property name="uri"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <field name="parent">
- <type name="Asset" c:type="GESAsset"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="ProjectPrivate" c:type="GESProjectPrivate*"/>
- </field>
- <field name="__ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="asset-added" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="502">The #GESAsset that has been added to @project</doc>
- <type name="Asset"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="asset-loading" when="last" version="1.8">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="512">The #GESAsset that started loading</doc>
- <type name="Asset"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="asset-removed" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="524">The #GESAsset that has been removed from @project</doc>
- <type name="Asset"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="error-loading" when="last" version="1.18">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="607">The timeline that failed loading</doc>
- <type name="Timeline"/>
- </parameter>
- <parameter name="error" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="608">The #GError defining the error that occured</doc>
- <type name="GLib.Error"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="error-loading-asset" when="last">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="586">Informs you that a #GESAsset could not be created. In case of
-missing GStreamer plugins, the error will be set to #GST_CORE_ERROR
-#GST_CORE_ERROR_MISSING_PLUGIN</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="error" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="589">The #GError defining the error that occured, might be %NULL</doc>
- <type name="GLib.Error"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="590">The @id of the asset that failed loading</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- <parameter name="extractable_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="591">The @extractable_type of the asset that
-failed loading</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="loaded" when="first">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="546">The #GESTimeline that completed loading</doc>
- <type name="Timeline"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="loading" when="first" version="1.18">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="534">The #GESTimeline that started loading</doc>
- <type name="Timeline"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="missing-uri" when="last">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="553">|[
-static gchar
-source_moved_cb (GESProject *project, GError *error, GESAsset *asset_with_error)
-{
- return g_strdup ("file:///the/new/uri.ogg");
-}
-
-static int
-main (int argc, gchar ** argv)
-{
- GESTimeline *timeline;
- GESProject *project = ges_project_new ("file:///some/uri.xges");
-
- g_signal_connect (project, "missing-uri", source_moved_cb, NULL);
- timeline = ges_asset_extract (GES_ASSET (project));
-}
-]|</doc>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="578">The new URI of @wrong_asset</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="error" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="556">The error that happened</doc>
- <type name="GLib.Error"/>
- </parameter>
- <parameter name="wrong_asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-project.c"
- line="557">The asset with the wrong ID, you should us it and its content
-only to find out what the new location is.</doc>
- <type name="Asset"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="ProjectClass"
- c:type="GESProjectClass"
- glib:is-gtype-struct-for="Project">
- <source-position filename="ges/ges-project.h" line="68"/>
- <field name="parent_class">
- <type name="AssetClass" c:type="GESAssetClass"/>
- </field>
- <field name="asset_added">
- <callback name="asset_added">
- <source-position filename="ges/ges-project.h" line="49"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </parameter>
- <parameter name="asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="asset_loading">
- <callback name="asset_loading">
- <source-position filename="ges/ges-project.h" line="51"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </parameter>
- <parameter name="asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="asset_removed">
- <callback name="asset_removed">
- <source-position filename="ges/ges-project.h" line="53"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </parameter>
- <parameter name="asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="missing_uri">
- <callback name="missing_uri">
- <source-position filename="ges/ges-project.h" line="55"/>
- <return-value transfer-ownership="full">
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </parameter>
- <parameter name="error" transfer-ownership="none">
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- <parameter name="wrong_asset" transfer-ownership="none">
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="loading_error">
- <callback name="loading_error">
- <source-position filename="ges/ges-project.h" line="58"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </parameter>
- <parameter name="error" transfer-ownership="none">
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- <parameter name="extractable_type" transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="loaded">
- <callback name="loaded">
- <source-position filename="ges/ges-project.h" line="62"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </parameter>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="loading">
- <callback name="loading">
- <source-position filename="ges/ges-project.h" line="64"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Project" c:type="GESProject*"/>
- </parameter>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="ProjectPrivate" c:type="GESProjectPrivate" disguised="1">
- <source-position filename="ges/ges-project.h" line="31"/>
- </record>
- <class name="Source"
- c:symbol-prefix="source"
- c:type="GESSource"
- parent="TrackElement"
- glib:type-name="GESSource"
- glib:get-type="ges_source_get_type"
- glib:type-struct="SourceClass">
- <doc xml:space="preserve"
- filename="ges/ges-source.h"
- line="33">Base class for single-media sources</doc>
- <source-position filename="ges/ges-source.h" line="61"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <field name="parent" readable="0" private="1">
- <type name="TrackElement" c:type="GESTrackElement"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="SourcePrivate" c:type="GESSourcePrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="SourceClass"
- c:type="GESSourceClass"
- glib:is-gtype-struct-for="Source">
- <source-position filename="ges/ges-source.h" line="61"/>
- <field name="parent_class" readable="0" private="1">
- <type name="TrackElementClass" c:type="GESTrackElementClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="SourceClip"
- c:symbol-prefix="source_clip"
- c:type="GESSourceClip"
- parent="Clip"
- glib:type-name="GESSourceClip"
- glib:get-type="ges_source_clip_get_type"
- glib:type-struct="SourceClipClass">
- <doc xml:space="preserve"
- filename="ges/ges-source-clip.c"
- line="21">#GESSourceClip-s are clips whose core elements are #GESSource-s.
-
-## Effects
-
-#GESSourceClip-s can also have #GESBaseEffect-s added as non-core
-elements. These effects are applied to the core sources of the clip
-that they share a #GESTrack with. See #GESClip for how to add and move
-these effects from the clip.</doc>
- <source-position filename="ges/ges-source-clip.h" line="59"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new_time_overlay"
- c:identifier="ges_source_clip_new_time_overlay"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-time-overlay-clip.c"
- line="34">Creates a new #GESSourceClip that renders a time overlay on top</doc>
- <source-position filename="ges/ges-time-overlay-clip.h" line="28"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-time-overlay-clip.c"
- line="39">The newly created #GESSourceClip,
-or %NULL if there was an error.</doc>
- <type name="SourceClip" c:type="GESSourceClip*"/>
- </return-value>
- </constructor>
- <field name="parent">
- <type name="Clip" c:type="GESClip"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="SourceClipPrivate" c:type="GESSourceClipPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <class name="SourceClipAsset"
- c:symbol-prefix="source_clip_asset"
- c:type="GESSourceClipAsset"
- parent="ClipAsset"
- glib:type-name="GESSourceClipAsset"
- glib:get-type="ges_source_clip_asset_get_type"
- glib:type-struct="SourceClipAssetClass">
- <source-position filename="ges/ges-source-clip-asset.h" line="37"/>
- <implements name="MetaContainer"/>
- <implements name="Gio.AsyncInitable"/>
- <implements name="Gio.Initable"/>
- <field name="parent_instance">
- <type name="ClipAsset" c:type="GESClipAsset"/>
- </field>
- </class>
- <record name="SourceClipAssetClass"
- c:type="GESSourceClipAssetClass"
- glib:is-gtype-struct-for="SourceClipAsset">
- <source-position filename="ges/ges-source-clip-asset.h" line="37"/>
- <field name="parent_class">
- <type name="ClipAssetClass" c:type="GESClipAssetClass"/>
- </field>
- </record>
- <record name="SourceClipClass"
- c:type="GESSourceClipClass"
- glib:is-gtype-struct-for="SourceClip">
- <source-position filename="ges/ges-source-clip.h" line="59"/>
- <field name="parent_class" readable="0" private="1">
- <type name="ClipClass" c:type="GESClipClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="SourceClipPrivate"
- c:type="GESSourceClipPrivate"
- disguised="1">
- <source-position filename="ges/ges-source-clip.h" line="31"/>
- </record>
- <record name="SourcePrivate" c:type="GESSourcePrivate" disguised="1">
- <source-position filename="ges/ges-source.h" line="31"/>
- </record>
- <function-macro name="TIMELINE_ELEMENT_DURATION"
- c:identifier="GES_TIMELINE_ELEMENT_DURATION"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="57">The #GESTimelineElement:duration of @obj.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="63"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="59">A #GESTimelineElement</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMELINE_ELEMENT_END"
- c:identifier="GES_TIMELINE_ELEMENT_END"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="40">The end position of @obj: #GESTimelineElement:start +
-#GESTimelineElement:duration.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="47"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="42">A #GESTimelineElement</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMELINE_ELEMENT_INPOINT"
- c:identifier="GES_TIMELINE_ELEMENT_INPOINT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="49">The #GESTimelineElement:in-point of @obj.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="55"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="51">A #GESTimelineElement</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMELINE_ELEMENT_LAYER_PRIORITY"
- c:identifier="GES_TIMELINE_ELEMENT_LAYER_PRIORITY"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="88">See #ges_timeline_element_get_layer_priority.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="94"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="90">The object to retrieve the layer priority from</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMELINE_ELEMENT_MAX_DURATION"
- c:identifier="GES_TIMELINE_ELEMENT_MAX_DURATION"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="65">The #GESTimelineElement:max-duration of @obj.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="71"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="67">A #GESTimelineElement</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMELINE_ELEMENT_NAME"
- c:identifier="GES_TIMELINE_ELEMENT_NAME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="112">The #GESTimelineElement:name of @obj.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="118"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="114">A #GESTimelineElement</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="TIMELINE_ELEMENT_NO_LAYER_PRIORITY"
- value="4294967295"
- c:type="GES_TIMELINE_ELEMENT_NO_LAYER_PRIORITY">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="81">Layer priority when a timeline element is not in any layer.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="86"/>
- <type name="guint32" c:type="guint32"/>
- </constant>
- <function-macro name="TIMELINE_ELEMENT_PARENT"
- c:identifier="GES_TIMELINE_ELEMENT_PARENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="96">The #GESTimelineElement:parent of @obj.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="102"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="98">A #GESTimelineElement</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMELINE_ELEMENT_PRIORITY"
- c:identifier="GES_TIMELINE_ELEMENT_PRIORITY"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="73">The #GESTimelineElement:priority of @obj.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="79"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="75">A #GESTimelineElement</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMELINE_ELEMENT_START"
- c:identifier="GES_TIMELINE_ELEMENT_START"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="32">The #GESTimelineElement:start of @obj.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="38"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="34">A #GESTimelineElement</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMELINE_ELEMENT_TIMELINE"
- c:identifier="GES_TIMELINE_ELEMENT_TIMELINE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="104">The #GESTimelineElement:timeline of @obj.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="110"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="106">A #GESTimelineElement</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMELINE_GET_LAYERS"
- c:identifier="GES_TIMELINE_GET_LAYERS"
- introspectable="0">
- <source-position filename="ges/ges-timeline.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMELINE_GET_TRACKS"
- c:identifier="GES_TIMELINE_GET_TRACKS"
- introspectable="0">
- <source-position filename="ges/ges-timeline.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACK_ELEMENT_CLASS_DEFAULT_HAS_INTERNAL_SOURCE"
- c:identifier="GES_TRACK_ELEMENT_CLASS_DEFAULT_HAS_INTERNAL_SOURCE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.h"
- line="36">What the default #GESTrackElement:has-internal-source value should be
-for new elements from this class.</doc>
- <source-position filename="ges/ges-track-element.h" line="43"/>
- <parameters>
- <parameter name="klass">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.h"
- line="38">A #GESTrackElementClass</doc>
- </parameter>
- </parameters>
- </function-macro>
- <class name="TestClip"
- c:symbol-prefix="test_clip"
- c:type="GESTestClip"
- parent="SourceClip"
- glib:type-name="GESTestClip"
- glib:get-type="ges_test_clip_get_type"
- glib:type-struct="TestClipClass">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="23">Useful for testing purposes.
-
-## Asset
-
-The default asset ID is GESTestClip, but the framerate and video
-size can be overridden using an ID of the form:
-
-```
-framerate=60/1, width=1920, height=1080, max-duration=5.0
-```
-Note: `max-duration` can be provided in seconds as float, or as GstClockTime
-as guint64 or gint.</doc>
- <source-position filename="ges/ges-test-clip.h" line="62"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new" c:identifier="ges_test_clip_new">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="565">Creates a new #GESTestClip.</doc>
- <source-position filename="ges/ges-test-clip.h" line="90"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="570">The newly created #GESTestClip,
-or %NULL if there was an error.</doc>
- <type name="TestClip" c:type="GESTestClip*"/>
- </return-value>
- </constructor>
- <constructor name="new_for_nick"
- c:identifier="ges_test_clip_new_for_nick">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="585">Creates a new #GESTestClip for the provided @nick.</doc>
- <source-position filename="ges/ges-test-clip.h" line="92"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="591">The newly created #GESTestClip,
-or %NULL if there was an error.</doc>
- <type name="TestClip" c:type="GESTestClip*"/>
- </return-value>
- <parameters>
- <parameter name="nick" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="587">the nickname for which to create the #GESTestClip</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="get_frequency" c:identifier="ges_test_clip_get_frequency">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="488">Get the frequency @self generates.</doc>
- <source-position filename="ges/ges-test-clip.h" line="85"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="494">The frequency @self generates. See audiotestsrc element.</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="490">a #GESTestClip</doc>
- <type name="TestClip" c:type="GESTestClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_volume" c:identifier="ges_test_clip_get_volume">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="502">Get the volume of the test audio signal applied on @self.</doc>
- <source-position filename="ges/ges-test-clip.h" line="87"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="508">The volume of the test audio signal applied on @self.</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="504">a #GESTestClip</doc>
- <type name="TestClip" c:type="GESTestClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_vpattern" c:identifier="ges_test_clip_get_vpattern">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="460">Get the #GESVideoTestPattern which is applied on @self.</doc>
- <source-position filename="ges/ges-test-clip.h" line="80"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="466">The #GESVideoTestPattern which is applied on @self.</doc>
- <type name="VideoTestPattern" c:type="GESVideoTestPattern"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="462">a #GESTestClip</doc>
- <type name="TestClip" c:type="GESTestClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_muted" c:identifier="ges_test_clip_is_muted">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="474">Let you know if the audio track of @self is muted or not.</doc>
- <source-position filename="ges/ges-test-clip.h" line="83"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="480">Whether the audio track of @self is muted or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="476">a #GESTestClip</doc>
- <type name="TestClip" c:type="GESTestClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_frequency" c:identifier="ges_test_clip_set_frequency">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="414">Sets the frequency to generate. See audiotestsrc element.</doc>
- <source-position filename="ges/ges-test-clip.h" line="72"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="416">the #GESTestClip to set the frequency on</doc>
- <type name="TestClip" c:type="GESTestClip*"/>
- </instance-parameter>
- <parameter name="freq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="417">the frequency you want to use on @self</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_mute" c:identifier="ges_test_clip_set_mute">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="364">Sets whether the audio track of this clip is muted or not.</doc>
- <source-position filename="ges/ges-test-clip.h" line="65"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="366">the #GESTestClip on which to mute or unmute the audio track</doc>
- <type name="TestClip" c:type="GESTestClip*"/>
- </instance-parameter>
- <parameter name="mute" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="367">%TRUE to mute the audio track, %FALSE to unmute it</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_volume" c:identifier="ges_test_clip_set_volume">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="437">Sets the volume of the test audio signal.</doc>
- <source-position filename="ges/ges-test-clip.h" line="75"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="439">the #GESTestClip to set the volume on</doc>
- <type name="TestClip" c:type="GESTestClip*"/>
- </instance-parameter>
- <parameter name="volume" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="440">the volume of the audio signal you want to use on @self</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_vpattern" c:identifier="ges_test_clip_set_vpattern">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="391">Sets which video pattern to display on @self.</doc>
- <source-position filename="ges/ges-test-clip.h" line="68"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="393">the #GESTestClip to set the pattern on</doc>
- <type name="TestClip" c:type="GESTestClip*"/>
- </instance-parameter>
- <parameter name="vpattern" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="394">the #GESVideoTestPattern to use on @self</doc>
- <type name="VideoTestPattern" c:type="GESVideoTestPattern"/>
- </parameter>
- </parameters>
- </method>
- <property name="freq"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="320">The frequency to generate for audio track elements.</doc>
- <type name="gdouble" c:type="gdouble"/>
- </property>
- <property name="mute"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="341">Whether the sound will be played or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="volume"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="330">The volume for the audio track elements.</doc>
- <type name="gdouble" c:type="gdouble"/>
- </property>
- <property name="vpattern"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-test-clip.c"
- line="309">Video pattern to display in video track elements.</doc>
- <type name="VideoTestPattern"/>
- </property>
- <field name="parent">
- <type name="SourceClip" c:type="GESSourceClip"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TestClipPrivate" c:type="GESTestClipPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TestClipClass"
- c:type="GESTestClipClass"
- glib:is-gtype-struct-for="TestClip">
- <source-position filename="ges/ges-test-clip.h" line="62"/>
- <field name="parent_class" readable="0" private="1">
- <type name="SourceClipClass" c:type="GESSourceClipClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="TestClipPrivate" c:type="GESTestClipPrivate" disguised="1">
- <source-position filename="ges/ges-test-clip.h" line="35"/>
- </record>
- <enumeration name="TextHAlign"
- glib:type-name="GESTextHAlign"
- glib:get-type="ges_text_halign_get_type"
- c:type="GESTextHAlign">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="257">Horizontal alignment of the text.</doc>
- <member name="left"
- value="0"
- c:identifier="GES_TEXT_HALIGN_LEFT"
- glib:nick="left">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="259">align text left</doc>
- </member>
- <member name="center"
- value="1"
- c:identifier="GES_TEXT_HALIGN_CENTER"
- glib:nick="center">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="260">align text center</doc>
- </member>
- <member name="right"
- value="2"
- c:identifier="GES_TEXT_HALIGN_RIGHT"
- glib:nick="right">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="261">align text right</doc>
- </member>
- <member name="position"
- value="4"
- c:identifier="GES_TEXT_HALIGN_POSITION"
- glib:nick="position">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="262">align text on xpos position</doc>
- </member>
- <member name="absolute"
- value="5"
- c:identifier="GES_TEXT_HALIGN_ABSOLUTE"
- glib:nick="absolute">
- </member>
- </enumeration>
- <class name="TextOverlay"
- c:symbol-prefix="text_overlay"
- c:type="GESTextOverlay"
- parent="Operation"
- glib:type-name="GESTextOverlay"
- glib:get-type="ges_text_overlay_get_type"
- glib:type-struct="TextOverlayClass">
- <source-position filename="ges/ges-text-overlay.h" line="54"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new"
- c:identifier="ges_text_overlay_new"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="426">Creates a new #GESTextOverlay.</doc>
- <doc-deprecated xml:space="preserve">This should never be called by applications as this will
-be created by clips.</doc-deprecated>
- <source-position filename="ges/ges-text-overlay.h" line="81"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="431">The newly created #GESTextOverlay or
-%NULL if something went wrong.</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </return-value>
- </constructor>
- <method name="get_color" c:identifier="ges_text_overlay_get_color">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="384">Get the color used by @source.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="94"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="390">The color used by @source.</doc>
- <type name="guint32" c:type="const guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="386">a GESTextOverlay</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_font_desc"
- c:identifier="ges_text_overlay_get_font_desc">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="342">Get the pango font description currently set on @source.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="86"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="348">The pango font description currently set on @source.</doc>
- <type name="utf8" c:type="const char*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="344">a GESTextOverlay</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_halignment"
- c:identifier="ges_text_overlay_get_halignment">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="356">Get the horizontal aligment used by @source.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="88"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="362">The horizontal aligment used by @source.</doc>
- <type name="TextHAlign" c:type="GESTextHAlign"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="358">a GESTextOverlay</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_text" c:identifier="ges_text_overlay_get_text">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="328">Get the text currently set on @source.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="84"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="334">The text currently set on @source.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="330">a GESTextOverlay</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_valignment"
- c:identifier="ges_text_overlay_get_valignment">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="370">Get the vertical aligment used by @source.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="91"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="376">The vertical aligment used by @source.</doc>
- <type name="TextVAlign" c:type="GESTextVAlign"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="372">a GESTextOverlay</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_xpos" c:identifier="ges_text_overlay_get_xpos">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="398">Get the horizontal position used by @source.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="96"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="404">The horizontal position used by @source.</doc>
- <type name="gdouble" c:type="const gdouble"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="400">a GESTextOverlay</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_ypos" c:identifier="ges_text_overlay_get_ypos">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="412">Get the vertical position used by @source.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="98"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="418">The vertical position used by @source.</doc>
- <type name="gdouble" c:type="const gdouble"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="414">a GESTextOverlay</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_color" c:identifier="ges_text_overlay_set_color">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="277">Sets the color of the text.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="71"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="279">the #GESTextOverlay* to set</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- <parameter name="color" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="280">The color @self is being set to</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_font_desc"
- c:identifier="ges_text_overlay_set_font_desc">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="216">Sets the pango font description of the text this track element
-will render.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="60"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="218">the #GESTextOverlay</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- <parameter name="font_desc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="219">the pango font description</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_halignment"
- c:identifier="ges_text_overlay_set_halignment">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="258">Sets the horizontal aligment of the text.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="64"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="260">the #GESTextOverlay* to set text on</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- <parameter name="halign" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="261">The #GESTextHAlign defining the horizontal alignment
-of the text render by @self.</doc>
- <type name="TextHAlign" c:type="GESTextHAlign"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_text" c:identifier="ges_text_overlay_set_text">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="194">Sets the text this track element will render.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="57"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="196">the #GESTextOverlay* to set text on</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- <parameter name="text" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="197">the text to render. an internal copy of this text will be
-made.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_valignment"
- c:identifier="ges_text_overlay_set_valignment">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="239">Sets the vertical aligment of the text.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="68"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="241">the #GESTextOverlay* to set text on</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- <parameter name="valign" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="242">The #GESTextVAlign defining the vertical alignment
-of the text render by @self.</doc>
- <type name="TextVAlign" c:type="GESTextVAlign"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_xpos" c:identifier="ges_text_overlay_set_xpos">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="294">Sets the horizontal position of the text.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="74"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="296">the #GESTextOverlay* to set</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="297">The horizontal position @self is being set to</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_ypos" c:identifier="ges_text_overlay_set_ypos">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="311">Sets the vertical position of the text.</doc>
- <source-position filename="ges/ges-text-overlay.h" line="77"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="313">the #GESTextOverlay* to set</doc>
- <type name="TextOverlay" c:type="GESTextOverlay*"/>
- </instance-parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay.c"
- line="314">The vertical position @self is being set to</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <field name="parent">
- <type name="Operation" c:type="GESOperation"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TextOverlayPrivate" c:type="GESTextOverlayPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TextOverlayClass"
- c:type="GESTextOverlayClass"
- glib:is-gtype-struct-for="TextOverlay">
- <source-position filename="ges/ges-text-overlay.h" line="54"/>
- <field name="parent_class">
- <type name="OperationClass" c:type="GESOperationClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="TextOverlayClip"
- c:symbol-prefix="text_overlay_clip"
- c:type="GESTextOverlayClip"
- parent="OverlayClip"
- glib:type-name="GESTextOverlayClip"
- glib:get-type="ges_text_overlay_clip_get_type"
- glib:type-struct="TextOverlayClipClass">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="21">Renders text onto the next lower priority stream using textrender.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="59"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new" c:identifier="ges_text_overlay_clip_new">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="582">Creates a new #GESTextOverlayClip</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="112"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="587">The newly created
-#GESTextOverlayClip, or %NULL if there was an error.</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </return-value>
- </constructor>
- <method name="get_color" c:identifier="ges_text_overlay_clip_get_color">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="513">Get the color used by @source.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="100"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="519">The color used by @source.</doc>
- <type name="guint32" c:type="const guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="515">a #GESTextOverlayClip</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_font_desc"
- c:identifier="ges_text_overlay_clip_get_font_desc">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="471">Get the pango font description used by @self.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="93"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="477">The pango font description used by @self.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="473">a #GESTextOverlayClip</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_halignment"
- c:identifier="ges_text_overlay_clip_get_halignment">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="485">Get the horizontal aligment used by @self.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="109"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="491">The horizontal aligment used by @self.</doc>
- <type name="TextHAlign" c:type="GESTextHAlign"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="487">a #GESTextOverlayClip</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_text" c:identifier="ges_text_overlay_clip_get_text">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="456">Get the text currently set on @self.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="90"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="462">The text currently set on @self.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="458">a #GESTextOverlayClip</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_valignment"
- c:identifier="ges_text_overlay_clip_get_valignment">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="499">Get the vertical aligment used by @self.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="97"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="505">The vertical aligment used by @self.</doc>
- <type name="TextVAlign" c:type="GESTextVAlign"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="501">a #GESTextOverlayClip</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_xpos" c:identifier="ges_text_overlay_clip_get_xpos">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="528">Get the horizontal position used by @source.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="103"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="534">The horizontal position used by @source.</doc>
- <type name="gdouble" c:type="const gdouble"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="530">a #GESTextOverlayClip</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_ypos" c:identifier="ges_text_overlay_clip_get_ypos">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="543">Get the vertical position used by @source.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="106"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="549">The vertical position used by @source.</doc>
- <type name="gdouble" c:type="const gdouble"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="545">a #GESTextOverlayClip</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_color" c:identifier="ges_text_overlay_clip_set_color">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="378">Sets the color of the text.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="78"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="380">the #GESTextOverlayClip* to set</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- <parameter name="color" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="381">The color @self is being set to</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_font_desc"
- c:identifier="ges_text_overlay_clip_set_font_desc">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="288">Sets the pango font description of the text</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="66"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="290">the #GESTextOverlayClip*</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- <parameter name="font_desc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="291">the pango font description</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_halign"
- c:identifier="ges_text_overlay_clip_set_halign">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="320">Sets the horizontal aligment of the text.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="74"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="322">the #GESTextOverlayClip* to set horizontal alignement of text on</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- <parameter name="halign" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="323">#GESTextHAlign</doc>
- <type name="TextHAlign" c:type="GESTextHAlign"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_text" c:identifier="ges_text_overlay_clip_set_text">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="257">Sets the text this clip will render.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="62"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="259">the #GESTextOverlayClip* to set text on</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- <parameter name="text" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="260">the text to render. an internal copy of this text will be
-made.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_valign"
- c:identifier="ges_text_overlay_clip_set_valign">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="349">Sets the vertical aligment of the text.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="70"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="351">the #GESTextOverlayClip* to set vertical alignement of text on</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- <parameter name="valign" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="352">#GESTextVAlign</doc>
- <type name="TextVAlign" c:type="GESTextVAlign"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_xpos" c:identifier="ges_text_overlay_clip_set_xpos">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="404">Sets the horizontal position of the text.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="82"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="406">the #GESTextOverlayClip* to set</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="407">The horizontal position @self is being set to</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_ypos" c:identifier="ges_text_overlay_clip_set_ypos">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="430">Sets the vertical position of the text.</doc>
- <source-position filename="ges/ges-text-overlay-clip.h" line="86"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="432">the #GESTextOverlayClip* to set</doc>
- <type name="TextOverlayClip" c:type="GESTextOverlayClip*"/>
- </instance-parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="433">The vertical position @self is being set to</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <property name="color"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="210">The color of the text</doc>
- <type name="guint" c:type="guint"/>
- </property>
- <property name="font-desc"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="173">Pango font description string</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="halignment"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="196">Horizontal alignment of the text</doc>
- <type name="TextHAlign"/>
- </property>
- <property name="text"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="163">The text to diplay</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="valignment"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="186">Vertical alignent of the text</doc>
- <type name="TextVAlign"/>
- </property>
- <property name="xpos"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="220">The horizontal position of the text</doc>
- <type name="gdouble" c:type="gdouble"/>
- </property>
- <property name="ypos"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-text-overlay-clip.c"
- line="230">The vertical position of the text</doc>
- <type name="gdouble" c:type="gdouble"/>
- </property>
- <field name="parent">
- <type name="OverlayClip" c:type="GESOverlayClip"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TextOverlayClipPrivate"
- c:type="GESTextOverlayClipPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TextOverlayClipClass"
- c:type="GESTextOverlayClipClass"
- glib:is-gtype-struct-for="TextOverlayClip">
- <source-position filename="ges/ges-text-overlay-clip.h" line="59"/>
- <field name="parent_class" readable="0" private="1">
- <type name="OverlayClipClass" c:type="GESOverlayClipClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="TextOverlayClipPrivate"
- c:type="GESTextOverlayClipPrivate"
- disguised="1">
- <source-position filename="ges/ges-text-overlay-clip.h" line="30"/>
- </record>
- <record name="TextOverlayPrivate"
- c:type="GESTextOverlayPrivate"
- disguised="1">
- <source-position filename="ges/ges-text-overlay.h" line="30"/>
- </record>
- <enumeration name="TextVAlign"
- glib:type-name="GESTextVAlign"
- glib:get-type="ges_text_valign_get_type"
- c:type="GESTextVAlign">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="230">Vertical alignment of the text.</doc>
- <member name="baseline"
- value="0"
- c:identifier="GES_TEXT_VALIGN_BASELINE"
- glib:nick="baseline">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="232">draw text on the baseline</doc>
- </member>
- <member name="bottom"
- value="1"
- c:identifier="GES_TEXT_VALIGN_BOTTOM"
- glib:nick="bottom">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="233">draw text on the bottom</doc>
- </member>
- <member name="top"
- value="2"
- c:identifier="GES_TEXT_VALIGN_TOP"
- glib:nick="top">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="234">draw text on top</doc>
- </member>
- <member name="position"
- value="3"
- c:identifier="GES_TEXT_VALIGN_POSITION"
- glib:nick="position">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="235">draw text on ypos position</doc>
- </member>
- <member name="center"
- value="4"
- c:identifier="GES_TEXT_VALIGN_CENTER"
- glib:nick="center">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="236">draw text on the center</doc>
- </member>
- <member name="absolute"
- value="5"
- c:identifier="GES_TEXT_VALIGN_ABSOLUTE"
- glib:nick="absolute">
- </member>
- </enumeration>
- <class name="Timeline"
- c:symbol-prefix="timeline"
- c:type="GESTimeline"
- parent="Gst.Bin"
- glib:type-name="GESTimeline"
- glib:get-type="ges_timeline_get_type"
- glib:type-struct="TimelineClass">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="26">#GESTimeline is the central object for any multimedia timeline.
-
-A timeline is composed of a set of #GESTrack-s and a set of
-#GESLayer-s, which are added to the timeline using
-ges_timeline_add_track() and ges_timeline_append_layer(), respectively.
-
-The contained tracks define the supported types of the timeline
-and provide the media output. Essentially, each track provides an
-additional source #GstPad.
-
-Most usage of a timeline will likely only need a single #GESAudioTrack
-and/or a single #GESVideoTrack. You can create such a timeline with
-ges_timeline_new_audio_video(). After this, you are unlikely to need to
-work with the tracks directly.
-
-A timeline's layers contain #GESClip-s, which in turn control the
-creation of #GESTrackElement-s, which are added to the timeline's
-tracks. See #GESTimeline::select-tracks-for-object if you wish to have
-more control over which track a clip's elements are added to.
-
-The layers are ordered, with higher priority layers having their
-content prioritised in the tracks. This ordering can be changed using
-ges_timeline_move_layer().
-
-## Editing
-
-See #GESTimelineElement for the various ways the elements of a timeline
-can be edited.
-
-If you change the timing or ordering of a timeline's
-#GESTimelineElement-s, then these changes will not actually be taken
-into account in the output of the timeline's tracks until the
-ges_timeline_commit() method is called. This allows you to move its
-elements around, say, in response to an end user's mouse dragging, with
-little expense before finalising their effect on the produced data.
-
-## Overlaps and Auto-Transitions
-
-There are certain restrictions placed on how #GESSource-s may overlap
-in a #GESTrack that belongs to a timeline. These will be enforced by
-GES, so the user will not need to keep track of them, but they should
-be aware that certain edits will be refused as a result if the overlap
-rules would be broken.
-
-Consider two #GESSource-s, `A` and `B`, with start times `startA` and
-`startB`, and end times `endA` and `endB`, respectively. The start
-time refers to their #GESTimelineElement:start, and the end time is
-their #GESTimelineElement:start + #GESTimelineElement:duration. These
-two sources *overlap* if:
-
-+ they share the same #GESTrackElement:track (non %NULL), which belongs
- to the timeline;
-+ they share the same #GES_TIMELINE_ELEMENT_LAYER_PRIORITY; and
-+ `startA &lt; endB` and `startB &lt; endA `.
-
-Note that when `startA = endB` or `startB = endA` then the two sources
-will *touch* at their edges, but are not considered overlapping.
-
-If, in addition, `startA &lt; startB &lt; endA`, then we can say that the
-end of `A` overlaps the start of `B`.
-
-If, instead, `startA &lt;= startB` and `endA &gt;= endB`, then we can say
-that `A` fully overlaps `B`.
-
-The overlap rules for a timeline are that:
-
-1. One source cannot fully overlap another source.
-2. A source can only overlap the end of up to one other source at its
- start.
-3. A source can only overlap the start of up to one other source at its
- end.
-
-The last two rules combined essentially mean that at any given timeline
-position, only up to two #GESSource-s may overlap at that position. So
-triple or more overlaps are not allowed.
-
-If you switch on #GESTimeline:auto-transition, then at any moment when
-the end of one source (the first source) overlaps the start of another
-(the second source), a #GESTransitionClip will be automatically created
-for the pair in the same layer and it will cover their overlap. If the
-two elements are edited in a way such that the end of the first source
-no longer overlaps the start of the second, the transition will be
-automatically removed from the timeline. However, if the two sources
-still overlap at the same edges after the edit, then the same
-transition object will be kept, but with its timing and layer adjusted
-accordingly.
-
-## Saving
-
-To save/load a timeline, you can use the ges_timeline_load_from_uri()
-and ges_timeline_save_to_uri() methods that use the default format.
-
-## Playing
-
-A timeline is a #GstBin with a source #GstPad for each of its
-tracks, which you can fetch with ges_timeline_get_pad_for_track(). You
-will likely want to link these to some compatible sink #GstElement-s to
-be able to play or capture the content of the timeline.
-
-You can use a #GESPipeline to easily preview/play the timeline's
-content, or render it to a file.</doc>
- <source-position filename="ges/ges-timeline.h" line="87"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <implements name="Gst.ChildProxy"/>
- <constructor name="new" c:identifier="ges_timeline_new">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2089">Creates a new empty timeline.</doc>
- <source-position filename="ges/ges-timeline.h" line="90"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2094">The new timeline.</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </return-value>
- </constructor>
- <constructor name="new_audio_video"
- c:identifier="ges_timeline_new_audio_video">
- <doc xml:space="preserve"
- filename="ges/ges-utils.c"
- line="40">Creates a new timeline containing a single #GESAudioTrack and a
-single #GESVideoTrack.</doc>
- <source-position filename="ges/ges-utils.h" line="29"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-utils.c"
- line="46">The new timeline, or %NULL if the tracks
-could not be created and added.</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </return-value>
- </constructor>
- <constructor name="new_from_uri"
- c:identifier="ges_timeline_new_from_uri"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2109">Creates a timeline from the given URI.</doc>
- <source-position filename="ges/ges-timeline.h" line="92"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2117">A new timeline if the uri was loaded
-successfully, or %NULL if the uri could not be loaded.</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2111">The URI to load from</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <virtual-method name="group_added">
- <source-position filename="ges/ges-timeline.h" line="82"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="group" transfer-ownership="none">
- <type name="Group" c:type="GESGroup*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="group_removed" introspectable="0">
- <source-position filename="ges/ges-timeline.h" line="83"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="group" transfer-ownership="none">
- <type name="Group" c:type="GESGroup*"/>
- </parameter>
- <parameter name="children" transfer-ownership="none">
- <array name="GLib.PtrArray" c:type="GPtrArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="layer_added">
- <source-position filename="ges/ges-timeline.h" line="80"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="layer" transfer-ownership="none">
- <type name="Layer" c:type="GESLayer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="layer_removed">
- <source-position filename="ges/ges-timeline.h" line="81"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="layer" transfer-ownership="none">
- <type name="Layer" c:type="GESLayer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="track_added">
- <source-position filename="ges/ges-timeline.h" line="78"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="track" transfer-ownership="none">
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="track_removed">
- <source-position filename="ges/ges-timeline.h" line="79"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="track" transfer-ownership="none">
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add_layer"
- c:identifier="ges_timeline_add_layer"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2253">Add a layer to the timeline.
-
-If the layer contains #GESClip-s, then this may trigger the creation of
-their core track element children for the timeline's tracks, and the
-placement of the clip's children in the tracks of the timeline using
-#GESTimeline::select-tracks-for-object. Some errors may occur if this
-would break one of the configuration rules of the timeline in one of
-its tracks. In such cases, some track elements would fail to be added
-to their tracks, but this method would still return %TRUE. As such, it
-is advised that you only add clips to layers that already part of a
-timeline. In such situations, ges_layer_add_clip() is able to fail if
-adding the clip would cause such an error.</doc>
- <doc-deprecated xml:space="preserve">This method requires you to ensure the layer's
-#GESLayer:priority will be unique to the timeline. Use
-ges_timeline_append_layer() and ges_timeline_move_layer() instead.</doc-deprecated>
- <source-position filename="ges/ges-timeline.h" line="100"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2275">%TRUE if @layer was properly added.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2255">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2256">The layer to add</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_track" c:identifier="ges_timeline_add_track">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2399">Add a track to the timeline.
-
-If the timeline already contains clips, then this may trigger the
-creation of their core track element children for the track, and the
-placement of the clip's children in the track of the timeline using
-#GESTimeline::select-tracks-for-object. Some errors may occur if this
-would break one of the configuration rules for the timeline in the
-track. In such cases, some track elements would fail to be added to the
-track, but this method would still return %TRUE. As such, it is advised
-that you avoid adding tracks to timelines that already contain clips.</doc>
- <source-position filename="ges/ges-timeline.h" line="111"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2415">%TRUE if @track was properly added.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2401">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="track" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2402">The track to add</doc>
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- </parameters>
- </method>
- <method name="append_layer" c:identifier="ges_timeline_append_layer">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2221">Append a newly created layer to the timeline. The layer will
-be added at the lowest #GESLayer:priority (numerically, the highest).</doc>
- <source-position filename="ges/ges-timeline.h" line="102"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2228">The newly created layer.</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2223">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="commit" c:identifier="ges_timeline_commit">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2762">Commit all the pending changes of the clips contained in the
-timeline.
-
-When changes happen in a timeline, they are not immediately executed
-internally, in a way that effects the output data of the timeline. You
-should call this method when you are done with a set of changes and you
-want them to be executed.
-
-Any pending changes will be executed in the backend. The
-#GESTimeline::commited signal will be emitted once this has completed.
-You should not try to change the state of the timeline, seek it or add
-tracks to it before receiving this signal. You can use
-ges_timeline_commit_sync() if you do not want to perform other tasks in
-the mean time.
-
-Note that all the pending changes will automatically be executed when
-the timeline goes from #GST_STATE_READY to #GST_STATE_PAUSED, which is
-usually triggered by a corresponding state changes in a containing
-#GESPipeline.</doc>
- <source-position filename="ges/ges-timeline.h" line="126"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2786">%TRUE if pending changes were committed, or %FALSE if nothing
-needed to be committed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2764">A #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="commit_sync" c:identifier="ges_timeline_commit_sync">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2819">Commit all the pending changes of the clips contained in the
-timeline and wait for the changes to complete.
-
-See ges_timeline_commit().</doc>
- <source-position filename="ges/ges-timeline.h" line="128"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2828">%TRUE if pending changes were committed, or %FALSE if nothing
-needed to be committed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2821">A #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_auto_transition"
- c:identifier="ges_timeline_get_auto_transition">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2885">Gets #GESTimeline:auto-transition for the timeline.</doc>
- <source-position filename="ges/ges-timeline.h" line="134"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2891">The auto-transition of @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2887">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_duration" c:identifier="ges_timeline_get_duration">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2868">Get the current #GESTimeline:duration of the timeline</doc>
- <source-position filename="ges/ges-timeline.h" line="131"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2874">The current duration of @timeline.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2870">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_element" c:identifier="ges_timeline_get_element">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2970">Gets the element contained in the timeline with the given name.</doc>
- <source-position filename="ges/ges-timeline.h" line="142"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2977">The timeline element in @timeline
-with the given @name, or %NULL if it was not found.</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2972">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2973">The name of the element to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_frame_at" c:identifier="ges_timeline_get_frame_at">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3241">This method allows you to convert a timeline #GstClockTime into its
-corresponding #GESFrameNumber in the timeline's output.</doc>
- <source-position filename="ges/ges-timeline.h" line="156"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3249">The frame number @timestamp corresponds to.</doc>
- <type name="FrameNumber" c:type="GESFrameNumber"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3243">A #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3244">The timestamp to get the corresponding frame number of</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_frame_time" c:identifier="ges_timeline_get_frame_time">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3214">This method allows you to convert a timeline output frame number into a
-timeline #GstClockTime. For example, this time could be used to seek to a
-particular frame in the timeline's output, or as the edit position for
-an element within the timeline.</doc>
- <source-position filename="ges/ges-timeline.h" line="152"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3225">The timestamp corresponding to @frame_number in the output of @self.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3216">The self on which to retrieve the timestamp for @frame_number</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="frame_number" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3217">The frame number to get the corresponding timestamp of in the
- timeline coordinates</doc>
- <type name="FrameNumber" c:type="GESFrameNumber"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_groups" c:identifier="ges_timeline_get_groups">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2202">Get the list of #GESGroup-s present in the timeline.</doc>
- <source-position filename="ges/ges-timeline.h" line="123"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2208">The list of
-groups that contain clips present in @timeline's layers.
-Must not be changed.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Group"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2204">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_layer" c:identifier="ges_timeline_get_layer">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3041">Retrieve the layer whose index in the timeline matches the given
-priority.</doc>
- <source-position filename="ges/ges-timeline.h" line="108"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3049">The layer with the given
-@priority, or %NULL if none was found.
-
-Since 1.6</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3043">The #GESTimeline to retrieve a layer from</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3044">The priority/index of the layer to find</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_layers" c:identifier="ges_timeline_get_layers">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2672">Get the list of #GESLayer-s present in the timeline.</doc>
- <source-position filename="ges/ges-timeline.h" line="106"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2678">The list of
-layers present in @timeline sorted by priority.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Layer"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2674">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_pad_for_track"
- c:identifier="ges_timeline_get_pad_for_track">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2616">Search for the #GstPad corresponding to the given timeline's track.
-You can link to this pad to receive the output data of the given track.</doc>
- <source-position filename="ges/ges-timeline.h" line="118"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2624">The pad corresponding to @track,
-or %NULL if there is an error.</doc>
- <type name="Gst.Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2618">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2619">A track</doc>
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_snapping_distance"
- c:identifier="ges_timeline_get_snapping_distance">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2933">Gets the #GESTimeline:snapping-distance for the timeline.</doc>
- <source-position filename="ges/ges-timeline.h" line="138"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2939">The snapping distance (in nanoseconds) of @timeline.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2935">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_track_for_pad"
- c:identifier="ges_timeline_get_track_for_pad">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2585">Search for the #GESTrack corresponding to the given timeline's pad.</doc>
- <source-position filename="ges/ges-timeline.h" line="116"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2592">The track corresponding to @pad,
-or %NULL if there is an error.</doc>
- <type name="Track" c:type="GESTrack*"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2587">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2588">A pad</doc>
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_tracks" c:identifier="ges_timeline_get_tracks">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2650">Get the list of #GESTrack-s used by the timeline.</doc>
- <source-position filename="ges/ges-timeline.h" line="120"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2656">The list of tracks
-used by @timeline.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Track"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2652">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_empty" c:identifier="ges_timeline_is_empty">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3011">Check whether the timeline is empty or not.</doc>
- <source-position filename="ges/ges-timeline.h" line="144"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3017">%TRUE if @timeline is empty.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3013">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="load_from_uri"
- c:identifier="ges_timeline_load_from_uri"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2132">Loads the contents of URI into the timeline.</doc>
- <source-position filename="ges/ges-timeline.h" line="95"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2141">%TRUE if the timeline was loaded successfully from @uri.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2134">An empty #GESTimeline into which to load the formatter</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2135">The URI to load from</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="move_layer"
- c:identifier="ges_timeline_move_layer"
- version="1.16">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3171">Moves a layer within the timeline to the index given by
-@new_layer_priority.
-An index of 0 corresponds to the layer with the highest priority in a
-timeline. If @new_layer_priority is greater than the number of layers
-present in the timeline, it will become the lowest priority layer.</doc>
- <source-position filename="ges/ges-timeline.h" line="149"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3173">A #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3174">A layer within @timeline, whose priority should be changed</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </parameter>
- <parameter name="new_layer_priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3175">The new index for @layer</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="paste_element" c:identifier="ges_timeline_paste_element">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3097">Paste an element inside the timeline. @element **must** be the return of
-ges_timeline_element_copy() with `deep=TRUE`,
-and it should not be changed before pasting. @element itself is not
-placed in the timeline, instead a new element is created, alike to the
-originally copied element. Note that the originally copied element must
-also lie within @timeline, at both the point of copying and pasting.
-
-Pasting may fail if it would place the timeline in an unsupported
-configuration.
-
-After calling this function @element should not be used. In particular,
-@element can **not** be pasted again. Instead, you can copy the
-returned element and paste that copy (although, this is only possible
-if the paste was successful).
-
-See also ges_timeline_element_paste().</doc>
- <source-position filename="ges/ges-timeline.h" line="146"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3123">The newly created element, or
-%NULL if pasting fails.</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3099">The #GESTimeline onto which @element should be pasted</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3100">The element to paste</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3101">The position in the timeline @element should be pasted to,
-i.e. the #GESTimelineElement:start value for the pasted element.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="layer_priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="3103">The layer into which the element should be pasted.
--1 means paste to the same layer from which @element has been copied from</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_layer" c:identifier="ges_timeline_remove_layer">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2344">Removes a layer from the timeline.</doc>
- <source-position filename="ges/ges-timeline.h" line="104"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2351">%TRUE if @layer was properly removed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2346">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2347">The layer to remove</doc>
- <type name="Layer" c:type="GESLayer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_track" c:identifier="ges_timeline_remove_track">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2496">Remove a track from the timeline.</doc>
- <source-position filename="ges/ges-timeline.h" line="113"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2503">%TRUE if @track was properly removed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2498">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2499">The track to remove</doc>
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- </parameters>
- </method>
- <method name="save_to_uri"
- c:identifier="ges_timeline_save_to_uri"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2161">Saves the timeline to the given location. If @formatter_asset is %NULL,
-the method will attempt to save in the same format the timeline was
-loaded from, before defaulting to the formatter with highest rank.</doc>
- <source-position filename="ges/ges-timeline.h" line="97"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2174">%TRUE if @timeline was successfully saved to @uri.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2163">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2164">The location to save to</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="formatter_asset"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2165">The formatter asset to use, or %NULL</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </parameter>
- <parameter name="overwrite" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2166">%TRUE to overwrite file if it exists</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_auto_transition"
- c:identifier="ges_timeline_set_auto_transition">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2902">Sets #GESTimeline:auto-transition for the timeline. This will also set
-the corresponding #GESLayer:auto-transition for all of the timeline's
-layers to the same value. See ges_layer_set_auto_transition() if you
-wish to set the layer's #GESLayer:auto-transition individually.</doc>
- <source-position filename="ges/ges-timeline.h" line="136"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2904">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="auto_transition" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2905">Whether transitions should be automatically added
-to @timeline's layers</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_snapping_distance"
- c:identifier="ges_timeline_set_snapping_distance">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2951">Sets #GESTimeline:snapping-distance for the timeline. This new value
-will only effect future snappings and will not be used to snap the
-current element positions within the timeline.</doc>
- <source-position filename="ges/ges-timeline.h" line="140"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="timeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2953">The #GESTimeline</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </instance-parameter>
- <parameter name="snapping_distance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="2954">The snapping distance to use (in nanoseconds)</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <property name="auto-transition" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="613">Whether to automatically create a transition whenever two
-#GESSource-s overlap in a track of the timeline. See
-#GESLayer:auto-transition if you want this to only happen in some
-layers.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="599">The current duration (in nanoseconds) of the timeline. A timeline
-'starts' at time 0, so this is the maximum end time of all of its
-#GESTimelineElement-s.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="snapping-distance"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="625">The distance (in nanoseconds) at which a #GESTimelineElement being
-moved within the timeline should snap one of its #GESSource-s with
-another #GESSource-s edge. See #GESEditMode for which edges can
-snap during an edit. 0 means no snapping.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <field name="parent">
- <type name="Gst.Bin" c:type="GstBin"/>
- </field>
- <field name="layers">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.h"
- line="48">A list of #GESLayer-s sorted by
-priority. NOTE: Do not modify.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Layer"/>
- </type>
- </field>
- <field name="tracks">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.h"
- line="50">Deprecated:1.10: (element-type GES.Track): This is not thread
-safe, use #ges_timeline_get_tracks instead.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TimelinePrivate" c:type="GESTimelinePrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="commited" when="last">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="845">This signal will be emitted once the changes initiated by
-ges_timeline_commit() have been executed in the backend. Use
-ges_timeline_commit_sync() if you do not want to have to connect
-to this signal.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="group-added" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="698">Will be emitted after the group is added to to the timeline. This can
-happen when grouping with `ges_container_group`, or by adding
-containers to a newly created group.
-
-Note that this should not be emitted whilst a timeline is being
-loaded from its #GESProject asset. You should connect to the
-project's #GESProject::loaded signal if you want to know which groups
-were created for the timeline.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="group" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="701">The group that was added to @timeline</doc>
- <type name="Group"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="group-removed" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="717">Will be emitted after the group is removed from the timeline through
-`ges_container_ungroup`. Note that @group will no longer contain its
-former children, these are held in @children.
-
-Note that if a group is emptied, then it will no longer belong to the
-timeline, but this signal will **not** be emitted in such a case.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="group" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="720">The group that was removed from @timeline</doc>
- <type name="Group"/>
- </parameter>
- <parameter name="children" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="721">A list
-of #GESContainer-s that _were_ the children of the removed @group</doc>
- <array name="GLib.PtrArray">
- <type name="Container"/>
- </array>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="layer-added" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="669">Will be emitted after the layer is added to the timeline.
-
-Note that this should not be emitted whilst a timeline is being
-loaded from its #GESProject asset. You should connect to the
-project's #GESProject::loaded signal if you want to know which
-layers were created for the timeline.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="672">The layer that was added to @timeline</doc>
- <type name="Layer"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="layer-removed" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="686">Will be emitted after the layer is removed from the timeline.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="layer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="689">The layer that was removed from @timeline</doc>
- <type name="Layer"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="select-tracks-for-object" when="last">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="778">This will be emitted whenever the timeline needs to determine which
-tracks a clip's children should be added to. The track element will
-be added to each of the tracks given in the return. If a track
-element is selected to go into multiple tracks, it will be copied
-into the additional tracks, under the same clip. Note that the copy
-will *not* keep its properties or state in sync with the original.
-
-Connect to this signal once if you wish to control which element
-should be added to which track. Doing so will overwrite the default
-behaviour, which adds @track_element to all tracks whose
-#GESTrack:track-type includes the @track_element's
-#GESTrackElement:track-type.
-
-Note that under the default track selection, if a clip would produce
-multiple core children of the same #GESTrackType, it will choose
-one of the core children arbitrarily to place in the corresponding
-tracks, with a warning for the other core children that are not
-placed in the track. For example, this would happen for a #GESUriClip
-that points to a file that contains multiple audio streams. If you
-wish to choose the stream, you could connect to this signal, and use,
-say, ges_uri_source_asset_get_stream_info() to choose which core
-source to add.
-
-When a clip is first added to a timeline, its core elements will
-be created for the current tracks in the timeline if they have not
-already been created. Then this will be emitted for each of these
-core children to select which tracks, if any, they should be added
-to. It will then be called for any non-core children in the clip.
-
-In addition, if a new track element is ever added to a clip in a
-timeline (and it is not already part of a track) this will be emitted
-to select which tracks the element should be added to.
-
-Finally, as a special case, if a track is added to the timeline
-*after* it already contains clips, then it will request the creation
-of the clips' core elements of the corresponding type, if they have
-not already been created, and this signal will be emitted for each of
-these newly created elements. In addition, this will also be released
-for all other track elements in the timeline's clips that have not
-yet been assigned a track. However, in this final case, the timeline
-will only check whether the newly added track appears in the track
-list. If it does appear, the track element will be added to the newly
-added track. All other tracks in the returned track list are ignored.
-
-In this latter case, track elements that are already part of a track
-will not be asked if they want to be copied into the new track. If
-you wish to do this, you can use ges_clip_add_child_to_track().
-
-Note that the returned #GPtrArray should own a new reference to each
-of its contained #GESTrack. The timeline will set the #GDestroyNotify
-free function on the #GPtrArray to dereference the elements.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="836">An array of
-#GESTrack-s that @track_element should be added to, or %NULL to
-not add the element to any track.</doc>
- <array name="GLib.PtrArray">
- <type name="Track"/>
- </array>
- </return-value>
- <parameters>
- <parameter name="clip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="781">The clip that @track_element is being added to</doc>
- <type name="Clip"/>
- </parameter>
- <parameter name="track_element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="782">The element being added</doc>
- <type name="TrackElement"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="snapping-ended" when="last">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="759">Will be emitted whenever a snapping event ends. After a snap event
-has started (see #GESTimeline::snapping-started), it can later end
-because either another timeline edit has occurred (which may or may
-not have created a new snapping event), or because the timeline has
-been committed.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="obj1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="762">The first element that was snapping</doc>
- <type name="TrackElement"/>
- </parameter>
- <parameter name="obj2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="763">The second element that was snapping</doc>
- <type name="TrackElement"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="764">The position where the two objects were to be snapped to</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="snapping-started" when="last">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="736">Will be emitted whenever an element's movement invokes a snapping
-event during an edit (usually of one of its ancestors) because its
-start or end point lies within the #GESTimeline:snapping-distance of
-another element's start or end point.
-
-See #GESEditMode to see what can snap during an edit.
-
-Note that only up to one snapping-started signal will be emitted per
-element edit within a timeline.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="obj1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="739">The first element that is snapping</doc>
- <type name="TrackElement"/>
- </parameter>
- <parameter name="obj2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="740">The second element that is snapping</doc>
- <type name="TrackElement"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="741">The position where the two objects will snap to</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="track-added" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="640">Will be emitted after the track is added to the timeline.
-
-Note that this should not be emitted whilst a timeline is being
-loaded from its #GESProject asset. You should connect to the
-project's #GESProject::loaded signal if you want to know which
-tracks were created for the timeline.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="643">The track that was added to @timeline</doc>
- <type name="Track"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="track-removed" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="657">Will be emitted after the track is removed from the timeline.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.c"
- line="660">The track that was removed from @timeline</doc>
- <type name="Track"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="TimelineClass"
- c:type="GESTimelineClass"
- glib:is-gtype-struct-for="Timeline">
- <source-position filename="ges/ges-timeline.h" line="87"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.h"
- line="70">parent class</doc>
- <type name="Gst.BinClass" c:type="GstBinClass"/>
- </field>
- <field name="track_added">
- <callback name="track_added">
- <source-position filename="ges/ges-timeline.h" line="78"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="track" transfer-ownership="none">
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="track_removed">
- <callback name="track_removed">
- <source-position filename="ges/ges-timeline.h" line="79"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="track" transfer-ownership="none">
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="layer_added">
- <callback name="layer_added">
- <source-position filename="ges/ges-timeline.h" line="80"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="layer" transfer-ownership="none">
- <type name="Layer" c:type="GESLayer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="layer_removed">
- <callback name="layer_removed">
- <source-position filename="ges/ges-timeline.h" line="81"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="layer" transfer-ownership="none">
- <type name="Layer" c:type="GESLayer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="group_added">
- <callback name="group_added">
- <source-position filename="ges/ges-timeline.h" line="82"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="group" transfer-ownership="none">
- <type name="Group" c:type="GESGroup*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="group_removed" introspectable="0">
- <callback name="group_removed" introspectable="0">
- <source-position filename="ges/ges-timeline.h" line="83"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- <parameter name="group" transfer-ownership="none">
- <type name="Group" c:type="GESGroup*"/>
- </parameter>
- <parameter name="children" transfer-ownership="none">
- <array name="GLib.PtrArray" c:type="GPtrArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="TimelineElement"
- c:symbol-prefix="timeline_element"
- c:type="GESTimelineElement"
- parent="GObject.InitiallyUnowned"
- abstract="1"
- glib:type-name="GESTimelineElement"
- glib:get-type="ges_timeline_element_get_type"
- glib:type-struct="TimelineElementClass">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="19">A #GESTimelineElement will have some temporal extent in its
-corresponding #GESTimelineElement:timeline, controlled by its
-#GESTimelineElement:start and #GESTimelineElement:duration. This
-determines when its content will be displayed, or its effect applied,
-in the timeline. Several objects may overlap within a given
-#GESTimeline, in which case their #GESTimelineElement:priority is used
-to determine their ordering in the timeline. Priority is mostly handled
-internally by #GESLayer-s and #GESClip-s.
-
-A timeline element can have a #GESTimelineElement:parent,
-such as a #GESClip, which is responsible for controlling its timing.
-
-## Editing
-
-Elements can be moved around in their #GESTimelineElement:timeline by
-setting their #GESTimelineElement:start and
-#GESTimelineElement:duration using ges_timeline_element_set_start()
-and ges_timeline_element_set_duration(). Additionally, which parts of
-the underlying content are played in the timeline can be adjusted by
-setting the #GESTimelineElement:in-point using
-ges_timeline_element_set_inpoint(). The library also provides
-ges_timeline_element_edit(), with various #GESEditMode-s, which can
-adjust these properties in a convenient way, as well as introduce
-similar changes in neighbouring or later elements in the timeline.
-
-However, a timeline may refuse a change in these properties if they
-would place the timeline in an unsupported configuration. See
-#GESTimeline for its overlap rules.
-
-Additionally, an edit may be refused if it would place one of the
-timing properties out of bounds (such as a negative time value for
-#GESTimelineElement:start, or having insufficient internal
-content to last for the desired #GESTimelineElement:duration).
-
-## Time Coordinates
-
-There are three main sets of time coordinates to consider when using
-timeline elements:
-
-+ Timeline coordinates: these are the time coordinates used in the
- output of the timeline in its #GESTrack-s. Each track share the same
- coordinates, so there is only one set of coordinates for the
- timeline. These extend indefinitely from 0. The times used for
- editing (including setting #GESTimelineElement:start and
- #GESTimelineElement:duration) use these coordinates, since these
- define when an element is present and for how long the element lasts
- for in the timeline.
-+ Internal source coordinates: these are the time coordinates used
- internally at the element's output. This is only really defined for
- #GESTrackElement-s, where it refers to time coordinates used at the
- final source pad of the wrapped #GstElement-s. However, these
- coordinates may also be used in a #GESClip in reference to its
- children. In particular, these are the coordinates used for
- #GESTimelineElement:in-point and #GESTimelineElement:max-duration.
-+ Internal sink coordinates: these are the time coordinates used
- internally at the element's input. A #GESSource has no input, so
- these would be undefined. Otherwise, for most #GESTrackElement-s
- these will be the same set of coordinates as the internal source
- coordinates because the element does not change the timing
- internally. Only #GESBaseEffect can support elements where these
- are different. See #GESBaseEffect for more information.
-
-You can determine the timeline time for a given internal source time
-in a #GESTrack in a #GESClip using
-ges_clip_get_timeline_time_from_internal_time(), and vice versa using
-ges_clip_get_internal_time_from_timeline_time(), for the purposes of
-editing and setting timings properties.
-
-## Children Properties
-
-If a timeline element owns another #GstObject and wishes to expose
-some of its properties, it can do so by registering the property as one
-of the timeline element's children properties using
-ges_timeline_element_add_child_property(). The registered property of
-the child can then be read and set using the
-ges_timeline_element_get_child_property() and
-ges_timeline_element_set_child_property() methods, respectively. Some
-sub-classed objects will be created with pre-registered children
-properties; for example, to expose part of an underlying #GstElement
-that is used internally. The registered properties can be listed with
-ges_timeline_element_list_children_properties().</doc>
- <source-position filename="ges/ges-timeline-element.h" line="288"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <virtual-method name="deep_copy">
- <source-position filename="ges/ges-timeline-element.h" line="261"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="copy" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_layer_priority"
- invoker="get_layer_priority"
- version="1.16">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2327">Gets the priority of the layer the element is in. A #GESGroup may span
-several layers, so this would return the highest priority (numerically,
-the smallest) amongst them.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="276"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2335">The priority of the layer @self is in, or
-#GES_TIMELINE_ELEMENT_NO_LAYER_PRIORITY if @self does not exist in a
-layer.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2329">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_natural_framerate"
- invoker="get_natural_framerate"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2453">Get the "natural" framerate of @self. This is to say, for example
-for a #GESVideoUriSource the framerate of the source.
-
-Note that a #GESAudioSource may also have a natural framerate if it derives
-from the same #GESSourceClip asset as a #GESVideoSource, and its value will
-be that of the video source. For example, if the uri of a #GESUriClip points
-to a file that contains both a video and audio stream, then the corresponding
-#GESAudioUriSource will share the natural framerate of the corresponding
-#GESVideoUriSource.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="279"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2469">Whether @self has a natural framerate or not, @framerate_n
-and @framerate_d will be set to, respectively, 0 and -1 if it is
-not the case.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2455">The #GESTimelineElement to get "natural" framerate from</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="framerate_n"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2456">The framerate numerator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="framerate_d"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2457">The framerate denominator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_track_types"
- invoker="get_track_types"
- version="1.6.0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2250">Gets the track types that the element can interact with, i.e. the type
-of #GESTrack it can exist in, or will create #GESTrackElement-s for.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="270"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2257">The track types that @self supports.</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2252">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="list_children_properties" introspectable="0">
- <source-position filename="ges/ges-timeline-element.h" line="267"/>
- <return-value>
- <type name="GObject.ParamSpec" c:type="GParamSpec**"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="n_properties" transfer-ownership="none">
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="lookup_child" invoker="lookup_child">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1954">Looks up a child property of the element.
-
-@prop_name can either be in the format "prop-name" or
-"TypeName::prop-name", where "prop-name" is the name of the property
-to look up (as used in g_object_get()), and "TypeName" is the type name
-of the child (as returned by G_OBJECT_TYPE_NAME()). The latter format is
-useful when two children of different types share the same property
-name.
-
-The first child found with the given "prop-name" property that was
-registered with ges_timeline_element_add_child_property() (and of the
-type "TypeName", if it was given) will be passed to @child, and the
-registered specification of this property will be passed to @pspec.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="268"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1977">%TRUE if a child corresponding to the property was found, in
-which case @child and @pspec are set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1956">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="prop_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1957">The name of a child property</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="child"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1958">The return location for the
-found child</doc>
- <type name="GObject.Object" c:type="GObject**"/>
- </parameter>
- <parameter name="pspec"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1960">The return location for the
-specification of the child property</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="paste" introspectable="0">
- <source-position filename="ges/ges-timeline-element.h" line="263"/>
- <return-value>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="ref_element" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="paste_position" transfer-ownership="none">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="ripple" invoker="ripple">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1418">Edits the start time of an element within its timeline in ripple mode.
-See ges_timeline_element_edit() with #GES_EDIT_MODE_RIPPLE and
-#GES_EDGE_NONE.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="256"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1427">%TRUE if the ripple edit of @self completed, %FALSE on
-failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1420">The #GESTimelineElement to ripple</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1421">The new start time of @self in ripple mode</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="ripple_end" invoker="ripple_end">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1448">Edits the end time of an element within its timeline in ripple mode.
-See ges_timeline_element_edit() with #GES_EDIT_MODE_RIPPLE and
-#GES_EDGE_END.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="257"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1457">%TRUE if the ripple edit of @self completed, %FALSE on
-failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1450">The #GESTimelineElement to ripple</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1451">The new end time of @self in ripple mode</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="roll_end" invoker="roll_end">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1503">Edits the end time of an element within its timeline in roll mode.
-See ges_timeline_element_edit() with #GES_EDIT_MODE_ROLL and
-#GES_EDGE_END.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="259"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1512">%TRUE if the roll edit of @self completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1505">The #GESTimelineElement to roll</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1506">The new end time of @self in roll mode</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="roll_start" invoker="roll_start">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1476">Edits the start time of an element within its timeline in roll mode.
-See ges_timeline_element_edit() with #GES_EDIT_MODE_ROLL and
-#GES_EDGE_START.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="258"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1485">%TRUE if the roll edit of @self completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1478">The #GESTimelineElement to roll</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1479">The new start time of @self in roll mode</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_child_property">
- <source-position filename="ges/ges-timeline-element.h" line="271"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="pspec" transfer-ownership="none">
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_child_property_full" throws="1">
- <source-position filename="ges/ges-timeline-element.h" line="281"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="pspec" transfer-ownership="none">
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_duration" invoker="set_duration">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1240">Sets #GESTimelineElement:duration for the element.
-
-Whilst the element is part of a #GESTimeline, this is the same as
-editing the element with ges_timeline_element_edit() under
-#GES_EDIT_MODE_TRIM with #GES_EDGE_END. In particular, the
-#GESTimelineElement:duration of the element may be snapped to a
-different timeline time difference from the one given. In addition,
-setting may fail if it would place the timeline in an unsupported
-configuration, or the element does not have enough internal content to
-last the desired duration.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="252"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1256">%TRUE if @duration could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1242">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1243">The desired duration in its timeline</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_inpoint" invoker="set_inpoint">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1132">Sets #GESTimelineElement:in-point for the element. If the new in-point
-is above the current #GESTimelineElement:max-duration of the element,
-this method will fail.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="251"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1141">%TRUE if @inpoint could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1134">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="inpoint" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1135">The in-point, in internal time coordinates</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_max_duration" invoker="set_max_duration">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1188">Sets #GESTimelineElement:max-duration for the element. If the new
-maximum duration is below the current #GESTimelineElement:in-point of
-the element, this method will fail.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="253"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1197">%TRUE if @maxduration could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1190">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="maxduration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1191">The maximum duration, in internal time coordinates</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_parent" invoker="set_parent">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="878">Sets the #GESTimelineElement:parent for the element.
-
-This is used internally and you should normally not call this. A
-#GESContainer will set the #GESTimelineElement:parent of its children
-in ges_container_add() and ges_container_remove().
-
-Note, if @parent is not %NULL, @self must not already have a parent
-set. Therefore, if you wish to switch parents, you will need to call
-this function twice: first to set the parent to %NULL, and then to the
-new parent.
-
-If @parent is not %NULL, you must ensure it already has a
-(non-floating) reference to @self before calling this.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="249"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="897">%TRUE if @parent could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="880">A #GESTimelineElement
-@parent (nullable): New parent of @self</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="parent" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_priority"
- invoker="set_priority"
- deprecated="1"
- deprecated-version="1.10">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1377">Sets the priority of the element within the containing layer.</doc>
- <doc-deprecated xml:space="preserve">All priority management is done by GES itself now.
-To set #GESEffect priorities #ges_clip_set_top_effect_index should
-be used.</doc-deprecated>
- <source-position filename="ges/ges-timeline-element.h" line="254"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1388">%TRUE if @priority could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1379">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1380">The priority</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_start" invoker="set_start">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1057">Sets #GESTimelineElement:start for the element. If the element has a
-parent, this will also move its siblings with the same shift.
-
-Whilst the element is part of a #GESTimeline, this is the same as
-editing the element with ges_timeline_element_edit() under
-#GES_EDIT_MODE_NORMAL with #GES_EDGE_NONE. In particular, the
-#GESTimelineElement:start of the element may be snapped to a different
-timeline time from the one given. In addition, setting may fail if it
-would place the timeline in an unsupported configuration.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="250"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1072">%TRUE if @start could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1059">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1060">The desired start position of the element in its timeline</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="trim" invoker="trim">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1530">Edits the start time of an element within its timeline in trim mode.
-See ges_timeline_element_edit() with #GES_EDIT_MODE_TRIM and
-#GES_EDGE_START.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="260"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1539">%TRUE if the trim edit of @self completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1532">The #GESTimelineElement to trim</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1533">The new start time of @self in trim mode</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add_child_property"
- c:identifier="ges_timeline_element_add_child_property">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1745">Register a property of a child of the element to allow it to be
-written with ges_timeline_element_set_child_property() and read with
-ges_timeline_element_get_child_property(). A change in the property
-will also appear in the #GESTimelineElement::deep-notify signal.
-
-@pspec should be unique from other children properties that have been
-registered on @self.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="394"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1759">%TRUE if the property was successfully registered.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1747">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="pspec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1748">The specification for the property to add</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- <parameter name="child" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1749">The #GstObject who the property belongs to</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="ges_timeline_element_copy">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1557">Create a copy of @self. All the properties of @self are copied into
-a new element, with the exception of #GESTimelineElement:parent,
-#GESTimelineElement:timeline and #GESTimelineElement:name. Other data,
-such the list of a #GESContainer's children, is **not** copied.
-
-If @deep is %TRUE, then the new element is prepared so that it can be
-used in ges_timeline_element_paste() or ges_timeline_paste_element().
-In the case of copying a #GESContainer, this ensures that the children
-of @self will also be pasted. The new element should not be used for
-anything else and can only be used **once** in a pasting operation. In
-particular, the new element itself is not an actual 'deep' copy of
-@self, but should be thought of as an intermediate object used for a
-single paste operation.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="343"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1576">The newly create element,
-copied from @self.</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1559">The #GESTimelineElement to copy</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="deep" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1560">Whether the copy is needed for pasting</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="edit"
- c:identifier="ges_timeline_element_edit"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2420">See ges_timeline_element_edit_full(), which also gives an error.
-
-Note that the @layers argument is currently ignored, so you should
-just pass %NULL.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="414"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2438">%TRUE if the edit of @self completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2422">The #GESTimelineElement to edit</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="layers"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2423">A whitelist of layers
-where the edit can be performed, %NULL allows all layers in the
-timeline.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Layer"/>
- </type>
- </parameter>
- <parameter name="new_layer_priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2426">The priority/index of the layer @self should be
-moved to. -1 means no move</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2428">The edit mode</doc>
- <type name="EditMode" c:type="GESEditMode"/>
- </parameter>
- <parameter name="edge" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2429">The edge of @self where the edit should occur</doc>
- <type name="Edge" c:type="GESEdge"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2430">The edit position: a new location for the edge of @self
-(in nanoseconds) in the timeline coordinates</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="edit_full"
- c:identifier="ges_timeline_element_edit_full"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2353">Edits the element within its timeline by adjusting its
-#GESTimelineElement:start, #GESTimelineElement:duration or
-#GESTimelineElement:in-point, and potentially doing the same for
-other elements in the timeline. See #GESEditMode for details about each
-edit mode. An edit may fail if it would place one of these properties
-out of bounds, or if it would place the timeline in an unsupported
-configuration.
-
-Note that if you act on a #GESTrackElement, this will edit its parent
-#GESClip instead. Moreover, for any #GESTimelineElement, if you select
-#GES_EDGE_NONE for #GES_EDIT_MODE_NORMAL or #GES_EDIT_MODE_RIPPLE, this
-will edit the toplevel instead, but still in such a way as to make the
-#GESTimelineElement:start of @self reach the edit @position.
-
-Note that if the element's timeline has a
-#GESTimeline:snapping-distance set, then the edit position may be
-snapped to the edge of some element under the edited element.
-
-@new_layer_priority can be used to switch @self, and other elements
-moved by the edit, to a new layer. New layers may be be created if the
-the corresponding layer priority/index does not yet exist for the
-timeline.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="422"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2387">%TRUE if the edit of @self completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2355">The #GESTimelineElement to edit</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="new_layer_priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2356">The priority/index of the layer @self should be
-moved to. -1 means no move</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2358">The edit mode</doc>
- <type name="EditMode" c:type="GESEditMode"/>
- </parameter>
- <parameter name="edge" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2359">The edge of @self where the edit should occur</doc>
- <type name="Edge" c:type="GESEdge"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2360">The edit position: a new location for the edge of @self
-(in nanoseconds) in the timeline coordinates</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_child_properties"
- c:identifier="ges_timeline_element_get_child_properties"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2184">Gets several of the children properties of the element. See
-ges_timeline_element_get_child_property().</doc>
- <source-position filename="ges/ges-timeline-element.h" line="366"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2186">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="first_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2187">The name of the first child property to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2188">The return location for the first property, followed
-optionally by more name/return location pairs, followed by %NULL</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="get_child_property"
- c:identifier="ges_timeline_element_get_child_property">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1897">Gets the property of a child of the element.
-
-@property_name can either be in the format "prop-name" or
-"TypeName::prop-name", where "prop-name" is the name of the property
-to get (as used in g_object_get()), and "TypeName" is the type name of
-the child (as returned by G_OBJECT_TYPE_NAME()). The latter format is
-useful when two children of different types share the same property
-name.
-
-The first child found with the given "prop-name" property that was
-registered with ges_timeline_element_add_child_property() (and of the
-type "TypeName", if it was given) will have the corresponding
-property copied into @value.
-
-Note that ges_timeline_element_get_child_properties() may be more
-convenient for C programming.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="390"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1920">%TRUE if the property was found and copied to @value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1899">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1900">The name of the child property to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1901">The return location for the value</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_child_property_by_pspec"
- c:identifier="ges_timeline_element_get_child_property_by_pspec">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1773">Gets the property of a child of the element. Specifically, the property
-corresponding to the @pspec used in
-ges_timeline_element_add_child_property() is copied into @value.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="359"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1775">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="pspec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1776">The specification of a registered child property to get</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1777">The return location for the value</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_child_property_valist"
- c:identifier="ges_timeline_element_get_child_property_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2080">Gets several of the children properties of the element. See
-ges_timeline_element_get_child_property().</doc>
- <source-position filename="ges/ges-timeline-element.h" line="362"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2082">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="first_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2083">The name of the first child property to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2084">The return location for the first property, followed
-optionally by more name/return location pairs, followed by %NULL</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_duration"
- c:identifier="ges_timeline_element_get_duration">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1329">Gets the #GESTimelineElement:duration for the element.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="320"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1335">The duration of @self (in nanoseconds).</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1331">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_inpoint"
- c:identifier="ges_timeline_element_get_inpoint">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1313">Gets the #GESTimelineElement:in-point for the element.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="318"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1319">The in-point of @self (in nanoseconds).</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1315">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_layer_priority"
- c:identifier="ges_timeline_element_get_layer_priority"
- version="1.16">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2327">Gets the priority of the layer the element is in. A #GESGroup may span
-several layers, so this would return the highest priority (numerically,
-the smallest) amongst them.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="411"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2335">The priority of the layer @self is in, or
-#GES_TIMELINE_ELEMENT_NO_LAYER_PRIORITY if @self does not exist in a
-layer.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2329">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_max_duration"
- c:identifier="ges_timeline_element_get_max_duration">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1345">Gets the #GESTimelineElement:max-duration for the element.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="322"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1351">The max-duration of @self (in nanoseconds).</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1347">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_name" c:identifier="ges_timeline_element_get_name">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1653">Gets the #GESTimelineElement:name for the element.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="346"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1659">The name of @self.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1655">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_natural_framerate"
- c:identifier="ges_timeline_element_get_natural_framerate"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2453">Get the "natural" framerate of @self. This is to say, for example
-for a #GESVideoUriSource the framerate of the source.
-
-Note that a #GESAudioSource may also have a natural framerate if it derives
-from the same #GESSourceClip asset as a #GESVideoSource, and its value will
-be that of the video source. For example, if the uri of a #GESUriClip points
-to a file that contains both a video and audio stream, then the corresponding
-#GESAudioUriSource will share the natural framerate of the corresponding
-#GESVideoUriSource.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="406"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2469">Whether @self has a natural framerate or not, @framerate_n
-and @framerate_d will be set to, respectively, 0 and -1 if it is
-not the case.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2455">The #GESTimelineElement to get "natural" framerate from</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="framerate_n"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2456">The framerate numerator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="framerate_d"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2457">The framerate denominator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_parent" c:identifier="ges_timeline_element_get_parent">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="944">Gets the #GESTimelineElement:parent for the element.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="293"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="950">The parent of @self, or %NULL if
-@self has no parent.</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="946">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_priority"
- c:identifier="ges_timeline_element_get_priority">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1361">Gets the #GESTimelineElement:priority for the element.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="326"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1367">The priority of @self.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1363">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_start" c:identifier="ges_timeline_element_get_start">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1297">Gets the #GESTimelineElement:start for the element.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="316"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1303">The start of @self (in nanoseconds).</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1299">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_timeline"
- c:identifier="ges_timeline_element_get_timeline">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1034">Gets the #GESTimelineElement:timeline for the element.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="324"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1040">The timeline of @self, or %NULL
-if @self has no timeline.</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1036">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_toplevel_parent"
- c:identifier="ges_timeline_element_get_toplevel_parent">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1633">Gets the toplevel #GESTimelineElement:parent of the element.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="291"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1639">The toplevel parent of @self.</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1635">The #GESTimelineElement to get the toplevel parent from</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_track_types"
- c:identifier="ges_timeline_element_get_track_types"
- version="1.6.0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2250">Gets the track types that the element can interact with, i.e. the type
-of #GESTrack it can exist in, or will create #GESTrackElement-s for.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="404"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2257">The track types that @self supports.</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2252">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="list_children_properties"
- c:identifier="ges_timeline_element_list_children_properties">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2144">Get a list of children properties of the element, which is a list of
-all the specifications passed to
-ges_timeline_element_add_child_property().</doc>
- <source-position filename="ges/ges-timeline-element.h" line="351"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2154">An array of
-#GParamSpec corresponding to the child properties of @self, or %NULL if
-something went wrong.</doc>
- <array length="0" zero-terminated="0" c:type="GParamSpec**">
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2146">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="n_properties"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2147">The return location for the length of the
-returned array</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="lookup_child"
- c:identifier="ges_timeline_element_lookup_child">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1954">Looks up a child property of the element.
-
-@prop_name can either be in the format "prop-name" or
-"TypeName::prop-name", where "prop-name" is the name of the property
-to look up (as used in g_object_get()), and "TypeName" is the type name
-of the child (as returned by G_OBJECT_TYPE_NAME()). The latter format is
-useful when two children of different types share the same property
-name.
-
-The first child found with the given "prop-name" property that was
-registered with ges_timeline_element_add_child_property() (and of the
-type "TypeName", if it was given) will be passed to @child, and the
-registered specification of this property will be passed to @pspec.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="354"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1977">%TRUE if a child corresponding to the property was found, in
-which case @child and @pspec are set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1956">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="prop_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1957">The name of a child property</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="child"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1958">The return location for the
-found child</doc>
- <type name="GObject.Object" c:type="GObject**"/>
- </parameter>
- <parameter name="pspec"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1960">The return location for the
-specification of the child property</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec**"/>
- </parameter>
- </parameters>
- </method>
- <method name="paste"
- c:identifier="ges_timeline_element_paste"
- version="1.6.0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2271">Paste an element inside the same timeline and layer as @self. @self
-**must** be the return of ges_timeline_element_copy() with `deep=TRUE`,
-and it should not be changed before pasting.
-@self is not placed in the timeline, instead a new element is created,
-alike to the originally copied element. Note that the originally
-copied element must stay within the same timeline and layer, at both
-the point of copying and pasting.
-
-Pasting may fail if it would place the timeline in an unsupported
-configuration.
-
-After calling this function @element should not be used. In particular,
-@element can **not** be pasted again. Instead, you can copy the
-returned element and paste that copy (although, this is only possible
-if the paste was successful).
-
-See also ges_timeline_paste_element().</doc>
- <source-position filename="ges/ges-timeline-element.h" line="401"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2295">The newly created element, or
-%NULL if pasting fails.</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2273">The #GESTimelineElement to paste</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="paste_position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2274">The position in the timeline @element should be pasted
-to, i.e. the #GESTimelineElement:start value for the pasted element.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_child_property"
- c:identifier="ges_timeline_element_remove_child_property">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2208">Remove a child property from the element. @pspec should be a
-specification that was passed to
-ges_timeline_element_add_child_property(). The corresponding property
-will no longer be registered as a child property for the element.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="398"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2218">%TRUE if the property was successfully un-registered for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2210">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="pspec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2211">The specification for the property to remove</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- </parameters>
- </method>
- <method name="ripple" c:identifier="ges_timeline_element_ripple">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1418">Edits the start time of an element within its timeline in ripple mode.
-See ges_timeline_element_edit() with #GES_EDIT_MODE_RIPPLE and
-#GES_EDGE_NONE.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="328"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1427">%TRUE if the ripple edit of @self completed, %FALSE on
-failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1420">The #GESTimelineElement to ripple</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1421">The new start time of @self in ripple mode</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="ripple_end" c:identifier="ges_timeline_element_ripple_end">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1448">Edits the end time of an element within its timeline in ripple mode.
-See ges_timeline_element_edit() with #GES_EDIT_MODE_RIPPLE and
-#GES_EDGE_END.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="331"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1457">%TRUE if the ripple edit of @self completed, %FALSE on
-failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1450">The #GESTimelineElement to ripple</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1451">The new end time of @self in ripple mode</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="roll_end" c:identifier="ges_timeline_element_roll_end">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1503">Edits the end time of an element within its timeline in roll mode.
-See ges_timeline_element_edit() with #GES_EDIT_MODE_ROLL and
-#GES_EDGE_END.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="337"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1512">%TRUE if the roll edit of @self completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1505">The #GESTimelineElement to roll</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1506">The new end time of @self in roll mode</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="roll_start" c:identifier="ges_timeline_element_roll_start">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1476">Edits the start time of an element within its timeline in roll mode.
-See ges_timeline_element_edit() with #GES_EDIT_MODE_ROLL and
-#GES_EDGE_START.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="334"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1485">%TRUE if the roll edit of @self completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1478">The #GESTimelineElement to roll</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1479">The new start time of @self in roll mode</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_child_properties"
- c:identifier="ges_timeline_element_set_child_properties"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2056">Sets several of the children properties of the element. See
-ges_timeline_element_set_child_property().</doc>
- <source-position filename="ges/ges-timeline-element.h" line="377"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2058">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="first_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2059">The name of the first child property to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2060">The value for the first property, followed optionally by more
-name/value pairs, followed by %NULL</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="set_child_property"
- c:identifier="ges_timeline_element_set_child_property">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1875">See ges_timeline_element_set_child_property_full(), which also gives an
-error.
-
-Note that ges_timeline_element_set_child_properties() may be more
-convenient for C programming.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="381"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1887">%TRUE if the property was found and set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1877">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1878">The name of the child property to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1879">The value to set the property to</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_child_property_by_pspec"
- c:identifier="ges_timeline_element_set_child_property_by_pspec">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1807">Sets the property of a child of the element. Specifically, the property
-corresponding to the @pspec used in
-ges_timeline_element_add_child_property() is set to @value.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="373"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1809">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="pspec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1810">The specification of a registered child property to set</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1811">The value to set the property to</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_child_property_full"
- c:identifier="ges_timeline_element_set_child_property_full"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1827">Sets the property of a child of the element.
-
-@property_name can either be in the format "prop-name" or
-"TypeName::prop-name", where "prop-name" is the name of the property
-to set (as used in g_object_set()), and "TypeName" is the type name of
-the child (as returned by G_OBJECT_TYPE_NAME()). The latter format is
-useful when two children of different types share the same property
-name.
-
-The first child found with the given "prop-name" property that was
-registered with ges_timeline_element_add_child_property() (and of the
-type "TypeName", if it was given) will have the corresponding
-property set to @value. Other children that may have also matched the
-property name (and type name) are left unchanged!</doc>
- <source-position filename="ges/ges-timeline-element.h" line="385"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1849">%TRUE if the property was found and set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1829">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1830">The name of the child property to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1831">The value to set the property to</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_child_property_valist"
- c:identifier="ges_timeline_element_set_child_property_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1993">Sets several of the children properties of the element. See
-ges_timeline_element_set_child_property().</doc>
- <source-position filename="ges/ges-timeline-element.h" line="369"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1995">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="first_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1996">The name of the first child property to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1997">The value for the first property, followed optionally by more
-name/value pairs, followed by %NULL</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_duration"
- c:identifier="ges_timeline_element_set_duration">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1240">Sets #GESTimelineElement:duration for the element.
-
-Whilst the element is part of a #GESTimeline, this is the same as
-editing the element with ges_timeline_element_edit() under
-#GES_EDIT_MODE_TRIM with #GES_EDGE_END. In particular, the
-#GESTimelineElement:duration of the element may be snapped to a
-different timeline time difference from the one given. In addition,
-setting may fail if it would place the timeline in an unsupported
-configuration, or the element does not have enough internal content to
-last the desired duration.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="307"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1256">%TRUE if @duration could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1242">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1243">The desired duration in its timeline</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_inpoint"
- c:identifier="ges_timeline_element_set_inpoint">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1132">Sets #GESTimelineElement:in-point for the element. If the new in-point
-is above the current #GESTimelineElement:max-duration of the element,
-this method will fail.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="304"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1141">%TRUE if @inpoint could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1134">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="inpoint" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1135">The in-point, in internal time coordinates</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_max_duration"
- c:identifier="ges_timeline_element_set_max_duration">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1188">Sets #GESTimelineElement:max-duration for the element. If the new
-maximum duration is below the current #GESTimelineElement:in-point of
-the element, this method will fail.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="310"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1197">%TRUE if @maxduration could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1190">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="maxduration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1191">The maximum duration, in internal time coordinates</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_name" c:identifier="ges_timeline_element_set_name">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1669">Sets the #GESTimelineElement:name for the element. If %NULL is given
-for @name, then the library will instead generate a new name based on
-the type name of the element, such as the name "uriclip3" for a
-#GESUriClip, and will set that name instead.
-
-If @self already has a #GESTimelineElement:timeline, you should not
-call this function with @name set to %NULL.
-
-You should ensure that, within each #GESTimeline, every element has a
-unique name. If you call this function with @name as %NULL, then
-the library should ensure that the set generated name is unique from
-previously **generated** names. However, if you choose a @name that
-interferes with the naming conventions of the library, the library will
-attempt to ensure that the generated names will not conflict with the
-chosen name, which may lead to a different name being set instead, but
-the uniqueness between generated and user-chosen names is not
-guaranteed.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="348"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1692">%TRUE if @name or a generated name for @self could be set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1671">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1672">The name @self should take</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_parent" c:identifier="ges_timeline_element_set_parent">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="878">Sets the #GESTimelineElement:parent for the element.
-
-This is used internally and you should normally not call this. A
-#GESContainer will set the #GESTimelineElement:parent of its children
-in ges_container_add() and ges_container_remove().
-
-Note, if @parent is not %NULL, @self must not already have a parent
-set. Therefore, if you wish to switch parents, you will need to call
-this function twice: first to set the parent to %NULL, and then to the
-new parent.
-
-If @parent is not %NULL, you must ensure it already has a
-(non-floating) reference to @self before calling this.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="295"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="897">%TRUE if @parent could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="880">A #GESTimelineElement
-@parent (nullable): New parent of @self</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="parent" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_priority"
- c:identifier="ges_timeline_element_set_priority"
- deprecated="1"
- deprecated-version="1.10">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1377">Sets the priority of the element within the containing layer.</doc>
- <doc-deprecated xml:space="preserve">All priority management is done by GES itself now.
-To set #GESEffect priorities #ges_clip_set_top_effect_index should
-be used.</doc-deprecated>
- <source-position filename="ges/ges-timeline-element.h" line="313"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1388">%TRUE if @priority could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1379">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1380">The priority</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_start" c:identifier="ges_timeline_element_set_start">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1057">Sets #GESTimelineElement:start for the element. If the element has a
-parent, this will also move its siblings with the same shift.
-
-Whilst the element is part of a #GESTimeline, this is the same as
-editing the element with ges_timeline_element_edit() under
-#GES_EDIT_MODE_NORMAL with #GES_EDGE_NONE. In particular, the
-#GESTimelineElement:start of the element may be snapped to a different
-timeline time from the one given. In addition, setting may fail if it
-would place the timeline in an unsupported configuration.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="301"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1072">%TRUE if @start could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1059">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1060">The desired start position of the element in its timeline</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_timeline"
- c:identifier="ges_timeline_element_set_timeline">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="967">Sets the #GESTimelineElement:timeline of the element.
-
-This is used internally and you should normally not call this. A
-#GESClip will have its #GESTimelineElement:timeline set through its
-#GESLayer. A #GESTrack will similarly take care of setting the
-#GESTimelineElement:timeline of its #GESTrackElement-s. A #GESGroup
-will adopt the same #GESTimelineElement:timeline as its children.
-
-If @timeline is %NULL, this will stop its current
-#GESTimelineElement:timeline from tracking it, otherwise @timeline will
-start tracking @self. Note, in the latter case, @self must not already
-have a timeline set. Therefore, if you wish to switch timelines, you
-will need to call this function twice: first to set the timeline to
-%NULL, and then to the new timeline.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="298"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="987">%TRUE if @timeline could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="969">A #GESTimelineElement
-@timeline (nullable): The #GESTimeline @self should be in</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- </parameters>
- </method>
- <method name="trim" c:identifier="ges_timeline_element_trim">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1530">Edits the start time of an element within its timeline in trim mode.
-See ges_timeline_element_edit() with #GES_EDIT_MODE_TRIM and
-#GES_EDGE_START.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="340"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1539">%TRUE if the trim edit of @self completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1532">The #GESTimelineElement to trim</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1533">The new start time of @self in trim mode</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <property name="duration" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="490">The duration that the element is in effect for in the timeline (a
-time difference in nanoseconds using the time coordinates of the
-timeline). For example, for a source element, this would determine
-for how long it should output its internal content for. For an
-operation element, this would determine for how long its effect
-should be applied to any source content.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="in-point" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="469">The initial offset to use internally when outputting content (in
-nanoseconds, but in the time coordinates of the internal content).
-
-For example, for a #GESVideoUriSource that references some media
-file, the "internal content" is the media file data, and the
-in-point would correspond to some timestamp in the media file.
-When playing the timeline, and when the element is first reached at
-timeline-time #GESTimelineElement:start, it will begin outputting the
-data from the timestamp in-point **onwards**, until it reaches the
-end of its #GESTimelineElement:duration in the timeline.
-
-For elements that have no internal content, this should be kept
-as 0.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="max-duration"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="505">The full duration of internal content that is available (a time
-difference in nanoseconds using the time coordinates of the internal
-content).
-
-This will act as a cap on the #GESTimelineElement:in-point of the
-element (which is in the same time coordinates), and will sometimes
-be used to limit the #GESTimelineElement:duration of the element in
-the timeline.
-
-For example, for a #GESVideoUriSource that references some media
-file, this would be the length of the media file.
-
-For elements that have no internal content, or whose content is
-indefinite, this should be kept as #GST_CLOCK_TIME_NONE.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="name"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="538">The name of the element. This should be unique within its timeline.</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="parent" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="435">The parent container of the element.</doc>
- <type name="TimelineElement"/>
- </property>
- <property name="priority"
- deprecated="1"
- deprecated-version="1.10"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="528">The priority of the element.</doc>
- <doc-deprecated xml:space="preserve">Priority management is now done by GES itself.</doc-deprecated>
- <type name="guint" c:type="guint"/>
- </property>
- <property name="serialize" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="547">Whether the element should be serialized.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="start" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="455">The starting position of the element in the timeline (in nanoseconds
-and in the time coordinates of the timeline). For example, for a
-source element, this would determine the time at which it should
-start outputting its internal content. For an operation element, this
-would determine the time at which it should start applying its effect
-to any source content.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="timeline" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="445">The timeline that the element lies within.</doc>
- <type name="Timeline"/>
- </property>
- <field name="parent_instance">
- <type name="GObject.InitiallyUnowned" c:type="GInitiallyUnowned"/>
- </field>
- <field name="parent">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="122">The #GESTimelineElement:parent of the element</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </field>
- <field name="asset">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="123">The #GESAsset from which the object has been extracted</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </field>
- <field name="start">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="124">The #GESTimelineElement:start of the element</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="inpoint">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="125">The #GESTimelineElement:in-point of the element</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="duration">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="126">The #GESTimelineElement:duration of the element</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="maxduration">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="127">The #GESTimelineElement:max-duration of the element</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="priority">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="128">The #GESTimelineElement:priority of the element</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="timeline">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="130">The #GESTimelineElement:timeline of the element</doc>
- <type name="Timeline" c:type="GESTimeline*"/>
- </field>
- <field name="name">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="129">The #GESTimelineElement:name of the element</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TimelineElementPrivate"
- c:type="GESTimelineElementPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="child-property-added" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="575">Emitted when the element has a new child property registered. See
-ges_timeline_element_add_child_property().
-
-Note that some GES elements will be automatically created with
-pre-registered children properties. You can use
-ges_timeline_element_list_children_properties() to list these.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="prop_object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="578">The child whose property has been registered</doc>
- <type name="GObject.Object"/>
- </parameter>
- <parameter name="prop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="579">The specification for the property that has been registered</doc>
- <type name="GObject.ParamSpec"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="child-property-removed" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="593">Emitted when the element has a child property unregistered. See
-ges_timeline_element_remove_child_property().</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="prop_object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="596">The child whose property has been unregistered</doc>
- <type name="GObject.Object"/>
- </parameter>
- <parameter name="prop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="597">The specification for the property that has been unregistered</doc>
- <type name="GObject.ParamSpec"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="deep-notify"
- when="first"
- no-recurse="1"
- detailed="1"
- no-hooks="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="558">Emitted when a child of the element has one of its registered
-properties set. See ges_timeline_element_add_child_property().
-Note that unlike #GObject::notify, a child property name can not be
-used as a signal detail.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="prop_object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="561">The child whose property has been set</doc>
- <type name="GObject.Object"/>
- </parameter>
- <parameter name="prop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="562">The specification for the property that been set</doc>
- <type name="GObject.ParamSpec"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="TimelineElementClass"
- c:type="GESTimelineElementClass"
- glib:is-gtype-struct-for="TimelineElement">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.h"
- line="159">The #GESTimelineElement base class. Subclasses should override at least
-@set_start @set_inpoint @set_duration @ripple @ripple_end @roll_start
-@roll_end and @trim.
-
-Vmethods in subclasses should apply all the operation they need to but
-the real method implementation is in charge of setting the proper field,
-and emitting the notify signal.</doc>
- <source-position filename="ges/ges-timeline-element.h" line="288"/>
- <field name="parent_class">
- <type name="GObject.InitiallyUnownedClass"
- c:type="GInitiallyUnownedClass"/>
- </field>
- <field name="set_parent">
- <callback name="set_parent">
- <source-position filename="ges/ges-timeline-element.h" line="249"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="897">%TRUE if @parent could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="880">A #GESTimelineElement
-@parent (nullable): New parent of @self</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="parent" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_start">
- <callback name="set_start">
- <source-position filename="ges/ges-timeline-element.h" line="250"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1072">%TRUE if @start could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1059">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1060">The desired start position of the element in its timeline</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_inpoint">
- <callback name="set_inpoint">
- <source-position filename="ges/ges-timeline-element.h" line="251"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1141">%TRUE if @inpoint could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1134">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="inpoint" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1135">The in-point, in internal time coordinates</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_duration">
- <callback name="set_duration">
- <source-position filename="ges/ges-timeline-element.h" line="252"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1256">%TRUE if @duration could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1242">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1243">The desired duration in its timeline</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_max_duration">
- <callback name="set_max_duration">
- <source-position filename="ges/ges-timeline-element.h" line="253"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1197">%TRUE if @maxduration could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1190">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="maxduration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1191">The maximum duration, in internal time coordinates</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_priority">
- <callback name="set_priority">
- <source-position filename="ges/ges-timeline-element.h" line="254"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1388">%TRUE if @priority could be set for @self.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1379">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1380">The priority</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="ripple">
- <callback name="ripple">
- <source-position filename="ges/ges-timeline-element.h" line="256"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1427">%TRUE if the ripple edit of @self completed, %FALSE on
-failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1420">The #GESTimelineElement to ripple</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1421">The new start time of @self in ripple mode</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="ripple_end">
- <callback name="ripple_end">
- <source-position filename="ges/ges-timeline-element.h" line="257"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1457">%TRUE if the ripple edit of @self completed, %FALSE on
-failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1450">The #GESTimelineElement to ripple</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1451">The new end time of @self in ripple mode</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="roll_start">
- <callback name="roll_start">
- <source-position filename="ges/ges-timeline-element.h" line="258"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1485">%TRUE if the roll edit of @self completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1478">The #GESTimelineElement to roll</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1479">The new start time of @self in roll mode</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="roll_end">
- <callback name="roll_end">
- <source-position filename="ges/ges-timeline-element.h" line="259"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1512">%TRUE if the roll edit of @self completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1505">The #GESTimelineElement to roll</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1506">The new end time of @self in roll mode</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="trim">
- <callback name="trim">
- <source-position filename="ges/ges-timeline-element.h" line="260"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1539">%TRUE if the trim edit of @self completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1532">The #GESTimelineElement to trim</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1533">The new start time of @self in trim mode</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="deep_copy">
- <callback name="deep_copy">
- <source-position filename="ges/ges-timeline-element.h" line="261"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="copy" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="paste" introspectable="0">
- <callback name="paste" introspectable="0">
- <source-position filename="ges/ges-timeline-element.h" line="263"/>
- <return-value>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="ref_element" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="paste_position" transfer-ownership="none">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="list_children_properties" introspectable="0">
- <callback name="list_children_properties" introspectable="0">
- <source-position filename="ges/ges-timeline-element.h" line="267"/>
- <return-value>
- <type name="GObject.ParamSpec" c:type="GParamSpec**"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="n_properties" transfer-ownership="none">
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="lookup_child">
- <callback name="lookup_child">
- <source-position filename="ges/ges-timeline-element.h" line="268"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1977">%TRUE if a child corresponding to the property was found, in
-which case @child and @pspec are set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1956">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="prop_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1957">The name of a child property</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="child"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1958">The return location for the
-found child</doc>
- <type name="GObject.Object" c:type="GObject**"/>
- </parameter>
- <parameter name="pspec"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="1960">The return location for the
-specification of the child property</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_track_types">
- <callback name="get_track_types">
- <source-position filename="ges/ges-timeline-element.h" line="270"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2257">The track types that @self supports.</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2252">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_child_property">
- <callback name="set_child_property">
- <source-position filename="ges/ges-timeline-element.h" line="271"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="child" transfer-ownership="none">
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="pspec" transfer-ownership="none">
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_layer_priority">
- <callback name="get_layer_priority">
- <source-position filename="ges/ges-timeline-element.h" line="276"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2335">The priority of the layer @self is in, or
-#GES_TIMELINE_ELEMENT_NO_LAYER_PRIORITY if @self does not exist in a
-layer.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2329">A #GESTimelineElement</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_natural_framerate">
- <callback name="get_natural_framerate">
- <source-position filename="ges/ges-timeline-element.h" line="279"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2469">Whether @self has a natural framerate or not, @framerate_n
-and @framerate_d will be set to, respectively, 0 and -1 if it is
-not the case.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2455">The #GESTimelineElement to get "natural" framerate from</doc>
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="framerate_n"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2456">The framerate numerator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="framerate_d"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-timeline-element.c"
- line="2457">The framerate denominator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_child_property_full">
- <callback name="set_child_property_full" throws="1">
- <source-position filename="ges/ges-timeline-element.h" line="281"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="TimelineElement" c:type="GESTimelineElement*"/>
- </parameter>
- <parameter name="child" transfer-ownership="none">
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="pspec" transfer-ownership="none">
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="14">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="TimelineElementPrivate"
- c:type="GESTimelineElementPrivate"
- disguised="1">
- <source-position filename="ges/ges-timeline-element.h" line="30"/>
- </record>
- <record name="TimelinePrivate" c:type="GESTimelinePrivate" disguised="1">
- <source-position filename="ges/ges-timeline.h" line="31"/>
- </record>
- <class name="TitleClip"
- c:symbol-prefix="title_clip"
- c:type="GESTitleClip"
- parent="SourceClip"
- glib:type-name="GESTitleClip"
- glib:get-type="ges_title_clip_get_type"
- glib:type-struct="TitleClipClass">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="21">Renders the given text in the specified font, at specified position, and
-with the specified background pattern.</doc>
- <source-position filename="ges/ges-title-clip.h" line="55"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new" c:identifier="ges_title_clip_new">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="683">Creates a new #GESTitleClip</doc>
- <source-position filename="ges/ges-title-clip.h" line="106"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="688">The newly created #GESTitleClip,
-or %NULL if there was an error.</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </return-value>
- </constructor>
- <method name="get_background_color"
- c:identifier="ges_title_clip_get_background_color"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="573">Get the background used by @self.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="94"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="579">The color used by @self.</doc>
- <type name="guint32" c:type="const guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="575">a #GESTitleClip</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_font_desc"
- c:identifier="ges_title_clip_get_font_desc"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="485">Get the pango font description used by @self.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="82"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="491">The pango font description used by @self.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="487">a #GESTitleClip</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_halignment"
- c:identifier="ges_title_clip_get_halignment"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="507">Get the horizontal aligment used by @self.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="88"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="513">The horizontal aligment used by @self.</doc>
- <type name="TextHAlign" c:type="GESTextHAlign"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="509">a #GESTitleClip</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_text"
- c:identifier="ges_title_clip_get_text"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="463">Get the text currently set on @self.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="103"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="469">The text currently set on @self.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="465">a #GESTitleClip</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_text_color"
- c:identifier="ges_title_clip_get_text_color"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="551">Get the color used by @self.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="91"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="557">The color used by @self.</doc>
- <type name="guint32" c:type="const guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="553">a #GESTitleClip</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_valignment"
- c:identifier="ges_title_clip_get_valignment"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="529">Get the vertical aligment used by @self.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="85"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="535">The vertical aligment used by @self.</doc>
- <type name="TextVAlign" c:type="GESTextVAlign"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="531">a #GESTitleClip</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_xpos"
- c:identifier="ges_title_clip_get_xpos"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="595">Get the horizontal position used by @self.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="97"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="601">The horizontal position used by @self.</doc>
- <type name="gdouble" c:type="const gdouble"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="597">a #GESTitleClip</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_ypos"
- c:identifier="ges_title_clip_get_ypos"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="617">Get the vertical position used by @self.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_get_children_property instead</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="100"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="623">The vertical position used by @self.</doc>
- <type name="gdouble" c:type="const gdouble"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="619">a #GESTitleClip</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_background"
- c:identifier="ges_title_clip_set_background"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="394">Sets the background of the text.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="73"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="396">the #GESTitleClip* to set</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- <parameter name="background" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="397">The color @self is being set to</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_color"
- c:identifier="ges_title_clip_set_color"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="372">Sets the color of the text.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="70"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="374">the #GESTitleClip* to set</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- <parameter name="color" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="375">The color @self is being set to</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_font_desc"
- c:identifier="ges_title_clip_set_font_desc"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="303">Sets the pango font description of the text.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="61"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="305">the #GESTitleClip*</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- <parameter name="font_desc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="306">the pango font description</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_halignment"
- c:identifier="ges_title_clip_set_halignment"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="326">Sets the horizontal aligment of the text.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="67"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="328">the #GESTitleClip* to set horizontal alignement of text on</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- <parameter name="halign" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="329">#GESTextHAlign</doc>
- <type name="TextHAlign" c:type="GESTextHAlign"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_text"
- c:identifier="ges_title_clip_set_text"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="280">Sets the text this clip will render.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="58"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="282">the #GESTitleClip* to set text on</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- <parameter name="text" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="283">the text to render. an internal copy of this text will be
-made.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_valignment"
- c:identifier="ges_title_clip_set_valignment"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="349">Sets the vertical aligment of the text.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="64"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="351">the #GESTitleClip* to set vertical alignement of text on</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- <parameter name="valign" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="352">#GESTextVAlign</doc>
- <type name="TextVAlign" c:type="GESTextVAlign"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_xpos"
- c:identifier="ges_title_clip_set_xpos"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="417">Sets the horizontal position of the text.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="76"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="419">the #GESTitleClip* to set</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="420">The horizontal position @self is being set to</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_ypos"
- c:identifier="ges_title_clip_set_ypos"
- deprecated="1"
- deprecated-version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="440">Sets the vertical position of the text.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <source-position filename="ges/ges-title-clip.h" line="79"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="442">the #GESTitleClip* to set</doc>
- <type name="TitleClip" c:type="GESTitleClip*"/>
- </instance-parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="443">The vertical position @self is being set to</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <property name="background"
- deprecated="1"
- deprecated-version="1.6"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="225">The background of the text</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties or
-#ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <type name="guint" c:type="guint"/>
- </property>
- <property name="color"
- deprecated="1"
- deprecated-version="1.6"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="210">The color of the text</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties or
-#ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <type name="guint" c:type="guint"/>
- </property>
- <property name="font-desc"
- deprecated="1"
- deprecated-version="1.6"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="157">Pango font description string</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties or
-#ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="halignment"
- deprecated="1"
- deprecated-version="1.6"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="189">Horizontal alignment of the text</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties or
-#ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <type name="TextHAlign"/>
- </property>
- <property name="text"
- deprecated="1"
- deprecated-version="1.6"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="143">The text to diplay</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties or
-#ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="valignment"
- deprecated="1"
- deprecated-version="1.6"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="174">Vertical alignent of the text</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties or
-#ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <type name="TextVAlign"/>
- </property>
- <property name="xpos"
- deprecated="1"
- deprecated-version="1.6"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="240">The horizontal position of the text</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties or
-#ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <type name="gdouble" c:type="gdouble"/>
- </property>
- <property name="ypos"
- deprecated="1"
- deprecated-version="1.6"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-clip.c"
- line="255">The vertical position of the text</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_children_properties or
-#ges_timeline_element_get_children_properties instead.
-See #GESTitleSource for more information about exposed properties</doc-deprecated>
- <type name="gdouble" c:type="gdouble"/>
- </property>
- <field name="parent">
- <type name="SourceClip" c:type="GESSourceClip"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TitleClipPrivate" c:type="GESTitleClipPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TitleClipClass"
- c:type="GESTitleClipClass"
- glib:is-gtype-struct-for="TitleClip">
- <source-position filename="ges/ges-title-clip.h" line="55"/>
- <field name="parent_class" readable="0" private="1">
- <type name="SourceClipClass" c:type="GESSourceClipClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="TitleClipPrivate" c:type="GESTitleClipPrivate" disguised="1">
- <source-position filename="ges/ges-title-clip.h" line="31"/>
- </record>
- <class name="TitleSource"
- c:symbol-prefix="title_source"
- c:type="GESTitleSource"
- parent="VideoSource"
- glib:type-name="GESTitleSource"
- glib:get-type="ges_title_source_get_type"
- glib:type-struct="TitleSourceClass">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="21">#GESTitleSource is a GESTimelineElement that implements the notion
-of titles in GES.</doc>
- <source-position filename="ges/ges-title-source.h" line="60"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <method name="get_background_color"
- c:identifier="ges_title_source_get_background_color">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="489">Get the background used by @source.</doc>
- <source-position filename="ges/ges-title-source.h" line="102"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="495">The background used by @source.</doc>
- <type name="guint32" c:type="const guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="491">a #GESTitleSource</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_font_desc"
- c:identifier="ges_title_source_get_font_desc"
- deprecated="1"
- deprecated-version="1.16">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="409">Get the pango font description used by @source.</doc>
- <doc-deprecated xml:space="preserve">Use ges_timeline_element_get_child_property instead
-(this actually returns a newly allocated string)</doc-deprecated>
- <source-position filename="ges/ges-title-source.h" line="94"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="415">The pango font description used by this
-@source.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="411">a #GESTitleSource</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_halignment"
- c:identifier="ges_title_source_get_halignment">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="432">Get the horizontal aligment used by @source.</doc>
- <source-position filename="ges/ges-title-source.h" line="96"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="438">The horizontal aligment used by @source.</doc>
- <type name="TextHAlign" c:type="GESTextHAlign"/>
- </return-value>
- <parameters>
- <instance-parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="434">a #GESTitleSource</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_text"
- c:identifier="ges_title_source_get_text"
- deprecated="1"
- deprecated-version="1.16">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="387">Get the text currently set on the @source.</doc>
- <doc-deprecated xml:space="preserve">Use ges_timeline_element_get_child_property instead
-(this actually returns a newly allocated string)</doc-deprecated>
- <source-position filename="ges/ges-title-source.h" line="92"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="393">The text currently set on the @source.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="389">a #GESTitleSource</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_text_color"
- c:identifier="ges_title_source_get_text_color">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="470">Get the color used by @source.</doc>
- <source-position filename="ges/ges-title-source.h" line="100"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="476">The color used by @source.</doc>
- <type name="guint32" c:type="const guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="472">a #GESTitleSource</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_valignment"
- c:identifier="ges_title_source_get_valignment">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="451">Get the vertical aligment used by @source.</doc>
- <source-position filename="ges/ges-title-source.h" line="98"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="457">The vertical aligment used by @source.</doc>
- <type name="TextVAlign" c:type="GESTextVAlign"/>
- </return-value>
- <parameters>
- <instance-parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="453">a #GESTitleSource</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_xpos" c:identifier="ges_title_source_get_xpos">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="508">Get the horizontal position used by @source.</doc>
- <source-position filename="ges/ges-title-source.h" line="104"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="514">The horizontal position used by @source.</doc>
- <type name="gdouble" c:type="const gdouble"/>
- </return-value>
- <parameters>
- <instance-parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="510">a #GESTitleSource</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_ypos" c:identifier="ges_title_source_get_ypos">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="527">Get the vertical position used by @source.</doc>
- <source-position filename="ges/ges-title-source.h" line="106"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="533">The vertical position used by @source.</doc>
- <type name="gdouble" c:type="const gdouble"/>
- </return-value>
- <parameters>
- <instance-parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="529">a #GESTitleSource</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_background_color"
- c:identifier="ges_title_source_set_background_color">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="336">Sets the color of the background</doc>
- <source-position filename="ges/ges-title-source.h" line="82"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="338">the #GESTitleSource* to set</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- <parameter name="color" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="339">the color @self is being set to</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_font_desc"
- c:identifier="ges_title_source_set_font_desc">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="263">Set the pango font description this source will use to render
-the text.</doc>
- <source-position filename="ges/ges-title-source.h" line="67"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="265">the #GESTitleSource</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- <parameter name="font_desc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="266">the pango font description</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_halignment"
- c:identifier="ges_title_source_set_halignment">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="302">Sets the vertical aligment of the text.</doc>
- <source-position filename="ges/ges-title-source.h" line="71"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="304">the #GESTitleSource* to set text on</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- <parameter name="halign" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="305">#GESTextHAlign</doc>
- <type name="TextHAlign" c:type="GESTextHAlign"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_text"
- c:identifier="ges_title_source_set_text"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="238">Sets the text this track element will render.</doc>
- <doc-deprecated xml:space="preserve">use ges_track_element_get/set_children_properties on the
-GESTrackElement instead</doc-deprecated>
- <source-position filename="ges/ges-title-source.h" line="63"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="240">the #GESTitleSource* to set text on</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- <parameter name="text" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="241">the text to render. an internal copy of this text will be
-made.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_text_color"
- c:identifier="ges_title_source_set_text_color">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="319">Sets the color of the text.</doc>
- <source-position filename="ges/ges-title-source.h" line="79"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="321">the #GESTitleSource* to set</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- <parameter name="color" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="322">the color @self is being set to</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_valignment"
- c:identifier="ges_title_source_set_valignment">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="285">Sets the vertical aligment of the text.</doc>
- <source-position filename="ges/ges-title-source.h" line="75"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="287">the #GESTitleSource* to set text on</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- <parameter name="valign" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="288">#GESTextVAlign</doc>
- <type name="TextVAlign" c:type="GESTextVAlign"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_xpos" c:identifier="ges_title_source_set_xpos">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="353">Sets the horizontal position of the text.</doc>
- <source-position filename="ges/ges-title-source.h" line="85"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="355">the #GESTitleSource* to set</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="356">the horizontal position @self is being set to</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_ypos" c:identifier="ges_title_source_set_ypos">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="370">Sets the vertical position of the text.</doc>
- <source-position filename="ges/ges-title-source.h" line="88"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="372">the #GESTitleSource* to set</doc>
- <type name="TitleSource" c:type="GESTitleSource*"/>
- </instance-parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.c"
- line="373">the color @self is being set to</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <field name="parent">
- <type name="VideoSource" c:type="GESVideoSource"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TitleSourcePrivate" c:type="GESTitleSourcePrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TitleSourceClass"
- c:type="GESTitleSourceClass"
- glib:is-gtype-struct-for="TitleSource">
- <source-position filename="ges/ges-title-source.h" line="60"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="ges/ges-title-source.h"
- line="51">parent class</doc>
- <type name="VideoSourceClass" c:type="GESVideoSourceClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="TitleSourcePrivate"
- c:type="GESTitleSourcePrivate"
- disguised="1">
- <source-position filename="ges/ges-title-source.h" line="30"/>
- </record>
- <class name="Track"
- c:symbol-prefix="track"
- c:type="GESTrack"
- parent="Gst.Bin"
- glib:type-name="GESTrack"
- glib:get-type="ges_track_get_type"
- glib:type-struct="TrackClass">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="21">A #GESTrack acts an output source for a #GESTimeline. Each one
-essentially provides an additional #GstPad for the timeline, with
-#GESTrack:restriction-caps capabilities. Internally, a track
-wraps an #nlecomposition filtered by a #capsfilter.
-
-A track will contain a number of #GESTrackElement-s, and its role is
-to select and activate these elements according to their timings when
-the timeline in played. For example, a track would activate a
-#GESSource when its #GESTimelineElement:start is reached by outputting
-its data for its #GESTimelineElement:duration. Similarly, a
-#GESOperation would be activated by applying its effect to the source
-data, starting from its #GESTimelineElement:start time and lasting for
-its #GESTimelineElement:duration.
-
-For most users, it will usually be sufficient to add newly created
-tracks to a timeline, but never directly add an element to a track.
-Whenever a #GESClip is added to a timeline, the clip adds its
-elements to the timeline's tracks and assumes responsibility for
-updating them.</doc>
- <source-position filename="ges/ges-track.h" line="75"/>
- <implements name="MetaContainer"/>
- <implements name="Gst.ChildProxy"/>
- <constructor name="new" c:identifier="ges_track_new">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="845">Creates a new track with the given track-type and caps.
-
-If @type is #GES_TRACK_TYPE_VIDEO, and @caps is a subset of
-"video/x-raw(ANY)", then a #GESVideoTrack is created. This will
-automatically choose a gap creation method suitable for video data. You
-will likely want to set #GESTrack:restriction-caps separately. You may
-prefer to use the ges_video_track_new() method instead.
-
-If @type is #GES_TRACK_TYPE_AUDIO, and @caps is a subset of
-"audio/x-raw(ANY)", then a #GESAudioTrack is created. This will
-automatically choose a gap creation method suitable for audio data, and
-will set the #GESTrack:restriction-caps to the default for
-#GESAudioTrack. You may prefer to use the ges_audio_track_new() method
-instead.
-
-Otherwise, a plain #GESTrack is returned. You will likely want to set
-the #GESTrack:restriction-caps and call
-ges_track_set_create_element_for_gap_func() on the returned track.</doc>
- <source-position filename="ges/ges-track.h" line="120"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="869">A new track.</doc>
- <type name="Track" c:type="GESTrack*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="847">The #GESTrack:track-type for the track</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- <parameter name="caps" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="848">The #GESTrack:caps for the track</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </constructor>
- <virtual-method name="get_mixing_element" introspectable="0">
- <source-position filename="ges/ges-track.h" line="71"/>
- <return-value>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <method name="add_element" c:identifier="ges_track_add_element">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1229">See ges_track_add_element(), which also gives an error.</doc>
- <source-position filename="ges/ges-track.h" line="89"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1236">%TRUE if @object was successfully added to @track.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1231">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1232">The element to add</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_element_full"
- c:identifier="ges_track_add_element_full"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1137">Adds the given track element to the track, which takes ownership of the
-element.
-
-Note that this can fail if it would break a configuration rule of the
-track's #GESTimeline.
-
-Note that a #GESTrackElement can only be added to one track.</doc>
- <source-position filename="ges/ges-track.h" line="92"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1151">%TRUE if @object was successfully added to @track.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1139">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1140">The element to add</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="commit" c:identifier="ges_track_commit">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1363">Commits all the pending changes for the elements contained in the
-track.
-
-When changes are made to the timing or priority of elements within a
-track, they are not directly executed for the underlying
-#nlecomposition and its children. This method will finally execute
-these changes so they are reflected in the data output of the track.
-
-Any pending changes will be executed in the backend. The
-#GESTimeline::commited signal will be emitted once this has completed.
-
-Note that ges_timeline_commit() will call this method on all of its
-tracks, so you are unlikely to need to use this directly.</doc>
- <source-position filename="ges/ges-track.h" line="84"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1381">%TRUE if pending changes were committed, or %FALSE if nothing
-needed to be committed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1365">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_caps" c:identifier="ges_track_get_caps">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1312">Get the #GESTrack:caps of the track.</doc>
- <source-position filename="ges/ges-track.h" line="78"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1318">The caps of @track.</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1314">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_elements" c:identifier="ges_track_get_elements">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1244">Gets the track elements contained in the track. The returned list is
-sorted by the element's #GESTimelineElement:priority and
-#GESTimelineElement:start.</doc>
- <source-position filename="ges/ges-track.h" line="80"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1252">A list of
-all the #GESTrackElement-s in @track.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="TrackElement"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1246">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_mixing" c:identifier="ges_track_get_mixing">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1347">Gets the #GESTrack:mixing of the track.</doc>
- <source-position filename="ges/ges-track.h" line="109"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1353">Whether @track is mixing.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1349">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_restriction_caps"
- c:identifier="ges_track_get_restriction_caps"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1422">Gets the #GESTrack:restriction-caps of the track.</doc>
- <source-position filename="ges/ges-track.h" line="117"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1428">The restriction-caps of @track.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1424">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_timeline" c:identifier="ges_track_get_timeline">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1329">Get the timeline this track belongs to.</doc>
- <source-position filename="ges/ges-track.h" line="82"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1335">The timeline that @track belongs to, or %NULL if
-it does not belong to a timeline.</doc>
- <type name="Timeline" c:type="const GESTimeline*"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1331">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_element" c:identifier="ges_track_remove_element">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1297">See ges_track_remove_element_full(), which also returns an error.</doc>
- <source-position filename="ges/ges-track.h" line="96"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1304">%TRUE if @object was successfully removed from @track.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1299">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1300">The element to remove</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_element_full"
- c:identifier="ges_track_remove_element_full"
- version="1.18"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1270">Removes the given track element from the track, which revokes
-ownership of the element.</doc>
- <source-position filename="ges/ges-track.h" line="99"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1279">%TRUE if @object was successfully removed from @track.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1272">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1273">The element to remove</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_create_element_for_gap_func"
- c:identifier="ges_track_set_create_element_for_gap_func"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1396">Sets the function that will be used to create a #GstElement that can be
-used as a source to fill the gaps of the track. A gap is a timeline
-region where the track has no #GESTrackElement sources. Therefore, you
-are likely to want the #GstElement returned by the function to always
-produce 'empty' content, defined relative to the stream type, such as
-transparent frames for a video, or mute samples for audio.
-
-#GESAudioTrack and #GESVideoTrack objects are created with such a
-function already set appropriately.</doc>
- <source-position filename="ges/ges-track.h" line="103"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1398">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- <parameter name="func" transfer-ownership="none" scope="notified">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1399">The function to be used to create a source
-#GstElement that can fill gaps in @track</doc>
- <type name="CreateElementForGapFunc"
- c:type="GESCreateElementForGapFunc"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_mixing" c:identifier="ges_track_set_mixing">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1065">Sets the #GESTrack:mixing for the track.</doc>
- <source-position filename="ges/ges-track.h" line="106"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1067">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- <parameter name="mixing" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1068">Whether @track should be mixing</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_restriction_caps"
- c:identifier="ges_track_set_restriction_caps">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="981">Sets the #GESTrack:restriction-caps for the track.</doc>
- <source-position filename="ges/ges-track.h" line="111"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="983">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="984">The new restriction-caps for @track</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_timeline" c:identifier="ges_track_set_timeline">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="916">Informs the track that it belongs to the given timeline. Calling this
-does not actually add the track to the timeline. For that, you should
-use ges_timeline_add_track(), which will also take care of informing
-the track that it belongs to the timeline. As such, there is no need
-for you to call this method.</doc>
- <source-position filename="ges/ges-track.h" line="86"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="918">A #GESTrack
-@timeline (nullable): A #GESTimeline</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- <parameter name="timeline" transfer-ownership="none">
- <type name="Timeline" c:type="GESTimeline*"/>
- </parameter>
- </parameters>
- </method>
- <method name="update_restriction_caps"
- c:identifier="ges_track_update_restriction_caps">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1010">Updates the #GESTrack:restriction-caps of the track using the fields
-found in the given caps. Each of the #GstStructure-s in @caps is
-compared against the existing structure with the same index in the
-current #GESTrack:restriction-caps. If there is no corresponding
-existing structure at that index, then the new structure is simply
-copied to that index. Otherwise, any fields in the new structure are
-copied into the existing structure. This will replace existing values,
-and may introduce new ones, but any fields 'missing' in the new
-structure are left unchanged in the existing structure.
-
-For example, if the existing #GESTrack:restriction-caps are
-"video/x-raw, width=480, height=360", and the updating caps is
-"video/x-raw, format=I420, width=500; video/x-bayer, width=400", then
-the new #GESTrack:restriction-caps after calling this will be
-"video/x-raw, width=500, height=360, format=I420; video/x-bayer,
-width=400".</doc>
- <source-position filename="ges/ges-track.h" line="114"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1012">A #GESTrack</doc>
- <type name="Track" c:type="GESTrack*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="1013">The caps to update the restriction-caps with</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <property name="caps"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="671">The capabilities used to choose the output of the #GESTrack's
-elements. Internally, this is used to select output streams when
-several may be available, by determining whether its #GstPad is
-compatible (see #nlecomposition:caps for #nlecomposition). As such,
-this is used as a weaker indication of the desired output type of the
-track, **before** the #GESTrack:restriction-caps is applied.
-Therefore, this should be set to a *generic* superset of the
-#GESTrack:restriction-caps, such as "video/x-raw(ANY)". In addition,
-it should match with the track's #GESTrack:track-type.
-
-Note that when you set this property, the #GstCapsFeatures of all its
-#GstStructure-s will be automatically set to #GST_CAPS_FEATURES_ANY.
-
-Once a track has been added to a #GESTimeline, you should not change
-this.
-
-Default value: #GST_CAPS_ANY.</doc>
- <type name="Gst.Caps"/>
- </property>
- <property name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="718">Current duration of the track
-
-Default value: O</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="id"
- version="1.18"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="765">The #nlecomposition:id of the underlying #nlecomposition.</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="mixing"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="750">Whether the track should support the mixing of #GESLayer data, such
-as composing the video data of each layer (when part of the video
-data is transparent, the next layer will become visible) or adding
-together the audio data. As such, for audio and video tracks, you'll
-likely want to keep this set to %TRUE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="restriction-caps" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="698">The capabilities that specifies the final output format of the
-#GESTrack. For example, for a video track, it would specify the
-height, width, framerate and other properties of the stream.
-
-You may change this property after the track has been added to a
-#GESTimeline, but it must remain compatible with the track's
-#GESTrack:caps.
-
-Default value: #GST_CAPS_ANY.</doc>
- <type name="Gst.Caps"/>
- </property>
- <property name="track-type"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="733">The track type of the track. This controls the type of
-#GESTrackElement-s that can be added to the track. This should
-match with the track's #GESTrack:caps.
-
-Once a track has been added to a #GESTimeline, you should not change
-this.</doc>
- <type name="TrackType"/>
- </property>
- <field name="parent">
- <type name="Gst.Bin" c:type="GstBin"/>
- </field>
- <field name="type">
- <doc xml:space="preserve"
- filename="ges/ges-track.h"
- line="47">The #GESTrack:track-type of the track</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TrackPrivate" c:type="GESTrackPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="commited" when="last">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="805">This signal will be emitted once the changes initiated by
-ges_track_commit() have been executed in the backend. In particular,
-this will be emitted whenever the underlying #nlecomposition has been
-committed (see #nlecomposition::commited).</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="track-element-added" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="781">Will be emitted after a track element is added to the track.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="effect" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="784">The element that was added</doc>
- <type name="TrackElement"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="track-element-removed" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="793">Will be emitted after a track element is removed from the track.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="effect" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track.c"
- line="796">The element that was removed</doc>
- <type name="TrackElement"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="TrackClass"
- c:type="GESTrackClass"
- glib:is-gtype-struct-for="Track">
- <source-position filename="ges/ges-track.h" line="75"/>
- <field name="parent_class" readable="0" private="1">
- <type name="Gst.BinClass" c:type="GstBinClass"/>
- </field>
- <field name="get_mixing_element" introspectable="0">
- <callback name="get_mixing_element" introspectable="0">
- <source-position filename="ges/ges-track.h" line="71"/>
- <return-value>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="track" transfer-ownership="none">
- <type name="Track" c:type="GESTrack*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="TrackElement"
- c:symbol-prefix="track_element"
- c:type="GESTrackElement"
- parent="TimelineElement"
- abstract="1"
- glib:type-name="GESTrackElement"
- glib:get-type="ges_track_element_get_type"
- glib:type-struct="TrackElementClass">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="21">A #GESTrackElement is a #GESTimelineElement that specifically belongs
-to a single #GESTrack of its #GESTimelineElement:timeline. Its
-#GESTimelineElement:start and #GESTimelineElement:duration specify its
-temporal extent in the track. Specifically, a track element wraps some
-nleobject, such as an #nlesource or #nleoperation, which can be
-retrieved with ges_track_element_get_nleobject(), and its
-#GESTimelineElement:start, #GESTimelineElement:duration,
-#GESTimelineElement:in-point, #GESTimelineElement:priority and
-#GESTrackElement:active properties expose the corresponding nleobject
-properties. When a track element is added to a track, its nleobject is
-added to the corresponding #nlecomposition that the track wraps.
-
-Most users will not have to work directly with track elements since a
-#GESClip will automatically create track elements for its timeline's
-tracks and take responsibility for updating them. The only track
-elements that are not automatically created by clips, but a user is
-likely to want to create, are #GESEffect-s.
-
-## Control Bindings for Children Properties
-
-You can set up control bindings for a track element child property
-using ges_track_element_set_control_source(). A
-#GstTimedValueControlSource should specify the timed values using the
-internal source coordinates (see #GESTimelineElement). By default,
-these will be updated to lie between the #GESTimelineElement:in-point
-and out-point of the element. This can be switched off by setting
-#GESTrackElement:auto-clamp-control-sources to %FALSE.</doc>
- <source-position filename="ges/ges-track-element.h" line="119"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <virtual-method name="active_changed">
- <source-position filename="ges/ges-track-element.h" line="97"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="active" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="changed">
- <source-position filename="ges/ges-track-element.h" line="101"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="create_element" introspectable="0">
- <source-position filename="ges/ges-track-element.h" line="95"/>
- <return-value>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="create_gnl_object" introspectable="0">
- <source-position filename="ges/ges-track-element.h" line="94"/>
- <return-value>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="list_children_properties" introspectable="0">
- <source-position filename="ges/ges-track-element.h" line="105"/>
- <return-value>
- <type name="GObject.ParamSpec" c:type="GParamSpec**"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="n_properties" transfer-ownership="none">
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="lookup_child"
- invoker="lookup_child"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1358">Looks up which @element and @pspec would be effected by the given @name. If various
-contained elements have this property name you will get the first one, unless you
-specify the class name in @name.</doc>
- <doc-deprecated xml:space="preserve">Use #ges_timeline_element_lookup_child</doc-deprecated>
- <source-position filename="ges/ges-track-element.h" line="107"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1375">TRUE if @element and @pspec could be found. FALSE otherwise. In that
-case the values for @pspec and @element are not modified. Unref @element after
-usage.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1360">Object to lookup the property in</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="prop_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1361">Name of the property to look up. You can specify the name of the
- class as such: "ClassName::property-name", to guarantee that you get the
- proper GParamSpec in case various GstElement-s contain the same property
- name. If you don't do so, you will get the first element found, having
- this property and the and the corresponding GParamSpec.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="element"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1366">pointer to a #GstElement that
- takes the real object to set property on</doc>
- <type name="Gst.Element" c:type="GstElement**"/>
- </parameter>
- <parameter name="pspec"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1368">pointer to take the specification
- describing the property</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add_children_props"
- c:identifier="ges_track_element_add_children_props">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1115">Adds all the properties of a #GstElement that match the criteria as
-children properties of the track element. If the name of @element's
-#GstElementFactory is not in @blacklist, and the factory's
-#GST_ELEMENT_METADATA_KLASS contains at least one member of
-@wanted_categories (e.g. #GST_ELEMENT_FACTORY_KLASS_DECODER), then
-all the properties of @element that are also in @whitelist are added as
-child properties of @self using
-ges_timeline_element_add_child_property().
-
-This is intended to be used by subclasses when constructing.</doc>
- <source-position filename="ges/ges-track-element.h" line="178"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1117">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1118">The child object to retrieve properties from</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="wanted_categories"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1119">
-An array of element factory "klass" categories to whitelist, or %NULL
-to accept all categories</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- <parameter name="blacklist"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1122">A
-blacklist of element factory names, or %NULL to not blacklist any
-element factory</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- <parameter name="whitelist"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1125">A
-whitelist of element property names, or %NULL to whitelist all
-writeable properties</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="clamp_control_source"
- c:identifier="ges_track_element_clamp_control_source"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1981">Clamp the #GstTimedValueControlSource for the specified child property
-to lie between the #GESTimelineElement:in-point and out-point of the
-element. The out-point is the #GES_TIMELINE_ELEMENT_END of the element
-translated from the timeline coordinates to the internal source
-coordinates of the element.
-
-If the property does not have a #GstTimedValueControlSource set by
-ges_track_element_set_control_source(), nothing happens. Otherwise, if
-a timed value for the control source lies before the in-point of the
-element, or after its out-point, then it will be removed. At the
-in-point and out-point times, a new interpolated value will be placed.</doc>
- <source-position filename="ges/ges-track-element.h" line="165"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1983">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1984">The name of the child property to clamp the control
-source of</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="edit"
- c:identifier="ges_track_element_edit"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1769">Edits the element within its track.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_edit instead.</doc-deprecated>
- <source-position filename="ges/ges-track-element-deprecated.h"
- line="59"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1782">%TRUE if the edit of @object completed, %FALSE on failure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1771">The #GESTrackElement to edit</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="layers"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1772">A whitelist of layers
-where the edit can be performed, %NULL allows all layers in the
-timeline</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Layer"/>
- </type>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1775">The edit mode</doc>
- <type name="EditMode" c:type="GESEditMode"/>
- </parameter>
- <parameter name="edge" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1776">The edge of @object where the edit should occur</doc>
- <type name="Edge" c:type="GESEdge"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1777">The edit position: a new location for the edge of @object
-(in nanoseconds)</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_all_control_bindings"
- c:identifier="ges_track_element_get_all_control_bindings">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1231">Get all the control bindings that have been created for the children
-properties of the track element using
-ges_track_element_set_control_source(). The keys used in the returned
-hash table are the child property names that were passed to
-ges_track_element_set_control_source(), and their values are the
-corresponding created #GstControlBinding.</doc>
- <source-position filename="ges/ges-track-element.h" line="184"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1242">A
-hash table containing all child-property-name/control-binding pairs
-for @trackelement.</doc>
- <type name="GLib.HashTable" c:type="GHashTable*">
- <type name="utf8"/>
- <type name="Gst.ControlBinding"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="trackelement" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1233">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_auto_clamp_control_sources"
- c:identifier="ges_track_element_get_auto_clamp_control_sources"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="2058">Gets #GESTrackElement:auto-clamp-control-sources.</doc>
- <source-position filename="ges/ges-track-element.h" line="172"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="2064">Whether the control sources for the child properties of
-@object are automatically clamped.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="2060">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_child_properties"
- c:identifier="ges_track_element_get_child_properties"
- introspectable="0"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1505">Gets properties of a child of @object.</doc>
- <doc-deprecated xml:space="preserve">Use #ges_timeline_element_get_child_properties</doc-deprecated>
- <source-position filename="ges/ges-track-element-deprecated.h"
- line="25"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1507">The origin #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="first_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1508">The name of the first property to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1509">return location for the first property, followed optionally by more
-name/return location pairs, followed by NULL</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="get_child_property"
- c:identifier="ges_track_element_get_child_property"
- introspectable="0"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1572">In general, a copy is made of the property contents and
-the caller is responsible for freeing the memory by calling
-g_value_unset().
-
-Gets a property of a GstElement contained in @object.
-
-Note that #ges_track_element_get_child_property is really
-intended for language bindings, #ges_track_element_get_child_properties
-is much more convenient for C programming.</doc>
- <doc-deprecated xml:space="preserve">Use #ges_timeline_element_get_child_property</doc-deprecated>
- <source-position filename="ges/ges-track-element-deprecated.h"
- line="53"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1589">%TRUE if the property was found, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1574">The origin #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1575">The name of the property</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1576">return location for the property value, it will
-be initialized if it is initialized with 0</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_child_property_by_pspec"
- c:identifier="ges_track_element_get_child_property_by_pspec"
- introspectable="0"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1530">Gets a property of a child of @object.</doc>
- <doc-deprecated xml:space="preserve">Use #ges_timeline_element_get_child_property_by_pspec</doc-deprecated>
- <source-position filename="ges/ges-track-element.h" line="154"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1532">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="pspec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1533">The #GParamSpec that specifies the property you want to get</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1534">return location for the value</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_child_property_valist"
- c:identifier="ges_track_element_get_child_property_valist"
- introspectable="0"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1461">Gets a property of a child of @object. If there are various child elements
-that have the same property name, you can distinguish them using the following
-syntax: 'ClasseName::property_name' as property name. If you don't, the
-corresponding property of the first element found will be set.</doc>
- <doc-deprecated xml:space="preserve">Use #ges_timeline_element_get_child_property_valist</doc-deprecated>
- <source-position filename="ges/ges-track-element-deprecated.h"
- line="20"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1463">The #GESTrackElement parent object</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="first_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1464">The name of the first property to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1465">Value for the first property, followed optionally by more
-name/return location pairs, followed by NULL</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_control_binding"
- c:identifier="ges_track_element_get_control_binding">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1948">Gets the control binding that was created for the specified child
-property of the track element using
-ges_track_element_set_control_source(). The given @property_name must
-be the same name of the child property that was passed to
-ges_track_element_set_control_source().</doc>
- <source-position filename="ges/ges-track-element.h" line="175"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1960">The control binding that was
-created for the specified child property of @object, or %NULL if
-@property_name does not correspond to any control binding.</doc>
- <type name="Gst.ControlBinding" c:type="GstControlBinding*"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1950">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1951">The name of the child property to return the control
-binding of</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_element" c:identifier="ges_track_element_get_element">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1307">Get the #GstElement that the track element's underlying nleobject
-controls.</doc>
- <source-position filename="ges/ges-track-element.h" line="134"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1314">The #GstElement being controlled by the
-nleobject that @object wraps.</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1309">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_gnlobject"
- c:identifier="ges_track_element_get_gnlobject"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1271">Get the GNonLin object this object is controlling.</doc>
- <doc-deprecated xml:space="preserve">use #ges_track_element_get_nleobject instead.</doc-deprecated>
- <source-position filename="ges/ges-track-element-deprecated.h"
- line="4"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1277">The GNonLin object this object is controlling.</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1273">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_nleobject"
- c:identifier="ges_track_element_get_nleobject"
- version="1.6">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1289">Get the nleobject that this element wraps.</doc>
- <source-position filename="ges/ges-track-element.h" line="131"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1295">The nleobject that @object wraps.</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1291">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_track" c:identifier="ges_track_element_get_track">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1254">Get the #GESTrackElement:track for the element.</doc>
- <source-position filename="ges/ges-track-element.h" line="122"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1260">The track that @object belongs to,
-or %NULL if it does not belong to a track.</doc>
- <type name="Track" c:type="GESTrack*"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1256">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_track_type"
- c:identifier="ges_track_element_get_track_type">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="966">Gets the #GESTrackElement:track-type for the element.</doc>
- <source-position filename="ges/ges-track-element.h" line="125"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="972">The track-type of @object.</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="968">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_internal_source"
- c:identifier="ges_track_element_has_internal_source">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1342">Gets #GESTrackElement:has-internal-source for the element.</doc>
- <source-position filename="ges/ges-track-element.h" line="151"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1348">%TRUE if @object can have its 'internal time' properties set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1344">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_active" c:identifier="ges_track_element_is_active">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1325">Gets #GESTrackElement:active for the element.</doc>
- <source-position filename="ges/ges-track-element.h" line="144"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1331">%TRUE if @object is active in its track.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1327">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_core"
- c:identifier="ges_track_element_is_core"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="2086">Get whether the given track element is a core track element. That is,
-it was created by the @create_track_elements #GESClipClass method for
-some #GESClip.
-
-Note that such a track element can only be added to a clip that shares
-the same #GESAsset as the clip that created it. For example, you are
-allowed to move core children between clips that resulted from
-ges_container_ungroup(), but you could not move the core child from a
-#GESUriClip to a #GESTitleClip or another #GESUriClip with a different
-#GESUriClip:uri.
-
-Moreover, if a core track element is added to a clip, it will always be
-added as a core child. Therefore, if this returns %TRUE, then @element
-will be a core child of its parent clip.</doc>
- <source-position filename="ges/ges-track-element.h" line="137"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="2105">%TRUE if @element is a core track element.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="2088">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="list_children_properties"
- c:identifier="ges_track_element_list_children_properties"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1483">Gets an array of #GParamSpec* for all configurable properties of the
-children of @object.</doc>
- <doc-deprecated xml:space="preserve">Use #ges_timeline_element_list_children_properties</doc-deprecated>
- <source-position filename="ges/ges-track-element-deprecated.h"
- line="9"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1491">An array of #GParamSpec* which should be freed after use or
-%NULL if something went wrong.</doc>
- <array length="0" zero-terminated="0" c:type="GParamSpec**">
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1485">The #GESTrackElement to get the list of children properties from</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="n_properties"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1486">return location for the length of the returned array</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="lookup_child"
- c:identifier="ges_track_element_lookup_child"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1358">Looks up which @element and @pspec would be effected by the given @name. If various
-contained elements have this property name you will get the first one, unless you
-specify the class name in @name.</doc>
- <doc-deprecated xml:space="preserve">Use #ges_timeline_element_lookup_child</doc-deprecated>
- <source-position filename="ges/ges-track-element-deprecated.h"
- line="13"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1375">TRUE if @element and @pspec could be found. FALSE otherwise. In that
-case the values for @pspec and @element are not modified. Unref @element after
-usage.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1360">Object to lookup the property in</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="prop_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1361">Name of the property to look up. You can specify the name of the
- class as such: "ClassName::property-name", to guarantee that you get the
- proper GParamSpec in case various GstElement-s contain the same property
- name. If you don't do so, you will get the first element found, having
- this property and the and the corresponding GParamSpec.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="element"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1366">pointer to a #GstElement that
- takes the real object to set property on</doc>
- <type name="Gst.Element" c:type="GstElement**"/>
- </parameter>
- <parameter name="pspec"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1368">pointer to take the specification
- describing the property</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec**"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_control_binding"
- c:identifier="ges_track_element_remove_control_binding">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1796">Removes the #GstControlBinding that was created for the specified child
-property of the track element using
-ges_track_element_set_control_source(). The given @property_name must
-be the same name of the child property that was passed to
-ges_track_element_set_control_source().</doc>
- <source-position filename="ges/ges-track-element.h" line="186"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1808">%TRUE if the control binding was removed from the specified
-child property of @object, or %FALSE if an error occurred.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1798">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1799">The name of the child property to remove the control
-binding from</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_active" c:identifier="ges_track_element_set_active">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="847">Sets #GESTrackElement:active for the element.</doc>
- <source-position filename="ges/ges-track-element.h" line="140"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="854">%TRUE if the property was *toggled*.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="849">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="850">Whether @object should be active in its track</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_auto_clamp_control_sources"
- c:identifier="ges_track_element_set_auto_clamp_control_sources"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="2029">Sets #GESTrackElement:auto-clamp-control-sources. If set to %TRUE, this
-will immediately clamp all the control sources.</doc>
- <source-position filename="ges/ges-track-element.h" line="169"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="2031">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="auto_clamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="2032">Whether to automatically clamp the control sources for the
-child properties of @object</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_child_properties"
- c:identifier="ges_track_element_set_child_properties"
- introspectable="0"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1433">Sets a property of a child of @object. If there are various child elements
-that have the same property name, you can distinguish them using the following
-syntax: 'ClasseName::property_name' as property name. If you don't, the
-corresponding property of the first element found will be set.</doc>
- <doc-deprecated xml:space="preserve">Use #ges_timeline_element_set_child_properties</doc-deprecated>
- <source-position filename="ges/ges-track-element-deprecated.h"
- line="43"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1435">The #GESTrackElement parent object</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="first_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1436">The name of the first property to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1437">value for the first property, followed optionally by more
-name/return location pairs, followed by NULL</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="set_child_property"
- c:identifier="ges_track_element_set_child_property"
- introspectable="0"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1548">Sets a property of a GstElement contained in @object.
-
-Note that #ges_track_element_set_child_property is really
-intended for language bindings, #ges_track_element_set_child_properties
-is much more convenient for C programming.</doc>
- <doc-deprecated xml:space="preserve">use #ges_timeline_element_set_child_property instead</doc-deprecated>
- <source-position filename="ges/ges-track-element-deprecated.h"
- line="48"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1560">%TRUE if the property was set, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1550">The origin #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1551">The name of the property</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1552">The value</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_child_property_by_pspec"
- c:identifier="ges_track_element_set_child_property_by_pspec"
- introspectable="0"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1389">Sets a property of a child of @object.</doc>
- <doc-deprecated xml:space="preserve">Use #ges_timeline_element_set_child_property_by_spec</doc-deprecated>
- <source-position filename="ges/ges-track-element-deprecated.h"
- line="37"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1391">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="pspec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1392">The #GParamSpec that specifies the property you want to set</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1393">The value</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_child_property_valist"
- c:identifier="ges_track_element_set_child_property_valist"
- introspectable="0"
- deprecated="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1411">Sets a property of a child of @object. If there are various child elements
-that have the same property name, you can distinguish them using the following
-syntax: 'ClasseName::property_name' as property name. If you don't, the
-corresponding property of the first element found will be set.</doc>
- <doc-deprecated xml:space="preserve">Use #ges_timeline_element_set_child_property_valist</doc-deprecated>
- <source-position filename="ges/ges-track-element-deprecated.h"
- line="31"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1413">The #GESTrackElement parent object</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="first_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1414">The name of the first property to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1415">Value for the first property, followed optionally by more
-name/return location pairs, followed by NULL</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_control_source"
- c:identifier="ges_track_element_set_control_source">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1847">Creates a #GstControlBinding for the specified child property of the
-track element using the given control source. The given @property_name
-should refer to an existing child property of the track element, as
-used in ges_timeline_element_lookup_child().
-
-If @binding_type is "direct", then the control binding is created with
-gst_direct_control_binding_new() using the given control source. If
-@binding_type is "direct-absolute", it is created with
-gst_direct_control_binding_new_absolute() instead.</doc>
- <source-position filename="ges/ges-track-element.h" line="159"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1865">%TRUE if the specified child property could be bound to
-@source, or %FALSE if an error occurred.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1849">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1850">The control source to bind the child property to</doc>
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1851">The name of the child property to control</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="binding_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1852">The type of binding to create ("direct" or
-"direct-absolute")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_has_internal_source"
- c:identifier="ges_track_element_set_has_internal_source">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="893">Sets #GESTrackElement:has-internal-source for the element. If this is
-set to %FALSE, this method will also set the
-#GESTimelineElement:in-point of the element to 0 and its
-#GESTimelineElement:max-duration to #GST_CLOCK_TIME_NONE.</doc>
- <source-position filename="ges/ges-track-element.h" line="147"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="904">%FALSE if @has_internal_source is forbidden for @object and
-%TRUE in any other case.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="895">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="has_internal_source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="896">Whether the @object should be allowed to have its
-'internal time' properties set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_track_type"
- c:identifier="ges_track_element_set_track_type">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="948">Sets the #GESTrackElement:track-type for the element.</doc>
- <source-position filename="ges/ges-track-element.h" line="127"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="950">A #GESTrackElement</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="951">The new track-type for @object</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- </parameters>
- </method>
- <property name="active" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="348">Whether the effect of the element should be applied in its
-#GESTrackElement:track. If set to %FALSE, it will not be used in
-the output of the track.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="auto-clamp-control-sources"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="432">Whether the control sources on the element (see
-ges_track_element_set_control_source()) will be automatically
-updated whenever the #GESTimelineElement:in-point or out-point of the
-element change in value.
-
-See ges_track_element_clamp_control_source() for how this is done
-per control source.
-
-Default value: %TRUE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="has-internal-source"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="387">This property is used to determine whether the 'internal time'
-properties of the element have any meaning. In particular, unless
-this is set to %TRUE, the #GESTimelineElement:in-point and
-#GESTimelineElement:max-duration can not be set to any value other
-than the default 0 and #GST_CLOCK_TIME_NONE, respectively.
-
-If an element has some *internal* *timed* source #GstElement that it
-reads stream data from as part of its function in a #GESTrack, then
-you'll likely want to set this to %TRUE to allow the
-#GESTimelineElement:in-point and #GESTimelineElement:max-duration to
-be set.
-
-The default value is determined by the #GESTrackElementClass
-@default_has_internal_source class property. For most
-#GESSourceClass-es, this will be %TRUE, with the exception of those
-that have a potentially *static* source, such as #GESImageSourceClass
-and #GESTitleSourceClass. Otherwise, this will usually be %FALSE.
-
-For most #GESOperation-s you will likely want to leave this set to
-%FALSE. The exception may be for an operation that reads some stream
-data from some private internal source as part of manipulating the
-input data from the usual linked upstream #GESTrackElement.
-
-For example, you may want to set this to %TRUE for a
-#GES_TRACK_TYPE_VIDEO operation that wraps a #textoverlay that reads
-from a subtitle file and places its text on top of the received video
-data. The #GESTimelineElement:in-point of the element would be used
-to shift the initial seek time on the #textoverlay away from 0, and
-the #GESTimelineElement:max-duration could be set to reflect the
-time at which the subtitle file runs out of data.
-
-Note that GES can not support track elements that have both internal
-content and manipulate the timing of their data streams (time
-effects).</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="376">The track that this element belongs to, or %NULL if it does not
-belong to a track.</doc>
- <type name="Track"/>
- </property>
- <property name="track-type"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="361">The track type of the element, which determines the type of track the
-element can be added to (see #GESTrack:track-type). This should
-correspond to the type of data that the element can produce or
-process.</doc>
- <type name="TrackType"/>
- </property>
- <field name="parent">
- <type name="TimelineElement" c:type="GESTimelineElement"/>
- </field>
- <field name="active" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TrackElementPrivate" c:type="GESTrackElementPrivate*"/>
- </field>
- <field name="asset" readable="0" private="1">
- <type name="Asset" c:type="GESAsset*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="control-binding-added" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="454">This is emitted when a control binding is added to a child property
-of the track element.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="control_binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="457">The control binding that has been added</doc>
- <type name="Gst.ControlBinding"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="control-binding-removed" when="first">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="467">This is emitted when a control binding is removed from a child
-property of the track element.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="control_binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="470">The control binding that has been removed</doc>
- <type name="Gst.ControlBinding"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <class name="TrackElementAsset"
- c:symbol-prefix="track_element_asset"
- c:type="GESTrackElementAsset"
- parent="Asset"
- glib:type-name="GESTrackElementAsset"
- glib:get-type="ges_track_element_asset_get_type"
- glib:type-struct="TrackElementAssetClass">
- <source-position filename="ges/ges-track-element-asset.h" line="50"/>
- <implements name="MetaContainer"/>
- <implements name="Gio.AsyncInitable"/>
- <implements name="Gio.Initable"/>
- <virtual-method name="get_natural_framerate"
- invoker="get_natural_framerate">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="147">Result: %TRUE if @self has a natural framerate %FALSE otherwise</doc>
- <source-position filename="ges/ges-track-element-asset.h" line="47"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="149">A #GESAsset</doc>
- <type name="TrackElementAsset" c:type="GESTrackElementAsset*"/>
- </instance-parameter>
- <parameter name="framerate_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="150">The framerate numerator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="framerate_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="151">The framerate denominator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="get_natural_framerate"
- c:identifier="ges_track_element_asset_get_natural_framerate">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="147">Result: %TRUE if @self has a natural framerate %FALSE otherwise</doc>
- <source-position filename="ges/ges-track-element-asset.h" line="57"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="149">A #GESAsset</doc>
- <type name="TrackElementAsset" c:type="GESTrackElementAsset*"/>
- </instance-parameter>
- <parameter name="framerate_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="150">The framerate numerator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="framerate_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="151">The framerate denominator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_track_type"
- c:identifier="ges_track_element_asset_get_track_type">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="129">Get the GESAssetTrackType the #GESTrackElement extracted from @self
-should get into</doc>
- <source-position filename="ges/ges-track-element-asset.h" line="53"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="136">a #GESTrackType</doc>
- <type name="TrackType" c:type="const GESTrackType"/>
- </return-value>
- <parameters>
- <instance-parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="131">A #GESAsset</doc>
- <type name="TrackElementAsset" c:type="GESTrackElementAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_track_type"
- c:identifier="ges_track_element_asset_set_track_type">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="112">Set the #GESTrackType the #GESTrackElement extracted from @self
-should get into</doc>
- <source-position filename="ges/ges-track-element-asset.h" line="55"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="114">A #GESAsset</doc>
- <type name="TrackElementAsset" c:type="GESTrackElementAsset*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="115">A #GESTrackType</doc>
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- </parameters>
- </method>
- <property name="track-type"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="TrackType"/>
- </property>
- <field name="parent">
- <type name="Asset" c:type="GESAsset"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TrackElementAssetPrivate"
- c:type="GESTrackElementAssetPrivate*"/>
- </field>
- <field name="__ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TrackElementAssetClass"
- c:type="GESTrackElementAssetClass"
- glib:is-gtype-struct-for="TrackElementAsset">
- <source-position filename="ges/ges-track-element-asset.h" line="50"/>
- <field name="parent_class">
- <type name="AssetClass" c:type="GESAssetClass"/>
- </field>
- <field name="get_natural_framerate">
- <callback name="get_natural_framerate">
- <source-position filename="ges/ges-track-element-asset.h" line="47"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="149">A #GESAsset</doc>
- <type name="TrackElementAsset" c:type="GESTrackElementAsset*"/>
- </parameter>
- <parameter name="framerate_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="150">The framerate numerator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="framerate_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element-asset.c"
- line="151">The framerate denominator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="TrackElementAssetPrivate"
- c:type="GESTrackElementAssetPrivate"
- disguised="1">
- <source-position filename="ges/ges-track-element-asset.h" line="30"/>
- </record>
- <record name="TrackElementClass"
- c:type="GESTrackElementClass"
- glib:is-gtype-struct-for="TrackElement">
- <source-position filename="ges/ges-track-element.h" line="119"/>
- <field name="parent_class" readable="0" private="1">
- <type name="TimelineElementClass" c:type="GESTimelineElementClass"/>
- </field>
- <field name="nleobject_factorytype">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.h"
- line="67">The name of the #GstElementFactory to use to
-create the underlying nleobject of a track element</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="create_gnl_object" introspectable="0">
- <callback name="create_gnl_object" introspectable="0">
- <source-position filename="ges/ges-track-element.h" line="94"/>
- <return-value>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="create_element" introspectable="0">
- <callback name="create_element" introspectable="0">
- <source-position filename="ges/ges-track-element.h" line="95"/>
- <return-value>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="active_changed">
- <callback name="active_changed">
- <source-position filename="ges/ges-track-element.h" line="97"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="changed">
- <callback name="changed">
- <source-position filename="ges/ges-track-element.h" line="101"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="list_children_properties" introspectable="0">
- <callback name="list_children_properties" introspectable="0">
- <source-position filename="ges/ges-track-element.h" line="105"/>
- <return-value>
- <type name="GObject.ParamSpec" c:type="GParamSpec**"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- <parameter name="n_properties" transfer-ownership="none">
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="lookup_child">
- <callback name="lookup_child">
- <source-position filename="ges/ges-track-element.h" line="107"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1375">TRUE if @element and @pspec could be found. FALSE otherwise. In that
-case the values for @pspec and @element are not modified. Unref @element after
-usage.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1360">Object to lookup the property in</doc>
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- <parameter name="prop_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1361">Name of the property to look up. You can specify the name of the
- class as such: "ClassName::property-name", to guarantee that you get the
- proper GParamSpec in case various GstElement-s contain the same property
- name. If you don't do so, you will get the first element found, having
- this property and the and the corresponding GParamSpec.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="element"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1366">pointer to a #GstElement that
- takes the real object to set property on</doc>
- <type name="Gst.Element" c:type="GstElement**"/>
- </parameter>
- <parameter name="pspec"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-track-element.c"
- line="1368">pointer to take the specification
- describing the property</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <union name="ABI" c:type="ABI">
- <source-position filename="ges/ges-track-element.h" line="118"/>
- <field name="_ges_reserved" writable="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <record name="abi" c:type="abi">
- <source-position filename="ges/ges-track-element.h" line="117"/>
- <field name="default_has_internal_source" writable="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="default_track_type" writable="1">
- <type name="TrackType" c:type="GESTrackType"/>
- </field>
- </record>
- </union>
- </record>
- <record name="TrackElementPrivate"
- c:type="GESTrackElementPrivate"
- disguised="1">
- <source-position filename="ges/ges-track-element.h" line="34"/>
- </record>
- <record name="TrackPrivate" c:type="GESTrackPrivate" disguised="1">
- <source-position filename="ges/ges-track.h" line="31"/>
- </record>
- <bitfield name="TrackType"
- glib:type-name="GESTrackType"
- glib:get-type="ges_track_type_get_type"
- c:type="GESTrackType">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="32">Types of content handled by a track. If the content is not one of
-@GES_TRACK_TYPE_AUDIO, @GES_TRACK_TYPE_VIDEO or @GES_TRACK_TYPE_TEXT,
-the user of the #GESTrack must set the type to @GES_TRACK_TYPE_CUSTOM.
-
-@GES_TRACK_TYPE_UNKNOWN is for internal purposes and should not be used
-by users</doc>
- <member name="unknown"
- value="1"
- c:identifier="GES_TRACK_TYPE_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="34">A track of unknown type (i.e. invalid)</doc>
- </member>
- <member name="audio"
- value="2"
- c:identifier="GES_TRACK_TYPE_AUDIO"
- glib:nick="audio">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="35">An audio track</doc>
- </member>
- <member name="video"
- value="4"
- c:identifier="GES_TRACK_TYPE_VIDEO"
- glib:nick="video">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="36">A video track</doc>
- </member>
- <member name="text"
- value="8"
- c:identifier="GES_TRACK_TYPE_TEXT"
- glib:nick="text">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="37">A text (subtitle) track</doc>
- </member>
- <member name="custom"
- value="16"
- c:identifier="GES_TRACK_TYPE_CUSTOM"
- glib:nick="custom">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="38">A custom-content track</doc>
- </member>
- <function name="name" c:identifier="ges_track_type_name">
- <source-position filename="ges/ges-enums.h" line="567"/>
- <return-value transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- </parameters>
- </function>
- </bitfield>
- <class name="Transition"
- c:symbol-prefix="transition"
- c:type="GESTransition"
- parent="Operation"
- abstract="1"
- glib:type-name="GESTransition"
- glib:get-type="ges_transition_get_type"
- glib:type-struct="TransitionClass">
- <doc xml:space="preserve"
- filename="ges/ges-transition.h"
- line="34">Base class for media transitions.</doc>
- <source-position filename="ges/ges-transition.h" line="62"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <field name="parent" readable="0" private="1">
- <type name="Operation" c:type="GESOperation"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TransitionPrivate" c:type="GESTransitionPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TransitionClass"
- c:type="GESTransitionClass"
- glib:is-gtype-struct-for="Transition">
- <source-position filename="ges/ges-transition.h" line="62"/>
- <field name="parent_class" readable="0" private="1">
- <type name="OperationClass" c:type="GESOperationClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="TransitionClip"
- c:symbol-prefix="transition_clip"
- c:type="GESTransitionClip"
- parent="BaseTransitionClip"
- glib:type-name="GESTransitionClip"
- glib:get-type="ges_transition_clip_get_type"
- glib:type-struct="TransitionClipClass">
- <doc xml:space="preserve"
- filename="ges/ges-transition-clip.c"
- line="21">Creates an object that mixes together the two underlying objects, A and B.
-The A object is assumed to have a higher prioirity (lower number) than the
-B object. At the transition in point, only A will be visible, and by the
-end only B will be visible.
-
-The shape of the video transition depends on the value of the "vtype"
-property. The default value is "crossfade". For audio, only "crossfade" is
-supported.
-
-The ID of the ExtractableType is the nickname of the vtype property value. Note
-that this value can be changed after creation and the GESExtractable.asset value
-will be updated when needed.</doc>
- <source-position filename="ges/ges-transition-clip.h" line="66"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new" c:identifier="ges_transition_clip_new">
- <doc xml:space="preserve"
- filename="ges/ges-transition-clip.c"
- line="382">Creates a new #GESTransitionClip.</doc>
- <source-position filename="ges/ges-transition-clip.h" line="69"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-transition-clip.c"
- line="388">a newly created #GESTransitionClip,
-or %NULL if something went wrong.</doc>
- <type name="TransitionClip" c:type="GESTransitionClip*"/>
- </return-value>
- <parameters>
- <parameter name="vtype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-transition-clip.c"
- line="384">the type of transition to create</doc>
- <type name="VideoStandardTransitionType"
- c:type="GESVideoStandardTransitionType"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_for_nick"
- c:identifier="ges_transition_clip_new_for_nick">
- <doc xml:space="preserve"
- filename="ges/ges-transition-clip.c"
- line="417">Creates a new #GESTransitionClip for the provided @nick.</doc>
- <source-position filename="ges/ges-transition-clip.h" line="71"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-transition-clip.c"
- line="423">The newly created #GESTransitionClip,
-or %NULL if something went wrong</doc>
- <type name="TransitionClip" c:type="GESTransitionClip*"/>
- </return-value>
- <parameters>
- <parameter name="nick" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-transition-clip.c"
- line="419">a string representing the type of transition to create</doc>
- <type name="utf8" c:type="char*"/>
- </parameter>
- </parameters>
- </constructor>
- <property name="vtype"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-transition-clip.c"
- line="276">a #GESVideoStandardTransitionType representing the wipe to use</doc>
- <type name="VideoStandardTransitionType"/>
- </property>
- <field name="parent" readable="0" private="1">
- <type name="BaseTransitionClip" c:type="GESBaseTransitionClip"/>
- </field>
- <field name="vtype">
- <doc xml:space="preserve"
- filename="ges/ges-transition-clip.h"
- line="34">a #GESVideoStandardTransitionType indicating the type of video transition
-to apply.</doc>
- <type name="VideoStandardTransitionType"
- c:type="GESVideoStandardTransitionType"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TransitionClipPrivate" c:type="GESTransitionClipPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TransitionClipClass"
- c:type="GESTransitionClipClass"
- glib:is-gtype-struct-for="TransitionClip">
- <source-position filename="ges/ges-transition-clip.h" line="66"/>
- <field name="parent_class" readable="0" private="1">
- <type name="BaseTransitionClipClass"
- c:type="GESBaseTransitionClipClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="TransitionClipPrivate"
- c:type="GESTransitionClipPrivate"
- disguised="1">
- <source-position filename="ges/ges-transition-clip.h" line="30"/>
- </record>
- <record name="TransitionPrivate"
- c:type="GESTransitionPrivate"
- disguised="1">
- <source-position filename="ges/ges-transition.h" line="32"/>
- </record>
- <class name="UriClip"
- c:symbol-prefix="uri_clip"
- c:type="GESUriClip"
- parent="SourceClip"
- glib:type-name="GESUriClip"
- glib:get-type="ges_uri_clip_get_type"
- glib:type-struct="UriClipClass">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="21">Represents all the output streams from a particular uri. It is assumed that
-the URI points to a file of some type.</doc>
- <source-position filename="ges/ges-uri-clip.h" line="53"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new" c:identifier="ges_uri_clip_new">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="538">Creates a new #GESUriClip for the provided @uri.
-
-&gt; **WARNING**: This function might 'discover` @uri **synchrounously**, it is
-&gt; an IO and processing intensive task that you probably don't want to run in
-&gt; an application mainloop. Have a look at #ges_asset_request_async to see how
-&gt; to make that operation happen **asynchronously**.</doc>
- <source-position filename="ges/ges-uri-clip.h" line="70"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="549">The newly created #GESUriClip, or
-%NULL if there was an error.</doc>
- <type name="UriClip" c:type="GESUriClip*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="540">the URI the source should control</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="get_uri" c:identifier="ges_uri_clip_get_uri">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="492">Get the location of the resource.</doc>
- <source-position filename="ges/ges-uri-clip.h" line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="498">The location of the resource.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="494">the #GESUriClip</doc>
- <type name="UriClip" c:type="GESUriClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_image" c:identifier="ges_uri_clip_is_image">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="478">Lets you know if @self is an image or not.</doc>
- <source-position filename="ges/ges-uri-clip.h" line="65"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="484">%TRUE if @self is a still image %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="480">the #GESUriClip</doc>
- <type name="UriClip" c:type="GESUriClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_muted" c:identifier="ges_uri_clip_is_muted">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="464">Lets you know if the audio track of @self is muted or not.</doc>
- <source-position filename="ges/ges-uri-clip.h" line="63"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="470">%TRUE if the audio track of @self is muted, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="466">the #GESUriClip</doc>
- <type name="UriClip" c:type="GESUriClip*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_is_image" c:identifier="ges_uri_clip_set_is_image">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="451">Sets whether the clip is a still image or not.</doc>
- <source-position filename="ges/ges-uri-clip.h" line="59"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="453">the #GESUriClip</doc>
- <type name="UriClip" c:type="GESUriClip*"/>
- </instance-parameter>
- <parameter name="is_image" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="454">%TRUE if @self is a still image, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_mute" c:identifier="ges_uri_clip_set_mute">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="407">Sets whether the audio track of this clip is muted or not.</doc>
- <source-position filename="ges/ges-uri-clip.h" line="56"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="409">the #GESUriClip on which to mute or unmute the audio track</doc>
- <type name="UriClip" c:type="GESUriClip*"/>
- </instance-parameter>
- <parameter name="mute" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="410">%TRUE to mute @self audio track, %FALSE to unmute it</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <property name="is-image"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="170">Whether this uri clip represents a still image or not. This must be set
-before create_track_elements is called.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="mute"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="161">Whether the sound will be played or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="supported-formats"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="TrackType"/>
- </property>
- <property name="uri"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-clip.c"
- line="152">The location of the file/resource to use.</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <field name="parent">
- <type name="SourceClip" c:type="GESSourceClip"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="UriClipPrivate" c:type="GESUriClipPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <class name="UriClipAsset"
- c:symbol-prefix="uri_clip_asset"
- c:type="GESUriClipAsset"
- parent="SourceClipAsset"
- glib:type-name="GESUriClipAsset"
- glib:get-type="ges_uri_clip_asset_get_type"
- glib:type-struct="UriClipAssetClass">
- <source-position filename="ges/ges-uri-asset.h" line="60"/>
- <implements name="MetaContainer"/>
- <implements name="Gio.AsyncInitable"/>
- <implements name="Gio.Initable"/>
- <function name="finish"
- c:identifier="ges_uri_clip_asset_finish"
- version="1.16"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="658">Finalize the request of an async #GESUriClipAsset</doc>
- <source-position filename="ges/ges-uri-asset.h" line="76"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="665">The #GESUriClipAsset previously requested</doc>
- <type name="UriClipAsset" c:type="GESUriClipAsset*"/>
- </return-value>
- <parameters>
- <parameter name="res" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="660">The #GAsyncResult from which to get the newly created #GESUriClipAsset</doc>
- <type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
- </parameter>
- </parameters>
- </function>
- <function name="new" c:identifier="ges_uri_clip_asset_new">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="614">Creates a #GESUriClipAsset for @uri
-
-Example of request of a GESUriClipAsset:
-|[
-// The request callback
-static void
-filesource_asset_loaded_cb (GESAsset * source, GAsyncResult * res, gpointer user_data)
-{
- GError *error = NULL;
- GESUriClipAsset *filesource_asset;
-
- filesource_asset = ges_uri_clip_asset_finish (res, &amp;error);
- if (filesource_asset) {
- g_print ("The file: %s is usable as a FileSource, it is%s an image and lasts %" GST_TIME_FORMAT,
- ges_asset_get_id (GES_ASSET (filesource_asset))
- ges_uri_clip_asset_is_image (filesource_asset) ? "" : " not",
- GST_TIME_ARGS (ges_uri_clip_asset_get_duration (filesource_asset));
- } else {
- g_print ("The file: %s is *not* usable as a FileSource because: %s",
- ges_asset_get_id (source), error-&gt;message);
- }
-
- gst_object_unref (mfs);
-}
-
-// The request:
-ges_uri_clip_asset_new (uri, (GAsyncReadyCallback) filesource_asset_loaded_cb, user_data);
-]|</doc>
- <source-position filename="ges/ges-uri-asset.h" line="71"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="616">The URI of the file for which to create a #GESUriClipAsset</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="617">optional %GCancellable object, %NULL to ignore.</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- <parameter name="callback"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="async"
- closure="3">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="618">a #GAsyncReadyCallback to call when the initialization is finished</doc>
- <type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="619">The user data to pass when @callback is called</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="request_sync"
- c:identifier="ges_uri_clip_asset_request_sync"
- throws="1">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="684">Creates a #GESUriClipAsset for @uri syncronously. You should avoid
-to use it in application, and rather create #GESUriClipAsset asynchronously</doc>
- <source-position filename="ges/ges-uri-asset.h" line="78"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="693">A reference to the requested asset or %NULL if
-an error happened</doc>
- <type name="UriClipAsset" c:type="GESUriClipAsset*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="686">The URI of the file for which to create a #GESUriClipAsset.
-You can also use multi file uris for #GESMultiFileSource.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <method name="get_duration"
- c:identifier="ges_uri_clip_asset_get_duration">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="560">Gets duration of the file represented by @self</doc>
- <source-position filename="ges/ges-uri-asset.h" line="65"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="566">The duration of @self</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="562">a #GESUriClipAsset</doc>
- <type name="UriClipAsset" c:type="GESUriClipAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_info" c:identifier="ges_uri_clip_asset_get_info">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="544">Gets #GstDiscovererInfo about the file</doc>
- <source-position filename="ges/ges-uri-asset.h" line="63"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="550">#GstDiscovererInfo of specified asset</doc>
- <type name="GstPbutils.DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="546">Target asset</doc>
- <type name="UriClipAsset" c:type="const GESUriClipAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_max_duration"
- c:identifier="ges_uri_clip_asset_get_max_duration"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="577">Gets maximum duration of the file represented by @self,
-it is usually the same as GESUriClipAsset::duration,
-but in the case of nested timelines, for example, they
-are different as those can be extended 'infinitely'.</doc>
- <source-position filename="ges/ges-uri-asset.h" line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="586">The maximum duration of @self</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="579">a #GESUriClipAsset</doc>
- <type name="UriClipAsset" c:type="GESUriClipAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_assets"
- c:identifier="ges_uri_clip_asset_get_stream_assets">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="759">Get the GESUriSourceAsset @self containes</doc>
- <source-position filename="ges/ges-uri-asset.h" line="83"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="765">a
-#GList of #GESUriSourceAsset</doc>
- <type name="GLib.List" c:type="const GList*">
- <type name="UriSourceAsset"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="761">A #GESUriClipAsset</doc>
- <type name="UriClipAsset" c:type="GESUriClipAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_image" c:identifier="ges_uri_clip_asset_is_image">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="598">Gets Whether the file represented by @self is an image or not</doc>
- <source-position filename="ges/ges-uri-asset.h" line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="604">Whether the file represented by @self is an image or not</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="600">a #GESUriClipAsset</doc>
- <type name="UriClipAsset" c:type="GESUriClipAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <property name="duration" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="318">The duration (in nanoseconds) of the media file</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="is-nested-timeline"
- version="1.18"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="329">The duration (in nanoseconds) of the media file</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="parent">
- <type name="SourceClipAsset" c:type="GESSourceClipAsset"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="UriClipAssetPrivate" c:type="GESUriClipAssetPrivate*"/>
- </field>
- <field name="__ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="UriClipAssetClass"
- c:type="GESUriClipAssetClass"
- glib:is-gtype-struct-for="UriClipAsset">
- <source-position filename="ges/ges-uri-asset.h" line="60"/>
- <field name="parent_class">
- <type name="SourceClipAssetClass" c:type="GESSourceClipAssetClass"/>
- </field>
- <field name="discoverer" readable="0" private="1">
- <type name="GstPbutils.Discoverer" c:type="GstDiscoverer*"/>
- </field>
- <field name="sync_discoverer" readable="0" private="1">
- <type name="GstPbutils.Discoverer" c:type="GstDiscoverer*"/>
- </field>
- <field name="discovered">
- <callback name="discovered">
- <source-position filename="ges/ges-uri-asset.h" line="54"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="discoverer" transfer-ownership="none">
- <type name="GstPbutils.Discoverer" c:type="GstDiscoverer*"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <type name="GstPbutils.DiscovererInfo"
- c:type="GstDiscovererInfo*"/>
- </parameter>
- <parameter name="err" transfer-ownership="none">
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="3">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="set_timeout"
- c:identifier="ges_uri_clip_asset_class_set_timeout">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="734">Sets the timeout of #GESUriClipAsset loading</doc>
- <source-position filename="ges/ges-uri-asset.h" line="80"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="736">The #GESUriClipAssetClass on which to set the discoverer timeout</doc>
- <type name="UriClipAssetClass" c:type="GESUriClipAssetClass*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="737">The timeout to set</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <record name="UriClipAssetPrivate"
- c:type="GESUriClipAssetPrivate"
- disguised="1">
- <source-position filename="ges/ges-uri-asset.h" line="33"/>
- </record>
- <record name="UriClipClass"
- c:type="GESUriClipClass"
- glib:is-gtype-struct-for="UriClip">
- <source-position filename="ges/ges-uri-clip.h" line="53"/>
- <field name="parent_class" readable="0" private="1">
- <type name="SourceClipClass" c:type="GESSourceClipClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="UriClipPrivate" c:type="GESUriClipPrivate" disguised="1">
- <source-position filename="ges/ges-uri-clip.h" line="31"/>
- </record>
- <class name="UriSourceAsset"
- c:symbol-prefix="uri_source_asset"
- c:type="GESUriSourceAsset"
- parent="TrackElementAsset"
- glib:type-name="GESUriSourceAsset"
- glib:get-type="ges_uri_source_asset_get_type"
- glib:type-struct="UriSourceAssetClass">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.h"
- line="88">Asset to create a stream specific #GESSource for a media file.
-
-NOTE: You should never request such a #GESAsset as they will be created automatically
-by #GESUriClipAsset-s.</doc>
- <source-position filename="ges/ges-uri-asset.h" line="112"/>
- <implements name="MetaContainer"/>
- <implements name="Gio.AsyncInitable"/>
- <implements name="Gio.Initable"/>
- <method name="get_filesource_asset"
- c:identifier="ges_uri_source_asset_get_filesource_asset">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="877">Get the #GESUriClipAsset @self is contained in</doc>
- <source-position filename="ges/ges-uri-asset.h" line="118"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="883">a #GESUriClipAsset</doc>
- <type name="UriClipAsset" c:type="const GESUriClipAsset*"/>
- </return-value>
- <parameters>
- <instance-parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="879">A #GESUriClipAsset</doc>
- <type name="UriSourceAsset" c:type="GESUriSourceAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_info"
- c:identifier="ges_uri_source_asset_get_stream_info">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="853">Get the #GstDiscovererStreamInfo user by @asset</doc>
- <source-position filename="ges/ges-uri-asset.h" line="114"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="859">a #GESUriClipAsset</doc>
- <type name="GstPbutils.DiscovererStreamInfo"
- c:type="GstDiscovererStreamInfo*"/>
- </return-value>
- <parameters>
- <instance-parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="855">A #GESUriClipAsset</doc>
- <type name="UriSourceAsset" c:type="GESUriSourceAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_uri"
- c:identifier="ges_uri_source_asset_get_stream_uri">
- <source-position filename="ges/ges-uri-asset.h" line="116"/>
- <return-value transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="asset" transfer-ownership="none">
- <type name="UriSourceAsset" c:type="GESUriSourceAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_image" c:identifier="ges_uri_source_asset_is_image">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="893">Check if @asset contains a single image</doc>
- <source-position filename="ges/ges-uri-asset.h" line="120"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="899">%TRUE if the video stream corresponds to an image (i.e. only
-contains one frame)</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="asset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-uri-asset.c"
- line="895">A #GESUriClipAsset</doc>
- <type name="UriSourceAsset" c:type="GESUriSourceAsset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <field name="parent">
- <type name="TrackElementAsset" c:type="GESTrackElementAsset"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="UriSourceAssetPrivate" c:type="GESUriSourceAssetPrivate*"/>
- </field>
- <field name="__ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="UriSourceAssetClass"
- c:type="GESUriSourceAssetClass"
- glib:is-gtype-struct-for="UriSourceAsset">
- <source-position filename="ges/ges-uri-asset.h" line="112"/>
- <field name="parent_class">
- <type name="TrackElementAssetClass"
- c:type="GESTrackElementAssetClass"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="UriSourceAssetPrivate"
- c:type="GESUriSourceAssetPrivate"
- disguised="1">
- <source-position filename="ges/ges-uri-asset.h" line="86"/>
- </record>
- <class name="VideoSource"
- c:symbol-prefix="video_source"
- c:type="GESVideoSource"
- parent="Source"
- abstract="1"
- glib:type-name="GESVideoSource"
- glib:get-type="ges_video_source_get_type"
- glib:type-struct="VideoSourceClass">
- <doc xml:space="preserve"
- filename="ges/ges-video-source.h"
- line="34">Base class for video sources</doc>
- <source-position filename="ges/ges-video-source.h" line="75"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <method name="get_natural_size"
- c:identifier="ges_video_source_get_natural_size">
- <doc xml:space="preserve"
- filename="ges/ges-video-source.c"
- line="243">Retrieves the natural size of the video stream. The natural size, is
-the size at which it will be displayed if no scaling is being applied.
-
-NOTE: The sources take into account the potential video rotation applied
-by the #videoflip element that is inside the source, effects applied on
-the clip which potentially also rotate the element are not taken into
-account.</doc>
- <source-position filename="ges/ges-video-source.h" line="78"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-source.c"
- line="257">%TRUE if the object has a natural size, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-source.c"
- line="245">A #GESVideoSource</doc>
- <type name="VideoSource" c:type="GESVideoSource*"/>
- </instance-parameter>
- <parameter name="width"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-video-source.c"
- line="246">The natural width of the underlying source</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="height"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-video-source.c"
- line="247">The natural height of the underlying source</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <field name="parent" readable="0" private="1">
- <type name="Source" c:type="GESSource"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="VideoSourcePrivate" c:type="GESVideoSourcePrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="VideoSourceClass"
- c:type="GESVideoSourceClass"
- glib:is-gtype-struct-for="VideoSource">
- <source-position filename="ges/ges-video-source.h" line="75"/>
- <field name="parent_class" readable="0" private="1">
- <type name="SourceClass" c:type="GESSourceClass"/>
- </field>
- <field name="create_source" introspectable="0">
- <callback name="create_source" introspectable="0">
- <source-position filename="ges/ges-video-source.h" line="62"/>
- <return-value>
- <type name="Gst.Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="TrackElement" c:type="GESTrackElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <union name="ABI" c:type="ABI">
- <source-position filename="ges/ges-video-source.h" line="74"/>
- <field name="_ges_reserved" writable="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <record name="abi" c:type="abi">
- <source-position filename="ges/ges-video-source.h" line="73"/>
- <field name="disable_scale_in_compositor" writable="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="needs_converters">
- <callback name="needs_converters">
- <source-position filename="ges/ges-video-source.h" line="70"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="VideoSource" c:type="GESVideoSource*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_natural_size">
- <callback name="get_natural_size">
- <source-position filename="ges/ges-video-source.h" line="71"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="VideoSource" c:type="GESVideoSource*"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="create_filters" introspectable="0">
- <callback name="create_filters" introspectable="0">
- <source-position filename="ges/ges-video-source.h" line="72"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="VideoSource" c:type="GESVideoSource*"/>
- </parameter>
- <parameter name="filters" transfer-ownership="none">
- <array name="GLib.PtrArray" c:type="GPtrArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </parameter>
- <parameter name="needs_converters" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- </record>
- </union>
- </record>
- <record name="VideoSourcePrivate"
- c:type="GESVideoSourcePrivate"
- disguised="1">
- <source-position filename="ges/ges-video-source.h" line="32"/>
- </record>
- <enumeration name="VideoStandardTransitionType"
- glib:type-name="GESVideoStandardTransitionType"
- glib:get-type="ges_video_standard_transition_type_get_type"
- c:type="GESVideoStandardTransitionType">
- <member name="none"
- value="0"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="74">Transition type has not been set,</doc>
- </member>
- <member name="bar_wipe_lr"
- value="1"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BAR_WIPE_LR"
- glib:nick="bar-wipe-lr">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="75">A bar moves from left to right,</doc>
- </member>
- <member name="bar_wipe_tb"
- value="2"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BAR_WIPE_TB"
- glib:nick="bar-wipe-tb">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="76">A bar moves from top to bottom,</doc>
- </member>
- <member name="box_wipe_tl"
- value="3"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BOX_WIPE_TL"
- glib:nick="box-wipe-tl">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="77">A box expands from the upper-left corner to the lower-right corner,</doc>
- </member>
- <member name="box_wipe_tr"
- value="4"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BOX_WIPE_TR"
- glib:nick="box-wipe-tr">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="78">A box expands from the upper-right corner to the lower-left corner,</doc>
- </member>
- <member name="box_wipe_br"
- value="5"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BOX_WIPE_BR"
- glib:nick="box-wipe-br">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="79">A box expands from the lower-right corner to the upper-left corner,</doc>
- </member>
- <member name="box_wipe_bl"
- value="6"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BOX_WIPE_BL"
- glib:nick="box-wipe-bl">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="80">A box expands from the lower-left corner to the upper-right corner,</doc>
- </member>
- <member name="four_box_wipe_ci"
- value="7"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_FOUR_BOX_WIPE_CI"
- glib:nick="four-box-wipe-ci">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="81">A box shape expands from each of the four corners toward the center,</doc>
- </member>
- <member name="four_box_wipe_co"
- value="8"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_FOUR_BOX_WIPE_CO"
- glib:nick="four-box-wipe-co">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="82">A box shape expands from the center of each quadrant toward the corners of each quadrant,</doc>
- </member>
- <member name="barndoor_v"
- value="21"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BARNDOOR_V"
- glib:nick="barndoor-v">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="83">A central, vertical line splits and expands toward the left and right edges,</doc>
- </member>
- <member name="barndoor_h"
- value="22"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BARNDOOR_H"
- glib:nick="barndoor-h">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="84">A central, horizontal line splits and expands toward the top and bottom edges,</doc>
- </member>
- <member name="box_wipe_tc"
- value="23"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BOX_WIPE_TC"
- glib:nick="box-wipe-tc">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="85">A box expands from the top edge's midpoint to the bottom corners,</doc>
- </member>
- <member name="box_wipe_rc"
- value="24"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BOX_WIPE_RC"
- glib:nick="box-wipe-rc">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="86">A box expands from the right edge's midpoint to the left corners,</doc>
- </member>
- <member name="box_wipe_bc"
- value="25"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BOX_WIPE_BC"
- glib:nick="box-wipe-bc">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="87">A box expands from the bottom edge's midpoint to the top corners,</doc>
- </member>
- <member name="box_wipe_lc"
- value="26"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BOX_WIPE_LC"
- glib:nick="box-wipe-lc">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="88">A box expands from the left edge's midpoint to the right corners,</doc>
- </member>
- <member name="diagonal_tl"
- value="41"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_DIAGONAL_TL"
- glib:nick="diagonal-tl">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="89">A diagonal line moves from the upper-left corner to the lower-right corner,</doc>
- </member>
- <member name="diagonal_tr"
- value="42"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_DIAGONAL_TR"
- glib:nick="diagonal-tr">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="90">A diagonal line moves from the upper right corner to the lower-left corner,</doc>
- </member>
- <member name="bowtie_v"
- value="43"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BOWTIE_V"
- glib:nick="bowtie-v">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="91">Two wedge shapes slide in from the top and bottom edges toward the center,</doc>
- </member>
- <member name="bowtie_h"
- value="44"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BOWTIE_H"
- glib:nick="bowtie-h">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="92">Two wedge shapes slide in from the left and right edges toward the center,</doc>
- </member>
- <member name="barndoor_dbl"
- value="45"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BARNDOOR_DBL"
- glib:nick="barndoor-dbl">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="93">A diagonal line from the lower-left to upper-right corners splits and expands toward the opposite corners,</doc>
- </member>
- <member name="barndoor_dtl"
- value="46"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BARNDOOR_DTL"
- glib:nick="barndoor-dtl">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="94">A diagonal line from upper-left to lower-right corners splits and expands toward the opposite corners,</doc>
- </member>
- <member name="misc_diagonal_dbd"
- value="47"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_MISC_DIAGONAL_DBD"
- glib:nick="misc-diagonal-dbd">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="95">Four wedge shapes split from the center and retract toward the four edges,</doc>
- </member>
- <member name="misc_diagonal_dd"
- value="48"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_MISC_DIAGONAL_DD"
- glib:nick="misc-diagonal-dd">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="96">A diamond connecting the four edge midpoints simultaneously contracts toward the center and expands toward the edges,</doc>
- </member>
- <member name="vee_d"
- value="61"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_VEE_D"
- glib:nick="vee-d">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="97">A wedge shape moves from top to bottom,</doc>
- </member>
- <member name="vee_l"
- value="62"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_VEE_L"
- glib:nick="vee-l">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="98">A wedge shape moves from right to left,</doc>
- </member>
- <member name="vee_u"
- value="63"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_VEE_U"
- glib:nick="vee-u">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="99">A wedge shape moves from bottom to top,</doc>
- </member>
- <member name="vee_r"
- value="64"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_VEE_R"
- glib:nick="vee-r">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="100">A wedge shape moves from left to right,</doc>
- </member>
- <member name="barnvee_d"
- value="65"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BARNVEE_D"
- glib:nick="barnvee-d">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="101">A 'V' shape extending from the bottom edge's midpoint to the opposite corners contracts toward the center and expands toward the edges,</doc>
- </member>
- <member name="barnvee_l"
- value="66"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BARNVEE_L"
- glib:nick="barnvee-l">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="102">A 'V' shape extending from the left edge's midpoint to the opposite corners contracts toward the center and expands toward the edges,</doc>
- </member>
- <member name="barnvee_u"
- value="67"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BARNVEE_U"
- glib:nick="barnvee-u">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="103">A 'V' shape extending from the top edge's midpoint to the opposite corners contracts toward the center and expands toward the edges,</doc>
- </member>
- <member name="barnvee_r"
- value="68"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_BARNVEE_R"
- glib:nick="barnvee-r">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="104">A 'V' shape extending from the right edge's midpoint to the opposite corners contracts toward the center and expands toward the edges,</doc>
- </member>
- <member name="iris_rect"
- value="101"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_IRIS_RECT"
- glib:nick="iris-rect">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="105">A rectangle expands from the center.,</doc>
- </member>
- <member name="clock_cw12"
- value="201"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_CLOCK_CW12"
- glib:nick="clock-cw12">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="106">A radial hand sweeps clockwise from the twelve o'clock position,</doc>
- </member>
- <member name="clock_cw3"
- value="202"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_CLOCK_CW3"
- glib:nick="clock-cw3">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="107">A radial hand sweeps clockwise from the three o'clock position,</doc>
- </member>
- <member name="clock_cw6"
- value="203"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_CLOCK_CW6"
- glib:nick="clock-cw6">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="108">A radial hand sweeps clockwise from the six o'clock position,</doc>
- </member>
- <member name="clock_cw9"
- value="204"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_CLOCK_CW9"
- glib:nick="clock-cw9">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="109">A radial hand sweeps clockwise from the nine o'clock position,</doc>
- </member>
- <member name="pinwheel_tbv"
- value="205"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_PINWHEEL_TBV"
- glib:nick="pinwheel-tbv">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="110">Two radial hands sweep clockwise from the twelve and six o'clock positions,</doc>
- </member>
- <member name="pinwheel_tbh"
- value="206"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_PINWHEEL_TBH"
- glib:nick="pinwheel-tbh">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="111">Two radial hands sweep clockwise from the nine and three o'clock positions,</doc>
- </member>
- <member name="pinwheel_fb"
- value="207"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_PINWHEEL_FB"
- glib:nick="pinwheel-fb">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="112">Four radial hands sweep clockwise,</doc>
- </member>
- <member name="fan_ct"
- value="211"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_FAN_CT"
- glib:nick="fan-ct">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="113">A fan unfolds from the top edge, the fan axis at the center,</doc>
- </member>
- <member name="fan_cr"
- value="212"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_FAN_CR"
- glib:nick="fan-cr">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="114">A fan unfolds from the right edge, the fan axis at the center,</doc>
- </member>
- <member name="doublefan_fov"
- value="213"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_DOUBLEFAN_FOV"
- glib:nick="doublefan-fov">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="115">Two fans, their axes at the center, unfold from the top and bottom,</doc>
- </member>
- <member name="doublefan_foh"
- value="214"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_DOUBLEFAN_FOH"
- glib:nick="doublefan-foh">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="116">Two fans, their axes at the center, unfold from the left and right,</doc>
- </member>
- <member name="singlesweep_cwt"
- value="221"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_SINGLESWEEP_CWT"
- glib:nick="singlesweep-cwt">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="117">A radial hand sweeps clockwise from the top edge's midpoint,</doc>
- </member>
- <member name="singlesweep_cwr"
- value="222"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_SINGLESWEEP_CWR"
- glib:nick="singlesweep-cwr">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="118">A radial hand sweeps clockwise from the right edge's midpoint,</doc>
- </member>
- <member name="singlesweep_cwb"
- value="223"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_SINGLESWEEP_CWB"
- glib:nick="singlesweep-cwb">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="119">A radial hand sweeps clockwise from the bottom edge's midpoint,</doc>
- </member>
- <member name="singlesweep_cwl"
- value="224"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_SINGLESWEEP_CWL"
- glib:nick="singlesweep-cwl">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="120">A radial hand sweeps clockwise from the left edge's midpoint,</doc>
- </member>
- <member name="doublesweep_pv"
- value="225"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_DOUBLESWEEP_PV"
- glib:nick="doublesweep-pv">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="121">Two radial hands sweep clockwise and counter-clockwise from the top and bottom edges' midpoints,</doc>
- </member>
- <member name="doublesweep_pd"
- value="226"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_DOUBLESWEEP_PD"
- glib:nick="doublesweep-pd">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="122">Two radial hands sweep clockwise and counter-clockwise from the left and right edges' midpoints,</doc>
- </member>
- <member name="doublesweep_ov"
- value="227"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_DOUBLESWEEP_OV"
- glib:nick="doublesweep-ov">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="123">Two radial hands attached at the top and bottom edges' midpoints sweep from right to left,</doc>
- </member>
- <member name="doublesweep_oh"
- value="228"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_DOUBLESWEEP_OH"
- glib:nick="doublesweep-oh">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="124">Two radial hands attached at the left and right edges' midpoints sweep from top to bottom,</doc>
- </member>
- <member name="fan_t"
- value="231"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_FAN_T"
- glib:nick="fan-t">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="125">A fan unfolds from the bottom, the fan axis at the top edge's midpoint,</doc>
- </member>
- <member name="fan_r"
- value="232"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_FAN_R"
- glib:nick="fan-r">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="126">A fan unfolds from the left, the fan axis at the right edge's midpoint,</doc>
- </member>
- <member name="fan_b"
- value="233"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_FAN_B"
- glib:nick="fan-b">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="127">A fan unfolds from the top, the fan axis at the bottom edge's midpoint,</doc>
- </member>
- <member name="fan_l"
- value="234"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_FAN_L"
- glib:nick="fan-l">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="128">A fan unfolds from the right, the fan axis at the left edge's midpoint,</doc>
- </member>
- <member name="doublefan_fiv"
- value="235"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_DOUBLEFAN_FIV"
- glib:nick="doublefan-fiv">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="129">Two fans, their axes at the top and bottom, unfold from the center,</doc>
- </member>
- <member name="doublefan_fih"
- value="236"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_DOUBLEFAN_FIH"
- glib:nick="doublefan-fih">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="130">Two fans, their axes at the left and right, unfold from the center,</doc>
- </member>
- <member name="singlesweep_cwtl"
- value="241"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_SINGLESWEEP_CWTL"
- glib:nick="singlesweep-cwtl">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="131">A radial hand sweeps clockwise from the upper-left corner,</doc>
- </member>
- <member name="singlesweep_cwbl"
- value="242"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_SINGLESWEEP_CWBL"
- glib:nick="singlesweep-cwbl">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="132">A radial hand sweeps counter-clockwise from the lower-left corner.,</doc>
- </member>
- <member name="singlesweep_cwbr"
- value="243"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_SINGLESWEEP_CWBR"
- glib:nick="singlesweep-cwbr">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="133">A radial hand sweeps clockwise from the lower-right corner,</doc>
- </member>
- <member name="singlesweep_cwtr"
- value="244"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_SINGLESWEEP_CWTR"
- glib:nick="singlesweep-cwtr">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="134">A radial hand sweeps counter-clockwise from the upper-right corner,</doc>
- </member>
- <member name="doublesweep_pdtl"
- value="245"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_DOUBLESWEEP_PDTL"
- glib:nick="doublesweep-pdtl">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="135">Two radial hands attached at the upper-left and lower-right corners sweep down and up,</doc>
- </member>
- <member name="doublesweep_pdbl"
- value="246"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_DOUBLESWEEP_PDBL"
- glib:nick="doublesweep-pdbl">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="136">Two radial hands attached at the lower-left and upper-right corners sweep down and up,</doc>
- </member>
- <member name="saloondoor_t"
- value="251"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_SALOONDOOR_T"
- glib:nick="saloondoor-t">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="137">Two radial hands attached at the upper-left and upper-right corners sweep down,</doc>
- </member>
- <member name="saloondoor_l"
- value="252"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_SALOONDOOR_L"
- glib:nick="saloondoor-l">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="138">Two radial hands attached at the upper-left and lower-left corners sweep to the right,</doc>
- </member>
- <member name="saloondoor_b"
- value="253"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_SALOONDOOR_B"
- glib:nick="saloondoor-b">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="139">Two radial hands attached at the lower-left and lower-right corners sweep up,</doc>
- </member>
- <member name="saloondoor_r"
- value="254"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_SALOONDOOR_R"
- glib:nick="saloondoor-r">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="140">Two radial hands attached at the upper-right and lower-right corners sweep to the left,</doc>
- </member>
- <member name="windshield_r"
- value="261"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_WINDSHIELD_R"
- glib:nick="windshield-r">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="141">Two radial hands attached at the midpoints of the top and bottom halves sweep from right to left,</doc>
- </member>
- <member name="windshield_u"
- value="262"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_WINDSHIELD_U"
- glib:nick="windshield-u">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="142">Two radial hands attached at the midpoints of the left and right halves sweep from top to bottom,</doc>
- </member>
- <member name="windshield_v"
- value="263"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_WINDSHIELD_V"
- glib:nick="windshield-v">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="143">Two sets of radial hands attached at the midpoints of the top and bottom halves sweep from top to bottom and bottom to top,</doc>
- </member>
- <member name="windshield_h"
- value="264"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_WINDSHIELD_H"
- glib:nick="windshield-h">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="144">Two sets of radial hands attached at the midpoints of the left and right halves sweep from left to right and right to left,</doc>
- </member>
- <member name="crossfade"
- value="512"
- c:identifier="GES_VIDEO_STANDARD_TRANSITION_TYPE_CROSSFADE"
- glib:nick="crossfade">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="145">Crossfade</doc>
- </member>
- </enumeration>
- <enumeration name="VideoTestPattern"
- glib:type-name="GESVideoTestPattern"
- glib:get-type="ges_video_test_pattern_get_type"
- c:type="GESVideoTestPattern">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="282">The test pattern to produce</doc>
- <member name="smpte"
- value="0"
- c:identifier="GES_VIDEO_TEST_PATTERN_SMPTE"
- glib:nick="smpte">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="284">A standard SMPTE test pattern</doc>
- </member>
- <member name="snow"
- value="1"
- c:identifier="GES_VIDEO_TEST_PATTERN_SNOW"
- glib:nick="snow">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="285">Random noise</doc>
- </member>
- <member name="black"
- value="2"
- c:identifier="GES_VIDEO_TEST_PATTERN_BLACK"
- glib:nick="black">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="286">A black image</doc>
- </member>
- <member name="white"
- value="3"
- c:identifier="GES_VIDEO_TEST_PATTERN_WHITE"
- glib:nick="white">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="287">A white image</doc>
- </member>
- <member name="red"
- value="4"
- c:identifier="GES_VIDEO_TEST_PATTERN_RED"
- glib:nick="red">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="288">A red image</doc>
- </member>
- <member name="green"
- value="5"
- c:identifier="GES_VIDEO_TEST_PATTERN_GREEN"
- glib:nick="green">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="289">A green image</doc>
- </member>
- <member name="blue"
- value="6"
- c:identifier="GES_VIDEO_TEST_PATTERN_BLUE"
- glib:nick="blue">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="290">A blue image</doc>
- </member>
- <member name="checkers_1"
- value="7"
- c:identifier="GES_VIDEO_TEST_PATTERN_CHECKERS1"
- glib:nick="checkers-1">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="291">Checkers pattern (1px)</doc>
- </member>
- <member name="checkers_2"
- value="8"
- c:identifier="GES_VIDEO_TEST_PATTERN_CHECKERS2"
- glib:nick="checkers-2">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="292">Checkers pattern (2px)</doc>
- </member>
- <member name="checkers_4"
- value="9"
- c:identifier="GES_VIDEO_TEST_PATTERN_CHECKERS4"
- glib:nick="checkers-4">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="293">Checkers pattern (4px)</doc>
- </member>
- <member name="checkers_8"
- value="10"
- c:identifier="GES_VIDEO_TEST_PATTERN_CHECKERS8"
- glib:nick="checkers-8">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="294">Checkers pattern (8px)</doc>
- </member>
- <member name="circular"
- value="11"
- c:identifier="GES_VIDEO_TEST_PATTERN_CIRCULAR"
- glib:nick="circular">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="295">Circular pattern</doc>
- </member>
- <member name="blink"
- value="12"
- c:identifier="GES_VIDEO_TEST_PATTERN_BLINK"
- glib:nick="blink">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="297">Alternate between black and white</doc>
- </member>
- <member name="smpte75"
- value="13"
- c:identifier="GES_VIDEO_TEST_PATTERN_SMPTE75"
- glib:nick="smpte75">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="301">SMPTE test pattern (75% color bars)</doc>
- </member>
- <member name="zone_plate"
- value="14"
- c:identifier="GES_VIDEO_TEST_ZONE_PLATE"
- glib:nick="zone-plate">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="298">Zone plate</doc>
- </member>
- <member name="gamut"
- value="15"
- c:identifier="GES_VIDEO_TEST_GAMUT"
- glib:nick="gamut">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="299">Gamut checkers</doc>
- </member>
- <member name="chroma_zone_plate"
- value="16"
- c:identifier="GES_VIDEO_TEST_CHROMA_ZONE_PLATE"
- glib:nick="chroma-zone-plate">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="300">Chroma zone plate</doc>
- </member>
- <member name="solid_color"
- value="17"
- c:identifier="GES_VIDEO_TEST_PATTERN_SOLID"
- glib:nick="solid-color">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="296">Solid color</doc>
- </member>
- </enumeration>
- <class name="VideoTestSource"
- c:symbol-prefix="video_test_source"
- c:type="GESVideoTestSource"
- parent="VideoSource"
- glib:type-name="GESVideoTestSource"
- glib:get-type="ges_video_test_source_get_type"
- glib:type-struct="VideoTestSourceClass">
- <doc xml:space="preserve"
- filename="ges/ges-video-test-source.h"
- line="35">### Children Properties
-
- {{ libs/GESVideoTestSource-children-props.md }}</doc>
- <source-position filename="ges/ges-video-test-source.h" line="57"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <method name="get_pattern"
- c:identifier="ges_video_test_source_get_pattern">
- <doc xml:space="preserve"
- filename="ges/ges-video-test-source.c"
- line="291">Get the video pattern used by the @source.</doc>
- <source-position filename="ges/ges-video-test-source.h" line="63"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-test-source.c"
- line="297">The video pattern used by the @source.</doc>
- <type name="VideoTestPattern" c:type="GESVideoTestPattern"/>
- </return-value>
- <parameters>
- <instance-parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-test-source.c"
- line="293">a #GESVideoTestPattern</doc>
- <type name="VideoTestSource" c:type="GESVideoTestSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_pattern"
- c:identifier="ges_video_test_source_set_pattern">
- <doc xml:space="preserve"
- filename="ges/ges-video-test-source.c"
- line="265">Sets the source to use the given @pattern.</doc>
- <source-position filename="ges/ges-video-test-source.h" line="60"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-test-source.c"
- line="267">a #GESVideoTestSource</doc>
- <type name="VideoTestSource" c:type="GESVideoTestSource*"/>
- </instance-parameter>
- <parameter name="pattern" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-test-source.c"
- line="268">a #GESVideoTestPattern</doc>
- <type name="VideoTestPattern" c:type="GESVideoTestPattern"/>
- </parameter>
- </parameters>
- </method>
- <field name="parent" readable="0" private="1">
- <type name="VideoSource" c:type="GESVideoSource"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="VideoTestSourcePrivate"
- c:type="GESVideoTestSourcePrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="VideoTestSourceClass"
- c:type="GESVideoTestSourceClass"
- glib:is-gtype-struct-for="VideoTestSource">
- <source-position filename="ges/ges-video-test-source.h" line="57"/>
- <field name="parent_class">
- <type name="VideoSourceClass" c:type="GESVideoSourceClass"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="VideoTestSourcePrivate"
- c:type="GESVideoTestSourcePrivate"
- disguised="1">
- <source-position filename="ges/ges-video-test-source.h" line="33"/>
- </record>
- <class name="VideoTrack"
- c:symbol-prefix="video_track"
- c:type="GESVideoTrack"
- parent="Track"
- glib:type-name="GESVideoTrack"
- glib:get-type="ges_video_track_get_type"
- glib:type-struct="VideoTrackClass">
- <doc xml:space="preserve"
- filename="ges/ges-video-track.c"
- line="20">A #GESVideoTrack is a default video #GESTrack, with a
-#GES_TRACK_TYPE_VIDEO #GESTrack:track-type and "video/x-raw(ANY)"
-#GESTrack:caps.
-
-By default, a video track will have its #GESTrack:restriction-caps
-set to "video/x-raw" with the following properties:
-
-- width: 1280
-- height: 720
-- framerate: 30/1
-
-These fields are needed for negotiation purposes, but you can change
-their values if you wish. It is advised that you do so using
-ges_track_update_restriction_caps() with new values for the fields you
-wish to change, and any additional fields you may want to add. Unlike
-using ges_track_set_restriction_caps(), this will ensure that these
-default fields will at least have some value set.</doc>
- <source-position filename="ges/ges-video-track.h" line="37"/>
- <implements name="MetaContainer"/>
- <implements name="Gst.ChildProxy"/>
- <constructor name="new" c:identifier="ges_video_track_new">
- <doc xml:space="preserve"
- filename="ges/ges-video-track.c"
- line="155">Creates a new video track, with a #GES_TRACK_TYPE_VIDEO
-#GESTrack:track-type and "video/x-raw(ANY)" #GESTrack:caps, and
-"video/x-raw" #GESTrack:restriction-caps with the properties:
-
-- width: 1280
-- height: 720
-- framerate: 30/1
-
-You should use ges_track_update_restriction_caps() if you wish to
-modify these fields, or add additional ones.</doc>
- <source-position filename="ges/ges-video-track.h" line="51"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-track.c"
- line="169">The newly created video track.</doc>
- <type name="VideoTrack" c:type="GESVideoTrack*"/>
- </return-value>
- </constructor>
- <field name="parent_instance">
- <type name="Track" c:type="GESTrack"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="VideoTrackPrivate" c:type="GESVideoTrackPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="VideoTrackClass"
- c:type="GESVideoTrackClass"
- glib:is-gtype-struct-for="VideoTrack">
- <source-position filename="ges/ges-video-track.h" line="37"/>
- <field name="parent_class">
- <type name="TrackClass" c:type="GESTrackClass"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="VideoTrackPrivate"
- c:type="GESVideoTrackPrivate"
- disguised="1">
- <source-position filename="ges/ges-video-track.h" line="29"/>
- </record>
- <class name="VideoTransition"
- c:symbol-prefix="video_transition"
- c:type="GESVideoTransition"
- parent="Transition"
- glib:type-name="GESVideoTransition"
- glib:get-type="ges_video_transition_get_type"
- glib:type-struct="VideoTransitionClass">
- <source-position filename="ges/ges-video-transition.h" line="59"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <constructor name="new" c:identifier="ges_video_transition_new">
- <source-position filename="ges/ges-video-transition.h" line="62"/>
- <return-value transfer-ownership="none">
- <type name="VideoTransition" c:type="GESVideoTransition*"/>
- </return-value>
- </constructor>
- <method name="get_border" c:identifier="ges_video_transition_get_border">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="577">Get the border property of @self, this value represents
-the border width of the transition.</doc>
- <source-position filename="ges/ges-video-transition.h" line="74"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="584">The border values of @self or -1 if not meaningful
-(this will happen when not using a smpte transition).</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="579">The #GESVideoTransition to get the border from</doc>
- <type name="VideoTransition" c:type="GESVideoTransition*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_transition_type"
- c:identifier="ges_video_transition_get_transition_type">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="662">Get the transition type used by @trans.</doc>
- <source-position filename="ges/ges-video-transition.h" line="68"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="668">The transition type used by @trans.</doc>
- <type name="VideoStandardTransitionType"
- c:type="GESVideoStandardTransitionType"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="664">a #GESVideoTransition</doc>
- <type name="VideoTransition" c:type="GESVideoTransition*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_inverted"
- c:identifier="ges_video_transition_is_inverted">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="619">Get the invert property of @self, this value represents
-the direction of the transition.</doc>
- <source-position filename="ges/ges-video-transition.h" line="80"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="626">The invert value of @self</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="621">The #GESVideoTransition to get the inversion from</doc>
- <type name="VideoTransition" c:type="GESVideoTransition*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_border" c:identifier="ges_video_transition_set_border">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="559">Set the border property of @self, this value represents
-the border width of the transition. In case this value does
-not make sense for the current transition type, it is cached
-for later use.</doc>
- <source-position filename="ges/ges-video-transition.h" line="71"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="561">The #GESVideoTransition to set the border to</doc>
- <type name="VideoTransition" c:type="GESVideoTransition*"/>
- </instance-parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="562">The value of the border to set on @object</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_inverted"
- c:identifier="ges_video_transition_set_inverted">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="601">Set the invert property of @self, this value represents
-the direction of the transition. In case this value does
-not make sense for the current transition type, it is cached
-for later use.</doc>
- <source-position filename="ges/ges-video-transition.h" line="77"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="603">The #GESVideoTransition to set invert on</doc>
- <type name="VideoTransition" c:type="GESVideoTransition*"/>
- </instance-parameter>
- <parameter name="inverted" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="604">%TRUE if the transition should be inverted %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_transition_type"
- c:identifier="ges_video_transition_set_transition_type">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="642">Sets the transition being used to @type.</doc>
- <source-position filename="ges/ges-video-transition.h" line="65"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="649">%TRUE if the transition type was properly changed, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="644">a #GESVideoTransition</doc>
- <type name="VideoTransition" c:type="GESVideoTransition*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="645">a #GESVideoStandardTransitionType</doc>
- <type name="VideoStandardTransitionType"
- c:type="GESVideoStandardTransitionType"/>
- </parameter>
- </parameters>
- </method>
- <property name="border" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="153">This value represents the border width of the transition.</doc>
- <type name="guint" c:type="guint"/>
- </property>
- <property name="invert" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.c"
- line="178">This value represents the direction of the transition.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="transition-type" writable="1" transfer-ownership="none">
- <type name="VideoStandardTransitionType"/>
- </property>
- <field name="parent">
- <type name="Transition" c:type="GESTransition"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="VideoTransitionPrivate"
- c:type="GESVideoTransitionPrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="VideoTransitionClass"
- c:type="GESVideoTransitionClass"
- glib:is-gtype-struct-for="VideoTransition">
- <source-position filename="ges/ges-video-transition.h" line="59"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="ges/ges-video-transition.h"
- line="49">parent class</doc>
- <type name="TransitionClass" c:type="GESTransitionClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="VideoTransitionPrivate"
- c:type="GESVideoTransitionPrivate"
- disguised="1">
- <source-position filename="ges/ges-video-transition.h" line="30"/>
- </record>
- <class name="VideoUriSource"
- c:symbol-prefix="video_uri_source"
- c:type="GESVideoUriSource"
- parent="VideoSource"
- glib:type-name="GESVideoUriSource"
- glib:get-type="ges_video_uri_source_get_type"
- glib:type-struct="VideoUriSourceClass">
- <doc xml:space="preserve"
- filename="ges/ges-video-uri-source.h"
- line="32">### Children Properties
-
- {{ libs/GESVideoUriSource-children-props.md }}</doc>
- <source-position filename="ges/ges-video-uri-source.h" line="57"/>
- <implements name="Extractable"/>
- <implements name="MetaContainer"/>
- <property name="uri"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-video-uri-source.c"
- line="342">The location of the file/resource to use.</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <field name="parent" readable="0" private="1">
- <type name="VideoSource" c:type="GESVideoSource"/>
- </field>
- <field name="uri" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="VideoUriSourcePrivate" c:type="GESVideoUriSourcePrivate*"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="VideoUriSourceClass"
- c:type="GESVideoUriSourceClass"
- glib:is-gtype-struct-for="VideoUriSource">
- <source-position filename="ges/ges-video-uri-source.h" line="57"/>
- <field name="parent_class" readable="0" private="1">
- <type name="VideoSourceClass" c:type="GESVideoSourceClass"/>
- </field>
- <field name="_ges_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="VideoUriSourcePrivate"
- c:type="GESVideoUriSourcePrivate"
- disguised="1">
- <source-position filename="ges/ges-video-uri-source.h" line="30"/>
- </record>
- <class name="XmlFormatter"
- c:symbol-prefix="xml_formatter"
- c:type="GESXmlFormatter"
- parent="BaseXmlFormatter"
- glib:type-name="GESXmlFormatter"
- glib:get-type="ges_xml_formatter_get_type"
- glib:type-struct="XmlFormatterClass">
- <source-position filename="ges/ges-xml-formatter.h" line="42"/>
- <implements name="Extractable"/>
- <field name="parent">
- <type name="BaseXmlFormatter" c:type="GESBaseXmlFormatter"/>
- </field>
- <field name="priv">
- <type name="XmlFormatterPrivate" c:type="GESXmlFormatterPrivate*"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="XmlFormatterClass"
- c:type="GESXmlFormatterClass"
- glib:is-gtype-struct-for="XmlFormatter">
- <source-position filename="ges/ges-xml-formatter.h" line="42"/>
- <field name="parent">
- <type name="BaseXmlFormatterClass" c:type="GESBaseXmlFormatterClass"/>
- </field>
- <field name="_ges_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="XmlFormatterPrivate"
- c:type="GESXmlFormatterPrivate"
- disguised="1">
- <source-position filename="ges/ges-xml-formatter.h" line="26"/>
- </record>
- <function name="add_missing_uri_relocation_uri"
- c:identifier="ges_add_missing_uri_relocation_uri">
- <source-position filename="ges/ges-project.h" line="117"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="recurse" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="deinit" c:identifier="ges_deinit">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="209">Clean up any resources created by GES in ges_init().
-
-It is normally not needed to call this function in a normal application as the
-resources will automatically be freed when the program terminates.
-This function is therefore mostly used by testsuites and other memory profiling tools.
-This function should be called from the thread where ges_init() was called.
-
-After this call GES should not be used until another ges_init() call.</doc>
- <source-position filename="ges/ges.h" line="98"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </function>
- <function name="edge_name"
- c:identifier="ges_edge_name"
- moved-to="Edge.name">
- <source-position filename="ges/ges-enums.h" line="558"/>
- <return-value transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="edge" transfer-ownership="none">
- <type name="Edge" c:type="GESEdge"/>
- </parameter>
- </parameters>
- </function>
- <function name="edit_mode_name"
- c:identifier="ges_edit_mode_name"
- moved-to="EditMode.name"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="525">Return a string representation of @mode.</doc>
- <source-position filename="ges/ges-enums.h" line="535"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="531">a string representation of @mode.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-enums.h"
- line="527">a #GESEditMode</doc>
- <type name="EditMode" c:type="GESEditMode"/>
- </parameter>
- </parameters>
- </function>
- <function name="find_formatter_for_uri"
- c:identifier="ges_find_formatter_for_uri"
- version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="750">Get the best formatter for @uri. It tries to find a formatter
-compatible with @uri extension, if none is found, it returns the default
-formatter asset.</doc>
- <source-position filename="ges/ges-formatter.h" line="156"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-formatter.c"
- line="757">The #GESAsset for the best formatter to save to @uri</doc>
- <type name="Asset" c:type="GESAsset*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="init" c:identifier="ges_init">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="182">Initialize the GStreamer Editing Service. Call this before any usage of
-GES. You should take care of initilizing GStreamer before calling this
-function.
-
-MT safety.
-GStreamer Editing Services do not guarantee MT safety.
-An application is required to use GES APIs (including ges_deinit())
-in the thread where ges_init() was called.</doc>
- <source-position filename="ges/ges.h" line="92"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="init_check" c:identifier="ges_init_check" throws="1">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="354">Initializes the GStreamer Editing Services library, setting up internal path lists,
-and loading evrything needed.
-
-This function will return %FALSE if GES could not be initialized
-for some reason.</doc>
- <source-position filename="ges/ges.h" line="95"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="366">%TRUE if GES could be initialized.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="argc"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="356">pointer to application's argc</doc>
- <type name="gint" c:type="int*"/>
- </parameter>
- <parameter name="argv"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="357">pointer to application's argv</doc>
- <array length="0" zero-terminated="0" c:type="char***">
- <type name="utf8" c:type="char**"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="init_get_option_group"
- c:identifier="ges_init_get_option_group"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="280">Returns a #GOptionGroup with GES's argument specifications. The
-group is set up to use standard GOption callbacks, so when using this
-group in combination with GOption parsing methods, all argument parsing
-and initialization is automated.
-
-This function is useful if you want to integrate GES with other
-libraries that use GOption (see g_option_context_add_group() ).
-
-If you use this function, you should make sure you initialise the GStreamer
-as one of the very first things in your program. That means you need to
-use gst_init_get_option_group() and add it to the option context before
-using the ges_init_get_option_group() result.</doc>
- <source-position filename="ges/ges.h" line="106"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="296">a pointer to GES's option group.</doc>
- <type name="GLib.OptionGroup" c:type="GOptionGroup*"/>
- </return-value>
- </function>
- <function name="is_initialized"
- c:identifier="ges_is_initialized"
- version="1.16">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="407">Use this function to check if GES has been initialized with ges_init()
-or ges_init_check().</doc>
- <source-position filename="ges/ges.h" line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="413">%TRUE if initialization has been done, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="list_assets" c:identifier="ges_list_assets">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1616">List all the assets in the current cache whose
-#GESAsset:extractable-type are of the given type (including
-subclasses).
-
-Note that, since only a #GESExtractable can be extracted from an asset,
-using `GES_TYPE_EXTRACTABLE` as @filter will return all the assets in
-the current cache.</doc>
- <source-position filename="ges/ges-asset.h" line="129"/>
- <return-value transfer-ownership="container">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1628">A list of all
-#GESAsset-s currently in the cache whose #GESAsset:extractable-type is
-of the @filter type.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Asset"/>
- </type>
- </return-value>
- <parameters>
- <parameter name="filter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-asset.c"
- line="1618">The type of object that can be extracted from the asset</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </function>
- <function name="play_sink_convert_frame"
- c:identifier="ges_play_sink_convert_frame"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="ges/ges-screenshot.c"
- line="29">Get the last buffer @playsink showed</doc>
- <doc-deprecated xml:space="preserve">Use the "convert-sample" action signal of
-#playsink instead.</doc-deprecated>
- <source-position filename="ges/ges-screenshot.h" line="29"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges-screenshot.c"
- line="36">A #GstSample containing the last frame from
-@playsink in the format defined by the @caps</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <parameter name="playsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-screenshot.c"
- line="31">The playsink to get last frame from</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="ges/ges-screenshot.c"
- line="32">The caps defining the format the return value will have</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="pspec_equal" c:identifier="ges_pspec_equal">
- <source-position filename="ges/ges-utils.h" line="31"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="key_spec_1"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gconstpointer"/>
- </parameter>
- <parameter name="key_spec_2"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gconstpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="pspec_hash" c:identifier="ges_pspec_hash">
- <source-position filename="ges/ges-utils.h" line="33"/>
- <return-value transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="key_spec"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gconstpointer"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="timeline_get_project"
- c:identifier="ges_timeline_get_project"
- introspectable="0">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.h"
- line="36">Helper macro to retrieve the project from which @obj was extracted</doc>
- <source-position filename="ges/ges-timeline.h" line="42"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="ges/ges-timeline.h"
- line="38">The #GESTimeline from which to retrieve the project</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="track_type_name"
- c:identifier="ges_track_type_name"
- moved-to="TrackType.name">
- <source-position filename="ges/ges-enums.h" line="567"/>
- <return-value transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <type name="TrackType" c:type="GESTrackType"/>
- </parameter>
- </parameters>
- </function>
- <function name="validate_register_action_types"
- c:identifier="ges_validate_register_action_types">
- <source-position filename="ges/ges.h" line="109"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="version" c:identifier="ges_version">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="331">Gets the version number of the GStreamer Editing Services library.</doc>
- <source-position filename="ges/ges.h" line="101"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="major"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="333">pointer to a guint to store the major version number</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="minor"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="334">pointer to a guint to store the minor version number</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="micro"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="335">pointer to a guint to store the micro version number</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="nano"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="ges/ges.c"
- line="336">pointer to a guint to store the nano version number</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- </namespace>
-</repository>
diff --git a/girs/Gst-1.0.gir b/girs/Gst-1.0.gir
deleted file mode 100644
index 9c00ee001c..0000000000
--- a/girs/Gst-1.0.gir
+++ /dev/null
@@ -1,79314 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="GLib" version="2.0"/>
- <include name="GModule" version="2.0"/>
- <include name="GObject" version="2.0"/>
- <package name="gstreamer-1.0"/>
- <c:include name="gst/gst.h"/>
- <namespace name="Gst"
- version="1.0"
- shared-library="libgstreamer-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <alias name="ClockID" c:type="GstClockID">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="61">A datatype to hold the handle to an outstanding sync or async clock callback.</doc>
- <source-position filename="gst/gstclock.h" line="66"/>
- <type name="gpointer" c:type="gpointer"/>
- </alias>
- <alias name="ClockTime" c:type="GstClockTime">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="41">A datatype to hold a time, measured in nanoseconds.</doc>
- <source-position filename="gst/gstclock.h" line="46"/>
- <type name="guint64" c:type="guint64"/>
- </alias>
- <alias name="ClockTimeDiff" c:type="GstClockTimeDiff">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="55">A datatype to hold a time difference, measured in nanoseconds.</doc>
- <source-position filename="gst/gstclock.h" line="60"/>
- <type name="gint64" c:type="gint64"/>
- </alias>
- <alias name="ElementFactoryListType" c:type="GstElementFactoryListType">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.h"
- line="124">A type defining the type of an element factory.</doc>
- <source-position filename="gst/gstelementfactory.h" line="129"/>
- <type name="guint64" c:type="guint64"/>
- </alias>
- <function-macro name="ALLOCATOR"
- c:identifier="GST_ALLOCATOR"
- introspectable="0">
- <source-position filename="gst/gstallocator.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ALLOCATOR_CAST"
- c:identifier="GST_ALLOCATOR_CAST"
- introspectable="0">
- <source-position filename="gst/gstallocator.h" line="40"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ALLOCATOR_CLASS"
- c:identifier="GST_ALLOCATOR_CLASS"
- introspectable="0">
- <source-position filename="gst/gstallocator.h" line="39"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ALLOCATOR_GET_CLASS"
- c:identifier="GST_ALLOCATOR_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstallocator.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="ALLOCATOR_SYSMEM"
- value="SystemMemory"
- c:type="GST_ALLOCATOR_SYSMEM">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="58">The allocator name for the default system memory allocator</doc>
- <source-position filename="gst/gstallocator.h" line="63"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <record name="AllocationParams"
- c:type="GstAllocationParams"
- glib:type-name="GstAllocationParams"
- glib:get-type="gst_allocation_params_get_type"
- c:symbol-prefix="allocation_params">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="65">Parameters to control the allocation of memory</doc>
- <source-position filename="gst/gstallocator.h" line="82"/>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="67">flags to control allocation</doc>
- <type name="MemoryFlags" c:type="GstMemoryFlags"/>
- </field>
- <field name="align" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="68">the desired alignment of the memory</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="prefix" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="69">the desired prefix</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="padding" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="70">the desired padding</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="copy" c:identifier="gst_allocation_params_copy">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="156">Create a copy of @params.
-
-Free-function: gst_allocation_params_free</doc>
- <source-position filename="gst/gstallocator.h" line="175"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="164">a new ##GstAllocationParams, free with
-gst_allocation_params_free().</doc>
- <type name="AllocationParams" c:type="GstAllocationParams*"/>
- </return-value>
- <parameters>
- <instance-parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="158">a #GstAllocationParams</doc>
- <type name="AllocationParams" c:type="const GstAllocationParams*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_allocation_params_free">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="180">Free @params</doc>
- <source-position filename="gst/gstallocator.h" line="178"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="params" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="182">a #GstAllocationParams</doc>
- <type name="AllocationParams" c:type="GstAllocationParams*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_allocation_params_init">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="142">Initialize @params to its default values</doc>
- <source-position filename="gst/gstallocator.h" line="171"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="params" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="144">a #GstAllocationParams</doc>
- <type name="AllocationParams" c:type="GstAllocationParams*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <class name="Allocator"
- c:symbol-prefix="allocator"
- c:type="GstAllocator"
- parent="Object"
- abstract="1"
- glib:type-name="GstAllocator"
- glib:get-type="gst_allocator_get_type"
- glib:type-struct="AllocatorClass">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="22">Memory is usually created by allocators with a gst_allocator_alloc()
-method call. When %NULL is used as the allocator, the default allocator will
-be used.
-
-New allocators can be registered with gst_allocator_register().
-Allocators are identified by name and can be retrieved with
-gst_allocator_find(). gst_allocator_set_default() can be used to change the
-default allocator.
-
-New memory can be created with gst_memory_new_wrapped() that wraps the memory
-allocated elsewhere.</doc>
- <source-position filename="gst/gstallocator.h" line="152"/>
- <function name="find" c:identifier="gst_allocator_find">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="216">Find a previously registered allocator with @name. When @name is %NULL, the
-default allocator will be returned.</doc>
- <source-position filename="gst/gstallocator.h" line="163"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="223">a #GstAllocator or %NULL when
-the allocator with @name was not registered. Use gst_object_unref()
-to release the allocator after usage.</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </return-value>
- <parameters>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="218">the name of the allocator</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="register" c:identifier="gst_allocator_register">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="192">Registers the memory @allocator with @name. This function takes ownership of
-@allocator.</doc>
- <source-position filename="gst/gstallocator.h" line="160"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="194">the name of the allocator</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="allocator" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="195">#GstAllocator</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="alloc" invoker="alloc">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="267">Use @allocator to allocate a new memory block with memory that is at least
-@size big.
-
-The optional @params can specify the prefix and padding for the memory. If
-%NULL is passed, no flags, no extra prefix/padding and a default alignment is
-used.
-
-The prefix/padding will be filled with 0 if flags contains
-#GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively.
-
-When @allocator is %NULL, the default allocator will be used.
-
-The alignment in @params is given as a bitmask so that @align + 1 equals
-the amount of bytes to align to. For example, to align to 8 bytes,
-use an alignment of 7.</doc>
- <source-position filename="gst/gstallocator.h" line="146"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="289">a new #GstMemory.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <instance-parameter name="allocator"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="269">a #GstAllocator to use</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="270">size of the visible memory area</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="271">optional parameters</doc>
- <type name="AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="free" invoker="free">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="317">Free @memory that was previously allocated with gst_allocator_alloc().</doc>
- <source-position filename="gst/gstallocator.h" line="148"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="allocator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="319">a #GstAllocator to use</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </instance-parameter>
- <parameter name="memory" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="320">the memory to free</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="alloc" c:identifier="gst_allocator_alloc">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="267">Use @allocator to allocate a new memory block with memory that is at least
-@size big.
-
-The optional @params can specify the prefix and padding for the memory. If
-%NULL is passed, no flags, no extra prefix/padding and a default alignment is
-used.
-
-The prefix/padding will be filled with 0 if flags contains
-#GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively.
-
-When @allocator is %NULL, the default allocator will be used.
-
-The alignment in @params is given as a bitmask so that @align + 1 equals
-the amount of bytes to align to. For example, to align to 8 bytes,
-use an alignment of 7.</doc>
- <source-position filename="gst/gstallocator.h" line="183"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="289">a new #GstMemory.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <instance-parameter name="allocator"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="269">a #GstAllocator to use</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="270">size of the visible memory area</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="271">optional parameters</doc>
- <type name="AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_allocator_free">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="317">Free @memory that was previously allocated with gst_allocator_alloc().</doc>
- <source-position filename="gst/gstallocator.h" line="187"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="allocator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="319">a #GstAllocator to use</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </instance-parameter>
- <parameter name="memory" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="320">the memory to free</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_default" c:identifier="gst_allocator_set_default">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="245">Set the default allocator. This function takes ownership of @allocator.</doc>
- <source-position filename="gst/gstallocator.h" line="166"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="allocator" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="247">a #GstAllocator</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </instance-parameter>
- </parameters>
- </method>
- <field name="object">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="mem_type">
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="mem_map">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="99">the implementation of the GstMemoryMapFunction</doc>
- <type name="MemoryMapFunction" c:type="GstMemoryMapFunction"/>
- </field>
- <field name="mem_unmap">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="100">the implementation of the GstMemoryUnmapFunction</doc>
- <type name="MemoryUnmapFunction" c:type="GstMemoryUnmapFunction"/>
- </field>
- <field name="mem_copy">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="101">the implementation of the GstMemoryCopyFunction</doc>
- <type name="MemoryCopyFunction" c:type="GstMemoryCopyFunction"/>
- </field>
- <field name="mem_share">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="102">the implementation of the GstMemoryShareFunction</doc>
- <type name="MemoryShareFunction" c:type="GstMemoryShareFunction"/>
- </field>
- <field name="mem_is_span">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="103">the implementation of the GstMemoryIsSpanFunction</doc>
- <type name="MemoryIsSpanFunction" c:type="GstMemoryIsSpanFunction"/>
- </field>
- <field name="mem_map_full">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="104">the implementation of the GstMemoryMapFullFunction.
- Will be used instead of @mem_map if present. (Since: 1.6)</doc>
- <type name="MemoryMapFullFunction" c:type="GstMemoryMapFullFunction"/>
- </field>
- <field name="mem_unmap_full">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="106">the implementation of the GstMemoryUnmapFullFunction.
- Will be used instead of @mem_unmap if present. (Since: 1.6)</doc>
- <type name="MemoryUnmapFullFunction"
- c:type="GstMemoryUnmapFullFunction"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="2">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AllocatorPrivate" c:type="GstAllocatorPrivate*"/>
- </field>
- </class>
- <record name="AllocatorClass"
- c:type="GstAllocatorClass"
- glib:is-gtype-struct-for="Allocator">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="134">The #GstAllocator is used to create new memory.</doc>
- <source-position filename="gst/gstallocator.h" line="152"/>
- <field name="object_class">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="136">Object parent class</doc>
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="alloc">
- <callback name="alloc">
- <source-position filename="gst/gstallocator.h" line="146"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="289">a new #GstMemory.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <parameter name="allocator"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="269">a #GstAllocator to use</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="270">size of the visible memory area</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="271">optional parameters</doc>
- <type name="AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="free">
- <callback name="free">
- <source-position filename="gst/gstallocator.h" line="148"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="allocator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="319">a #GstAllocator to use</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </parameter>
- <parameter name="memory" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="320">the memory to free</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <bitfield name="AllocatorFlags"
- glib:type-name="GstAllocatorFlags"
- glib:get-type="gst_allocator_flags_get_type"
- c:type="GstAllocatorFlags">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="84">Flags for allocators.</doc>
- <member name="custom_alloc"
- value="16"
- c:identifier="GST_ALLOCATOR_FLAG_CUSTOM_ALLOC"
- glib:nick="custom-alloc">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="86">The allocator has a custom alloc function.</doc>
- </member>
- <member name="last"
- value="1048576"
- c:identifier="GST_ALLOCATOR_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstallocator.h"
- line="87">first flag that can be used for custom purposes</doc>
- </member>
- </bitfield>
- <record name="AllocatorPrivate" c:type="GstAllocatorPrivate" disguised="1">
- <source-position filename="gst/gstallocator.h" line="31"/>
- </record>
- <record name="AtomicQueue"
- c:type="GstAtomicQueue"
- glib:type-name="GstAtomicQueue"
- glib:get-type="gst_atomic_queue_get_type"
- c:symbol-prefix="atomic_queue">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="31">The #GstAtomicQueue object implements a queue that can be used from multiple
-threads without performing any blocking operations.</doc>
- <source-position filename="gst/gstatomicqueue.h" line="41"/>
- <constructor name="new" c:identifier="gst_atomic_queue_new">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="146">Create a new atomic queue instance. @initial_size will be rounded up to the
-nearest power of 2 and used as the initial size of the queue.</doc>
- <source-position filename="gst/gstatomicqueue.h" line="48"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="153">a new #GstAtomicQueue</doc>
- <type name="AtomicQueue" c:type="GstAtomicQueue*"/>
- </return-value>
- <parameters>
- <parameter name="initial_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="148">initial queue size</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="length" c:identifier="gst_atomic_queue_length">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="391">Get the amount of items in the queue.</doc>
- <source-position filename="gst/gstatomicqueue.h" line="66"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="397">the number of elements in the queue.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="393">a #GstAtomicQueue</doc>
- <type name="AtomicQueue" c:type="GstAtomicQueue*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="peek" c:identifier="gst_atomic_queue_peek">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="211">Peek the head element of the queue without removing it from the queue.</doc>
- <source-position filename="gst/gstatomicqueue.h" line="63"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="217">the head element of @queue or
-%NULL when the queue is empty.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="213">a #GstAtomicQueue</doc>
- <type name="AtomicQueue" c:type="GstAtomicQueue*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pop" c:identifier="gst_atomic_queue_pop">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="261">Get the head element of the queue.</doc>
- <source-position filename="gst/gstatomicqueue.h" line="60"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="267">the head element of @queue or %NULL when
-the queue is empty.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="263">a #GstAtomicQueue</doc>
- <type name="AtomicQueue" c:type="GstAtomicQueue*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="push" c:identifier="gst_atomic_queue_push">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="330">Append @data to the tail of the queue.</doc>
- <source-position filename="gst/gstatomicqueue.h" line="57"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="332">a #GstAtomicQueue</doc>
- <type name="AtomicQueue" c:type="GstAtomicQueue*"/>
- </instance-parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="333">the data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_atomic_queue_ref">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="172">Increase the refcount of @queue.</doc>
- <source-position filename="gst/gstatomicqueue.h" line="51"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="174">a #GstAtomicQueue</doc>
- <type name="AtomicQueue" c:type="GstAtomicQueue*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_atomic_queue_unref">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="196">Unref @queue and free the memory when the refcount reaches 0.</doc>
- <source-position filename="gst/gstatomicqueue.h" line="54"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstatomicqueue.c"
- line="198">a #GstAtomicQueue</doc>
- <type name="AtomicQueue" c:type="GstAtomicQueue*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <function-macro name="BIN" c:identifier="GST_BIN" introspectable="0">
- <source-position filename="gst/gstbin.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BIN_CAST"
- c:identifier="GST_BIN_CAST"
- introspectable="0">
- <source-position filename="gst/gstbin.h" line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BIN_CHILDREN"
- c:identifier="GST_BIN_CHILDREN"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="84">Gets the list with children in a bin.</doc>
- <source-position filename="gst/gstbin.h" line="90"/>
- <parameters>
- <parameter name="bin">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="86">a #GstBin</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BIN_CHILDREN_COOKIE"
- c:identifier="GST_BIN_CHILDREN_COOKIE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="91">Gets the children cookie that watches the children list.</doc>
- <source-position filename="gst/gstbin.h" line="97"/>
- <parameters>
- <parameter name="bin">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="93">a #GstBin</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BIN_CLASS"
- c:identifier="GST_BIN_CLASS"
- introspectable="0">
- <source-position filename="gst/gstbin.h" line="38"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BIN_GET_CLASS"
- c:identifier="GST_BIN_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstbin.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BIN_IS_NO_RESYNC"
- c:identifier="GST_BIN_IS_NO_RESYNC"
- version="1.0.5"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="62">Check if @bin will resync its state change when elements are added and
-removed.</doc>
- <source-position filename="gst/gstbin.h" line="71"/>
- <parameters>
- <parameter name="bin">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="64">A #GstBin</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BIN_NUMCHILDREN"
- c:identifier="GST_BIN_NUMCHILDREN"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="77">Gets the number of children in a bin.</doc>
- <source-position filename="gst/gstbin.h" line="83"/>
- <parameters>
- <parameter name="bin">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="79">a #GstBin</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER" c:identifier="GST_BUFFER" introspectable="0">
- <source-position filename="gst/gstbuffer.h" line="44"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_CAST"
- c:identifier="GST_BUFFER_CAST"
- introspectable="0">
- <source-position filename="gst/gstbuffer.h" line="43"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="BUFFER_COPY_ALL" value="15" c:type="GST_BUFFER_COPY_ALL">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="530">Combination of all possible fields that can be copied with
-gst_buffer_copy_into().</doc>
- <source-position filename="gst/gstbuffer.h" line="535"/>
- <type name="BufferCopyFlags" c:type="GstBufferCopyFlags"/>
- </constant>
- <constant name="BUFFER_COPY_METADATA"
- value="7"
- c:type="GST_BUFFER_COPY_METADATA">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="521">Combination of all possible metadata fields that can be copied with
-gst_buffer_copy_into().</doc>
- <source-position filename="gst/gstbuffer.h" line="527"/>
- <type name="BufferCopyFlags" c:type="GstBufferCopyFlags"/>
- </constant>
- <function-macro name="BUFFER_DTS"
- c:identifier="GST_BUFFER_DTS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="89">The decoding timestamp (dts) in nanoseconds (as a #GstClockTime)
-of the data in the buffer. This is the timestamp when the media should be
-decoded or processed otherwise.
-Value will be %GST_CLOCK_TIME_NONE if the dts is unknown.</doc>
- <source-position filename="gst/gstbuffer.h" line="98"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="91">a #GstBuffer.:</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_DTS_IS_VALID"
- c:identifier="GST_BUFFER_DTS_IS_VALID"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="153">Tests if the dts is known.</doc>
- <source-position filename="gst/gstbuffer.h" line="159"/>
- <parameters>
- <parameter name="buffer">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="155">a #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_DTS_OR_PTS"
- c:identifier="GST_BUFFER_DTS_OR_PTS"
- version="1.8"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="99">Returns the buffer decoding timestamp (dts) if valid, else the buffer
-presentation time (pts)</doc>
- <source-position filename="gst/gstbuffer.h" line="108"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="101">a #GstBuffer.:</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_DURATION"
- c:identifier="GST_BUFFER_DURATION"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="109">The duration in nanoseconds (as a #GstClockTime) of the data in the buffer.
-Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.</doc>
- <source-position filename="gst/gstbuffer.h" line="116"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="111">a #GstBuffer.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_DURATION_IS_VALID"
- c:identifier="GST_BUFFER_DURATION_IS_VALID"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="139">Tests if the duration is known.</doc>
- <source-position filename="gst/gstbuffer.h" line="145"/>
- <parameters>
- <parameter name="buffer">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="141">a #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_FLAGS"
- c:identifier="GST_BUFFER_FLAGS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="46">A flags word containing #GstBufferFlags flags set on this buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="52"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="48">a #GstBuffer.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_FLAG_IS_SET"
- c:identifier="GST_BUFFER_FLAG_IS_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="53">Gives the status of a specific flag on a buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="60"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="55">a #GstBuffer.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="56">the #GstBufferFlags flag to check.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_FLAG_SET"
- c:identifier="GST_BUFFER_FLAG_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="61">Sets a buffer flag on a buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="68"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="63">a #GstBuffer.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="64">the #GstBufferFlags flag to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_FLAG_UNSET"
- c:identifier="GST_BUFFER_FLAG_UNSET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="69">Clears a buffer flag.</doc>
- <source-position filename="gst/gstbuffer.h" line="76"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="71">a #GstBuffer.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="72">the #GstBufferFlags flag to clear.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_IS_DISCONT"
- c:identifier="GST_BUFFER_IS_DISCONT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="174">Tests if the buffer marks a discontinuity in the stream.</doc>
- <source-position filename="gst/gstbuffer.h" line="180"/>
- <parameters>
- <parameter name="buffer">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="176">a #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_LIST"
- c:identifier="GST_BUFFER_LIST"
- introspectable="0">
- <source-position filename="gst/gstbufferlist.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_LIST_CAST"
- c:identifier="GST_BUFFER_LIST_CAST"
- introspectable="0">
- <source-position filename="gst/gstbufferlist.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_OFFSET"
- c:identifier="GST_BUFFER_OFFSET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="117">The offset in the source file of the beginning of this buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="123"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="119">a #GstBuffer.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_OFFSET_END"
- c:identifier="GST_BUFFER_OFFSET_END"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="124">The offset in the source file of the end of this buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="130"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="126">a #GstBuffer.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_OFFSET_END_IS_VALID"
- c:identifier="GST_BUFFER_OFFSET_END_IS_VALID"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="167">Tests if the end offset is known.</doc>
- <source-position filename="gst/gstbuffer.h" line="173"/>
- <parameters>
- <parameter name="buffer">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="169">a #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_OFFSET_IS_VALID"
- c:identifier="GST_BUFFER_OFFSET_IS_VALID"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="160">Tests if the start offset is known.</doc>
- <source-position filename="gst/gstbuffer.h" line="166"/>
- <parameters>
- <parameter name="buffer">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="162">a #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="BUFFER_OFFSET_NONE"
- value="18446744073709551615"
- c:type="GST_BUFFER_OFFSET_NONE">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="132">Constant for no-offset return results.</doc>
- <source-position filename="gst/gstbuffer.h" line="137"/>
- <type name="guint64" c:type="guint64"/>
- </constant>
- <function-macro name="BUFFER_POOL"
- c:identifier="GST_BUFFER_POOL"
- introspectable="0">
- <source-position filename="gst/gstbufferpool.h" line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_POOL_CAST"
- c:identifier="GST_BUFFER_POOL_CAST"
- introspectable="0">
- <source-position filename="gst/gstbufferpool.h" line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_POOL_CLASS"
- c:identifier="GST_BUFFER_POOL_CLASS"
- introspectable="0">
- <source-position filename="gst/gstbufferpool.h" line="40"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_POOL_GET_CLASS"
- c:identifier="GST_BUFFER_POOL_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstbufferpool.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_POOL_IS_FLUSHING"
- c:identifier="GST_BUFFER_POOL_IS_FLUSHING"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="90">Check if the bufferpool is flushing. Subclasses might want to check the
-state of the pool in the acquire function.</doc>
- <source-position filename="gst/gstbufferpool.h" line="97"/>
- <parameters>
- <parameter name="pool">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="92">a GstBufferPool</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_PTS"
- c:identifier="GST_BUFFER_PTS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="79">The presentation timestamp (pts) in nanoseconds (as a #GstClockTime)
-of the data in the buffer. This is the timestamp when the media should be
-presented to the user.
-Value will be %GST_CLOCK_TIME_NONE if the pts is unknown.</doc>
- <source-position filename="gst/gstbuffer.h" line="88"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="81">a #GstBuffer.:</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUFFER_PTS_IS_VALID"
- c:identifier="GST_BUFFER_PTS_IS_VALID"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="146">Tests if the pts is known.</doc>
- <source-position filename="gst/gstbuffer.h" line="152"/>
- <parameters>
- <parameter name="buffer">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="148">a #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUS" c:identifier="GST_BUS" introspectable="0">
- <source-position filename="gst/gstbus.h" line="36"/>
- <parameters>
- <parameter name="bus">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUS_CAST"
- c:identifier="GST_BUS_CAST"
- introspectable="0">
- <source-position filename="gst/gstbus.h" line="41"/>
- <parameters>
- <parameter name="bus">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUS_CLASS"
- c:identifier="GST_BUS_CLASS"
- introspectable="0">
- <source-position filename="gst/gstbus.h" line="38"/>
- <parameters>
- <parameter name="bclass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BUS_GET_CLASS"
- c:identifier="GST_BUS_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstbus.h" line="40"/>
- <parameters>
- <parameter name="bus">
- </parameter>
- </parameters>
- </function-macro>
- <class name="Bin"
- c:symbol-prefix="bin"
- c:type="GstBin"
- parent="Element"
- glib:type-name="GstBin"
- glib:get-type="gst_bin_get_type"
- glib:type-struct="BinClass">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="26">#GstBin is an element that can contain other #GstElement, allowing them to be
-managed as a group.
-Pads from the child elements can be ghosted to the bin, see #GstGhostPad.
-This makes the bin look like any other elements and enables creation of
-higher-level abstraction elements.
-
-A new #GstBin is created with gst_bin_new(). Use a #GstPipeline instead if you
-want to create a toplevel bin because a normal bin doesn't have a bus or
-handle clock distribution of its own.
-
-After the bin has been created you will typically add elements to it with
-gst_bin_add(). You can remove elements with gst_bin_remove().
-
-An element can be retrieved from a bin with gst_bin_get_by_name(), using the
-elements name. gst_bin_get_by_name_recurse_up() is mainly used for internal
-purposes and will query the parent bins when the element is not found in the
-current bin.
-
-An iterator of elements in a bin can be retrieved with
-gst_bin_iterate_elements(). Various other iterators exist to retrieve the
-elements in a bin.
-
-gst_object_unref() is used to drop your reference to the bin.
-
-The #GstBin::element-added signal is fired whenever a new element is added to
-the bin. Likewise the #GstBin::element-removed signal is fired whenever an
-element is removed from the bin.
-
-## Notes
-
-A #GstBin internally intercepts every #GstMessage posted by its children and
-implements the following default behaviour for each of them:
-
-* GST_MESSAGE_EOS: This message is only posted by sinks in the PLAYING
-state. If all sinks posted the EOS message, this bin will post and EOS
-message upwards.
-
-* GST_MESSAGE_SEGMENT_START: Just collected and never forwarded upwards.
-The messages are used to decide when all elements have completed playback
-of their segment.
-
-* GST_MESSAGE_SEGMENT_DONE: Is posted by #GstBin when all elements that posted
-a SEGMENT_START have posted a SEGMENT_DONE.
-
-* GST_MESSAGE_DURATION_CHANGED: Is posted by an element that detected a change
-in the stream duration. The duration change is posted to the
-application so that it can refetch the new duration with a duration
-query. Note that these messages can be posted before the bin is
-prerolled, in which case the duration query might fail. Note also that
-there might be a discrepancy (due to internal buffering/queueing) between the
-stream being currently displayed and the returned duration query.
-Applications might want to also query for duration (and changes) by
-listening to the GST_MESSAGE_STREAM_START message, signaling the active start
-of a (new) stream.
-
-* GST_MESSAGE_CLOCK_LOST: This message is posted by an element when it
-can no longer provide a clock. The default bin behaviour is to
-check if the lost clock was the one provided by the bin. If so and
-the bin is currently in the PLAYING state, the message is forwarded to
-the bin parent.
-This message is also generated when a clock provider is removed from
-the bin. If this message is received by the application, it should
-PAUSE the pipeline and set it back to PLAYING to force a new clock
-distribution.
-
-* GST_MESSAGE_CLOCK_PROVIDE: This message is generated when an element
-can provide a clock. This mostly happens when a new clock
-provider is added to the bin. The default behaviour of the bin is to
-mark the currently selected clock as dirty, which will perform a clock
-recalculation the next time the bin is asked to provide a clock.
-This message is never sent tot the application but is forwarded to
-the parent of the bin.
-
-* OTHERS: posted upwards.
-
-A #GstBin implements the following default behaviour for answering to a
-#GstQuery:
-
-* GST_QUERY_DURATION: The bin will forward the query to all sink
-elements contained within and will return the maximum value.
-If no sinks are available in the bin, the query fails.
-
-* GST_QUERY_POSITION:The query is sent to all sink elements in the bin and the
-MAXIMUM of all values is returned. If no sinks are available in the bin,
-the query fails.
-
-* OTHERS:the query is forwarded to all sink elements, the result
-of the first sink that answers the query successfully is returned. If no
-sink is in the bin, the query fails.
-
-A #GstBin will by default forward any event sent to it to all sink
-(#GST_EVENT_TYPE_DOWNSTREAM) or source (#GST_EVENT_TYPE_UPSTREAM) elements
-depending on the event type.
-If all the elements return %TRUE, the bin will also return %TRUE, else %FALSE
-is returned. If no elements of the required type are in the bin, the event
-handler will return %TRUE.</doc>
- <source-position filename="gst/gstbin.h" line="193"/>
- <implements name="ChildProxy"/>
- <constructor name="new" c:identifier="gst_bin_new">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="534">Creates a new bin with the given name.</doc>
- <source-position filename="gst/gstbin.h" line="199"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="540">a new #GstBin</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="536">the name of the new bin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <virtual-method name="add_element">
- <source-position filename="gst/gstbin.h" line="177"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="element" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="deep_element_added">
- <source-position filename="gst/gstbin.h" line="188"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="sub_bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="child" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="deep_element_removed">
- <source-position filename="gst/gstbin.h" line="189"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="sub_bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="child" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="do_latency">
- <source-position filename="gst/gstbin.h" line="184"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="element_added">
- <source-position filename="gst/gstbin.h" line="172"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="element_removed">
- <source-position filename="gst/gstbin.h" line="173"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="handle_message">
- <source-position filename="gst/gstbin.h" line="180"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="none">
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="remove_element">
- <source-position filename="gst/gstbin.h" line="178"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="element" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add" c:identifier="gst_bin_add">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1506">Adds the given element to the bin. Sets the element's parent, and thus
-takes ownership of the element. An element can only be added to one bin.
-
-If the element's pads are linked to other pads, the pads will be unlinked
-before the element is added to the bin.
-
-&gt; When you add an element to an already-running pipeline, you will have to
-&gt; take care to set the state of the newly-added element to the desired
-&gt; state (usually PLAYING or PAUSED, same you set the pipeline to originally)
-&gt; with gst_element_set_state(), or use gst_element_sync_state_with_parent().
-&gt; The bin or pipeline will not take care of this for you.
-
-MT safe.</doc>
- <source-position filename="gst/gstbin.h" line="204"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1525">%TRUE if the element could be added, %FALSE if
-the bin does not want to accept the element.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1508">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1509">the #GstElement to add</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_many"
- c:identifier="gst_bin_add_many"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2684">Adds a %NULL-terminated list of elements to a bin. This function is
-equivalent to calling gst_bin_add() for each member of the list. The return
-value of each gst_bin_add() is ignored.</doc>
- <source-position filename="gst/gstutils.h" line="1134"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2686">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="element_1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2687">the #GstElement element to add to the bin</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2688">additional elements to add to the bin</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="find_unlinked_pad"
- c:identifier="gst_bin_find_unlinked_pad">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3286">Recursively looks for elements with an unlinked pad of the given
-direction within the specified bin and returns an unlinked pad
-if one is found, or %NULL otherwise. If a pad is found, the caller
-owns a reference to it and should use gst_object_unref() on the
-pad when it is not needed any longer.</doc>
- <source-position filename="gst/gstutils.h" line="1140"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3297">unlinked pad of the given
-direction, %NULL.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3288">bin in which to look for elements with unlinked pads</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="direction" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3289">whether to look for an unlinked source or sink pad</doc>
- <type name="PadDirection" c:type="GstPadDirection"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_by_interface" c:identifier="gst_bin_get_by_interface">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4504">Looks for an element inside the bin that implements the given
-interface. If such an element is found, it returns the element.
-You can cast this element to the given interface afterwards. If you want
-all elements that implement the interface, use
-gst_bin_iterate_all_by_interface(). This function recurses into child bins.
-
-MT safe. Caller owns returned reference.</doc>
- <source-position filename="gst/gstbin.h" line="218"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4517">A #GstElement inside the bin
-implementing the interface</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4506">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="iface" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4507">the #GType of an interface</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_by_name" c:identifier="gst_bin_get_by_name">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4405">Gets the element with the given name from a bin. This
-function recurses into child bins.
-
-Returns %NULL if no element with the given name is found in the bin.
-
-MT safe. Caller owns returned reference.</doc>
- <source-position filename="gst/gstbin.h" line="212"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4417">the #GstElement with the given
-name, or %NULL</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4407">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4408">the element name to search for</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_by_name_recurse_up"
- c:identifier="gst_bin_get_by_name_recurse_up">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4448">Gets the element with the given name from this bin. If the
-element is not found, a recursion is performed on the parent bin.
-
-Returns %NULL if:
-- no element with the given name is found in the bin
-
-MT safe. Caller owns returned reference.</doc>
- <source-position filename="gst/gstbin.h" line="215"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4461">the #GstElement with the given
-name, or %NULL</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4450">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4451">the element name to search for</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_suppressed_flags"
- c:identifier="gst_bin_get_suppressed_flags"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1434">Return the suppressed flags of the bin.
-
-MT safe.</doc>
- <source-position filename="gst/gstbin.h" line="254"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1442">the bin's suppressed #GstElementFlags.</doc>
- <type name="ElementFlags" c:type="GstElementFlags"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1436">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="iterate_all_by_element_factory_name"
- c:identifier="gst_bin_iterate_all_by_element_factory_name"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4602">Looks for all elements inside the bin with the given element factory name.
-The function recurses inside child bins. The iterator will yield a series of
-#GstElement that should be unreffed after use.
-
-MT safe. Caller owns returned value.</doc>
- <source-position filename="gst/gstbin.h" line="241"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4613">a #GstIterator of #GstElement
- for all elements in the bin with the given element factory name,
- or %NULL.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4604">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="factory_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4605">the name of the #GstElementFactory</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="iterate_all_by_interface"
- c:identifier="gst_bin_iterate_all_by_interface">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4551">Looks for all elements inside the bin that implements the given
-interface. You can safely cast all returned elements to the given interface.
-The function recurses inside child bins. The iterator will yield a series
-of #GstElement that should be unreffed after use.
-
-MT safe. Caller owns returned value.</doc>
- <source-position filename="gst/gstbin.h" line="238"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4563">a #GstIterator of #GstElement
- for all elements in the bin implementing the given interface,
- or %NULL</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4553">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="iface" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="4554">the #GType of an interface</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="iterate_elements" c:identifier="gst_bin_iterate_elements">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1914">Gets an iterator for the elements in this bin.
-
-MT safe. Caller owns returned value.</doc>
- <source-position filename="gst/gstbin.h" line="223"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1922">a #GstIterator of #GstElement,
-or %NULL</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1916">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="iterate_recurse" c:identifier="gst_bin_iterate_recurse">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1954">Gets an iterator for the elements in this bin.
-This iterator recurses into GstBin children.
-
-MT safe. Caller owns returned value.</doc>
- <source-position filename="gst/gstbin.h" line="229"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1963">a #GstIterator of #GstElement,
-or %NULL</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1956">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="iterate_sinks" c:identifier="gst_bin_iterate_sinks">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="2012">Gets an iterator for all elements in the bin that have the
-#GST_ELEMENT_FLAG_SINK flag set.
-
-MT safe. Caller owns returned value.</doc>
- <source-position filename="gst/gstbin.h" line="232"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="2021">a #GstIterator of #GstElement,
-or %NULL</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="2014">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="iterate_sorted" c:identifier="gst_bin_iterate_sorted">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="2462">Gets an iterator for the elements in this bin in topologically
-sorted order. This means that the elements are returned from
-the most downstream elements (sinks) to the sources.
-
-This function is used internally to perform the state changes
-of the bin elements and for clock selection.
-
-MT safe. Caller owns returned value.</doc>
- <source-position filename="gst/gstbin.h" line="226"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="2475">a #GstIterator of #GstElement,
-or %NULL</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="2464">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="iterate_sources" c:identifier="gst_bin_iterate_sources">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="2073">Gets an iterator for all elements in the bin that have the
-#GST_ELEMENT_FLAG_SOURCE flag set.
-
-MT safe. Caller owns returned value.</doc>
- <source-position filename="gst/gstbin.h" line="235"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="2082">a #GstIterator of #GstElement,
-or %NULL</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="2075">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="recalculate_latency"
- c:identifier="gst_bin_recalculate_latency">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="2745">Query @bin for the current latency using and reconfigures this latency to all the
-elements with a LATENCY event.
-
-This method is typically called on the pipeline when a #GST_MESSAGE_LATENCY
-is posted on the bus.
-
-This function simply emits the 'do-latency' signal so any custom latency
-calculations will be performed.</doc>
- <source-position filename="gst/gstbin.h" line="246"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="2758">%TRUE if the latency could be queried and reconfigured.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="2747">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove" c:identifier="gst_bin_remove">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1861">Removes the element from the bin, unparenting it as well.
-Unparenting the element means that the element will be dereferenced,
-so if the bin holds the only reference to the element, the element
-will be freed in the process of removing it from the bin. If you
-want the element to still exist after removing, you need to call
-gst_object_ref() before removing it from the bin.
-
-If the element's pads are linked to other pads, the pads will be unlinked
-before the element is removed from the bin.
-
-MT safe.</doc>
- <source-position filename="gst/gstbin.h" line="207"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1878">%TRUE if the element could be removed, %FALSE if
-the bin does not want to remove the element.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1863">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1864">the #GstElement to remove</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_many"
- c:identifier="gst_bin_remove_many"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2713">Remove a list of elements from a bin. This function is equivalent
-to calling gst_bin_remove() with each member of the list.</doc>
- <source-position filename="gst/gstutils.h" line="1137"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2715">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="element_1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2716">the first #GstElement to remove from the bin</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2717">%NULL-terminated list of elements to remove from the bin</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="set_suppressed_flags"
- c:identifier="gst_bin_set_suppressed_flags"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1407">Suppress the given flags on the bin. #GstElementFlags of a
-child element are propagated when it is added to the bin.
-When suppressed flags are set, those specified flags will
-not be propagated to the bin.
-
-MT safe.</doc>
- <source-position filename="gst/gstbin.h" line="251"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1409">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="1410">the #GstElementFlags to suppress</doc>
- <type name="ElementFlags" c:type="GstElementFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="sync_children_states"
- c:identifier="gst_bin_sync_children_states"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3358">Synchronizes the state of every child of @bin with the state
-of @bin. See also gst_element_sync_state_with_parent().</doc>
- <source-position filename="gst/gstutils.h" line="1143"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3365">%TRUE if syncing the state was successful for all children,
- otherwise %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3360">a #GstBin</doc>
- <type name="Bin" c:type="GstBin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <property name="async-handling" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="345">If set to %TRUE, the bin will handle asynchronous state changes.
-This should be used only if the bin subclass is modifying the state
-of its children on its own.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="message-forward" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="428">Forward all children messages, even those that would normally be filtered by
-the bin. This can be interesting when one wants to be notified of the EOS
-state of individual elements, for example.
-
-The messages are converted to an ELEMENT message with the bin as the
-source. The structure of the message is named 'GstBinForwarded' and contains
-a field named 'message' of type GST_TYPE_MESSAGE that contains the original
-forwarded message.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="element">
- <type name="Element" c:type="GstElement"/>
- </field>
- <field name="numchildren">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="101">the number of children in this bin</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="children">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="102">the list of children in this bin</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Element"/>
- </type>
- </field>
- <field name="children_cookie">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="103">updated whenever @children changes</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="child_bus">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="104">internal bus for handling child messages</doc>
- <type name="Bus" c:type="GstBus*"/>
- </field>
- <field name="messages">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="105">queued and cached messages</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Message"/>
- </type>
- </field>
- <field name="polling">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="106">the bin is currently calculating its state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="state_dirty">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="107">the bin needs to recalculate its state (deprecated)</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="clock_dirty">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="108">the bin needs to select a new clock</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="provided_clock">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="109">the last clock selected</doc>
- <type name="Clock" c:type="GstClock*"/>
- </field>
- <field name="clock_provider">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="110">the element that provided @provided_clock</doc>
- <type name="Element" c:type="GstElement*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="BinPrivate" c:type="GstBinPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="deep-element-added" when="first" version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="379">Will be emitted after the element was added to sub_bin.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="sub_bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="382">the #GstBin the element was added to</doc>
- <type name="Bin"/>
- </parameter>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="383">the #GstElement that was added to @sub_bin</doc>
- <type name="Element"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="deep-element-removed" when="first" version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="393">Will be emitted after the element was removed from sub_bin.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="sub_bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="396">the #GstBin the element was removed from</doc>
- <type name="Bin"/>
- </parameter>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="397">the #GstElement that was removed from @sub_bin</doc>
- <type name="Element"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="do-latency" when="last">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="407">Will be emitted when the bin needs to perform latency calculations. This
-signal is only emitted for toplevel bins or when async-handling is
-enabled.
-
-Only one signal handler is invoked. If no signals are connected, the
-default handler is invoked, which will query and distribute the lowest
-possible latency to all sinks.
-
-Connect to this signal if the default latency calculations are not
-sufficient, like when you need different latencies for different sinks in
-the same pipeline.</doc>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </glib:signal>
- <glib:signal name="element-added" when="first">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="357">Will be emitted after the element was added to the bin.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="360">the #GstElement that was added to the bin</doc>
- <type name="Element"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="element-removed" when="first">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="368">Will be emitted after the element was removed from the bin.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbin.c"
- line="371">the #GstElement that was removed from the bin</doc>
- <type name="Element"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="BinClass"
- c:type="GstBinClass"
- glib:is-gtype-struct-for="Bin">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="141">Subclasses can override the @add_element and @remove_element to
-update the list of children in the bin.
-
-The @handle_message method can be overridden to implement custom
-message handling. @handle_message takes ownership of the message, just like
-#gst_element_post_message.
-
-The @deep_element_added vfunc will be called when a new element has been
-added to any bin inside this bin, so it will also be called if a new child
-was added to a sub-bin of this bin. #GstBin implementations that override
-this message should chain up to the parent class implementation so the
-#GstBin::deep-element-added signal is emitted on all parents.</doc>
- <source-position filename="gst/gstbin.h" line="193"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="143">bin parent class</doc>
- <type name="ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="pool" readable="0" private="1">
- <type name="GLib.ThreadPool" c:type="GThreadPool*"/>
- </field>
- <field name="element_added">
- <callback name="element_added">
- <source-position filename="gst/gstbin.h" line="172"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="child" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="element_removed">
- <callback name="element_removed">
- <source-position filename="gst/gstbin.h" line="173"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="child" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="add_element">
- <callback name="add_element">
- <source-position filename="gst/gstbin.h" line="177"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="element" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="remove_element">
- <callback name="remove_element">
- <source-position filename="gst/gstbin.h" line="178"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="element" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="handle_message">
- <callback name="handle_message">
- <source-position filename="gst/gstbin.h" line="180"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="message" transfer-ownership="none">
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="do_latency">
- <callback name="do_latency">
- <source-position filename="gst/gstbin.h" line="184"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="deep_element_added">
- <callback name="deep_element_added">
- <source-position filename="gst/gstbin.h" line="188"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="sub_bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="child" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="deep_element_removed">
- <callback name="deep_element_removed">
- <source-position filename="gst/gstbin.h" line="189"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="sub_bin" transfer-ownership="none">
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="child" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="2">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <bitfield name="BinFlags"
- glib:type-name="GstBinFlags"
- glib:get-type="gst_bin_flags_get_type"
- c:type="GstBinFlags">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="41">GstBinFlags are a set of flags specific to bins. Most are set/used
-internally. They can be checked using the GST_OBJECT_FLAG_IS_SET () macro,
-and (un)set using GST_OBJECT_FLAG_SET () and GST_OBJECT_FLAG_UNSET ().</doc>
- <member name="no_resync"
- value="16384"
- c:identifier="GST_BIN_FLAG_NO_RESYNC"
- glib:nick="no-resync">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="43">don't resync a state change when elements are
- added or linked in the bin (Since: 1.0.5)</doc>
- </member>
- <member name="streams_aware"
- value="32768"
- c:identifier="GST_BIN_FLAG_STREAMS_AWARE"
- glib:nick="streams-aware">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="45">Indicates whether the bin can handle elements
- that add/remove source pads at any point in time without
- first posting a no-more-pads signal (Since: 1.10)</doc>
- </member>
- <member name="last"
- value="524288"
- c:identifier="GST_BIN_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstbin.h"
- line="48">the last enum in the series of flags for bins.
-Derived classes can use this as first value in a list of flags.</doc>
- </member>
- </bitfield>
- <record name="BinPrivate" c:type="GstBinPrivate" disguised="1">
- <source-position filename="gst/gstbin.h" line="75"/>
- </record>
- <class name="Bitmask"
- c:symbol-prefix="bitmask"
- glib:type-name="GstBitmask"
- glib:get-type="gst_bitmask_get_type"
- glib:fundamental="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="358">A fundamental type that describes a 64-bit bitmask</doc>
- </class>
- <record name="Buffer"
- c:type="GstBuffer"
- glib:type-name="GstBuffer"
- glib:get-type="gst_buffer_get_type"
- c:symbol-prefix="buffer">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="23">Buffers are the basic unit of data transfer in GStreamer. They contain the
-timing and offset along with other arbitrary metadata that is associated
-with the #GstMemory blocks that the buffer contains.
-
-Buffers are usually created with gst_buffer_new(). After a buffer has been
-created one will typically allocate memory for it and add it to the buffer.
-The following example creates a buffer that can hold a given video frame
-with a given width, height and bits per plane.
-|[&lt;!-- language="C" --&gt;
- GstBuffer *buffer;
- GstMemory *memory;
- gint size, width, height, bpp;
- ...
- size = width * height * bpp;
- buffer = gst_buffer_new ();
- memory = gst_allocator_alloc (NULL, size, NULL);
- gst_buffer_insert_memory (buffer, -1, memory);
- ...
-]|
-
-Alternatively, use gst_buffer_new_allocate() to create a buffer with
-preallocated data of a given size.
-
-Buffers can contain a list of #GstMemory objects. You can retrieve how many
-memory objects with gst_buffer_n_memory() and you can get a pointer
-to memory with gst_buffer_peek_memory()
-
-A buffer will usually have timestamps, and a duration, but neither of these
-are guaranteed (they may be set to #GST_CLOCK_TIME_NONE). Whenever a
-meaningful value can be given for these, they should be set. The timestamps
-and duration are measured in nanoseconds (they are #GstClockTime values).
-
-The buffer DTS refers to the timestamp when the buffer should be decoded and
-is usually monotonically increasing. The buffer PTS refers to the timestamp when
-the buffer content should be presented to the user and is not always
-monotonically increasing.
-
-A buffer can also have one or both of a start and an end offset. These are
-media-type specific. For video buffers, the start offset will generally be
-the frame number. For audio buffers, it will be the number of samples
-produced so far. For compressed data, it could be the byte offset in a
-source or destination file. Likewise, the end offset will be the offset of
-the end of the buffer. These can only be meaningfully interpreted if you
-know the media type of the buffer (the preceding CAPS event). Either or both
-can be set to #GST_BUFFER_OFFSET_NONE.
-
-gst_buffer_ref() is used to increase the refcount of a buffer. This must be
-done when you want to keep a handle to the buffer after pushing it to the
-next element. The buffer refcount determines the writability of the buffer, a
-buffer is only writable when the refcount is exactly 1, i.e. when the caller
-has the only reference to the buffer.
-
-To efficiently create a smaller buffer out of an existing one, you can
-use gst_buffer_copy_region(). This method tries to share the memory objects
-between the two buffers.
-
-If a plug-in wants to modify the buffer data or metadata in-place, it should
-first obtain a buffer that is safe to modify by using
-gst_buffer_make_writable(). This function is optimized so that a copy will
-only be made when it is necessary.
-
-Several flags of the buffer can be set and unset with the
-GST_BUFFER_FLAG_SET() and GST_BUFFER_FLAG_UNSET() macros. Use
-GST_BUFFER_FLAG_IS_SET() to test if a certain #GstBufferFlags flag is set.
-
-Buffers can be efficiently merged into a larger buffer with
-gst_buffer_append(). Copying of memory will only be done when absolutely
-needed.
-
-Arbitrary extra metadata can be set on a buffer with gst_buffer_add_meta().
-Metadata can be retrieved with gst_buffer_get_meta(). See also #GstMeta
-
-An element should either unref the buffer or push it out on a src pad
-using gst_pad_push() (see #GstPad).
-
-Buffers are usually freed by unreffing them with gst_buffer_unref(). When
-the refcount drops to 0, any memory and metadata pointed to by the buffer is
-unreffed as well. Buffers allocated from a #GstBufferPool will be returned to
-the pool when the refcount drops to 0.
-
-The #GstParentBufferMeta is a meta which can be attached to a #GstBuffer
-to hold a reference to another buffer that is only released when the child
-#GstBuffer is released.
-
-Typically, #GstParentBufferMeta is used when the child buffer is directly
-using the #GstMemory of the parent buffer, and wants to prevent the parent
-buffer from being returned to a buffer pool until the #GstMemory is available
-for re-use. (Since: 1.6)</doc>
- <source-position filename="gst/gstbuffer.h" line="278"/>
- <field name="mini_object" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="243">the parent structure</doc>
- <type name="MiniObject" c:type="GstMiniObject"/>
- </field>
- <field name="pool" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="244">pointer to the pool owner of the buffer</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </field>
- <field name="pts" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="245">presentation timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
- pts is not known or relevant. The pts contains the timestamp when the
- media should be presented to the user.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="dts" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="248">decoding timestamp of the buffer, can be #GST_CLOCK_TIME_NONE when the
- dts is not known or relevant. The dts contains the timestamp when the
- media should be processed.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="duration" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="251">duration in time of the buffer data, can be #GST_CLOCK_TIME_NONE
- when the duration is not known or relevant.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="offset" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="253">a media specific offset for the buffer data.
- For video frames, this is the frame number of this buffer.
- For audio samples, this is the offset of the first sample in this buffer.
- For file data or compressed data this is the byte offset of the first
- byte in this buffer.</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="offset_end" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="258">the last offset contained in this buffer. It has the same
- format as @offset.</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <constructor name="new" c:identifier="gst_buffer_new">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="836">Creates a newly allocated buffer without any data.
-
-MT safe.</doc>
- <source-position filename="gst/gstbuffer.h" line="289"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="843">the new #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- </constructor>
- <constructor name="new_allocate" c:identifier="gst_buffer_new_allocate">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="858">Tries to create a newly allocated buffer with data of the given size and
-extra parameters from @allocator. If the requested amount of memory can't be
-allocated, %NULL will be returned. The allocated buffer memory is not cleared.
-
-When @allocator is %NULL, the default memory allocator will be used.
-
-Note that when @size == 0, the buffer will not have memory associated with it.
-
-MT safe.</doc>
- <source-position filename="gst/gstbuffer.h" line="292"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="875">a new #GstBuffer, or %NULL if
- the memory couldn't be allocated.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="allocator"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="860">the #GstAllocator to use, or %NULL to use the
- default allocator</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="862">the size in bytes of the new buffer's data.</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="863">optional parameters</doc>
- <type name="AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_wrapped" c:identifier="gst_buffer_new_wrapped">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1004">Creates a new buffer that wraps the given @data. The memory will be freed
-with g_free and will be marked writable.
-
-MT safe.</doc>
- <source-position filename="gst/gstbuffer.h" line="299"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1014">a new #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1006">data to wrap</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1007">allocated size of @data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_wrapped_bytes"
- c:identifier="gst_buffer_new_wrapped_bytes"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1022">Creates a new #GstBuffer that wraps the given @bytes. The data inside
-@bytes cannot be %NULL and the resulting buffer will be marked as read only.
-
-MT safe.</doc>
- <source-position filename="gst/gstbuffer.h" line="301"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1031">a new #GstBuffer wrapping @bytes</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="bytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1024">a #GBytes to wrap</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_wrapped_full"
- c:identifier="gst_buffer_new_wrapped_full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="964">Allocate a new buffer that wraps the given memory. @data must point to
-@maxsize of memory, the wrapped buffer will have the region from @offset and
-@size visible.
-
-When the buffer is destroyed, @notify will be called with @user_data.
-
-The prefix/padding must be filled with 0 if @flags contains
-#GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively.</doc>
- <source-position filename="gst/gstbuffer.h" line="295"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="983">a new #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="966">#GstMemoryFlags</doc>
- <type name="MemoryFlags" c:type="GstMemoryFlags"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="967">data to wrap</doc>
- <array length="4" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="maxsize" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="968">allocated size of @data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="969">offset in @data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="970">size of valid data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="971">user_data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="async"
- closure="5">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="972">called with @user_data when the memory is freed</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="add_custom_meta"
- c:identifier="gst_buffer_add_custom_meta"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2875">Creates and adds a #GstCustomMeta for the desired @name. @name must have
-been successfully registered with gst_meta_register_custom().</doc>
- <source-position filename="gst/gstbuffer.h" line="668"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2883">The #GstCustomMeta that was added to the buffer</doc>
- <type name="CustomMeta" c:type="GstCustomMeta*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2877">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2878">the registered name of the desired custom meta</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_meta" c:identifier="gst_buffer_add_meta">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2271">Add metadata for @info to @buffer using the parameters in @params.</doc>
- <source-position filename="gst/gstbuffer.h" line="650"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2279">the metadata for the api in @info on @buffer.</doc>
- <type name="Meta" c:type="GstMeta*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2273">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2274">a #GstMetaInfo</doc>
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2275">params for @info</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_parent_buffer_meta"
- c:identifier="gst_buffer_add_parent_buffer_meta"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2574">Add a #GstParentBufferMeta to @buffer that holds a reference on
-@ref until the buffer is freed.</doc>
- <source-position filename="gst/gstbuffer.h" line="753"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2582">The #GstParentBufferMeta that was added to the buffer</doc>
- <type name="ParentBufferMeta" c:type="GstParentBufferMeta*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2576">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="ref" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2577">a #GstBuffer to ref</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_protection_meta"
- c:identifier="gst_buffer_add_protection_meta"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstprotection.c"
- line="127">Attaches protection metadata to a #GstBuffer.</doc>
- <source-position filename="gst/gstprotection.h" line="90"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstprotection.c"
- line="137">a pointer to the added #GstProtectionMeta if successful; %NULL if
-unsuccessful.</doc>
- <type name="ProtectionMeta" c:type="GstProtectionMeta*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstprotection.c"
- line="129">#GstBuffer holding an encrypted sample, to which protection
- metadata should be added.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstprotection.c"
- line="131">a #GstStructure holding cryptographic
- information relating to the sample contained in @buffer. This
- function takes ownership of @info.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_reference_timestamp_meta"
- c:identifier="gst_buffer_add_reference_timestamp_meta"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2705">Add a #GstReferenceTimestampMeta to @buffer that holds a @timestamp and
-optionally @duration based on a specific timestamp @reference. See the
-documentation of #GstReferenceTimestampMeta for details.</doc>
- <source-position filename="gst/gstbuffer.h" line="798"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2716">The #GstReferenceTimestampMeta that was added to the buffer</doc>
- <type name="ReferenceTimestampMeta"
- c:type="GstReferenceTimestampMeta*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2707">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="reference" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2708">identifier for the timestamp reference.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2709">timestamp</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2710">duration, or %GST_CLOCK_TIME_NONE</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="append" c:identifier="gst_buffer_append">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2152">Append all the memory from @buf2 to @buf1. The result buffer will contain a
-concatenation of the memory of @buf1 and @buf2.</doc>
- <source-position filename="gst/gstbuffer.h" line="617"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2160">the new #GstBuffer that contains the memory
- of the two source buffers.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf1" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2154">the first source #GstBuffer to append.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="buf2" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2155">the second source #GstBuffer to append.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="append_memory" c:identifier="gst_buffer_append_memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1083">Append the memory block @mem to @buffer. This function takes
-ownership of @mem and thus doesn't increase its refcount.
-
-This function is identical to gst_buffer_insert_memory() with an index of -1.
-See gst_buffer_insert_memory() for more details.</doc>
- <source-position filename="gst/gstbuffer.h" line="327"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1085">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="mem" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1086">a #GstMemory.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- </parameters>
- </method>
- <method name="append_region" c:identifier="gst_buffer_append_region">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2169">Append @size bytes at @offset from @buf2 to @buf1. The result buffer will
-contain a concatenation of the memory of @buf1 and the requested region of
-@buf2.</doc>
- <source-position filename="gst/gstbuffer.h" line="614"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2180">the new #GstBuffer that contains the memory
- of the two source buffers.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf1" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2171">the first source #GstBuffer to append.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="buf2" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2172">the second source #GstBuffer to append.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2173">the offset in @buf2</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2174">the size or -1 of @buf2</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_buffer_copy" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="469">Create a copy of the given buffer. This will only copy the buffer's
-data to a newly allocated memory if needed (if the type of memory
-requires it), otherwise the underlying data is just referenced.
-Check gst_buffer_copy_deep() if you want to force the data
-to be copied to newly allocated memory.</doc>
- <source-position filename="gst/gstbuffer.h" line="481"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="479">a new copy of @buf.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="471">a #GstBuffer.</doc>
- <type name="Buffer" c:type="const GstBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="copy_deep"
- c:identifier="gst_buffer_copy_deep"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="728">Create a copy of the given buffer. This will make a newly allocated
-copy of the data the source buffer contains.</doc>
- <source-position filename="gst/gstbuffer.h" line="489"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="735">a new copy of @buf.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="730">a #GstBuffer.</doc>
- <type name="Buffer" c:type="const GstBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="copy_into" c:identifier="gst_buffer_copy_into">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="519">Copies the information from @src into @dest.
-
-If @dest already contains memory and @flags contains GST_BUFFER_COPY_MEMORY,
-the memory from @src will be appended to @dest.
-
-@flags indicate which fields will be copied.</doc>
- <source-position filename="gst/gstbuffer.h" line="541"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="534">%TRUE if the copying succeeded, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="521">a destination #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="522">a source #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="523">flags indicating what metadata fields should be copied.</doc>
- <type name="BufferCopyFlags" c:type="GstBufferCopyFlags"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="524">offset to copy from</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="525">total size to copy. If -1, all data is copied.</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy_region" c:identifier="gst_buffer_copy_region">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2109">Creates a sub-buffer from @parent at @offset and @size.
-This sub-buffer uses the actual memory space of the parent buffer.
-This function will copy the offset and timestamp fields when the
-offset is 0. If not, they will be set to #GST_CLOCK_TIME_NONE and
-#GST_BUFFER_OFFSET_NONE.
-If @offset equals 0 and @size equals the total size of @buffer, the
-duration and offset end fields are also copied. If not they will be set
-to #GST_CLOCK_TIME_NONE and #GST_BUFFER_OFFSET_NONE.
-
-MT safe.</doc>
- <source-position filename="gst/gstbuffer.h" line="608"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2129">the new #GstBuffer or %NULL if the arguments were
- invalid.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2111">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2112">the #GstBufferCopyFlags</doc>
- <type name="BufferCopyFlags" c:type="GstBufferCopyFlags"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2113">the offset into parent #GstBuffer at which the new sub-buffer
- begins.</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2115">the size of the new #GstBuffer sub-buffer, in bytes. If -1, all
- data is copied.</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="extract" c:identifier="gst_buffer_extract">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1957">Copy @size bytes starting from @offset in @buffer to @dest.</doc>
- <source-position filename="gst/gstbuffer.h" line="360"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1967">The amount of bytes extracted. This value can be lower than @size
- when @buffer did not contain enough data.</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1959">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1960">the offset to extract</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1961">
- the destination address</doc>
- <array length="2" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1963">the size to extract</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="extract_dup"
- c:identifier="gst_buffer_extract_dup"
- version="1.0.10">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2539">Extracts a copy of at most @size bytes the data at @offset into
-newly-allocated memory. @dest must be freed using g_free() when done.</doc>
- <source-position filename="gst/gstbuffer.h" line="396"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2541">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2542">the offset to extract</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2543">the size to extract</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2544">A pointer where
- the destination array will be written. Might be %NULL if the size is 0.</doc>
- <array length="3" zero-terminated="0" c:type="gpointer*">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="dest_size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2546">A location where the size of @dest can be written</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </method>
- <method name="fill" c:identifier="gst_buffer_fill">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1905">Copy @size bytes from @src to @buffer at @offset.</doc>
- <source-position filename="gst/gstbuffer.h" line="357"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1914">The amount of bytes copied. This value can be lower than @size
- when @buffer did not contain enough data.</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1907">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1908">the offset to fill</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1909">the source address</doc>
- <array length="2" zero-terminated="0" c:type="gconstpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1910">the size to fill</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="find_memory" c:identifier="gst_buffer_find_memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1359">Find the memory blocks that span @size bytes starting from @offset
-in @buffer.
-
-When this function returns %TRUE, @idx will contain the index of the first
-memory block where the byte for @offset can be found and @length contains the
-number of memory blocks containing the @size remaining bytes. @skip contains
-the number of bytes to skip in the memory block at @idx to get to the byte
-for @offset.
-
-@size can be -1 to get all the memory blocks after @idx.</doc>
- <source-position filename="gst/gstbuffer.h" line="348"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1379">%TRUE when @size bytes starting from @offset could be found in
-@buffer and @idx, @length and @skip will be filled.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1361">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1362">an offset</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1363">a size</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="idx"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1364">pointer to index</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="length"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1365">pointer to length</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="skip"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1366">pointer to skip</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </method>
- <method name="foreach_meta" c:identifier="gst_buffer_foreach_meta">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2467">Call @func with @user_data for each meta in @buffer.
-
-@func can modify the passed meta pointer or its contents. The return value
-of @func define if this function returns or if the remaining metadata items
-in the buffer should be skipped.</doc>
- <source-position filename="gst/gstbuffer.h" line="663"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2479">%FALSE when @func returned %FALSE for one of the metadata.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2469">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2470">a #GstBufferForeachMetaFunc to call</doc>
- <type name="BufferForeachMetaFunc"
- c:type="GstBufferForeachMetaFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2471">user data passed to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_all_memory" c:identifier="gst_buffer_get_all_memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1193">Get all the memory block in @buffer. The memory blocks will be merged
-into one large #GstMemory.</doc>
- <source-position filename="gst/gstbuffer.h" line="339"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1200">a #GstMemory that contains the merged memory.
-Use gst_memory_unref () after usage.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1195">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_custom_meta"
- c:identifier="gst_buffer_get_custom_meta"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2906">Find the first #GstCustomMeta on @buffer for the desired @name.</doc>
- <source-position filename="gst/gstbuffer.h" line="672"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2913">the #GstCustomMeta or %NULL when there
-is no such metadata on @buffer.</doc>
- <type name="CustomMeta" c:type="GstCustomMeta*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2908">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2909">the registered name of the custom meta to retrieve.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_flags"
- c:identifier="gst_buffer_get_flags"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="353">Get the #GstBufferFlags flags set on this buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="400"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="359">the flags set on this buffer.</doc>
- <type name="BufferFlags" c:type="GstBufferFlags"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="355">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_memory" c:identifier="gst_buffer_get_memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1177">Get the memory block at index @idx in @buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="336"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1184">a #GstMemory that contains the data of the
-memory block at @idx. Use gst_memory_unref () after usage.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1179">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1180">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_memory_range"
- c:identifier="gst_buffer_get_memory_range">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1209">Get @length memory blocks in @buffer starting at @idx. The memory blocks will
-be merged into one large #GstMemory.
-
-If @length is -1, all memory starting from @idx is merged.</doc>
- <source-position filename="gst/gstbuffer.h" line="318"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1220">a #GstMemory that contains the merged data of @length
- blocks starting at @idx. Use gst_memory_unref () after usage.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1211">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1212">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1213">a length</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_meta" c:identifier="gst_buffer_get_meta">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2215">Get the metadata for @api on buffer. When there is no such metadata, %NULL is
-returned. If multiple metadata with the given @api are attached to this
-buffer only the first one is returned. To handle multiple metadata with a
-given API use gst_buffer_iterate_meta() or gst_buffer_foreach_meta() instead
-and check the meta-&gt;info.api member for the API type.</doc>
- <source-position filename="gst/gstbuffer.h" line="644"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2226">the metadata for @api on
-@buffer.</doc>
- <type name="Meta" c:type="GstMeta*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2217">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="api" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2218">the #GType of an API</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_n_meta"
- c:identifier="gst_buffer_get_n_meta"
- version="1.14">
- <source-position filename="gst/gstbuffer.h" line="647"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2254">number of metas of type @api_type on @buffer.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2251">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="api_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2252">the #GType of an API</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_reference_timestamp_meta"
- c:identifier="gst_buffer_get_reference_timestamp_meta"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2743">Find the first #GstReferenceTimestampMeta on @buffer that conforms to
-@reference. Conformance is tested by checking if the meta's reference is a
-subset of @reference.
-
-Buffers can contain multiple #GstReferenceTimestampMeta metadata items.</doc>
- <source-position filename="gst/gstbuffer.h" line="804"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2754">the #GstReferenceTimestampMeta or %NULL when there
-is no such metadata on @buffer.</doc>
- <type name="ReferenceTimestampMeta"
- c:type="GstReferenceTimestampMeta*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2745">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="reference"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2746">a reference #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_size" c:identifier="gst_buffer_get_size">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1516">Get the total size of the memory blocks in @buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="378"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1522">total size of the memory blocks in @buffer.</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1518">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_sizes" c:identifier="gst_buffer_get_sizes">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1494">Get the total size of the memory blocks in @b.
-
-When not %NULL, @offset will contain the offset of the data in the
-first memory block in @buffer and @maxsize will contain the sum of
-the size and @offset and the amount of extra padding on the last
-memory block. @offset and @maxsize can be used to resize the
-buffer memory blocks with gst_buffer_resize().</doc>
- <source-position filename="gst/gstbuffer.h" line="375"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1508">total size of the memory blocks in @buffer.</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1496">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="offset"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1497">a pointer to the offset</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- <parameter name="maxsize"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1498">a pointer to the maxsize</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_sizes_range" c:identifier="gst_buffer_get_sizes_range">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1539">Get the total size of @length memory blocks stating from @idx in @buffer.
-
-When not %NULL, @offset will contain the offset of the data in the
-memory block in @buffer at @idx and @maxsize will contain the sum of the size
-and @offset and the amount of extra padding on the memory block at @idx +
-@length -1.
-@offset and @maxsize can be used to resize the buffer memory blocks with
-gst_buffer_resize_range().</doc>
- <source-position filename="gst/gstbuffer.h" line="369"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1556">total size of @length memory blocks starting at @idx in @buffer.</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1541">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1542">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1543">a length</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="offset"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1544">a pointer to the offset</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- <parameter name="maxsize"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1545">a pointer to the maxsize</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </method>
- <method name="has_flags"
- c:identifier="gst_buffer_has_flags"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="369">Gives the status of a specific flag on a buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="403"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="376">%TRUE if all flags in @flags are found on @buffer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="371">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="372">the #GstBufferFlags flag to check.</doc>
- <type name="BufferFlags" c:type="GstBufferFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert_memory" c:identifier="gst_buffer_insert_memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1100">Insert the memory block @mem to @buffer at @idx. This function takes ownership
-of @mem and thus doesn't increase its refcount.
-
-Only gst_buffer_get_max_memory() can be added to a buffer. If more memory is
-added, existing memory blocks will automatically be merged to make room for
-the new memory.</doc>
- <source-position filename="gst/gstbuffer.h" line="309"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1102">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1103">the index to add the memory at, or -1 to append it to the end</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="mem" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1104">a #GstMemory.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_all_memory_writable"
- c:identifier="gst_buffer_is_all_memory_writable"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1475">Check if all memory blocks in @buffer are writable.
-
-Note that this function does not check if @buffer is writable, use
-gst_buffer_is_writable() to check that if needed.</doc>
- <source-position filename="gst/gstbuffer.h" line="354"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1484">%TRUE if all memory blocks in @buffer are writable</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1477">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_memory_range_writable"
- c:identifier="gst_buffer_is_memory_range_writable"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1432">Check if @length memory blocks in @buffer starting from @idx are writable.
-
-@length can be -1 to check all the memory blocks after @idx.
-
-Note that this function does not check if @buffer is writable, use
-gst_buffer_is_writable() to check that if needed.</doc>
- <source-position filename="gst/gstbuffer.h" line="351"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1445">%TRUE if the memory range is writable</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1434">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1435">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1436">a length should not be 0</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="iterate_meta"
- c:identifier="gst_buffer_iterate_meta"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2389">Retrieve the next #GstMeta after @current. If @state points
-to %NULL, the first metadata is returned.
-
-@state will be updated with an opaque state pointer</doc>
- <source-position filename="gst/gstbuffer.h" line="656"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2399">The next #GstMeta or %NULL
-when there are no more items.</doc>
- <type name="Meta" c:type="GstMeta*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2391">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="state"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none"
- nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2392">an opaque state pointer</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="iterate_meta_filtered"
- c:identifier="gst_buffer_iterate_meta_filtered"
- version="1.12"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2424">Retrieve the next #GstMeta of type @meta_api_type after the current one
-according to @state. If @state points to %NULL, the first metadata of
-type @meta_api_type is returned.
-
-@state will be updated with an opaque state pointer</doc>
- <source-position filename="gst/gstbuffer.h" line="659"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2436">The next #GstMeta of type
-@meta_api_type or %NULL when there are no more items.</doc>
- <type name="Meta" c:type="GstMeta*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2426">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="state"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none"
- nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2427">an opaque state pointer</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="meta_api_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2428">only return #GstMeta of this type</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="map" c:identifier="gst_buffer_map">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1756">This function fills @info with the #GstMapInfo of all merged memory
-blocks in @buffer.
-
-@flags describe the desired access of the memory. When @flags is
-#GST_MAP_WRITE, @buffer should be writable (as returned from
-gst_buffer_is_writable()).
-
-When @buffer is writable but the memory isn't, a writable copy will
-automatically be created and returned. The readonly copy of the
-buffer memory will then also be replaced with this writable copy.
-
-The memory in @info should be unmapped with gst_buffer_unmap() after
-usage.</doc>
- <source-position filename="gst/gstbuffer.h" line="390"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1776">%TRUE if the map succeeded and @info contains valid data.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1758">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="info"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1759">info about the mapping</doc>
- <type name="MapInfo" c:type="GstMapInfo*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1760">flags for the mapping</doc>
- <type name="MapFlags" c:type="GstMapFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="map_range" c:identifier="gst_buffer_map_range">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1784">This function fills @info with the #GstMapInfo of @length merged memory blocks
-starting at @idx in @buffer. When @length is -1, all memory blocks starting
-from @idx are merged and mapped.
-
-@flags describe the desired access of the memory. When @flags is
-#GST_MAP_WRITE, @buffer should be writable (as returned from
-gst_buffer_is_writable()).
-
-When @buffer is writable but the memory isn't, a writable copy will
-automatically be created and returned. The readonly copy of the buffer memory
-will then also be replaced with this writable copy.
-
-The memory in @info should be unmapped with gst_buffer_unmap() after usage.</doc>
- <source-position filename="gst/gstbuffer.h" line="387"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1806">%TRUE if the map succeeded and @info contains valid
-data.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1786">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1787">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1788">a length</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="info"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1789">info about the mapping</doc>
- <type name="MapInfo" c:type="GstMapInfo*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1790">flags for the mapping</doc>
- <type name="MapFlags" c:type="GstMapFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="memcmp" c:identifier="gst_buffer_memcmp">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2008">Compare @size bytes starting from @offset in @buffer with the memory in @mem.</doc>
- <source-position filename="gst/gstbuffer.h" line="363"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2017">0 if the memory is equal.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2010">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2011">the offset in @buffer</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2012">the memory to compare</doc>
- <array length="2" zero-terminated="0" c:type="gconstpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2013">the size to compare</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="memset" c:identifier="gst_buffer_memset">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2061">Fill @buf with @size bytes with @val starting from @offset.</doc>
- <source-position filename="gst/gstbuffer.h" line="366"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2070">The amount of bytes filled. This value can be lower than @size
- when @buffer did not contain enough data.</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2063">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2064">the offset in @buffer</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2065">the value to set</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2066">the size to set</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="n_memory" c:identifier="gst_buffer_n_memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1049">Get the amount of memory blocks that this buffer has. This amount is never
-larger than what gst_buffer_get_max_memory() returns.</doc>
- <source-position filename="gst/gstbuffer.h" line="306"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1056">the number of memory blocks this buffer is made of.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1051">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="peek_memory" c:identifier="gst_buffer_peek_memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1157">Get the memory block at @idx in @buffer. The memory block stays valid until
-the memory block in @buffer is removed, replaced or merged, typically with
-any call that modifies the memory in @buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="315"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1166">the #GstMemory at @idx.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1159">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1160">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="prepend_memory" c:identifier="gst_buffer_prepend_memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1066">Prepend the memory block @mem to @buffer. This function takes
-ownership of @mem and thus doesn't increase its refcount.
-
-This function is identical to gst_buffer_insert_memory() with an index of 0.
-See gst_buffer_insert_memory() for more details.</doc>
- <source-position filename="gst/gstbuffer.h" line="324"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1068">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="mem" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1069">a #GstMemory.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_buffer_ref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="414">Increases the refcount of the given buffer by one.
-
-Note that the refcount affects the writability
-of @buf and its metadata, see gst_buffer_is_writable().
-It is important to note that keeping additional references to
-GstBuffer instances can potentially increase the number
-of memcpy operations in a pipeline.</doc>
- <source-position filename="gst/gstbuffer.h" line="428"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="426">@buf</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="416">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_all_memory"
- c:identifier="gst_buffer_remove_all_memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1316">Remove all the memory blocks in @buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="345"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1318">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_memory" c:identifier="gst_buffer_remove_memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1303">Remove the memory block in @b at index @i.</doc>
- <source-position filename="gst/gstbuffer.h" line="342"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1305">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1306">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_memory_range"
- c:identifier="gst_buffer_remove_memory_range">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1329">Remove @length memory blocks in @buffer starting from @idx.
-
-@length can be -1, in which case all memory starting from @idx is removed.</doc>
- <source-position filename="gst/gstbuffer.h" line="321"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1331">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1332">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1333">a length</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_meta" c:identifier="gst_buffer_remove_meta">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2335">Remove the metadata for @meta on @buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="653"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2342">%TRUE if the metadata existed and was removed, %FALSE if no such
-metadata was on @buffer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2337">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2338">a #GstMeta</doc>
- <type name="Meta" c:type="GstMeta*"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_all_memory"
- c:identifier="gst_buffer_replace_all_memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1255">Replaces all memory in @buffer with @mem.</doc>
- <source-position filename="gst/gstbuffer.h" line="333"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1257">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="mem" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1258">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_memory" c:identifier="gst_buffer_replace_memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1241">Replaces the memory block at index @idx in @buffer with @mem.</doc>
- <source-position filename="gst/gstbuffer.h" line="330"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1243">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1244">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="mem" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1245">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_memory_range"
- c:identifier="gst_buffer_replace_memory_range">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1268">Replaces @length memory blocks in @buffer starting at @idx with @mem.
-
-If @length is -1, all memory starting from @idx will be removed and
-replaced with @mem.
-
-@buffer should be writable.</doc>
- <source-position filename="gst/gstbuffer.h" line="312"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1270">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1271">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1272">a length should not be 0</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="mem" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1273">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- </parameters>
- </method>
- <method name="resize" c:identifier="gst_buffer_resize">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1621">Set the offset and total size of the memory blocks in @buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="381"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1623">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1624">the offset adjustment</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1625">the new size or -1 to just adjust the offset</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- </parameters>
- </method>
- <method name="resize_range" c:identifier="gst_buffer_resize_range">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1648">Set the total size of the @length memory blocks starting at @idx in
-@buffer</doc>
- <source-position filename="gst/gstbuffer.h" line="372"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1659">%TRUE if resizing succeeded, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1650">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1651">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1652">a length</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1653">the offset adjustment</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1654">the new size or -1 to just adjust the offset</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_flags"
- c:identifier="gst_buffer_set_flags"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="386">Sets one or more buffer flags on a buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="406"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="393">%TRUE if @flags were successfully set on buffer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="388">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="389">the #GstBufferFlags to set.</doc>
- <type name="BufferFlags" c:type="GstBufferFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_size" c:identifier="gst_buffer_set_size">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1635">Set the total size of the memory blocks in @buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="384"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1637">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1638">the new size</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- </parameters>
- </method>
- <method name="unmap" c:identifier="gst_buffer_unmap">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1884">Release the memory previously mapped with gst_buffer_map().</doc>
- <source-position filename="gst/gstbuffer.h" line="393"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1886">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="1887">a #GstMapInfo</doc>
- <type name="MapInfo" c:type="GstMapInfo*"/>
- </parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_buffer_unref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="435">Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
-with the associated metadata and memory will be freed.</doc>
- <source-position filename="gst/gstbuffer.h" line="442"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="437">a #GstBuffer.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unset_flags"
- c:identifier="gst_buffer_unset_flags"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="404">Clears one or more buffer flags.</doc>
- <source-position filename="gst/gstbuffer.h" line="409"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="411">true if @flags is successfully cleared from buffer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="406">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="407">the #GstBufferFlags to clear</doc>
- <type name="BufferFlags" c:type="GstBufferFlags"/>
- </parameter>
- </parameters>
- </method>
- <function name="get_max_memory"
- c:identifier="gst_buffer_get_max_memory"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="500">Get the maximum amount of memory blocks that a buffer can hold. This is a
-compile time constant that can be queried with the function.
-
-When more memory blocks are added, existing memory blocks will be merged
-together to make room for the new block.</doc>
- <source-position filename="gst/gstbuffer.h" line="284"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="509">the maximum amount of memory blocks that a buffer can hold.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- </function>
- <function name="replace"
- c:identifier="gst_buffer_replace"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="582">Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
-modification is done atomically (so this is useful for ensuring thread safety
-in some cases), and the reference counts are updated appropriately (the old
-buffer is unreffed, the new is reffed).
-
-Either @nbuf or the #GstBuffer pointed to by @obuf may be %NULL.</doc>
- <source-position filename="gst/gstbuffer.h" line="598"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="596">%TRUE when @obuf was different from @nbuf.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="obuf"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="584">pointer to a pointer to
- a #GstBuffer to be replaced.</doc>
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- <parameter name="nbuf"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="586">pointer to a #GstBuffer that will
- replace the buffer pointed to by @obuf.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <bitfield name="BufferCopyFlags"
- glib:type-name="GstBufferCopyFlags"
- glib:get-type="gst_buffer_copy_flags_get_type"
- c:type="GstBufferCopyFlags">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="491">A set of flags that can be provided to the gst_buffer_copy_into()
-function to specify which items should be copied.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_BUFFER_COPY_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="493">copy nothing</doc>
- </member>
- <member name="flags"
- value="1"
- c:identifier="GST_BUFFER_COPY_FLAGS"
- glib:nick="flags">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="494">flag indicating that buffer flags should be copied</doc>
- </member>
- <member name="timestamps"
- value="2"
- c:identifier="GST_BUFFER_COPY_TIMESTAMPS"
- glib:nick="timestamps">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="495">flag indicating that buffer pts, dts,
- duration, offset and offset_end should be copied</doc>
- </member>
- <member name="meta"
- value="4"
- c:identifier="GST_BUFFER_COPY_META"
- glib:nick="meta">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="503">flag indicating that buffer meta should be
- copied</doc>
- </member>
- <member name="memory"
- value="8"
- c:identifier="GST_BUFFER_COPY_MEMORY"
- glib:nick="memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="497">flag indicating that buffer memory should be reffed
- and appended to already existing memory. Unless the memory is marked as
- NO_SHARE, no actual copy of the memory is made but it is simply reffed.
- Add @GST_BUFFER_COPY_DEEP to force a real copy.</doc>
- </member>
- <member name="merge"
- value="16"
- c:identifier="GST_BUFFER_COPY_MERGE"
- glib:nick="merge">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="501">flag indicating that buffer memory should be
- merged</doc>
- </member>
- <member name="deep"
- value="32"
- c:identifier="GST_BUFFER_COPY_DEEP"
- glib:nick="deep">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="505">flag indicating that memory should always be
- copied instead of reffed (Since: 1.2)</doc>
- </member>
- </bitfield>
- <bitfield name="BufferFlags"
- glib:type-name="GstBufferFlags"
- glib:get-type="gst_buffer_flags_get_type"
- c:type="GstBufferFlags">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="182">A set of buffer flags used to describe properties of a #GstBuffer.</doc>
- <member name="live"
- value="16"
- c:identifier="GST_BUFFER_FLAG_LIVE"
- glib:nick="live">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="184">the buffer is live data and should be discarded in
- the PAUSED state.</doc>
- </member>
- <member name="decode_only"
- value="32"
- c:identifier="GST_BUFFER_FLAG_DECODE_ONLY"
- glib:nick="decode-only">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="186">the buffer contains data that should be dropped
- because it will be clipped against the segment
- boundaries or because it does not contain data
- that should be shown to the user.</doc>
- </member>
- <member name="discont"
- value="64"
- c:identifier="GST_BUFFER_FLAG_DISCONT"
- glib:nick="discont">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="190">the buffer marks a data discontinuity in the stream.
- This typically occurs after a seek or a dropped buffer
- from a live or network source.</doc>
- </member>
- <member name="resync"
- value="128"
- c:identifier="GST_BUFFER_FLAG_RESYNC"
- glib:nick="resync">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="193">the buffer timestamps might have a discontinuity
- and this buffer is a good point to resynchronize.</doc>
- </member>
- <member name="corrupted"
- value="256"
- c:identifier="GST_BUFFER_FLAG_CORRUPTED"
- glib:nick="corrupted">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="195">the buffer data is corrupted.</doc>
- </member>
- <member name="marker"
- value="512"
- c:identifier="GST_BUFFER_FLAG_MARKER"
- glib:nick="marker">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="196">the buffer contains a media specific marker. for
- video this is the end of a frame boundary, for audio
- this is the start of a talkspurt.</doc>
- </member>
- <member name="header"
- value="1024"
- c:identifier="GST_BUFFER_FLAG_HEADER"
- glib:nick="header">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="199">the buffer contains header information that is
- needed to decode the following data.</doc>
- </member>
- <member name="gap"
- value="2048"
- c:identifier="GST_BUFFER_FLAG_GAP"
- glib:nick="gap">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="201">the buffer has been created to fill a gap in the
- stream and contains media neutral data (elements can
- switch to optimized code path that ignores the buffer
- content).</doc>
- </member>
- <member name="droppable"
- value="4096"
- c:identifier="GST_BUFFER_FLAG_DROPPABLE"
- glib:nick="droppable">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="205">the buffer can be dropped without breaking the
- stream, for example to reduce bandwidth.</doc>
- </member>
- <member name="delta_unit"
- value="8192"
- c:identifier="GST_BUFFER_FLAG_DELTA_UNIT"
- glib:nick="delta-unit">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="207">this unit cannot be decoded independently.</doc>
- </member>
- <member name="tag_memory"
- value="16384"
- c:identifier="GST_BUFFER_FLAG_TAG_MEMORY"
- glib:nick="tag-memory">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="208">this flag is set when memory of the buffer
- is added/removed</doc>
- </member>
- <member name="sync_after"
- value="32768"
- c:identifier="GST_BUFFER_FLAG_SYNC_AFTER"
- glib:nick="sync-after">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="210">Elements which write to disk or permanent
- storage should ensure the data is synced after
- writing the contents of this buffer. (Since: 1.6)</doc>
- </member>
- <member name="non_droppable"
- value="65536"
- c:identifier="GST_BUFFER_FLAG_NON_DROPPABLE"
- glib:nick="non-droppable">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="213">This buffer is important and should not be dropped.
- This can be used to mark important buffers, e.g. to flag
- RTP packets carrying keyframes or codec setup data for RTP
- Forward Error Correction purposes, or to prevent still video
- frames from being dropped by elements due to QoS. (Since: 1.14)</doc>
- </member>
- <member name="last"
- value="1048576"
- c:identifier="GST_BUFFER_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="218">additional media specific flags can be added starting from
- this flag.</doc>
- </member>
- </bitfield>
- <callback name="BufferForeachMetaFunc" c:type="GstBufferForeachMetaFunc">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="622">A function that will be called from gst_buffer_foreach_meta(). The @meta
-field will point to a the reference of the meta.
-
-@buffer should not be modified from this callback.
-
-When this function returns %TRUE, the next meta will be
-returned. When %FALSE is returned, gst_buffer_foreach_meta() will return.
-
-When @meta is set to %NULL, the item will be removed from the buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="640"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="638">%FALSE when gst_buffer_foreach_meta() should stop</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="624">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="meta"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="625">a pointer to a #GstMeta</doc>
- <type name="Meta" c:type="GstMeta**"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="626">user data passed to gst_buffer_foreach_meta()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="BufferList"
- c:type="GstBufferList"
- glib:type-name="GstBufferList"
- glib:get-type="gst_buffer_list_get_type"
- c:symbol-prefix="buffer_list">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="24">Buffer lists are an object containing a list of buffers.
-
-Buffer lists are created with gst_buffer_list_new() and filled with data
-using a gst_buffer_list_insert().
-
-Buffer lists can be pushed on a srcpad with gst_pad_push_list(). This is
-interesting when multiple buffers need to be pushed in one go because it
-can reduce the amount of overhead for pushing each buffer individually.</doc>
- <source-position filename="gst/gstbufferlist.h" line="37"/>
- <constructor name="new" c:identifier="gst_buffer_list_new">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="181">Creates a new, empty #GstBufferList. The caller is responsible for unreffing
-the returned #GstBufferList.
-
-Free-function: gst_buffer_list_unref</doc>
- <source-position filename="gst/gstbufferlist.h" line="209"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="189">the new #GstBufferList. gst_buffer_list_unref()
- after usage.</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </return-value>
- </constructor>
- <constructor name="new_sized" c:identifier="gst_buffer_list_new_sized">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="145">Creates a new, empty #GstBufferList. The caller is responsible for unreffing
-the returned #GstBufferList. The list will have @size space preallocated so
-that memory reallocations can be avoided.
-
-Free-function: gst_buffer_list_unref</doc>
- <source-position filename="gst/gstbufferlist.h" line="212"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="155">the new #GstBufferList. gst_buffer_list_unref()
- after usage.</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </return-value>
- <parameters>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="147">an initial reserved size</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="calculate_size"
- c:identifier="gst_buffer_list_calculate_size"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="528">Calculates the size of the data contained in buffer list by adding the
-size of all buffers.</doc>
- <source-position filename="gst/gstbufferlist.h" line="237"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="535">the size of the data contained in buffer list in bytes.</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="530">a #GstBufferList</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="copy"
- c:identifier="gst_buffer_list_copy"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="118">Create a shallow copy of the given buffer list. This will make a newly
-allocated copy of the source list with copies of buffer pointers. The
-refcount of buffers pointed to will be increased by one.</doc>
- <source-position filename="gst/gstbufferlist.h" line="128"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="126">a new copy of @list.</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="120">a #GstBufferList</doc>
- <type name="BufferList" c:type="const GstBufferList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="copy_deep"
- c:identifier="gst_buffer_list_copy_deep"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="489">Create a copy of the given buffer list. This will make a newly allocated
-copy of the buffer that the source buffer list contains.</doc>
- <source-position filename="gst/gstbufferlist.h" line="234"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="496">a new copy of @list.</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="491">a #GstBufferList</doc>
- <type name="BufferList" c:type="const GstBufferList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="foreach" c:identifier="gst_buffer_list_foreach">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="236">Call @func with @data for each buffer in @list.
-
-@func can modify the passed buffer pointer or its contents. The return value
-of @func define if this function returns or if the remaining buffers in
-the list should be skipped.</doc>
- <source-position filename="gst/gstbufferlist.h" line="230"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="248">%TRUE when @func returned %TRUE for each buffer in @list or when
-@list is empty.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="238">a #GstBufferList</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="239">a #GstBufferListFunc to call</doc>
- <type name="BufferListFunc" c:type="GstBufferListFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="240">user data passed to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="get" c:identifier="gst_buffer_list_get">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="338">Get the buffer at @idx.
-
-You must make sure that @idx does not exceed the number of
-buffers available.</doc>
- <source-position filename="gst/gstbufferlist.h" line="218"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="348">the buffer at @idx in @group
- or %NULL when there is no buffer. The buffer remains valid as
- long as @list is valid and buffer is not removed from the list.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="340">a #GstBufferList</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="341">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_writable"
- c:identifier="gst_buffer_list_get_writable"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="361">Gets the buffer at @idx, ensuring it is a writable buffer.
-
-You must make sure that @idx does not exceed the number of
-buffers available.</doc>
- <source-position filename="gst/gstbufferlist.h" line="221"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="371">the buffer at @idx in @group.
- The returned buffer remains valid as long as @list is valid and
- the buffer is not removed from the list.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="363">a (writable) #GstBufferList</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="364">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert" c:identifier="gst_buffer_list_insert">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="409">Insert @buffer at @idx in @list. Other buffers are moved to make room for
-this new buffer.
-
-A -1 value for @idx will append the buffer at the end.</doc>
- <source-position filename="gst/gstbufferlist.h" line="224"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="411">a #GstBufferList</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="412">the index</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="413">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="length" c:identifier="gst_buffer_list_length">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="198">Returns the number of buffers in @list.</doc>
- <source-position filename="gst/gstbufferlist.h" line="215"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="204">the number of buffers in the buffer list</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="200">a #GstBufferList</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_buffer_list_ref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="63">Increases the refcount of the given buffer list by one.
-
-Note that the refcount affects the writability of @list and its data, see
-gst_buffer_list_make_writable(). It is important to note that keeping
-additional references to GstBufferList instances can potentially increase
-the number of memcpy operations in a pipeline.</doc>
- <source-position filename="gst/gstbufferlist.h" line="76"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="74">@list</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="65">a #GstBufferList</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove" c:identifier="gst_buffer_list_remove">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="469">Remove @length buffers starting from @idx in @list. The following buffers
-are moved to close the gap.</doc>
- <source-position filename="gst/gstbufferlist.h" line="227"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="471">a #GstBufferList</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="472">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="473">the amount to remove</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="unref"
- c:identifier="gst_buffer_list_unref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="84">Decreases the refcount of the buffer list. If the refcount reaches 0, the
-buffer list will be freed.</doc>
- <source-position filename="gst/gstbufferlist.h" line="91"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="86">a #GstBufferList</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <callback name="BufferListFunc" c:type="GstBufferListFunc">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="39">A function that will be called from gst_buffer_list_foreach(). The @buffer
-field will point to a the reference of the buffer at @idx.
-
-When this function returns %TRUE, the next buffer will be
-returned. When %FALSE is returned, gst_buffer_list_foreach() will return.
-
-When @buffer is set to %NULL, the item will be removed from the bufferlist.
-When @buffer has been made writable, the new buffer reference can be assigned
-to @buffer. This function is responsible for unreffing the old buffer when
-removing or modifying.</doc>
- <source-position filename="gst/gstbufferlist.h" line="58"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="56">%FALSE when gst_buffer_list_foreach() should stop</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="41">pointer the buffer</doc>
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="42">the index of @buffer</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="43">user data passed to gst_buffer_list_foreach()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <class name="BufferPool"
- c:symbol-prefix="buffer_pool"
- c:type="GstBufferPool"
- parent="Object"
- glib:type-name="GstBufferPool"
- glib:get-type="gst_buffer_pool_get_type"
- glib:type-struct="BufferPoolClass">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="22">A #GstBufferPool is an object that can be used to pre-allocate and recycle
-buffers of the same size and with the same properties.
-
-A #GstBufferPool is created with gst_buffer_pool_new().
-
-Once a pool is created, it needs to be configured. A call to
-gst_buffer_pool_get_config() returns the current configuration structure from
-the pool. With gst_buffer_pool_config_set_params() and
-gst_buffer_pool_config_set_allocator() the bufferpool parameters and
-allocator can be configured. Other properties can be configured in the pool
-depending on the pool implementation.
-
-A bufferpool can have extra options that can be enabled with
-gst_buffer_pool_config_add_option(). The available options can be retrieved
-with gst_buffer_pool_get_options(). Some options allow for additional
-configuration properties to be set.
-
-After the configuration structure has been configured,
-gst_buffer_pool_set_config() updates the configuration in the pool. This can
-fail when the configuration structure is not accepted.
-
-After the a pool has been configured, it can be activated with
-gst_buffer_pool_set_active(). This will preallocate the configured resources
-in the pool.
-
-When the pool is active, gst_buffer_pool_acquire_buffer() can be used to
-retrieve a buffer from the pool.
-
-Buffers allocated from a bufferpool will automatically be returned to the
-pool with gst_buffer_pool_release_buffer() when their refcount drops to 0.
-
-The bufferpool can be deactivated again with gst_buffer_pool_set_active().
-All further gst_buffer_pool_acquire_buffer() calls will return an error. When
-all buffers are returned to the pool they will be freed.
-
-Use gst_object_unref() to release the reference to a bufferpool. If the
-refcount of the pool reaches 0, the pool will be freed.</doc>
- <source-position filename="gst/gstbufferpool.h" line="176"/>
- <constructor name="new" c:identifier="gst_buffer_pool_new">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="205">Creates a new #GstBufferPool instance.</doc>
- <source-position filename="gst/gstbufferpool.h" line="184"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="210">a new #GstBufferPool instance</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </return-value>
- </constructor>
- <function name="config_add_option"
- c:identifier="gst_buffer_pool_config_add_option">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="873">Enabled the option in @config. This will instruct the @bufferpool to enable
-the specified option on the buffers that it allocates.
-
-The supported options by @pool can be retrieved with gst_buffer_pool_get_options().</doc>
- <source-position filename="gst/gstbufferpool.h" line="233"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="875">a #GstBufferPool configuration</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="option" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="876">an option to add</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="config_get_allocator"
- c:identifier="gst_buffer_pool_config_get_allocator">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1024">Get the @allocator and @params from @config.</doc>
- <source-position filename="gst/gstbufferpool.h" line="224"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1032">%TRUE, if the values are set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1026">a #GstBufferPool configuration</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="allocator"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- nullable="1"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1027">a #GstAllocator, or %NULL</doc>
- <type name="Allocator" c:type="GstAllocator**"/>
- </parameter>
- <parameter name="params"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1028">#GstAllocationParams, or %NULL</doc>
- <type name="AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </function>
- <function name="config_get_option"
- c:identifier="gst_buffer_pool_config_get_option">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="937">Parse an available @config and get the option at @index of the options API
-array.</doc>
- <source-position filename="gst/gstbufferpool.h" line="236"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="945">a #gchar of the option at @index.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="939">a #GstBufferPool configuration</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="940">position in the option array to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="config_get_params"
- c:identifier="gst_buffer_pool_config_get_params">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="996">Get the configuration values from @config.</doc>
- <source-position filename="gst/gstbufferpool.h" line="216"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1006">%TRUE if all parameters could be fetched.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="998">a #GstBufferPool configuration</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="caps"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- nullable="1"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="999">the caps of buffers</doc>
- <type name="Caps" c:type="GstCaps**"/>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1000">the size of each buffer, not including prefix and padding</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="min_buffers"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1001">the minimum amount of buffers to allocate.</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="max_buffers"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1002">the maximum amount of buffers to allocate or 0 for unlimited.</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="config_has_option"
- c:identifier="gst_buffer_pool_config_has_option">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="966">Check if @config contains @option.</doc>
- <source-position filename="gst/gstbufferpool.h" line="239"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="973">%TRUE if the options array contains @option.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="968">a #GstBufferPool configuration</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="option" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="969">an option</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="config_n_options"
- c:identifier="gst_buffer_pool_config_n_options">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="913">Retrieve the number of values currently stored in the options array of the
-@config structure.</doc>
- <source-position filename="gst/gstbufferpool.h" line="230"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="920">the options array size as a #guint.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="915">a #GstBufferPool configuration</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </function>
- <function name="config_set_allocator"
- c:identifier="gst_buffer_pool_config_set_allocator">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="842">Set the @allocator and @params on @config.
-
-One of @allocator and @params can be %NULL, but not both. When @allocator
-is %NULL, the default allocator of the pool will use the values in @param
-to perform its allocation. When @param is %NULL, the pool will use the
-provided @allocator with its default #GstAllocationParams.
-
-A call to gst_buffer_pool_set_config() can update the allocator and params
-with the values that it is able to do. Some pools are, for example, not able
-to operate with different allocators or cannot allocate with the values
-specified in @params. Use gst_buffer_pool_get_config() to get the currently
-used values.</doc>
- <source-position filename="gst/gstbufferpool.h" line="220"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="844">a #GstBufferPool configuration</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="allocator"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="845">a #GstAllocator</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="846">#GstAllocationParams</doc>
- <type name="AllocationParams" c:type="const GstAllocationParams*"/>
- </parameter>
- </parameters>
- </function>
- <function name="config_set_params"
- c:identifier="gst_buffer_pool_config_set_params">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="817">Configure @config with the given parameters.</doc>
- <source-position filename="gst/gstbufferpool.h" line="212"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="819">a #GstBufferPool configuration</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="820">caps for the buffers</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="821">the size of each buffer, not including prefix and padding</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="min_buffers" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="822">the minimum amount of buffers to allocate.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="max_buffers" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="823">the maximum amount of buffers to allocate or 0 for unlimited.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="config_validate_params"
- c:identifier="gst_buffer_pool_config_validate_params"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1057">Validate that changes made to @config are still valid in the context of the
-expected parameters. This function is a helper that can be used to validate
-changes made by a pool to a config when gst_buffer_pool_set_config()
-returns %FALSE. This expects that @caps haven't changed and that
-@min_buffers aren't lower then what we initially expected.
-This does not check if options or allocator parameters are still valid,
-won't check if size have changed, since changing the size is valid to adapt
-padding.</doc>
- <source-position filename="gst/gstbufferpool.h" line="242"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1076">%TRUE, if the parameters are valid in this context.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1059">a #GstBufferPool configuration</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1060">the excepted caps of buffers</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1061">the expected size of each buffer, not including prefix and padding</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="min_buffers" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1062">the expected minimum amount of buffers to allocate.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="max_buffers" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1063">the expect maximum amount of buffers to allocate or 0 for unlimited.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="acquire_buffer" invoker="acquire_buffer">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1247">Acquire a buffer from @pool. @buffer should point to a memory location that
-can hold a pointer to the new buffer.
-
-@params can be %NULL or contain optional parameters to influence the
-allocation.</doc>
- <source-position filename="gst/gstbufferpool.h" line="164"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1259">a #GstFlowReturn such as %GST_FLOW_FLUSHING when the pool is
-inactive.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1249">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- <parameter name="buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1250">a location for a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1251">parameters.</doc>
- <type name="BufferPoolAcquireParams"
- c:type="GstBufferPoolAcquireParams*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="alloc_buffer">
- <source-position filename="gst/gstbufferpool.h" line="166"/>
- <return-value transfer-ownership="none">
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- <parameter name="params" transfer-ownership="none">
- <type name="BufferPoolAcquireParams"
- c:type="GstBufferPoolAcquireParams*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="flush_start">
- <source-position filename="gst/gstbufferpool.h" line="171"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="flush_stop">
- <source-position filename="gst/gstbufferpool.h" line="172"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="free_buffer">
- <source-position filename="gst/gstbufferpool.h" line="170"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_options" invoker="get_options">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="753">Get a %NULL terminated array of string with supported bufferpool options for
-@pool. An option would typically be enabled with
-gst_buffer_pool_config_add_option().</doc>
- <source-position filename="gst/gstbufferpool.h" line="158"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="761">a %NULL terminated array
- of strings.</doc>
- <array c:type="const gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="755">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="release_buffer" invoker="release_buffer">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1346">Release @buffer to @pool. @buffer should have previously been allocated from
-@pool with gst_buffer_pool_acquire_buffer().
-
-This function is usually called automatically when the last ref on @buffer
-disappears.</doc>
- <source-position filename="gst/gstbufferpool.h" line="169"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1348">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1349">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="reset_buffer">
- <source-position filename="gst/gstbufferpool.h" line="168"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_config" invoker="set_config">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="631">Set the configuration of the pool. If the pool is already configured, and
-the configuration haven't change, this function will return %TRUE. If the
-pool is active, this method will return %FALSE and active configuration
-will remain. Buffers allocated form this pool must be returned or else this
-function will do nothing and return %FALSE.
-
-@config is a #GstStructure that contains the configuration parameters for
-the pool. A default and mandatory set of parameters can be configured with
-gst_buffer_pool_config_set_params(), gst_buffer_pool_config_set_allocator()
-and gst_buffer_pool_config_add_option().
-
-If the parameters in @config can not be set exactly, this function returns
-%FALSE and will try to update as much state as possible. The new state can
-then be retrieved and refined with gst_buffer_pool_get_config().
-
-This function takes ownership of @config.</doc>
- <source-position filename="gst/gstbufferpool.h" line="159"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="653">%TRUE when the configuration could be set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="633">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- <parameter name="config" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="634">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start">
- <source-position filename="gst/gstbufferpool.h" line="161"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop">
- <source-position filename="gst/gstbufferpool.h" line="162"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <method name="acquire_buffer"
- c:identifier="gst_buffer_pool_acquire_buffer">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1247">Acquire a buffer from @pool. @buffer should point to a memory location that
-can hold a pointer to the new buffer.
-
-@params can be %NULL or contain optional parameters to influence the
-allocation.</doc>
- <source-position filename="gst/gstbufferpool.h" line="248"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1259">a #GstFlowReturn such as %GST_FLOW_FLUSHING when the pool is
-inactive.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1249">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- <parameter name="buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1250">a location for a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1251">parameters.</doc>
- <type name="BufferPoolAcquireParams"
- c:type="GstBufferPoolAcquireParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_config" c:identifier="gst_buffer_pool_get_config">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="726">Get a copy of the current configuration of the pool. This configuration
-can either be modified and used for the gst_buffer_pool_set_config() call
-or it must be freed after usage.</doc>
- <source-position filename="gst/gstbufferpool.h" line="198"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="734">a copy of the current configuration of @pool. use
-gst_structure_free() after usage or gst_buffer_pool_set_config().</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="728">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_options" c:identifier="gst_buffer_pool_get_options">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="753">Get a %NULL terminated array of string with supported bufferpool options for
-@pool. An option would typically be enabled with
-gst_buffer_pool_config_add_option().</doc>
- <source-position filename="gst/gstbufferpool.h" line="201"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="761">a %NULL terminated array
- of strings.</doc>
- <array c:type="const gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="755">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_option" c:identifier="gst_buffer_pool_has_option">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="790">Check if the bufferpool supports @option.</doc>
- <source-position filename="gst/gstbufferpool.h" line="204"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="797">%TRUE if the buffer pool contains @option.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="792">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- <parameter name="option" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="793">an option</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_active" c:identifier="gst_buffer_pool_is_active">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="571">Check if @pool is active. A pool can be activated with the
-gst_buffer_pool_set_active() call.</doc>
- <source-position filename="gst/gstbufferpool.h" line="192"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="578">%TRUE when the pool is active.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="573">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="release_buffer"
- c:identifier="gst_buffer_pool_release_buffer">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1346">Release @buffer to @pool. @buffer should have previously been allocated from
-@pool with gst_buffer_pool_acquire_buffer().
-
-This function is usually called automatically when the last ref on @buffer
-disappears.</doc>
- <source-position filename="gst/gstbufferpool.h" line="252"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1348">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1349">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_active" c:identifier="gst_buffer_pool_set_active">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="475">Control the active state of @pool. When the pool is inactive, new calls to
-gst_buffer_pool_acquire_buffer() will return with %GST_FLOW_FLUSHING.
-
-Activating the bufferpool will preallocate all resources in the pool based on
-the configuration of the pool.
-
-Deactivating will free the resources again when there are no outstanding
-buffers. When there are outstanding buffers, they will be freed as soon as
-they are all returned to the pool.</doc>
- <source-position filename="gst/gstbufferpool.h" line="189"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="490">%FALSE when the pool was not configured or when preallocation of the
-buffers failed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="477">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="478">the new active state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_config" c:identifier="gst_buffer_pool_set_config">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="631">Set the configuration of the pool. If the pool is already configured, and
-the configuration haven't change, this function will return %TRUE. If the
-pool is active, this method will return %FALSE and active configuration
-will remain. Buffers allocated form this pool must be returned or else this
-function will do nothing and return %FALSE.
-
-@config is a #GstStructure that contains the configuration parameters for
-the pool. A default and mandatory set of parameters can be configured with
-gst_buffer_pool_config_set_params(), gst_buffer_pool_config_set_allocator()
-and gst_buffer_pool_config_add_option().
-
-If the parameters in @config can not be set exactly, this function returns
-%FALSE and will try to update as much state as possible. The new state can
-then be retrieved and refined with gst_buffer_pool_get_config().
-
-This function takes ownership of @config.</doc>
- <source-position filename="gst/gstbufferpool.h" line="195"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="653">%TRUE when the configuration could be set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="633">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- <parameter name="config" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="634">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_flushing"
- c:identifier="gst_buffer_pool_set_flushing"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1385">Enable or disable the flushing state of a @pool without freeing or
-allocating buffers.</doc>
- <source-position filename="gst/gstbufferpool.h" line="207"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1387">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </instance-parameter>
- <parameter name="flushing" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1388">whether to start or stop flushing</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <field name="object">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="flushing">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="BufferPoolPrivate" c:type="GstBufferPoolPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <bitfield name="BufferPoolAcquireFlags"
- glib:type-name="GstBufferPoolAcquireFlags"
- glib:get-type="gst_buffer_pool_acquire_flags_get_type"
- c:type="GstBufferPoolAcquireFlags">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="43">Additional flags to control the allocation of a buffer</doc>
- <member name="none"
- value="0"
- c:identifier="GST_BUFFER_POOL_ACQUIRE_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="45">no flags</doc>
- </member>
- <member name="key_unit"
- value="1"
- c:identifier="GST_BUFFER_POOL_ACQUIRE_FLAG_KEY_UNIT"
- glib:nick="key-unit">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="46">buffer is keyframe</doc>
- </member>
- <member name="dontwait"
- value="2"
- c:identifier="GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT"
- glib:nick="dontwait">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="47">when the bufferpool is empty, acquire_buffer
-will by default block until a buffer is released into the pool again. Setting
-this flag makes acquire_buffer return #GST_FLOW_EOS instead of blocking.</doc>
- </member>
- <member name="discont"
- value="4"
- c:identifier="GST_BUFFER_POOL_ACQUIRE_FLAG_DISCONT"
- glib:nick="discont">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="50">buffer is discont</doc>
- </member>
- <member name="last"
- value="65536"
- c:identifier="GST_BUFFER_POOL_ACQUIRE_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="51">last flag, subclasses can use private flags
- starting from this value.</doc>
- </member>
- </bitfield>
- <record name="BufferPoolAcquireParams" c:type="GstBufferPoolAcquireParams">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="66">Parameters passed to the gst_buffer_pool_acquire_buffer() function to control the
-allocation of the buffer.
-
-The default implementation ignores the @start and @stop members but other
-implementations can use this extra information to decide what buffer to
-return.</doc>
- <source-position filename="gst/gstbufferpool.h" line="88"/>
- <field name="format" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="68">the format of @start and @stop</doc>
- <type name="Format" c:type="GstFormat"/>
- </field>
- <field name="start" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="69">the start position</doc>
- <type name="gint64" c:type="gint64"/>
- </field>
- <field name="stop" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="70">the stop position</doc>
- <type name="gint64" c:type="gint64"/>
- </field>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="71">additional flags</doc>
- <type name="BufferPoolAcquireFlags"
- c:type="GstBufferPoolAcquireFlags"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="BufferPoolClass"
- c:type="GstBufferPoolClass"
- glib:is-gtype-struct-for="BufferPool">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="117">The GstBufferPool class.</doc>
- <source-position filename="gst/gstbufferpool.h" line="176"/>
- <field name="object_class">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.h"
- line="119">Object parent class</doc>
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="get_options">
- <callback name="get_options">
- <source-position filename="gst/gstbufferpool.h" line="158"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="761">a %NULL terminated array
- of strings.</doc>
- <array c:type="const gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="755">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_config">
- <callback name="set_config">
- <source-position filename="gst/gstbufferpool.h" line="159"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="653">%TRUE when the configuration could be set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="633">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- <parameter name="config" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="634">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="start">
- <callback name="start">
- <source-position filename="gst/gstbufferpool.h" line="161"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="gst/gstbufferpool.h" line="162"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="acquire_buffer">
- <callback name="acquire_buffer">
- <source-position filename="gst/gstbufferpool.h" line="164"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1259">a #GstFlowReturn such as %GST_FLOW_FLUSHING when the pool is
-inactive.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1249">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- <parameter name="buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1250">a location for a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1251">parameters.</doc>
- <type name="BufferPoolAcquireParams"
- c:type="GstBufferPoolAcquireParams*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="alloc_buffer">
- <callback name="alloc_buffer">
- <source-position filename="gst/gstbufferpool.h" line="166"/>
- <return-value transfer-ownership="none">
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- <parameter name="params" transfer-ownership="none">
- <type name="BufferPoolAcquireParams"
- c:type="GstBufferPoolAcquireParams*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="reset_buffer">
- <callback name="reset_buffer">
- <source-position filename="gst/gstbufferpool.h" line="168"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="release_buffer">
- <callback name="release_buffer">
- <source-position filename="gst/gstbufferpool.h" line="169"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1348">a #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbufferpool.c"
- line="1349">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="free_buffer">
- <callback name="free_buffer">
- <source-position filename="gst/gstbufferpool.h" line="170"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="flush_start">
- <callback name="flush_start">
- <source-position filename="gst/gstbufferpool.h" line="171"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="flush_stop">
- <callback name="flush_stop">
- <source-position filename="gst/gstbufferpool.h" line="172"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="2">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="BufferPoolPrivate"
- c:type="GstBufferPoolPrivate"
- disguised="1">
- <source-position filename="gst/gstbufferpool.h" line="32"/>
- </record>
- <enumeration name="BufferingMode"
- glib:type-name="GstBufferingMode"
- glib:get-type="gst_buffering_mode_get_type"
- c:type="GstBufferingMode">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="193">The different types of buffering methods.</doc>
- <member name="stream"
- value="0"
- c:identifier="GST_BUFFERING_STREAM"
- glib:nick="stream">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="195">a small amount of data is buffered</doc>
- </member>
- <member name="download"
- value="1"
- c:identifier="GST_BUFFERING_DOWNLOAD"
- glib:nick="download">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="196">the stream is being downloaded</doc>
- </member>
- <member name="timeshift"
- value="2"
- c:identifier="GST_BUFFERING_TIMESHIFT"
- glib:nick="timeshift">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="197">the stream is being downloaded in a ringbuffer</doc>
- </member>
- <member name="live"
- value="3"
- c:identifier="GST_BUFFERING_LIVE"
- glib:nick="live">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="198">the stream is a live stream</doc>
- </member>
- </enumeration>
- <class name="Bus"
- c:symbol-prefix="bus"
- c:type="GstBus"
- parent="Object"
- glib:type-name="GstBus"
- glib:get-type="gst_bus_get_type"
- glib:type-struct="BusClass">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="22">The #GstBus is an object responsible for delivering #GstMessage packets in
-a first-in first-out way from the streaming threads (see #GstTask) to the
-application.
-
-Since the application typically only wants to deal with delivery of these
-messages from one thread, the GstBus will marshall the messages between
-different threads. This is important since the actual streaming of media
-is done in another thread than the application.
-
-The GstBus provides support for #GSource based notifications. This makes it
-possible to handle the delivery in the glib mainloop.
-
-The #GSource callback function gst_bus_async_signal_func() can be used to
-convert all bus messages into signal emissions.
-
-A message is posted on the bus with the gst_bus_post() method. With the
-gst_bus_peek() and gst_bus_pop() methods one can look at or retrieve a
-previously posted message.
-
-The bus can be polled with the gst_bus_poll() method. This methods blocks
-up to the specified timeout value until one of the specified messages types
-is posted on the bus. The application can then gst_bus_pop() the messages
-from the bus to handle them.
-Alternatively the application can register an asynchronous bus function
-using gst_bus_add_watch_full() or gst_bus_add_watch(). This function will
-install a #GSource in the default glib main loop and will deliver messages
-a short while after they have been posted. Note that the main loop should
-be running for the asynchronous callbacks.
-
-It is also possible to get messages from the bus without any thread
-marshalling with the gst_bus_set_sync_handler() method. This makes it
-possible to react to a message in the same thread that posted the
-message on the bus. This should only be used if the application is able
-to deal with messages from different threads.
-
-Every #GstPipeline has one bus.
-
-Note that a #GstPipeline will set its bus into flushing state when changing
-from READY to NULL state.</doc>
- <source-position filename="gst/gstbus.h" line="133"/>
- <constructor name="new" c:identifier="gst_bus_new">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="297">Creates a new #GstBus instance.</doc>
- <source-position filename="gst/gstbus.h" line="139"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="302">a new #GstBus instance</doc>
- <type name="Bus" c:type="GstBus*"/>
- </return-value>
- </constructor>
- <virtual-method name="message">
- <source-position filename="gst/gstbus.h" line="128"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="none">
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sync_message">
- <source-position filename="gst/gstbus.h" line="129"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="none">
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add_signal_watch" c:identifier="gst_bus_add_signal_watch">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1446">Adds a bus signal watch to the default main context with the default priority
-(%G_PRIORITY_DEFAULT). It is also possible to use a non-default
-main context set up using g_main_context_push_thread_default() (before
-one had to create a bus watch source and attach it to the desired main
-context 'manually').
-
-After calling this statement, the bus will emit the "message" signal for each
-message posted on the bus.
-
-This function may be called multiple times. To clean up, the caller is
-responsible for calling gst_bus_remove_signal_watch() as many times as this
-function is called.
-
-MT safe.</doc>
- <source-position filename="gst/gstbus.h" line="212"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1448">a #GstBus on which you want to receive the "message" signal</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="add_signal_watch_full"
- c:identifier="gst_bus_add_signal_watch_full">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1387">Adds a bus signal watch to the default main context with the given @priority
-(e.g. %G_PRIORITY_DEFAULT). It is also possible to use a non-default main
-context set up using g_main_context_push_thread_default()
-(before one had to create a bus watch source and attach it to the desired
-main context 'manually').
-
-After calling this statement, the bus will emit the "message" signal for each
-message posted on the bus when the main loop is running.
-
-This function may be called multiple times. To clean up, the caller is
-responsible for calling gst_bus_remove_signal_watch() as many times as this
-function is called.
-
-There can only be a single bus watch per bus, you must remove any signal
-watch before you can set another type of watch.
-
-MT safe.</doc>
- <source-position filename="gst/gstbus.h" line="215"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1389">a #GstBus on which you want to receive the "message" signal</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1390">The priority of the watch.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_watch"
- c:identifier="gst_bus_add_watch"
- shadowed-by="add_watch_full"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1030">Adds a bus watch to the default main context with the default priority
-(%G_PRIORITY_DEFAULT). It is also possible to use a non-default main
-context set up using g_main_context_push_thread_default() (before
-one had to create a bus watch source and attach it to the desired main
-context 'manually').
-
-This function is used to receive asynchronous messages in the main loop.
-There can only be a single bus watch per bus, you must remove it before you
-can set a new one.
-
-The bus watch will only work if a GLib main loop is being run.
-
-The watch can be removed using gst_bus_remove_watch() or by returning %FALSE
-from @func. If the watch was added to the default main context it is also
-possible to remove the watch using g_source_remove().
-
-The bus watch will take its own reference to the @bus, so it is safe to unref
-@bus using gst_object_unref() after setting the bus watch.
-
-MT safe.</doc>
- <source-position filename="gst/gstbus.h" line="188"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1057">The event source id or 0 if @bus already got an event source.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1032">a #GstBus to create the watch for</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="func" transfer-ownership="none" closure="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1033">A function to call when a message is received.</doc>
- <type name="BusFunc" c:type="GstBusFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1034">user data passed to @func.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_watch_full"
- c:identifier="gst_bus_add_watch_full"
- shadows="add_watch">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="981">Adds a bus watch to the default main context with the given @priority (e.g.
-%G_PRIORITY_DEFAULT). It is also possible to use a non-default main
-context set up using g_main_context_push_thread_default() (before
-one had to create a bus watch source and attach it to the desired main
-context 'manually').
-
-This function is used to receive asynchronous messages in the main loop.
-There can only be a single bus watch per bus, you must remove it before you
-can set a new one.
-
-The bus watch will only work if a GLib main loop is being run.
-
-When @func is called, the message belongs to the caller; if you want to
-keep a copy of it, call gst_message_ref() before leaving @func.
-
-The watch can be removed using gst_bus_remove_watch() or by returning %FALSE
-from @func. If the watch was added to the default main context it is also
-possible to remove the watch using g_source_remove().
-
-The bus watch will take its own reference to the @bus, so it is safe to unref
-@bus using gst_object_unref() after setting the bus watch.
-
-MT safe.</doc>
- <source-position filename="gst/gstbus.h" line="182"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1013">The event source id or 0 if @bus already got an event source.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="983">a #GstBus to create the watch for.</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="984">The priority of the watch.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="notified"
- closure="2"
- destroy="3">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="985">A function to call when a message is received.</doc>
- <type name="BusFunc" c:type="GstBusFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="986">user data passed to @func.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="987">the function to call when the source is removed.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="async_signal_func"
- c:identifier="gst_bus_async_signal_func">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1274">A helper #GstBusFunc that can be used to convert all asynchronous messages
-into signals.</doc>
- <source-position filename="gst/gstbus.h" line="203"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1283">%TRUE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1276">a #GstBus</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1277">the #GstMessage received</doc>
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1278">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="create_watch" c:identifier="gst_bus_create_watch">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="911">Create watch for this bus. The GSource will be dispatched whenever
-a message is on the bus. After the GSource is dispatched, the
-message is popped off the bus and unreffed.</doc>
- <source-position filename="gst/gstbus.h" line="179"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="919">a #GSource that can be added to a mainloop.</doc>
- <type name="GLib.Source" c:type="GSource*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="913">a #GstBus to create the watch for</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="disable_sync_message_emission"
- c:identifier="gst_bus_disable_sync_message_emission">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1359">Instructs GStreamer to stop emitting the "sync-message" signal for this bus.
-See gst_bus_enable_sync_message_emission() for more information.
-
-In the event that multiple pieces of code have called
-gst_bus_enable_sync_message_emission(), the sync-message emissions will only
-be stopped after all calls to gst_bus_enable_sync_message_emission() were
-"cancelled" by calling this function. In this way the semantics are exactly
-the same as gst_object_ref() that which calls enable should also call
-disable.
-
-MT safe.</doc>
- <source-position filename="gst/gstbus.h" line="224"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1361">a #GstBus on which you previously called
-gst_bus_enable_sync_message_emission()</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="enable_sync_message_emission"
- c:identifier="gst_bus_enable_sync_message_emission">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1327">Instructs GStreamer to emit the "sync-message" signal after running the bus's
-sync handler. This function is here so that code can ensure that they can
-synchronously receive messages without having to affect what the bin's sync
-handler is.
-
-This function may be called multiple times. To clean up, the caller is
-responsible for calling gst_bus_disable_sync_message_emission() as many times
-as this function is called.
-
-While this function looks similar to gst_bus_add_signal_watch(), it is not
-exactly the same -- this function enables *synchronous* emission of
-signals when messages arrive; gst_bus_add_signal_watch() adds an idle callback
-to pop messages off the bus *asynchronously*. The sync-message signal
-comes from the thread of whatever object posted the message; the "message"
-signal is marshalled to the main thread via the main loop.
-
-MT safe.</doc>
- <source-position filename="gst/gstbus.h" line="221"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1329">a #GstBus on which you want to receive the "sync-message" signal</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_pollfd"
- c:identifier="gst_bus_get_pollfd"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="774">Gets the file descriptor from the bus which can be used to get notified about
-messages being available with functions like g_poll(), and allows integration
-into other event loops based on file descriptors.
-Whenever a message is available, the POLLIN / %G_IO_IN event is set.
-
-Warning: NEVER read or write anything to the returned fd but only use it
-for getting notifications via g_poll() or similar and then use the normal
-GstBus API, e.g. gst_bus_pop().</doc>
- <source-position filename="gst/gstbus.h" line="174"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="776">A #GstBus</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="fd"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="777">A GPollFD to fill</doc>
- <type name="GLib.PollFD" c:type="GPollFD*"/>
- </parameter>
- </parameters>
- </method>
- <method name="have_pending" c:identifier="gst_bus_have_pending">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="444">Check if there are pending messages on the bus that
-should be handled.</doc>
- <source-position filename="gst/gstbus.h" line="145"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="451">%TRUE if there are messages on the bus to be handled, %FALSE
-otherwise.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="446">a #GstBus to check</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="peek" c:identifier="gst_bus_peek">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="702">Peek the message on the top of the bus' queue. The message will remain
-on the bus' message queue. A reference is returned, and needs to be unreffed
-by the caller.</doc>
- <source-position filename="gst/gstbus.h" line="148"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="710">the #GstMessage that is on the
- bus, or %NULL if the bus is empty.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="704">a #GstBus</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="poll" c:identifier="gst_bus_poll">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1179">Poll the bus for messages. Will block while waiting for messages to come.
-You can specify a maximum time to poll with the @timeout parameter. If
-@timeout is negative, this function will block indefinitely.
-
-All messages not in @events will be popped off the bus and will be ignored.
-It is not possible to use message enums beyond #GST_MESSAGE_EXTENDED in the
-@events mask
-
-Because poll is implemented using the "message" signal enabled by
-gst_bus_add_signal_watch(), calling gst_bus_poll() will cause the "message"
-signal to be emitted for every message that poll sees. Thus a "message"
-signal handler will see the same messages that this function sees -- neither
-will steal messages from the other.
-
-This function will run a main loop from the default main context when
-polling.
-
-You should never use this function, since it is pure evil. This is
-especially true for GUI applications based on Gtk+ or Qt, but also for any
-other non-trivial application that uses the GLib main loop. As this function
-runs a GLib main loop, any callback attached to the default GLib main
-context may be invoked. This could be timeouts, GUI events, I/O events etc.;
-even if gst_bus_poll() is called with a 0 timeout. Any of these callbacks
-may do things you do not expect, e.g. destroy the main application window or
-some other resource; change other application state; display a dialog and
-run another main loop until the user clicks it away. In short, using this
-function may add a lot of complexity to your code through unexpected
-re-entrancy and unexpected changes to your application's state.
-
-For 0 timeouts use gst_bus_pop_filtered() instead of this function; for
-other short timeouts use gst_bus_timed_pop_filtered(); everything else is
-better handled by setting up an asynchronous bus watch and doing things
-from there.</doc>
- <source-position filename="gst/gstbus.h" line="197"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1221">the message that was received,
- or %NULL if the poll timed out. The message is taken from the
- bus and needs to be unreffed with gst_message_unref() after
- usage.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1181">a #GstBus</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="events" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1182">a mask of #GstMessageType, representing the set of message types to
-poll for (note special handling of extended message types below)</doc>
- <type name="MessageType" c:type="GstMessageType"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1184">the poll timeout, as a #GstClockTime, or #GST_CLOCK_TIME_NONE to poll
-indefinitely.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="pop" c:identifier="gst_bus_pop">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="681">Get a message from the bus.</doc>
- <source-position filename="gst/gstbus.h" line="151"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="687">the #GstMessage that is on the
- bus, or %NULL if the bus is empty. The message is taken from
- the bus and needs to be unreffed with gst_message_unref() after
- usage.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="683">a #GstBus to pop</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pop_filtered" c:identifier="gst_bus_pop_filtered">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="654">Get a message matching @type from the bus. Will discard all messages on
-the bus that do not match @type and that have been posted before the first
-message that does match @type. If there is no message matching @type on
-the bus, all messages will be discarded. It is not possible to use message
-enums beyond #GST_MESSAGE_EXTENDED in the @events mask.</doc>
- <source-position filename="gst/gstbus.h" line="154"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="665">the next #GstMessage matching
- @type that is on the bus, or %NULL if the bus is empty or there
- is no message matching @type. The message is taken from the bus
- and needs to be unreffed with gst_message_unref() after usage.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="656">a #GstBus to pop</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="types" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="657">message types to take into account</doc>
- <type name="MessageType" c:type="GstMessageType"/>
- </parameter>
- </parameters>
- </method>
- <method name="post" c:identifier="gst_bus_post">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="318">Post a message on the given bus. Ownership of the message
-is taken by the bus.</doc>
- <source-position filename="gst/gstbus.h" line="142"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="326">%TRUE if the message could be posted, %FALSE if the bus is flushing.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="320">a #GstBus to post on</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="321">the #GstMessage to post</doc>
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_signal_watch"
- c:identifier="gst_bus_remove_signal_watch">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1471">Removes a signal watch previously added with gst_bus_add_signal_watch().
-
-MT safe.</doc>
- <source-position filename="gst/gstbus.h" line="218"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1473">a #GstBus you previously added a signal watch to</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_watch"
- c:identifier="gst_bus_remove_watch"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1066">Removes an installed bus watch from @bus.</doc>
- <source-position filename="gst/gstbus.h" line="192"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1072">%TRUE on success or %FALSE if @bus has no event source.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1068">a #GstBus to remove the watch from.</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_flushing" c:identifier="gst_bus_set_flushing">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="469">If @flushing, flush out and unref any messages queued in the bus. Releases
-references to the message origin objects. Will flush future messages until
-gst_bus_set_flushing() sets @flushing to %FALSE.
-
-MT safe.</doc>
- <source-position filename="gst/gstbus.h" line="163"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="471">a #GstBus</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="flushing" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="472">whether or not to flush the bus</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_sync_handler" c:identifier="gst_bus_set_sync_handler">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="733">Sets the synchronous handler on the bus. The function will be called
-every time a new message is posted on the bus. Note that the function
-will be called in the same thread context as the posting object. This
-function is usually only called by the creator of the bus. Applications
-should handle messages asynchronously using the gst_bus watch and poll
-functions.
-
-Before 1.16.3 it was not possible to replace an existing handler and
-clearing an existing handler with %NULL was not thread-safe.</doc>
- <source-position filename="gst/gstbus.h" line="168"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="735">a #GstBus to install the handler on</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="736">The handler function to install</doc>
- <type name="BusSyncHandler" c:type="GstBusSyncHandler"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="737">User data that will be sent to the handler function.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="738">called when @user_data becomes unused</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="sync_signal_handler"
- c:identifier="gst_bus_sync_signal_handler">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1301">A helper GstBusSyncHandler that can be used to convert all synchronous
-messages into signals.</doc>
- <source-position filename="gst/gstbus.h" line="206"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1310">GST_BUS_PASS</doc>
- <type name="BusSyncReply" c:type="GstBusSyncReply"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1303">a #GstBus</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1304">the #GstMessage received</doc>
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="1305">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="timed_pop" c:identifier="gst_bus_timed_pop">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="628">Get a message from the bus, waiting up to the specified timeout.
-
-If @timeout is 0, this function behaves like gst_bus_pop(). If @timeout is
-#GST_CLOCK_TIME_NONE, this function will block forever until a message was
-posted on the bus.</doc>
- <source-position filename="gst/gstbus.h" line="157"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="639">the #GstMessage that is on the
- bus after the specified timeout or %NULL if the bus is empty
- after the timeout expired. The message is taken from the bus
- and needs to be unreffed with gst_message_unref() after usage.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="630">a #GstBus to pop</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="631">a timeout</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="timed_pop_filtered"
- c:identifier="gst_bus_timed_pop_filtered">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="507">Get a message from the bus whose type matches the message type mask @types,
-waiting up to the specified timeout (and discarding any messages that do not
-match the mask provided).
-
-If @timeout is 0, this function behaves like gst_bus_pop_filtered(). If
-@timeout is #GST_CLOCK_TIME_NONE, this function will block forever until a
-matching message was posted on the bus.</doc>
- <source-position filename="gst/gstbus.h" line="160"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="521">a #GstMessage matching the
- filter in @types, or %NULL if no matching message was found on
- the bus until the timeout expired. The message is taken from
- the bus and needs to be unreffed with gst_message_unref() after
- usage.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="509">a #GstBus to pop from</doc>
- <type name="Bus" c:type="GstBus*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="510">a timeout in nanoseconds, or GST_CLOCK_TIME_NONE to wait forever</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="types" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="511">message types to take into account, GST_MESSAGE_ANY for any type</doc>
- <type name="MessageType" c:type="GstMessageType"/>
- </parameter>
- </parameters>
- </method>
- <property name="enable-async"
- readable="0"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="object">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="BusPrivate" c:type="GstBusPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="message" when="last" detailed="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="232">A message has been posted on the bus. This signal is emitted from a
-GSource added to the mainloop. this signal will only be emitted when
-there is a mainloop running.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="235">the message that has been posted asynchronously</doc>
- <type name="Message"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="sync-message" when="last" detailed="1">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="215">A message has been posted on the bus. This signal is emitted from the
-thread that posted the message so one has to be careful with locking.
-
-This signal will not be emitted by default, you have to call
-gst_bus_enable_sync_message_emission() before.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.c"
- line="218">the message that has been posted synchronously</doc>
- <type name="Message"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="BusClass"
- c:type="GstBusClass"
- glib:is-gtype-struct-for="Bus">
- <source-position filename="gst/gstbus.h" line="133"/>
- <field name="parent_class">
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="message">
- <callback name="message">
- <source-position filename="gst/gstbus.h" line="128"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="bus" transfer-ownership="none">
- <type name="Bus" c:type="GstBus*"/>
- </parameter>
- <parameter name="message" transfer-ownership="none">
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sync_message">
- <callback name="sync_message">
- <source-position filename="gst/gstbus.h" line="129"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="bus" transfer-ownership="none">
- <type name="Bus" c:type="GstBus*"/>
- </parameter>
- <parameter name="message" transfer-ownership="none">
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <bitfield name="BusFlags"
- glib:type-name="GstBusFlags"
- glib:get-type="gst_bus_flags_get_type"
- c:type="GstBusFlags">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="43">The standard flags that a bus may have.</doc>
- <member name="flushing"
- value="16"
- c:identifier="GST_BUS_FLUSHING"
- glib:nick="flushing">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="45">The bus is currently dropping all messages</doc>
- </member>
- <member name="flag_last"
- value="32"
- c:identifier="GST_BUS_FLAG_LAST"
- glib:nick="flag-last">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="46">offset to define more flags</doc>
- </member>
- </bitfield>
- <callback name="BusFunc" c:type="GstBusFunc">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="88">Specifies the type of function passed to gst_bus_add_watch() or
-gst_bus_add_watch_full(), which is called from the mainloop when a message
-is available on the bus.
-
-The message passed to the function will be unreffed after execution of this
-function so it should not be freed in the function.
-
-Note that this function is used as a GSourceFunc which means that returning
-%FALSE will remove the GSource from the mainloop.</doc>
- <source-position filename="gst/gstbus.h" line="106"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="104">%FALSE if the event source should be removed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="90">the #GstBus that sent the message</doc>
- <type name="Bus" c:type="GstBus*"/>
- </parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="91">the #GstMessage</doc>
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="92">user data that has been given, when registering the handler</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="BusPrivate" c:type="GstBusPrivate" disguised="1">
- <source-position filename="gst/gstbus.h" line="26"/>
- </record>
- <callback name="BusSyncHandler" c:type="GstBusSyncHandler">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="71">Handler will be invoked synchronously, when a new message has been injected
-into the bus. This function is mostly used internally. Only one sync handler
-can be attached to a given bus.
-
-If the handler returns GST_BUS_DROP, it should unref the message, else the
-message should not be unreffed by the sync handler.</doc>
- <source-position filename="gst/gstbus.h" line="86"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="84">#GstBusSyncReply stating what to do with the message</doc>
- <type name="BusSyncReply" c:type="GstBusSyncReply"/>
- </return-value>
- <parameters>
- <parameter name="bus" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="73">the #GstBus that sent the message</doc>
- <type name="Bus" c:type="GstBus*"/>
- </parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="74">the #GstMessage</doc>
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="75">user data that has been given, when registering the handler</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <enumeration name="BusSyncReply"
- glib:type-name="GstBusSyncReply"
- glib:get-type="gst_bus_sync_reply_get_type"
- c:type="GstBusSyncReply">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="56">The result values for a GstBusSyncHandler.</doc>
- <member name="drop"
- value="0"
- c:identifier="GST_BUS_DROP"
- glib:nick="drop">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="58">drop the message</doc>
- </member>
- <member name="pass"
- value="1"
- c:identifier="GST_BUS_PASS"
- glib:nick="pass">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="59">pass the message to the async queue</doc>
- </member>
- <member name="async"
- value="2"
- c:identifier="GST_BUS_ASYNC"
- glib:nick="async">
- <doc xml:space="preserve"
- filename="gst/gstbus.h"
- line="60">pass message to async queue, continue if message is handled</doc>
- </member>
- </enumeration>
- <function-macro name="CALL_PARENT"
- c:identifier="GST_CALL_PARENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="135">Just call the parent handler. This assumes that there is a variable
-named parent_class that points to the (duh!) parent class. Note that
-this macro is not to be used with things that return something, use
-the _WITH_DEFAULT version for that</doc>
- <source-position filename="gst/gstutils.h" line="146"/>
- <parameters>
- <parameter name="parent_class_cast">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="137">the name of the class cast macro for the parent type</doc>
- </parameter>
- <parameter name="name">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="138">name of the function to call</doc>
- </parameter>
- <parameter name="args">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="139">arguments enclosed in '( )'</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CALL_PARENT_WITH_DEFAULT"
- c:identifier="GST_CALL_PARENT_WITH_DEFAULT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="150">Same as GST_CALL_PARENT(), but in case there is no implementation, it
-evaluates to @def_return.</doc>
- <source-position filename="gst/gstutils.h" line="160"/>
- <parameters>
- <parameter name="parent_class_cast">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="152">the name of the class cast macro for the parent type</doc>
- </parameter>
- <parameter name="name">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="153">name of the function to call</doc>
- </parameter>
- <parameter name="args">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="154">arguments enclosed in '( )'</doc>
- </parameter>
- <parameter name="def_return">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="155">default result</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="CAN_INLINE" value="1" c:type="GST_CAN_INLINE">
- <source-position filename="gst/gstmacros.h" line="34"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="CAPS" c:identifier="GST_CAPS" introspectable="0">
- <source-position filename="gst/gstcaps.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CAPS_CAST"
- c:identifier="GST_CAPS_CAST"
- introspectable="0">
- <source-position filename="gst/gstcaps.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CAPS_FEATURES"
- c:identifier="GST_CAPS_FEATURES"
- introspectable="0">
- <source-position filename="gst/gstcapsfeatures.h" line="38"/>
- <parameters>
- <parameter name="object">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CAPS_FEATURES_CAST"
- c:identifier="GST_CAPS_FEATURES_CAST"
- introspectable="0">
- <source-position filename="gst/gstcapsfeatures.h" line="37"/>
- <parameters>
- <parameter name="object">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="CAPS_FEATURE_MEMORY_SYSTEM_MEMORY"
- value="memory:SystemMemory"
- c:type="GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY">
- <source-position filename="gst/gstcapsfeatures.h" line="40"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="CAPS_FLAGS"
- c:identifier="GST_CAPS_FLAGS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="142">A flags word containing #GstCapsFlags flags set on this caps.</doc>
- <source-position filename="gst/gstcaps.h" line="148"/>
- <parameters>
- <parameter name="caps">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="144">a #GstCaps.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CAPS_FLAG_IS_SET"
- c:identifier="GST_CAPS_FLAG_IS_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="166">Gives the status of a specific flag on a caps.</doc>
- <source-position filename="gst/gstcaps.h" line="173"/>
- <parameters>
- <parameter name="caps">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="168">a #GstCaps.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="169">the #GstCapsFlags to check.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CAPS_FLAG_SET"
- c:identifier="GST_CAPS_FLAG_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="174">Sets a caps flag on a caps.</doc>
- <source-position filename="gst/gstcaps.h" line="181"/>
- <parameters>
- <parameter name="caps">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="176">a #GstCaps.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="177">the #GstCapsFlags to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CAPS_FLAG_UNSET"
- c:identifier="GST_CAPS_FLAG_UNSET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="182">Clears a caps flag.</doc>
- <source-position filename="gst/gstcaps.h" line="189"/>
- <parameters>
- <parameter name="caps">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="184">a #GstCaps.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="185">the #GstCapsFlags to clear.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CAPS_IS_SIMPLE"
- c:identifier="GST_CAPS_IS_SIMPLE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="113">Convenience macro that checks if the number of structures in the given caps
-is exactly one.</doc>
- <source-position filename="gst/gstcaps.h" line="120"/>
- <parameters>
- <parameter name="caps">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="115">the #GstCaps instance to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CAPS_REFCOUNT"
- c:identifier="GST_CAPS_REFCOUNT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="151">Get access to the reference count field of the caps</doc>
- <source-position filename="gst/gstcaps.h" line="157"/>
- <parameters>
- <parameter name="caps">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="153">a #GstCaps</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CAPS_REFCOUNT_VALUE"
- c:identifier="GST_CAPS_REFCOUNT_VALUE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="158">Get the reference count value of the caps.</doc>
- <source-position filename="gst/gstcaps.h" line="164"/>
- <parameters>
- <parameter name="caps">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="160">a #GstCaps</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CAT_MEMDUMP"
- c:identifier="GST_CAT_MEMDUMP"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="902">Output a hexdump of @data in the given category.
-
-There is no need to finish the end of the message string with a newline
-character, a newline character will be added automatically.</doc>
- <source-position filename="gst/gstinfo.h" line="730"/>
- <parameters>
- <parameter name="cat">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="904">category to use</doc>
- </parameter>
- <parameter name="msg">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="905">message string to log with the data</doc>
- </parameter>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="906">pointer to the data to output</doc>
- </parameter>
- <parameter name="length">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="907">length of the data to output</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CAT_MEMDUMP_OBJECT"
- c:identifier="GST_CAT_MEMDUMP_OBJECT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="816">Output a hexdump of @data relating to the given object in the given
-category.
-
-There is no need to finish the end of the message string with a newline
-character, a newline character will be added automatically.</doc>
- <source-position filename="gst/gstinfo.h" line="728"/>
- <parameters>
- <parameter name="cat">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="818">category to use</doc>
- </parameter>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="819">the #GObject the message belongs to</doc>
- </parameter>
- <parameter name="msg">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="820">message string to log with the data</doc>
- </parameter>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="821">pointer to the data to output</doc>
- </parameter>
- <parameter name="length">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="822">length of the data to output</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CHECK_VERSION"
- c:identifier="GST_CHECK_VERSION"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstversion.h"
- line="72">Check whether a GStreamer version equal to or greater than
-major.minor.micro is present.</doc>
- <source-position filename="gst/gstversion.h" line="81"/>
- <parameters>
- <parameter name="major">
- <doc xml:space="preserve"
- filename="gst/gstversion.h"
- line="74">a number indicating the major version</doc>
- </parameter>
- <parameter name="minor">
- <doc xml:space="preserve"
- filename="gst/gstversion.h"
- line="75">a number indicating the minor version</doc>
- </parameter>
- <parameter name="micro">
- <doc xml:space="preserve"
- filename="gst/gstversion.h"
- line="76">a number indicating the micro version</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CHILD_PROXY"
- c:identifier="GST_CHILD_PROXY"
- introspectable="0">
- <source-position filename="gst/gstchildproxy.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CHILD_PROXY_GET_INTERFACE"
- c:identifier="GST_CHILD_PROXY_GET_INTERFACE"
- introspectable="0">
- <source-position filename="gst/gstchildproxy.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK" c:identifier="GST_CLOCK" introspectable="0">
- <source-position filename="gst/gstclock.h" line="34"/>
- <parameters>
- <parameter name="clock">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_CAST"
- c:identifier="GST_CLOCK_CAST"
- introspectable="0">
- <source-position filename="gst/gstclock.h" line="39"/>
- <parameters>
- <parameter name="clock">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_CLASS"
- c:identifier="GST_CLOCK_CLASS"
- introspectable="0">
- <source-position filename="gst/gstclock.h" line="36"/>
- <parameters>
- <parameter name="cclass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_DIFF"
- c:identifier="GST_CLOCK_DIFF"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="153">Calculate a difference between two clock times as a #GstClockTimeDiff.
-The difference is calculated as @e - @s.</doc>
- <source-position filename="gst/gstclock.h" line="161"/>
- <parameters>
- <parameter name="s">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="155">the first time</doc>
- </parameter>
- <parameter name="e">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="156">the second time</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_ENTRY"
- c:identifier="GST_CLOCK_ENTRY"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="335">Cast to a clock entry</doc>
- <source-position filename="gst/gstclock.h" line="341"/>
- <parameters>
- <parameter name="entry">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="337">the entry to cast</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_ENTRY_CLOCK"
- c:identifier="GST_CLOCK_ENTRY_CLOCK"
- introspectable="0"
- deprecated="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="344">Get the owner clock of the entry</doc>
- <doc-deprecated xml:space="preserve">Use gst_clock_id_get_clock() instead.</doc-deprecated>
- <source-position filename="gst/gstclock.h" line="352"/>
- <parameters>
- <parameter name="entry">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="346">the entry to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_ENTRY_INTERVAL"
- c:identifier="GST_CLOCK_ENTRY_INTERVAL"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="368">Get the interval of this periodic entry</doc>
- <source-position filename="gst/gstclock.h" line="374"/>
- <parameters>
- <parameter name="entry">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="370">the entry to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_ENTRY_STATUS"
- c:identifier="GST_CLOCK_ENTRY_STATUS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="375">The status of the entry</doc>
- <source-position filename="gst/gstclock.h" line="381"/>
- <parameters>
- <parameter name="entry">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="377">the entry to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_ENTRY_TIME"
- c:identifier="GST_CLOCK_ENTRY_TIME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="361">Get the requested time of this entry</doc>
- <source-position filename="gst/gstclock.h" line="367"/>
- <parameters>
- <parameter name="entry">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="363">the entry to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_ENTRY_TYPE"
- c:identifier="GST_CLOCK_ENTRY_TYPE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="354">Get the type of the clock entry</doc>
- <source-position filename="gst/gstclock.h" line="360"/>
- <parameters>
- <parameter name="entry">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="356">the entry to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_FLAGS"
- c:identifier="GST_CLOCK_FLAGS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="444">Gets the #GstClockFlags clock flags.</doc>
- <source-position filename="gst/gstclock.h" line="450"/>
- <parameters>
- <parameter name="clock">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="446">the clock to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_GET_CLASS"
- c:identifier="GST_CLOCK_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstclock.h" line="38"/>
- <parameters>
- <parameter name="clock">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_STIME_IS_VALID"
- c:identifier="GST_CLOCK_STIME_IS_VALID"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="88">Tests if a given #GstClockTimeDiff of #gint64 represents a valid defined time.</doc>
- <source-position filename="gst/gstclock.h" line="96"/>
- <parameters>
- <parameter name="time">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="90">signed clock time to validate</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CLOCK_TIME_IS_VALID"
- c:identifier="GST_CLOCK_TIME_IS_VALID"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="74">Tests if a given #GstClockTime represents a valid defined time.</doc>
- <source-position filename="gst/gstclock.h" line="80"/>
- <parameters>
- <parameter name="time">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="76">clock time to validate</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="CLOCK_TIME_NONE"
- value="18446744073709551615"
- c:type="GST_CLOCK_TIME_NONE">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="68">Constant to define an undefined clock time.</doc>
- <source-position filename="gst/gstclock.h" line="73"/>
- <type name="ClockTime" c:type="GstClockTime"/>
- </constant>
- <function-macro name="CONTEXT"
- c:identifier="GST_CONTEXT"
- introspectable="0">
- <source-position filename="gst/gstcontext.h" line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CONTEXT_CAST"
- c:identifier="GST_CONTEXT_CAST"
- introspectable="0">
- <source-position filename="gst/gstcontext.h" line="40"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CONTROL_BINDING"
- c:identifier="GST_CONTROL_BINDING"
- introspectable="0">
- <source-position filename="gst/gstcontrolbinding.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CONTROL_BINDING_CLASS"
- c:identifier="GST_CONTROL_BINDING_CLASS"
- introspectable="0">
- <source-position filename="gst/gstcontrolbinding.h" line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CONTROL_BINDING_GET_CLASS"
- c:identifier="GST_CONTROL_BINDING_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstcontrolbinding.h" line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CONTROL_BINDING_PSPEC"
- c:identifier="GST_CONTROL_BINDING_PSPEC"
- introspectable="0">
- <source-position filename="gst/gstcontrolbinding.h" line="113"/>
- <parameters>
- <parameter name="cb">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CONTROL_SOURCE"
- c:identifier="GST_CONTROL_SOURCE"
- introspectable="0">
- <source-position filename="gst/gstcontrolsource.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CONTROL_SOURCE_CLASS"
- c:identifier="GST_CONTROL_SOURCE_CLASS"
- introspectable="0">
- <source-position filename="gst/gstcontrolsource.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="CONTROL_SOURCE_GET_CLASS"
- c:identifier="GST_CONTROL_SOURCE_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstcontrolsource.h" line="43"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <record name="Caps"
- c:type="GstCaps"
- glib:type-name="GstCaps"
- glib:get-type="gst_caps_get_type"
- c:symbol-prefix="caps">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="20">Caps (capabilities) are lightweight refcounted objects describing media types.
-They are composed of an array of #GstStructure.
-
-Caps are exposed on #GstPadTemplate to describe all possible types a
-given pad can handle. They are also stored in the #GstRegistry along with
-a description of the #GstElement.
-
-Caps are exposed on the element pads using the gst_pad_query_caps() pad
-function. This function describes the possible types that the pad can
-handle or produce at runtime.
-
-A #GstCaps can be constructed with the following code fragment:
-|[&lt;!-- language="C" --&gt;
- GstCaps *caps = gst_caps_new_simple ("video/x-raw",
- "format", G_TYPE_STRING, "I420",
- "framerate", GST_TYPE_FRACTION, 25, 1,
- "pixel-aspect-ratio", GST_TYPE_FRACTION, 1, 1,
- "width", G_TYPE_INT, 320,
- "height", G_TYPE_INT, 240,
- NULL);
-]|
-
-A #GstCaps is fixed when it has no properties with ranges or lists. Use
-gst_caps_is_fixed() to test for fixed caps. Fixed caps can be used in a
-caps event to notify downstream elements of the current media type.
-
-Various methods exist to work with the media types such as subtracting
-or intersecting.
-
-Be aware that the current #GstCaps / #GstStructure serialization into string
-has limited support for nested #GstCaps / #GstStructure fields. It can only
-support one level of nesting. Using more levels will lead to unexpected
-behavior when using serialization features, such as gst_caps_to_string() or
-gst_value_serialize() and their counterparts.</doc>
- <source-position filename="gst/gstcaps.h" line="334"/>
- <field name="mini_object" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="328">the parent type</doc>
- <type name="MiniObject" c:type="GstMiniObject"/>
- </field>
- <constructor name="new_any" c:identifier="gst_caps_new_any">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="268">Creates a new #GstCaps that indicates that it is compatible with
-any media format.</doc>
- <source-position filename="gst/gstcaps.h" line="413"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="274">the new #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- </constructor>
- <constructor name="new_empty" c:identifier="gst_caps_new_empty">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="242">Creates a new #GstCaps that is empty. That is, the returned
-#GstCaps contains no media formats.
-The #GstCaps is guaranteed to be writable.
-Caller is responsible for unreffing the returned caps.</doc>
- <source-position filename="gst/gstcaps.h" line="410"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="250">the new #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- </constructor>
- <constructor name="new_empty_simple"
- c:identifier="gst_caps_new_empty_simple">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="286">Creates a new #GstCaps that contains one #GstStructure with name
-@media_type.
-Caller is responsible for unreffing the returned caps.</doc>
- <source-position filename="gst/gstcaps.h" line="416"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="294">the new #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="media_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="288">the media type of the structure</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_full"
- c:identifier="gst_caps_new_full"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="344">Creates a new #GstCaps and adds all the structures listed as
-arguments. The list must be %NULL-terminated. The structures
-are not copied; the returned #GstCaps owns the structures.</doc>
- <source-position filename="gst/gstcaps.h" line="423"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="353">the new #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="struct1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="346">the first structure to add</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="347">additional structures to add</doc>
- <varargs/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_full_valist"
- c:identifier="gst_caps_new_full_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="368">Creates a new #GstCaps and adds all the structures listed as
-arguments. The list must be %NULL-terminated. The structures
-are not copied; the returned #GstCaps owns the structures.</doc>
- <source-position filename="gst/gstcaps.h" line="426"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="377">the new #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="370">the first structure to add</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="371">additional structures to add</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_simple"
- c:identifier="gst_caps_new_simple"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="310">Creates a new #GstCaps that contains one #GstStructure. The
-structure is defined by the arguments, which have the same format
-as gst_structure_new().
-Caller is responsible for unreffing the returned caps.</doc>
- <source-position filename="gst/gstcaps.h" line="419"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="321">the new #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="media_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="312">the media type of the structure</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="313">first field to set</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="314">additional arguments</doc>
- <varargs/>
- </parameter>
- </parameters>
- </constructor>
- <method name="append" c:identifier="gst_caps_append">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="550">Appends the structures contained in @caps2 to @caps1. The structures in
-@caps2 are not copied -- they are transferred to @caps1, and then @caps2 is
-freed. If either caps is ANY, the resulting caps will be ANY.</doc>
- <source-position filename="gst/gstcaps.h" line="443"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="552">the #GstCaps that will be appended to</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="caps2" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="553">the #GstCaps to append</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="append_structure" c:identifier="gst_caps_append_structure">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="639">Appends @structure to @caps. The structure is not copied; @caps
-becomes the owner of @structure.</doc>
- <source-position filename="gst/gstcaps.h" line="446"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="641">the #GstCaps that will be appended to</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="structure" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="642">the #GstStructure to append</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="append_structure_full"
- c:identifier="gst_caps_append_structure_full"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="665">Appends @structure with @features to @caps. The structure is not copied; @caps
-becomes the owner of @structure.</doc>
- <source-position filename="gst/gstcaps.h" line="449"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="667">the #GstCaps that will be appended to</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="structure" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="668">the #GstStructure to append</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="features"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="669">the #GstCapsFeatures to append</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </parameter>
- </parameters>
- </method>
- <method name="can_intersect" c:identifier="gst_caps_can_intersect">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1528">Tries intersecting @caps1 and @caps2 and reports whether the result would not
-be empty</doc>
- <source-position filename="gst/gstcaps.h" line="547"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1536">%TRUE if intersection would be not empty</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1530">a #GstCaps to intersect</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- <parameter name="caps2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1531">a #GstCaps to intersect</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_caps_copy">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2664">Creates a new #GstCaps as a copy of the old @caps. The new caps will have a
-refcount of 1, owned by the caller. The structures are copied as well.
-
-Note that this function is the semantic equivalent of a gst_caps_ref()
-followed by a gst_caps_make_writable(). If you only want to hold on to a
-reference to the data, you should use gst_caps_ref().
-
-When you are finished with the caps, call gst_caps_unref() on it.</doc>
- <source-position filename="gst/gstcaps.h" line="249"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2677">the new #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2666">a #GstCaps.</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="copy_nth" c:identifier="gst_caps_copy_nth" version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1019">Creates a new #GstCaps and appends a copy of the nth structure
-contained in @caps.</doc>
- <source-position filename="gst/gstcaps.h" line="487"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1027">the new #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1021">the #GstCaps to copy</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1022">the nth structure to copy</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="filter_and_map_in_place"
- c:identifier="gst_caps_filter_and_map_in_place"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2605">Calls the provided function once for each structure and caps feature in the
-#GstCaps. In contrast to gst_caps_foreach(), the function may modify the
-structure and features. In contrast to gst_caps_filter_and_map_in_place(),
-the structure and features are removed from the caps if %FALSE is returned
-from the function.
-The caps must be mutable.</doc>
- <source-position filename="gst/gstcaps.h" line="512"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2607">a #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2608">a function to call for each field</doc>
- <type name="CapsFilterMapFunc" c:type="GstCapsFilterMapFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2609">private data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="fixate" c:identifier="gst_caps_fixate">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2238">Modifies the given @caps into a representation with only fixed
-values. First the caps will be truncated and then the first structure will be
-fixated with gst_structure_fixate().
-
-This function takes ownership of @caps and will call gst_caps_make_writable()
-on it so you must not use @caps afterwards unless you keep an additional
-reference to it with gst_caps_ref().
-
-Note that it is not guaranteed that the returned caps have exactly one
-structure. If @caps are empty caps then then returned caps will be
-the empty too and contain no structure at all.
-
-Calling this function with any caps is not allowed.</doc>
- <source-position filename="gst/gstcaps.h" line="573"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2256">the fixated caps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2240">a #GstCaps to fixate</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="foreach" c:identifier="gst_caps_foreach" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2516">Calls the provided function once for each structure and caps feature in the
-#GstCaps. The function must not modify the fields.
-Also see gst_caps_map_in_place() and gst_caps_filter_and_map_in_place().</doc>
- <source-position filename="gst/gstcaps.h" line="504"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2526">%TRUE if the supplied function returns %TRUE for each call,
-%FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2518">a #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2519">a function to call for each field</doc>
- <type name="CapsForeachFunc" c:type="GstCapsForeachFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2520">private data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_features"
- c:identifier="gst_caps_get_features"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="888">Finds the features in @caps that has the index @index, and
-returns it.
-
-WARNING: This function takes a const GstCaps *, but returns a
-non-const GstCapsFeatures *. This is for programming convenience --
-the caller should be aware that structures inside a constant
-#GstCaps should not be modified. However, if you know the caps
-are writable, either because you have just copied them or made
-them writable with gst_caps_make_writable(), you may modify the
-features returned in the usual way, e.g. with functions like
-gst_caps_features_add().
-
-You do not need to free or unref the structure returned, it
-belongs to the #GstCaps.</doc>
- <source-position filename="gst/gstcaps.h" line="484"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="908">a pointer to the #GstCapsFeatures
- corresponding to @index</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="890">a #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="891">the index of the structure</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_size" c:identifier="gst_caps_get_size">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="840">Gets the number of structures contained in @caps.</doc>
- <source-position filename="gst/gstcaps.h" line="467"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="846">the number of structures that @caps contains</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="842">a #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_structure" c:identifier="gst_caps_get_structure">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="856">Finds the structure in @caps that has the index @index, and
-returns it.
-
-WARNING: This function takes a const GstCaps *, but returns a
-non-const GstStructure *. This is for programming convenience --
-the caller should be aware that structures inside a constant
-#GstCaps should not be modified. However, if you know the caps
-are writable, either because you have just copied them or made
-them writable with gst_caps_make_writable(), you may modify the
-structure returned in the usual way, e.g. with functions like
-gst_structure_set().
-
-You do not need to free or unref the structure returned, it
-belongs to the #GstCaps.</doc>
- <source-position filename="gst/gstcaps.h" line="470"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="876">a pointer to the #GstStructure corresponding
- to @index</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="858">a #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="859">the index of the structure</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="intersect" c:identifier="gst_caps_intersect">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1788">Creates a new #GstCaps that contains all the formats that are common
-to both @caps1 and @caps2. Defaults to %GST_CAPS_INTERSECT_ZIG_ZAG mode.</doc>
- <source-position filename="gst/gstcaps.h" line="557"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1796">the new #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1790">a #GstCaps to intersect</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="caps2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1791">a #GstCaps to intersect</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="intersect_full" c:identifier="gst_caps_intersect_full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1742">Creates a new #GstCaps that contains all the formats that are common
-to both @caps1 and @caps2, the order is defined by the #GstCapsIntersectMode
-used.</doc>
- <source-position filename="gst/gstcaps.h" line="560"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1752">the new #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1744">a #GstCaps to intersect</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="caps2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1745">a #GstCaps to intersect</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1746">The intersection algorithm/mode to use</doc>
- <type name="CapsIntersectMode" c:type="GstCapsIntersectMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_always_compatible"
- c:identifier="gst_caps_is_always_compatible">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1292">A given #GstCaps structure is always compatible with another if
-every media format that is in the first is also contained in the
-second. That is, @caps1 is a subset of @caps2.</doc>
- <source-position filename="gst/gstcaps.h" line="528"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1301">%TRUE if @caps1 is a subset of @caps2.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1294">the #GstCaps to test</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- <parameter name="caps2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1295">the #GstCaps to test</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_any" c:identifier="gst_caps_is_any">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1184">Determines if @caps represents any media format.</doc>
- <source-position filename="gst/gstcaps.h" line="519"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1190">%TRUE if @caps represents any format.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1186">the #GstCaps to test</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_empty" c:identifier="gst_caps_is_empty">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1200">Determines if @caps represents no media formats.</doc>
- <source-position filename="gst/gstcaps.h" line="522"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1206">%TRUE if @caps represents no formats.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1202">the #GstCaps to test</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_equal" c:identifier="gst_caps_is_equal">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1452">Checks if the given caps represent the same set of caps.</doc>
- <source-position filename="gst/gstcaps.h" line="541"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1459">%TRUE if both caps are equal.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1454">a #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- <parameter name="caps2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1455">another #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_equal_fixed" c:identifier="gst_caps_is_equal_fixed">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1260">Tests if two #GstCaps are equal. This function only works on fixed
-#GstCaps.</doc>
- <source-position filename="gst/gstcaps.h" line="544"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1268">%TRUE if the arguments represent the same format</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1262">the #GstCaps to test</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- <parameter name="caps2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1263">the #GstCaps to test</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_fixed" c:identifier="gst_caps_is_fixed">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1226">Fixed #GstCaps describe exactly one format, that is, they have exactly
-one structure, and each field in the structure describes a fixed type.
-Examples of non-fixed types are GST_TYPE_INT_RANGE and GST_TYPE_LIST.</doc>
- <source-position filename="gst/gstcaps.h" line="525"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1234">%TRUE if @caps is fixed</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1228">the #GstCaps to test</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_strictly_equal"
- c:identifier="gst_caps_is_strictly_equal">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1476">Checks if the given caps are exactly the same set of caps.</doc>
- <source-position filename="gst/gstcaps.h" line="550"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1483">%TRUE if both caps are strictly equal.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1478">a #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- <parameter name="caps2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1479">another #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_subset" c:identifier="gst_caps_is_subset">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1312">Checks if all caps represented by @subset are also represented by @superset.</doc>
- <source-position filename="gst/gstcaps.h" line="531"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1319">%TRUE if @subset is a subset of @superset</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="subset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1314">a #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- <parameter name="superset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1315">a potentially greater #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_subset_structure"
- c:identifier="gst_caps_is_subset_structure">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1368">Checks if @structure is a subset of @caps. See gst_caps_is_subset()
-for more information.</doc>
- <source-position filename="gst/gstcaps.h" line="534"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1376">%TRUE if @structure is a subset of @caps</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1370">a #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- <parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1371">a potential #GstStructure subset of @caps</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_subset_structure_full"
- c:identifier="gst_caps_is_subset_structure_full"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1404">Checks if @structure is a subset of @caps. See gst_caps_is_subset()
-for more information.</doc>
- <source-position filename="gst/gstcaps.h" line="537"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1413">%TRUE if @structure is a subset of @caps</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1406">a #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- <parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1407">a potential #GstStructure subset of @caps</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </parameter>
- <parameter name="features"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1408">a #GstCapsFeatures for @structure</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </parameter>
- </parameters>
- </method>
- <method name="map_in_place"
- c:identifier="gst_caps_map_in_place"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2557">Calls the provided function once for each structure and caps feature in the
-#GstCaps. In contrast to gst_caps_foreach(), the function may modify but not
-delete the structures and features. The caps must be mutable.</doc>
- <source-position filename="gst/gstcaps.h" line="508"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2567">%TRUE if the supplied function returns %TRUE for each call,
-%FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2559">a #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2560">a function to call for each field</doc>
- <type name="CapsMapFunc" c:type="GstCapsMapFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2561">private data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="merge" c:identifier="gst_caps_merge">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="585">Appends the structures contained in @caps2 to @caps1 if they are not yet
-expressed by @caps1. The structures in @caps2 are not copied -- they are
-transferred to a writable copy of @caps1, and then @caps2 is freed.
-If either caps is ANY, the resulting caps will be ANY.</doc>
- <source-position filename="gst/gstcaps.h" line="456"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="595">the merged caps.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps1" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="587">the #GstCaps that will take the new entries</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="caps2" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="588">the #GstCaps to merge in</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="merge_structure" c:identifier="gst_caps_merge_structure">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="718">Appends @structure to @caps if its not already expressed by @caps.</doc>
- <source-position filename="gst/gstcaps.h" line="459"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="725">the merged caps.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="720">the #GstCaps to merge into</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="structure" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="721">the #GstStructure to merge</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="merge_structure_full"
- c:identifier="gst_caps_merge_structure_full"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="771">Appends @structure with @features to @caps if its not already expressed by @caps.</doc>
- <source-position filename="gst/gstcaps.h" line="462"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="779">the merged caps.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="773">the #GstCaps to merge into</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="structure" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="774">the #GstStructure to merge</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="features"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="775">the #GstCapsFeatures to merge</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </parameter>
- </parameters>
- </method>
- <method name="normalize" c:identifier="gst_caps_normalize">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2001">Returns a #GstCaps that represents the same set of formats as
-@caps, but contains no lists. Each list is expanded into separate
-@GstStructures.
-
-This function takes ownership of @caps and will call gst_caps_make_writable()
-on it so you must not use @caps afterwards unless you keep an additional
-reference to it with gst_caps_ref().</doc>
- <source-position filename="gst/gstcaps.h" line="567"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2013">the normalized #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2003">a #GstCaps to normalize</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_caps_ref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="192">Add a reference to a #GstCaps object.
-
-From this point on, until the caller calls gst_caps_unref() or
-gst_caps_make_writable(), it is guaranteed that the caps object will not
-change. This means its structures won't change, etc. To use a #GstCaps
-object, you must always have a refcount on it -- either the one made
-implicitly by e.g. gst_caps_new_simple(), or via taking one explicitly with
-this function.</doc>
- <source-position filename="gst/gstcaps.h" line="207"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="205">the same #GstCaps object.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="194">the #GstCaps to reference</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_structure" c:identifier="gst_caps_remove_structure">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="697">removes the structure with the given index from the list of structures
-contained in @caps.</doc>
- <source-position filename="gst/gstcaps.h" line="453"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="699">the #GstCaps to remove from</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="700">Index of the structure to remove</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_features"
- c:identifier="gst_caps_set_features"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="946">Sets the #GstCapsFeatures @features for the structure at @index.</doc>
- <source-position filename="gst/gstcaps.h" line="476"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="948">a #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="949">the index of the structure</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="features"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="950">the #GstCapsFeatures to set</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_features_simple"
- c:identifier="gst_caps_set_features_simple"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="979">Sets the #GstCapsFeatures @features for all the structures of @caps.</doc>
- <source-position filename="gst/gstcaps.h" line="480"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="981">a #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="features"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="982">the #GstCapsFeatures to set</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_simple"
- c:identifier="gst_caps_set_simple"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1160">Sets fields in a #GstCaps. The arguments must be passed in the same
-manner as gst_structure_set(), and be %NULL-terminated.</doc>
- <source-position filename="gst/gstcaps.h" line="497"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1162">the #GstCaps to set</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1163">first field to set</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1164">additional parameters</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="set_simple_valist"
- c:identifier="gst_caps_set_simple_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1122">Sets fields in a #GstCaps. The arguments must be passed in the same
-manner as gst_structure_set(), and be %NULL-terminated.</doc>
- <source-position filename="gst/gstcaps.h" line="500"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1124">the #GstCaps to set</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1125">first field to set</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="varargs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1126">additional parameters</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_value" c:identifier="gst_caps_set_value">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1095">Sets the given @field on all structures of @caps to the given @value.
-This is a convenience function for calling gst_structure_set_value() on
-all structures of @caps.</doc>
- <source-position filename="gst/gstcaps.h" line="493"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1097">a writable caps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1098">name of the field to set</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1099">value to set the field to</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="simplify" c:identifier="gst_caps_simplify">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2159">Converts the given @caps into a representation that represents the
-same set of formats, but in a simpler form. Component structures that are
-identical are merged. Component structures that have values that can be
-merged are also merged.
-
-This function takes ownership of @caps and will call gst_caps_make_writable()
-on it if necessary, so you must not use @caps afterwards unless you keep an
-additional reference to it with gst_caps_ref().
-
-This method does not preserve the original order of @caps.</doc>
- <source-position filename="gst/gstcaps.h" line="570"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2174">The simplified caps.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2161">a #GstCaps to simplify</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="steal_structure" c:identifier="gst_caps_steal_structure">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="527">Retrieves the structure with the given index from the list of structures
-contained in @caps. The caller becomes the owner of the returned structure.</doc>
- <source-position filename="gst/gstcaps.h" line="473"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="535">a pointer to the #GstStructure
- corresponding to @index.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="529">the #GstCaps to retrieve from</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="530">Index of the structure to retrieve</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="subtract" c:identifier="gst_caps_subtract">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1867">Subtracts the @subtrahend from the @minuend.
-&gt; This function does not work reliably if optional properties for caps
-&gt; are included on one caps and omitted on the other.</doc>
- <source-position filename="gst/gstcaps.h" line="564"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1876">the resulting caps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="minuend" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1869">#GstCaps to subtract from</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- <parameter name="subtrahend" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1870">#GstCaps to subtract</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_string" c:identifier="gst_caps_to_string">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2294">Converts @caps to a string representation. This string representation
-can be converted back to a #GstCaps by gst_caps_from_string().
-
-For debugging purposes its easier to do something like this:
-|[&lt;!-- language="C" --&gt;
-GST_LOG ("caps are %" GST_PTR_FORMAT, caps);
-]|
-This prints the caps in human readable form.
-
-The current implementation of serialization will lead to unexpected results
-when there are nested #GstCaps / #GstStructure deeper than one level.</doc>
- <source-position filename="gst/gstcaps.h" line="578"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2310">a newly allocated string representing @caps.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2296">a #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="truncate" c:identifier="gst_caps_truncate">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1054">Discard all but the first structure from @caps. Useful when
-fixating.
-
-This function takes ownership of @caps and will call gst_caps_make_writable()
-on it if necessary, so you must not use @caps afterwards unless you keep an
-additional reference to it with gst_caps_ref().
-
-Note that it is not guaranteed that the returned caps have exactly one
-structure. If @caps is any or empty caps then then returned caps will be
-the same and contain no structure at all.</doc>
- <source-position filename="gst/gstcaps.h" line="490"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1069">truncated caps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="1056">the #GstCaps to truncate</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_caps_unref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="214">Unref a #GstCaps and and free all its structures and the
-structures' values when the refcount reaches 0.</doc>
- <source-position filename="gst/gstcaps.h" line="221"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="216">a #GstCaps.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="from_string" c:identifier="gst_caps_from_string">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2476">Converts @caps from a string representation.
-
-The current implementation of serialization will lead to unexpected results
-when there are nested #GstCaps / #GstStructure deeper than one level.</doc>
- <source-position filename="gst/gstcaps.h" line="581"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2485">a newly allocated #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="string" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2478">a string to convert to #GstCaps</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="replace"
- c:identifier="gst_caps_replace"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="283">Modifies a pointer to a #GstCaps to point to a different #GstCaps. The
-modification is done atomically (so this is useful for ensuring thread safety
-in some cases), and the reference counts are updated appropriately (the old
-caps is unreffed, the new is reffed).
-
-Either @new_caps or the #GstCaps pointed to by @old_caps may be %NULL.</doc>
- <source-position filename="gst/gstcaps.h" line="299"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="297">%TRUE if @new_caps was different from @old_caps</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="old_caps"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="285">pointer to a pointer
- to a #GstCaps to be replaced.</doc>
- <type name="Caps" c:type="GstCaps**"/>
- </parameter>
- <parameter name="new_caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="287">pointer to a #GstCaps that will
- replace the caps pointed to by @old_caps.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="take" c:identifier="gst_caps_take" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="306">Modifies a pointer to a #GstCaps to point to a different #GstCaps. This
-function is similar to gst_caps_replace() except that it takes ownership
-of @new_caps.</doc>
- <source-position filename="gst/gstcaps.h" line="319"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="317">%TRUE if @new_caps was different from @old_caps</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="old_caps"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="308">pointer to a pointer to a #GstCaps to be
- replaced.</doc>
- <type name="Caps" c:type="GstCaps**"/>
- </parameter>
- <parameter name="new_caps"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="310">pointer to a #GstCaps that will
- replace the caps pointed to by @old_caps.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <record name="CapsFeatures"
- c:type="GstCapsFeatures"
- version="1.2"
- glib:type-name="GstCapsFeatures"
- glib:get-type="gst_caps_features_get_type"
- c:symbol-prefix="caps_features">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="21">#GstCapsFeatures can optionally be set on a #GstCaps to add requirements
-for additional features for a specific #GstStructure. Caps structures with
-the same name but with a non-equal set of caps features are not compatible.
-If a pad supports multiple sets of features it has to add multiple equal
-structures with different feature sets to the caps.
-
-Empty #GstCapsFeatures are equivalent with the #GstCapsFeatures that only
-contain #GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY. ANY #GstCapsFeatures as
-created by gst_caps_features_new_any() are equal to any other #GstCapsFeatures
-and can be used to specify that any #GstCapsFeatures would be supported, e.g.
-for elements that don't touch buffer memory. #GstCaps with ANY #GstCapsFeatures
-are considered non-fixed and during negotiation some #GstCapsFeatures have
-to be selected.
-
-Examples for caps features would be the requirement of a specific #GstMemory
-types or the requirement of having a specific #GstMeta on the buffer. Features
-are given as a string of the format "memory:GstMemoryTypeName" or
-"meta:GstMetaAPIName".</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="31"/>
- <constructor name="new"
- c:identifier="gst_caps_features_new"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="220">Creates a new #GstCapsFeatures with the given features.
-The last argument must be %NULL.
-
-Free-function: gst_caps_features_free</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="61"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="230">a new, empty #GstCapsFeatures</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </return-value>
- <parameters>
- <parameter name="feature1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="222">name of first feature to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="223">additional features</doc>
- <varargs/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_any"
- c:identifier="gst_caps_features_new_any"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="196">Creates a new, ANY #GstCapsFeatures. This will be equal
-to any other #GstCapsFeatures but caps with these are
-unfixed.
-
-Free-function: gst_caps_features_free</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="58"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="205">a new, ANY #GstCapsFeatures</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </return-value>
- </constructor>
- <constructor name="new_empty"
- c:identifier="gst_caps_features_new_empty"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="169">Creates a new, empty #GstCapsFeatures.
-
-Free-function: gst_caps_features_free</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="55"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="176">a new, empty #GstCapsFeatures</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </return-value>
- </constructor>
- <constructor name="new_id"
- c:identifier="gst_caps_features_new_id"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="279">Creates a new #GstCapsFeatures with the given features.
-The last argument must be 0.
-
-Free-function: gst_caps_features_free</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="67"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="289">a new, empty #GstCapsFeatures</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </return-value>
- <parameters>
- <parameter name="feature1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="281">name of first feature to set</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="282">additional features</doc>
- <varargs/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_id_valist"
- c:identifier="gst_caps_features_new_id_valist"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="308">Creates a new #GstCapsFeatures with the given features.
-
-Free-function: gst_caps_features_free</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="70"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="317">a new, empty #GstCapsFeatures</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </return-value>
- <parameters>
- <parameter name="feature1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="310">name of first feature to set</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="varargs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="311">variable argument list</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_valist"
- c:identifier="gst_caps_features_new_valist"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="249">Creates a new #GstCapsFeatures with the given features.
-
-Free-function: gst_caps_features_free</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="64"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="258">a new, empty #GstCapsFeatures</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </return-value>
- <parameters>
- <parameter name="feature1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="251">name of first feature to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="varargs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="252">variable argument list</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="add" c:identifier="gst_caps_features_add" version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="768">Adds @feature to @features.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="109"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="770">a #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </instance-parameter>
- <parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="771">a feature.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_id"
- c:identifier="gst_caps_features_add_id"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="788">Adds @feature to @features.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="112"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="790">a #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </instance-parameter>
- <parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="791">a feature.</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- </parameters>
- </method>
- <method name="contains"
- c:identifier="gst_caps_features_contains"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="647">Check if @features contains @feature.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="97"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="654">%TRUE if @features contains @feature.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="649">a #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </instance-parameter>
- <parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="650">a feature</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="contains_id"
- c:identifier="gst_caps_features_contains_id"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="669">Check if @features contains @feature.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="100"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="676">%TRUE if @features contains @feature.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="671">a #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </instance-parameter>
- <parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="672">a feature</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_caps_features_copy" version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="377">Duplicates a #GstCapsFeatures and all its values.
-
-Free-function: gst_caps_features_free</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="76"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="385">a new #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="379">a #GstCapsFeatures to duplicate</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_caps_features_free" version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="406">Frees a #GstCapsFeatures and all its values. The caps features must not
-have a parent when this function is called.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="79"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="408">the #GstCapsFeatures to free</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_nth"
- c:identifier="gst_caps_features_get_nth"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="596">Returns the @i-th feature of @features.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="91"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="603">The @i-th feature of @features.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="598">a #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </instance-parameter>
- <parameter name="i" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="599">index of the feature</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_nth_id"
- c:identifier="gst_caps_features_get_nth_id"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="623">Returns the @i-th feature of @features.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="94"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="630">The @i-th feature of @features.</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="625">a #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </instance-parameter>
- <parameter name="i" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="626">index of the feature</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_size"
- c:identifier="gst_caps_features_get_size"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="578">Returns the number of features in @features.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="88"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="584">The number of features in @features.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="580">a #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_any"
- c:identifier="gst_caps_features_is_any"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="750">Check if @features is %GST_CAPS_FEATURES_ANY.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="106"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="756">%TRUE if @features is %GST_CAPS_FEATURES_ANY.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="752">a #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_equal"
- c:identifier="gst_caps_features_is_equal"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="703">Check if @features1 and @features2 are equal.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="103"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="710">%TRUE if @features1 and @features2 are equal.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="features1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="705">a #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </instance-parameter>
- <parameter name="features2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="706">a #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove"
- c:identifier="gst_caps_features_remove"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="821">Removes @feature from @features.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="115"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="823">a #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </instance-parameter>
- <parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="824">a feature.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_id"
- c:identifier="gst_caps_features_remove_id"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="840">Removes @feature from @features.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="118"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="842">a #GstCapsFeatures.</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </instance-parameter>
- <parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="843">a feature.</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_parent_refcount"
- c:identifier="gst_caps_features_set_parent_refcount"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="338">Sets the parent_refcount field of #GstCapsFeatures. This field is used to
-determine whether a caps features is mutable or not. This function should only be
-called by code implementing parent objects of #GstCapsFeatures, as described in
-the MT Refcounting section of the design documents.</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="73"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="348">%TRUE if the parent refcount could be set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="340">a #GstCapsFeatures</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </instance-parameter>
- <parameter name="refcount" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="341">a pointer to the parent's refcount</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_string"
- c:identifier="gst_caps_features_to_string"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="430">Converts @features to a human-readable string representation.
-
-For debugging purposes its easier to do something like this:
-|[&lt;!-- language="C" --&gt;
-GST_LOG ("features is %" GST_PTR_FORMAT, features);
-]|
-This prints the features in human readable form.
-
-Free-function: g_free</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="82"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="444">a pointer to string allocated by g_malloc().
- g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="432">a #GstCapsFeatures</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="from_string"
- c:identifier="gst_caps_features_from_string"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="486">Creates a #GstCapsFeatures from a string representation.
-
-Free-function: gst_caps_features_free</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="85"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="494">a new #GstCapsFeatures or
- %NULL when the string could not be parsed. Free with
- gst_caps_features_free() after use.</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </return-value>
- <parameters>
- <parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="488">a string representation of a #GstCapsFeatures.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <callback name="CapsFilterMapFunc" c:type="GstCapsFilterMapFunc">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="388">A function that will be called in gst_caps_filter_and_map_in_place().
-The function may modify @features and @structure, and both will be
-removed from the caps if %FALSE is returned.</doc>
- <source-position filename="gst/gstcaps.h" line="401"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="398">%TRUE if the features and structure should be preserved,
-%FALSE if it should be removed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="390">the #GstCapsFeatures</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </parameter>
- <parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="391">the #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="392">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <bitfield name="CapsFlags"
- glib:type-name="GstCapsFlags"
- glib:get-type="gst_caps_flags_get_type"
- c:type="GstCapsFlags">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="40">Extra flags for a caps.</doc>
- <member name="any"
- value="16"
- c:identifier="GST_CAPS_FLAG_ANY"
- glib:nick="any">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="42">Caps has no specific content, but can contain
- anything.</doc>
- </member>
- </bitfield>
- <callback name="CapsForeachFunc" c:type="GstCapsForeachFunc" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="354">A function that will be called in gst_caps_foreach(). The function may
-not modify @features or @structure.</doc>
- <source-position filename="gst/gstcaps.h" line="368"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="363">%TRUE if the foreach operation should continue, %FALSE if
-the foreach operation should stop with %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="356">the #GstCapsFeatures</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </parameter>
- <parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="357">the #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="358">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <enumeration name="CapsIntersectMode"
- glib:type-name="GstCapsIntersectMode"
- glib:get-type="gst_caps_intersect_mode_get_type"
- c:type="GstCapsIntersectMode">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="51">Modes of caps intersection
-
-@GST_CAPS_INTERSECT_ZIG_ZAG tries to preserve overall order of both caps
-by iterating on the caps' structures as the following matrix shows:
-|[
- caps1
- +-------------
- | 1 2 4 7
-caps2 | 3 5 8 10
- | 6 9 11 12
-]|
-Used when there is no explicit precedence of one caps over the other. e.g.
-tee's sink pad getcaps function, it will probe its src pad peers' for their
-caps and intersect them with this mode.
-
-@GST_CAPS_INTERSECT_FIRST is useful when an element wants to preserve
-another element's caps priority order when intersecting with its own caps.
-Example: If caps1 is [A, B, C] and caps2 is [E, B, D, A], the result
-would be [A, B], maintaining the first caps priority on the intersection.</doc>
- <member name="zig_zag"
- value="0"
- c:identifier="GST_CAPS_INTERSECT_ZIG_ZAG"
- glib:nick="zig-zag">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="53">Zig-zags over both caps.</doc>
- </member>
- <member name="first"
- value="1"
- c:identifier="GST_CAPS_INTERSECT_FIRST"
- glib:nick="first">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="54">Keeps the first caps order.</doc>
- </member>
- </enumeration>
- <callback name="CapsMapFunc" c:type="GstCapsMapFunc">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="372">A function that will be called in gst_caps_map_in_place(). The function
-may modify @features and @structure.</doc>
- <source-position filename="gst/gstcaps.h" line="384"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="381">%TRUE if the map operation should continue, %FALSE if
-the map operation should stop with %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="374">the #GstCapsFeatures</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </parameter>
- <parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="375">the #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="376">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <interface name="ChildProxy"
- c:symbol-prefix="child_proxy"
- c:type="GstChildProxy"
- glib:type-name="GstChildProxy"
- glib:get-type="gst_child_proxy_get_type"
- glib:type-struct="ChildProxyInterface">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="22">This interface abstracts handling of property sets for elements with
-children. Imagine elements such as mixers or polyphonic generators. They all
-have multiple #GstPad or some kind of voice objects. Another use case are
-container elements like #GstBin.
-The element implementing the interface acts as a parent for those child
-objects.
-
-By implementing this interface the child properties can be accessed from the
-parent element by using gst_child_proxy_get() and gst_child_proxy_set().
-
-Property names are written as "child-name::property-name". The whole naming
-scheme is recursive. Thus "child1::child2::property" is valid too, if
-"child1" and "child2" implement the #GstChildProxy interface.</doc>
- <source-position filename="gst/gstchildproxy.h" line="68"/>
- <virtual-method name="child_added" invoker="child_added">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="481">Emits the "child-added" signal.</doc>
- <source-position filename="gst/gstchildproxy.h" line="63"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="483">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="484">the newly added child</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="485">the name of the new child</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="child_removed" invoker="child_removed">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="496">Emits the "child-removed" signal.</doc>
- <source-position filename="gst/gstchildproxy.h" line="64"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="498">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="499">the removed child</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="500">the name of the old child</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_child_by_index" invoker="get_child_by_index">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="132">Fetches a child by its number.</doc>
- <source-position filename="gst/gstchildproxy.h" line="59"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="139">the child object or %NULL if
- not found (index too high). Unref after usage.
-
-MT safe.</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </return-value>
- <parameters>
- <instance-parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="134">the parent object to get the child from</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="135">the child's position in the child list</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_child_by_name" invoker="get_child_by_name">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="101">Looks up a child element by the given name.
-
-This virtual method has a default implementation that uses #GstObject
-together with gst_object_get_name(). If the interface is to be used with
-#GObjects, this methods needs to be overridden.</doc>
- <source-position filename="gst/gstchildproxy.h" line="58"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="112">the child object or %NULL if
- not found. Unref after usage.
-
-MT safe.</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </return-value>
- <parameters>
- <instance-parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="103">the parent object to get the child from</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="104">the child's name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_children_count" invoker="get_children_count">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="159">Gets the number of child objects this parent contains.</doc>
- <source-position filename="gst/gstchildproxy.h" line="60"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="165">the number of child objects
-
-MT safe.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="161">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <method name="child_added" c:identifier="gst_child_proxy_child_added">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="481">Emits the "child-added" signal.</doc>
- <source-position filename="gst/gstchildproxy.h" line="109"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="483">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="484">the newly added child</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="485">the name of the new child</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="child_removed"
- c:identifier="gst_child_proxy_child_removed">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="496">Emits the "child-removed" signal.</doc>
- <source-position filename="gst/gstchildproxy.h" line="112"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="498">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="child" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="499">the removed child</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="500">the name of the old child</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get" c:identifier="gst_child_proxy_get" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="347">Gets properties of the parent object and its children.</doc>
- <source-position filename="gst/gstchildproxy.h" line="93"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="349">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="first_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="350">name of the first property to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="351">return location for the first property, followed optionally by more name/return location pairs, followed by %NULL</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="get_child_by_index"
- c:identifier="gst_child_proxy_get_child_by_index">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="132">Fetches a child by its number.</doc>
- <source-position filename="gst/gstchildproxy.h" line="80"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="139">the child object or %NULL if
- not found (index too high). Unref after usage.
-
-MT safe.</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </return-value>
- <parameters>
- <instance-parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="134">the parent object to get the child from</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="135">the child's position in the child list</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_child_by_name"
- c:identifier="gst_child_proxy_get_child_by_name">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="101">Looks up a child element by the given name.
-
-This virtual method has a default implementation that uses #GstObject
-together with gst_object_get_name(). If the interface is to be used with
-#GObjects, this methods needs to be overridden.</doc>
- <source-position filename="gst/gstchildproxy.h" line="74"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="112">the child object or %NULL if
- not found. Unref after usage.
-
-MT safe.</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </return-value>
- <parameters>
- <instance-parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="103">the parent object to get the child from</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="104">the child's name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_children_count"
- c:identifier="gst_child_proxy_get_children_count">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="159">Gets the number of child objects this parent contains.</doc>
- <source-position filename="gst/gstchildproxy.h" line="77"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="165">the number of child objects
-
-MT safe.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="161">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_property" c:identifier="gst_child_proxy_get_property">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="257">Gets a single property using the GstChildProxy mechanism.
-You are responsible for freeing it by calling g_value_unset()</doc>
- <source-position filename="gst/gstchildproxy.h" line="86"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="259">object to query</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="260">name of the property</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="261">a #GValue that should take the result.</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_valist"
- c:identifier="gst_child_proxy_get_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="293">Gets properties of the parent object and its children.</doc>
- <source-position filename="gst/gstchildproxy.h" line="89"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="295">the object to query</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="first_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="296">name of the first property to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="297">return location for the first property, followed optionally by more name/return location pairs, followed by %NULL</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="lookup" c:identifier="gst_child_proxy_lookup">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="184">Looks up which object and #GParamSpec would be effected by the given @name.
-
-MT safe.</doc>
- <source-position filename="gst/gstchildproxy.h" line="83"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="197">%TRUE if @target and @pspec could be found. %FALSE otherwise. In that
-case the values for @pspec and @target are not modified. Unref @target after
-usage. For plain GObjects @target is the same as @object.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="186">child proxy object to lookup the property in</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="187">name of the property to look up</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="target"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="188">pointer to a #GObject that
- takes the real object to set property on</doc>
- <type name="GObject.Object" c:type="GObject**"/>
- </parameter>
- <parameter name="pspec"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="190">pointer to take the #GParamSpec
- describing the property</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec**"/>
- </parameter>
- </parameters>
- </method>
- <method name="set" c:identifier="gst_child_proxy_set" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="460">Sets properties of the parent object and its children.</doc>
- <source-position filename="gst/gstchildproxy.h" line="105"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="462">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="first_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="463">name of the first property to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="464">value for the first property, followed optionally by more name/value pairs, followed by %NULL</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="set_property" c:identifier="gst_child_proxy_set_property">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="368">Sets a single property using the GstChildProxy mechanism.</doc>
- <source-position filename="gst/gstchildproxy.h" line="97"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="370">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="371">name of the property to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="372">new #GValue for the property</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_valist"
- c:identifier="gst_child_proxy_set_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="402">Sets properties of the parent object and its children.</doc>
- <source-position filename="gst/gstchildproxy.h" line="101"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="404">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </instance-parameter>
- <parameter name="first_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="405">name of the first property to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="406">value for the first property, followed optionally by more name/value pairs, followed by %NULL</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <glib:signal name="child-added" when="first">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="528">Will be emitted after the @object was added to the @child_proxy.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="531">the #GObject that was added</doc>
- <type name="GObject.Object"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="532">the name of the new child</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="child-removed" when="first">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="542">Will be emitted after the @object was removed from the @child_proxy.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="545">the #GObject that was removed</doc>
- <type name="GObject.Object"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="546">the name of the old child</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- </parameters>
- </glib:signal>
- </interface>
- <record name="ChildProxyInterface"
- c:type="GstChildProxyInterface"
- glib:is-gtype-struct-for="ChildProxy">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.h"
- line="44">#GstChildProxy interface.</doc>
- <source-position filename="gst/gstchildproxy.h" line="68"/>
- <field name="parent">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.h"
- line="46">parent interface type.</doc>
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- <field name="get_child_by_name">
- <callback name="get_child_by_name">
- <source-position filename="gst/gstchildproxy.h" line="58"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="112">the child object or %NULL if
- not found. Unref after usage.
-
-MT safe.</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </return-value>
- <parameters>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="103">the parent object to get the child from</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="104">the child's name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_child_by_index">
- <callback name="get_child_by_index">
- <source-position filename="gst/gstchildproxy.h" line="59"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="139">the child object or %NULL if
- not found (index too high). Unref after usage.
-
-MT safe.</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </return-value>
- <parameters>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="134">the parent object to get the child from</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="135">the child's position in the child list</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_children_count">
- <callback name="get_children_count">
- <source-position filename="gst/gstchildproxy.h" line="60"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="165">the number of child objects
-
-MT safe.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="161">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="child_added">
- <callback name="child_added">
- <source-position filename="gst/gstchildproxy.h" line="63"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="483">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </parameter>
- <parameter name="child" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="484">the newly added child</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="485">the name of the new child</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="child_removed">
- <callback name="child_removed">
- <source-position filename="gst/gstchildproxy.h" line="64"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="498">the parent object</doc>
- <type name="ChildProxy" c:type="GstChildProxy*"/>
- </parameter>
- <parameter name="child" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="499">the removed child</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstchildproxy.c"
- line="500">the name of the old child</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="Clock"
- c:symbol-prefix="clock"
- c:type="GstClock"
- parent="Object"
- abstract="1"
- glib:type-name="GstClock"
- glib:get-type="gst_clock_get_type"
- glib:type-struct="ClockClass">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="24">GStreamer uses a global clock to synchronize the plugins in a pipeline.
-Different clock implementations are possible by implementing this abstract
-base class or, more conveniently, by subclassing #GstSystemClock.
-
-The #GstClock returns a monotonically increasing time with the method
-gst_clock_get_time(). Its accuracy and base time depend on the specific
-clock implementation but time is always expressed in nanoseconds. Since the
-baseline of the clock is undefined, the clock time returned is not
-meaningful in itself, what matters are the deltas between two clock times.
-The time returned by a clock is called the absolute time.
-
-The pipeline uses the clock to calculate the running time. Usually all
-renderers synchronize to the global clock using the buffer timestamps, the
-newsegment events and the element's base time, see #GstPipeline.
-
-A clock implementation can support periodic and single shot clock
-notifications both synchronous and asynchronous.
-
-One first needs to create a #GstClockID for the periodic or single shot
-notification using gst_clock_new_single_shot_id() or
-gst_clock_new_periodic_id().
-
-To perform a blocking wait for the specific time of the #GstClockID use the
-gst_clock_id_wait(). To receive a callback when the specific time is reached
-in the clock use gst_clock_id_wait_async(). Both these calls can be
-interrupted with the gst_clock_id_unschedule() call. If the blocking wait is
-unscheduled a return value of #GST_CLOCK_UNSCHEDULED is returned.
-
-Periodic callbacks scheduled async will be repeatedly called automatically
-until it is unscheduled. To schedule a sync periodic callback,
-gst_clock_id_wait() should be called repeatedly.
-
-The async callbacks can happen from any thread, either provided by the core
-or from a streaming thread. The application should be prepared for this.
-
-A #GstClockID that has been unscheduled cannot be used again for any wait
-operation, a new #GstClockID should be created and the old unscheduled one
-should be destroyed with gst_clock_id_unref().
-
-It is possible to perform a blocking wait on the same #GstClockID from
-multiple threads. However, registering the same #GstClockID for multiple
-async notifications is not possible, the callback will only be called for
-the thread registering the entry last.
-
-None of the wait operations unref the #GstClockID, the owner is responsible
-for unreffing the ids itself. This holds for both periodic and single shot
-notifications. The reason being that the owner of the #GstClockID has to
-keep a handle to the #GstClockID to unblock the wait on FLUSHING events or
-state changes and if the entry would be unreffed automatically, the handle
-might become invalid without any notification.
-
-These clock operations do not operate on the running time, so the callbacks
-will also occur when not in PLAYING state as if the clock just keeps on
-running. Some clocks however do not progress when the element that provided
-the clock is not PLAYING.
-
-When a clock has the #GST_CLOCK_FLAG_CAN_SET_MASTER flag set, it can be
-slaved to another #GstClock with the gst_clock_set_master(). The clock will
-then automatically be synchronized to this master clock by repeatedly
-sampling the master clock and the slave clock and recalibrating the slave
-clock with gst_clock_set_calibration(). This feature is mostly useful for
-plugins that have an internal clock but must operate with another clock
-selected by the #GstPipeline. They can track the offset and rate difference
-of their internal clock relative to the master clock by using the
-gst_clock_get_calibration() function.
-
-The master/slave synchronisation can be tuned with the #GstClock:timeout,
-#GstClock:window-size and #GstClock:window-threshold properties.
-The #GstClock:timeout property defines the interval to sample the master
-clock and run the calibration functions. #GstClock:window-size defines the
-number of samples to use when calibrating and #GstClock:window-threshold
-defines the minimum number of samples before the calibration is performed.</doc>
- <source-position filename="gst/gstclock.h" line="503"/>
- <function name="id_compare_func"
- c:identifier="gst_clock_id_compare_func">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="460">Compares the two #GstClockID instances. This function can be used
-as a GCompareFunc when sorting ids.</doc>
- <source-position filename="gst/gstclock.h" line="612"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="468">negative value if a &lt; b; zero if a = b; positive value if a &gt; b
-
-MT safe.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="id1"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="462">A #GstClockID</doc>
- <type name="gpointer" c:type="gconstpointer"/>
- </parameter>
- <parameter name="id2"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="463">A #GstClockID to compare with</doc>
- <type name="gpointer" c:type="gconstpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="id_get_clock"
- c:identifier="gst_clock_id_get_clock"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1390">This function returns the underlying clock.</doc>
- <source-position filename="gst/gstclock.h" line="615"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1396">a #GstClock or %NULL when the
- underlying clock has been freed. Unref after usage.
-
-MT safe.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </return-value>
- <parameters>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1392">a #GstClockID</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </parameter>
- </parameters>
- </function>
- <function name="id_get_time" c:identifier="gst_clock_id_get_time">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="489">Get the time of the clock ID</doc>
- <source-position filename="gst/gstclock.h" line="621"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="495">the time of the given clock id.
-
-MT safe.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="491">The #GstClockID to query</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </parameter>
- </parameters>
- </function>
- <function name="id_ref" c:identifier="gst_clock_id_ref">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="338">Increase the refcount of given @id.</doc>
- <source-position filename="gst/gstclock.h" line="604"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="344">The same #GstClockID with increased refcount.
-
-MT safe.</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </return-value>
- <parameters>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="340">The #GstClockID to ref</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </parameter>
- </parameters>
- </function>
- <function name="id_unref" c:identifier="gst_clock_id_unref">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="381">Unref given @id. When the refcount reaches 0 the
-#GstClockID will be freed.
-
-MT safe.</doc>
- <source-position filename="gst/gstclock.h" line="607"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="id" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="383">The #GstClockID to unref</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </parameter>
- </parameters>
- </function>
- <function name="id_unschedule" c:identifier="gst_clock_id_unschedule">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="676">Cancel an outstanding request with @id. This can either
-be an outstanding async notification or a pending sync notification.
-After this call, @id cannot be used anymore to receive sync or
-async notifications, you need to create a new #GstClockID.
-
-MT safe.</doc>
- <source-position filename="gst/gstclock.h" line="632"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="678">The id to unschedule</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </parameter>
- </parameters>
- </function>
- <function name="id_uses_clock"
- c:identifier="gst_clock_id_uses_clock"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1414">This function returns whether @id uses @clock as the underlying clock.
-@clock can be NULL, in which case the return value indicates whether
-the underlying clock has been freed. If this is the case, the @id is
-no longer usable and should be freed.</doc>
- <source-position filename="gst/gstclock.h" line="618"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1424">whether the clock @id uses the same underlying #GstClock @clock.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1416">a #GstClockID to check</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </parameter>
- <parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1417">a #GstClock to compare against</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- </parameters>
- </function>
- <function name="id_wait" c:identifier="gst_clock_id_wait">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="507">Perform a blocking wait on @id.
-@id should have been created with gst_clock_new_single_shot_id()
-or gst_clock_new_periodic_id() and should not have been unscheduled
-with a call to gst_clock_id_unschedule().
-
-If the @jitter argument is not %NULL and this function returns #GST_CLOCK_OK
-or #GST_CLOCK_EARLY, it will contain the difference
-against the clock and the time of @id when this method was
-called.
-Positive values indicate how late @id was relative to the clock
-(in which case this function will return #GST_CLOCK_EARLY).
-Negative values indicate how much time was spent waiting on the clock
-before this function returned.</doc>
- <source-position filename="gst/gstclock.h" line="624"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="527">the result of the blocking wait. #GST_CLOCK_EARLY will be returned
-if the current clock time is past the time of @id, #GST_CLOCK_OK if
-@id was scheduled in time. #GST_CLOCK_UNSCHEDULED if @id was
-unscheduled with gst_clock_id_unschedule().
-
-MT safe.</doc>
- <type name="ClockReturn" c:type="GstClockReturn"/>
- </return-value>
- <parameters>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="509">The #GstClockID to wait on</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </parameter>
- <parameter name="jitter"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="510">a pointer that will contain the jitter,
- can be %NULL.</doc>
- <type name="ClockTimeDiff" c:type="GstClockTimeDiff*"/>
- </parameter>
- </parameters>
- </function>
- <function name="id_wait_async" c:identifier="gst_clock_id_wait_async">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="597">Register a callback on the given #GstClockID @id with the given
-function and user_data. When passing a #GstClockID with an invalid
-time to this function, the callback will be called immediately
-with a time set to GST_CLOCK_TIME_NONE. The callback will
-be called when the time of @id has been reached.
-
-The callback @func can be invoked from any thread, either provided by the
-core or from a streaming thread. The application should be prepared for this.</doc>
- <source-position filename="gst/gstclock.h" line="627"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="613">the result of the non blocking wait.
-
-MT safe.</doc>
- <type name="ClockReturn" c:type="GstClockReturn"/>
- </return-value>
- <parameters>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="599">a #GstClockID to wait on</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="notified"
- closure="2"
- destroy="3">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="600">The callback function</doc>
- <type name="ClockCallback" c:type="GstClockCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="601">User data passed in the callback</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="destroy_data"
- transfer-ownership="none"
- scope="async">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="602">#GDestroyNotify for user_data</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="change_resolution">
- <source-position filename="gst/gstclock.h" line="488"/>
- <return-value transfer-ownership="none">
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="old_resolution" transfer-ownership="none">
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="new_resolution" transfer-ownership="none">
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_internal_time" invoker="get_internal_time">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1059">Gets the current internal time of the given clock. The time is returned
-unadjusted for the offset and the rate.</doc>
- <source-position filename="gst/gstclock.h" line="493"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1066">the internal time of the clock. Or GST_CLOCK_TIME_NONE when
-given invalid input.
-
-MT safe.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1061">a #GstClock to query</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_resolution" invoker="get_resolution">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="860">Get the accuracy of the clock. The accuracy of the clock is the granularity
-of the values returned by gst_clock_get_time().</doc>
- <source-position filename="gst/gstclock.h" line="491"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="867">the resolution of the clock in units of #GstClockTime.
-
-MT safe.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="862">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="unschedule">
- <source-position filename="gst/gstclock.h" line="499"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="entry" transfer-ownership="none">
- <type name="ClockEntry" c:type="GstClockEntry*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="wait">
- <source-position filename="gst/gstclock.h" line="496"/>
- <return-value transfer-ownership="none">
- <type name="ClockReturn" c:type="GstClockReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="entry" transfer-ownership="none">
- <type name="ClockEntry" c:type="GstClockEntry*"/>
- </parameter>
- <parameter name="jitter" transfer-ownership="none">
- <type name="ClockTimeDiff" c:type="GstClockTimeDiff*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="wait_async">
- <source-position filename="gst/gstclock.h" line="498"/>
- <return-value transfer-ownership="none">
- <type name="ClockReturn" c:type="GstClockReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="entry" transfer-ownership="none">
- <type name="ClockEntry" c:type="GstClockEntry*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add_observation" c:identifier="gst_clock_add_observation">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1452">The time @master of the master clock and the time @slave of the slave
-clock are added to the list of observations. If enough observations
-are available, a linear regression algorithm is run on the
-observations and @clock is recalibrated.
-
-If this functions returns %TRUE, @r_squared will contain the
-correlation coefficient of the interpolation. A value of 1.0
-means a perfect regression was performed. This value can
-be used to control the sampling frequency of the master and slave
-clocks.</doc>
- <source-position filename="gst/gstclock.h" line="543"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1470">%TRUE if enough observations were added to run the
-regression algorithm.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1454">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="slave" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1455">a time on the slave</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="master" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1456">a time on the master</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="r_squared"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1457">a pointer to hold the result</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_observation_unapplied"
- c:identifier="gst_clock_add_observation_unapplied"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1491">Add a clock observation to the internal slaving algorithm the same as
-gst_clock_add_observation(), and return the result of the master clock
-estimation, without updating the internal calibration.
-
-The caller can then take the results and call gst_clock_set_calibration()
-with the values, or some modified version of them.</doc>
- <source-position filename="gst/gstclock.h" line="546"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1493">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="slave" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1494">a time on the slave</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="master" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1495">a time on the master</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="r_squared"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1496">a pointer to hold the result</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="internal"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1497">a location to store the internal time</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="external"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1498">a location to store the external time</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="rate_num"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1499">a location to store the rate numerator</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="rate_denom"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1500">a location to store the rate denominator</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="adjust_unlocked" c:identifier="gst_clock_adjust_unlocked">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="943">Converts the given @internal clock time to the external time, adjusting for the
-rate and reference time set with gst_clock_set_calibration() and making sure
-that the returned time is increasing. This function should be called with the
-clock's OBJECT_LOCK held and is mainly used by clock subclasses.
-
-This function is the reverse of gst_clock_unadjust_unlocked().</doc>
- <source-position filename="gst/gstclock.h" line="559"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="955">the converted time of the clock.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="945">a #GstClock to use</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="internal" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="946">a clock time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="adjust_with_calibration"
- c:identifier="gst_clock_adjust_with_calibration"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="887">Converts the given @internal_target clock time to the external time,
-using the passed calibration parameters. This function performs the
-same calculation as gst_clock_adjust_unlocked() when called using the
-current calibration parameters, but doesn't ensure a monotonically
-increasing result as gst_clock_adjust_unlocked() does.
-
-Note: The @clock parameter is unused and can be NULL</doc>
- <source-position filename="gst/gstclock.h" line="562"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="905">the converted time of the clock.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="889">a #GstClock to use</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="internal_target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="890">a clock time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="cinternal" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="891">a reference internal time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="cexternal" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="892">a reference external time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="cnum" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="893">the numerator of the rate of the clock relative to its
- internal time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="cdenom" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="895">the denominator of the rate of the clock</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_calibration" c:identifier="gst_clock_get_calibration">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1201">Gets the internal rate and reference time of @clock. See
-gst_clock_set_calibration() for more information.
-
-@internal, @external, @rate_num, and @rate_denom can be left %NULL if the
-caller is not interested in the values.
-
-MT safe.</doc>
- <source-position filename="gst/gstclock.h" line="523"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1203">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="internal"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1204">a location to store the internal time</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="external"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1205">a location to store the external time</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="rate_num"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1206">a location to store the rate numerator</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="rate_denom"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1207">a location to store the rate denominator</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_internal_time"
- c:identifier="gst_clock_get_internal_time">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1059">Gets the current internal time of the given clock. The time is returned
-unadjusted for the offset and the rate.</doc>
- <source-position filename="gst/gstclock.h" line="556"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1066">the internal time of the clock. Or GST_CLOCK_TIME_NONE when
-given invalid input.
-
-MT safe.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1061">a #GstClock to query</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_master" c:identifier="gst_clock_get_master">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1359">Get the master clock that @clock is slaved to or %NULL when the clock is
-not slaved to any master clock.</doc>
- <source-position filename="gst/gstclock.h" line="534"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1366">a master #GstClock or %NULL
- when this clock is not slaved to a master clock. Unref after
- usage.
-
-MT safe.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1361">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_resolution" c:identifier="gst_clock_get_resolution">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="860">Get the accuracy of the clock. The accuracy of the clock is the granularity
-of the values returned by gst_clock_get_time().</doc>
- <source-position filename="gst/gstclock.h" line="512"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="867">the resolution of the clock in units of #GstClockTime.
-
-MT safe.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="862">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_time" c:identifier="gst_clock_get_time">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1105">Gets the current time of the given clock. The time is always
-monotonically increasing and adjusted according to the current
-offset and rate.</doc>
- <source-position filename="gst/gstclock.h" line="515"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1113">the time of the clock. Or GST_CLOCK_TIME_NONE when
-given invalid input.
-
-MT safe.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1107">a #GstClock to query</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_timeout" c:identifier="gst_clock_get_timeout">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1597">Get the amount of time that master and slave clocks are sampled.</doc>
- <source-position filename="gst/gstclock.h" line="540"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1603">the interval between samples.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1599">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_synced"
- c:identifier="gst_clock_is_synced"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1738">Checks if the clock is currently synced.
-
-This returns if GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC is not set on the clock.</doc>
- <source-position filename="gst/gstclock.h" line="584"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1746">%TRUE if the clock is currently synced</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1740">a GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="new_periodic_id" c:identifier="gst_clock_new_periodic_id">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="429">Get an ID from @clock to trigger a periodic notification.
-The periodic notifications will start at time @start_time and
-will then be fired with the given @interval. @id should be unreffed
-after usage.
-
-Free-function: gst_clock_id_unref</doc>
- <source-position filename="gst/gstclock.h" line="597"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="442">a #GstClockID that can be used to request the
- time notification.
-
-MT safe.</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="431">The #GstClockID to get a periodic notification id from</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="start_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="432">the requested start time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="433">the requested interval</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="new_single_shot_id"
- c:identifier="gst_clock_new_single_shot_id">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="404">Get a #GstClockID from @clock to trigger a single shot
-notification at the requested time. The single shot id should be
-unreffed after usage.
-
-Free-function: gst_clock_id_unref</doc>
- <source-position filename="gst/gstclock.h" line="594"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="415">a #GstClockID that can be used to request the
- time notification.
-
-MT safe.</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="406">The #GstClockID to get a single shot notification from</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="407">the requested time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="periodic_id_reinit"
- c:identifier="gst_clock_periodic_id_reinit">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="317">Reinitializes the provided periodic @id to the provided start time and
-interval. Does not modify the reference count.</doc>
- <source-position filename="gst/gstclock.h" line="639"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="327">%TRUE if the GstClockID could be reinitialized to the provided
-@time, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="319">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="320">a #GstClockID</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </parameter>
- <parameter name="start_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="321">the requested start time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="322">the requested interval</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_calibration" c:identifier="gst_clock_set_calibration">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1142">Adjusts the rate and time of @clock. A rate of 1/1 is the normal speed of
-the clock. Values bigger than 1/1 make the clock go faster.
-
-@internal and @external are calibration parameters that arrange that
-gst_clock_get_time() should have been @external at internal time @internal.
-This internal time should not be in the future; that is, it should be less
-than the value of gst_clock_get_internal_time() when this function is called.
-
-Subsequent calls to gst_clock_get_time() will return clock times computed as
-follows:
-
-|[
- time = (internal_time - internal) * rate_num / rate_denom + external
-]|
-
-This formula is implemented in gst_clock_adjust_unlocked(). Of course, it
-tries to do the integer arithmetic as precisely as possible.
-
-Note that gst_clock_get_time() always returns increasing values so when you
-move the clock backwards, gst_clock_get_time() will report the previous value
-until the clock catches up.
-
-MT safe.</doc>
- <source-position filename="gst/gstclock.h" line="518"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1144">a #GstClock to calibrate</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="internal" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1145">a reference internal time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="external" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1146">a reference external time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="rate_num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1147">the numerator of the rate of the clock relative to its
- internal time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="rate_denom" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1149">the denominator of the rate of the clock</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_master" c:identifier="gst_clock_set_master">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1271">Set @master as the master clock for @clock. @clock will be automatically
-calibrated so that gst_clock_get_time() reports the same time as the
-master clock.
-
-A clock provider that slaves its clock to a master can get the current
-calibration values with gst_clock_get_calibration().
-
-@master can be %NULL in which case @clock will not be slaved anymore. It will
-however keep reporting its time adjusted with the last configured rate
-and time offsets.</doc>
- <source-position filename="gst/gstclock.h" line="531"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1287">%TRUE if the clock is capable of being slaved to a master clock.
-Trying to set a master on a clock without the
-#GST_CLOCK_FLAG_CAN_SET_MASTER flag will make this function return %FALSE.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1273">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="master"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1274">a master #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_resolution" c:identifier="gst_clock_set_resolution">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="828">Set the accuracy of the clock. Some clocks have the possibility to operate
-with different accuracy at the expense of more resource usage. There is
-normally no need to change the default resolution of a clock. The resolution
-of a clock can only be changed if the clock has the
-#GST_CLOCK_FLAG_CAN_SET_RESOLUTION flag set.</doc>
- <source-position filename="gst/gstclock.h" line="509"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="839">the new resolution of the clock.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="830">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="resolution" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="831">The resolution to set</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_synced"
- c:identifier="gst_clock_set_synced"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1759">Sets @clock to synced and emits the GstClock::synced signal, and wakes up any
-thread waiting in gst_clock_wait_for_sync().
-
-This function must only be called if GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC
-is set on the clock, and is intended to be called by subclasses only.</doc>
- <source-position filename="gst/gstclock.h" line="589"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1761">a GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="synced" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1762">if the clock is synced</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_timeout" c:identifier="gst_clock_set_timeout">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1579">Set the amount of time, in nanoseconds, to sample master and slave
-clocks</doc>
- <source-position filename="gst/gstclock.h" line="537"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1581">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1582">a timeout</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="single_shot_id_reinit"
- c:identifier="gst_clock_single_shot_id_reinit">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="297">Reinitializes the provided single shot @id to the provided time. Does not
-modify the reference count.</doc>
- <source-position filename="gst/gstclock.h" line="635"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="306">%TRUE if the GstClockID could be reinitialized to the provided
-@time, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="299">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="300">a #GstClockID</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </parameter>
- <parameter name="time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="301">The requested time.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="unadjust_unlocked"
- c:identifier="gst_clock_unadjust_unlocked">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1029">Converts the given @external clock time to the internal time of @clock,
-using the rate and reference time set with gst_clock_set_calibration().
-This function should be called with the clock's OBJECT_LOCK held and
-is mainly used by clock subclasses.
-
-This function is the reverse of gst_clock_adjust_unlocked().</doc>
- <source-position filename="gst/gstclock.h" line="576"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1041">the internal time of the clock corresponding to @external.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1031">a #GstClock to use</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="external" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1032">an external clock time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="unadjust_with_calibration"
- c:identifier="gst_clock_unadjust_with_calibration"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="980">Converts the given @external_target clock time to the internal time,
-using the passed calibration parameters. This function performs the
-same calculation as gst_clock_unadjust_unlocked() when called using the
-current calibration parameters.
-
-Note: The @clock parameter is unused and can be NULL</doc>
- <source-position filename="gst/gstclock.h" line="569"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="997">the converted time of the clock.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="982">a #GstClock to use</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="external_target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="983">a clock time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="cinternal" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="984">a reference internal time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="cexternal" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="985">a reference external time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="cnum" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="986">the numerator of the rate of the clock relative to its
- internal time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="cdenom" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="988">the denominator of the rate of the clock</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="wait_for_sync"
- c:identifier="gst_clock_wait_for_sync"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1686">Waits until @clock is synced for reporting the current time. If @timeout
-is %GST_CLOCK_TIME_NONE it will wait forever, otherwise it will time out
-after @timeout nanoseconds.
-
-For asynchronous waiting, the GstClock::synced signal can be used.
-
-This returns immediately with TRUE if GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC
-is not set on the clock, or if the clock is already synced.</doc>
- <source-position filename="gst/gstclock.h" line="581"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1700">%TRUE if waiting was successful, or %FALSE on timeout</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1688">a GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1689">timeout for waiting or %GST_CLOCK_TIME_NONE</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <property name="timeout" writable="1" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="window-size" writable="1" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <property name="window-threshold" writable="1" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <field name="object">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="ClockPrivate" c:type="GstClockPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="synced" when="last" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="748">Signaled on clocks with GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC set once
-the clock is synchronized, or when it completely lost synchronization.
-This signal will not be emitted on clocks without the flag.
-
-This signal will be emitted from an arbitrary thread, most likely not
-the application's main thread.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="synced" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="751">if the clock is synced now</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <callback name="ClockCallback" c:type="GstClockCallback">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="285">The function prototype of the callback.</doc>
- <source-position filename="gst/gstclock.h" line="296"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="294">%TRUE or %FALSE (currently unused)</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="287">The clock that triggered the callback</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- <parameter name="time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="288">The time it was triggered</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="289">The #GstClockID that expired</doc>
- <type name="ClockID" c:type="GstClockID"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="3">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="290">user data passed in the gst_clock_id_wait_async() function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="ClockClass"
- c:type="GstClockClass"
- glib:is-gtype-struct-for="Clock">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="467">GStreamer clock class. Override the vmethods to implement the clock
-functionality.</doc>
- <source-position filename="gst/gstclock.h" line="503"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="469">the parent class structure</doc>
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="change_resolution">
- <callback name="change_resolution">
- <source-position filename="gst/gstclock.h" line="488"/>
- <return-value transfer-ownership="none">
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <parameter name="clock" transfer-ownership="none">
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- <parameter name="old_resolution" transfer-ownership="none">
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="new_resolution" transfer-ownership="none">
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_resolution">
- <callback name="get_resolution">
- <source-position filename="gst/gstclock.h" line="491"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="867">the resolution of the clock in units of #GstClockTime.
-
-MT safe.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="862">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_internal_time">
- <callback name="get_internal_time">
- <source-position filename="gst/gstclock.h" line="493"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1066">the internal time of the clock. Or GST_CLOCK_TIME_NONE when
-given invalid input.
-
-MT safe.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstclock.c"
- line="1061">a #GstClock to query</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="wait">
- <callback name="wait">
- <source-position filename="gst/gstclock.h" line="496"/>
- <return-value transfer-ownership="none">
- <type name="ClockReturn" c:type="GstClockReturn"/>
- </return-value>
- <parameters>
- <parameter name="clock" transfer-ownership="none">
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- <parameter name="entry" transfer-ownership="none">
- <type name="ClockEntry" c:type="GstClockEntry*"/>
- </parameter>
- <parameter name="jitter" transfer-ownership="none">
- <type name="ClockTimeDiff" c:type="GstClockTimeDiff*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="wait_async">
- <callback name="wait_async">
- <source-position filename="gst/gstclock.h" line="498"/>
- <return-value transfer-ownership="none">
- <type name="ClockReturn" c:type="GstClockReturn"/>
- </return-value>
- <parameters>
- <parameter name="clock" transfer-ownership="none">
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- <parameter name="entry" transfer-ownership="none">
- <type name="ClockEntry" c:type="GstClockEntry*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="unschedule">
- <callback name="unschedule">
- <source-position filename="gst/gstclock.h" line="499"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="clock" transfer-ownership="none">
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- <parameter name="entry" transfer-ownership="none">
- <type name="ClockEntry" c:type="GstClockEntry*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="ClockEntry" c:type="GstClockEntry">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="383">All pending timeouts or periodic notifies are converted into
-an entry.
-Note that GstClockEntry should be treated as an opaque structure. It must
-not be extended or allocated using a custom allocator.</doc>
- <source-position filename="gst/gstclock.h" line="414"/>
- <field name="refcount" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="385">reference counter (read-only)</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="clock" writable="1">
- <type name="Clock" c:type="GstClock*"/>
- </field>
- <field name="type" writable="1">
- <type name="ClockEntryType" c:type="GstClockEntryType"/>
- </field>
- <field name="time" writable="1">
- <type name="ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="interval" writable="1">
- <type name="ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="status" writable="1">
- <type name="ClockReturn" c:type="GstClockReturn"/>
- </field>
- <field name="func" writable="1">
- <type name="ClockCallback" c:type="GstClockCallback"/>
- </field>
- <field name="user_data" writable="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="destroy_data" writable="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="unscheduled" writable="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="woken_up" writable="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <enumeration name="ClockEntryType"
- glib:type-name="GstClockEntryType"
- glib:get-type="gst_clock_entry_type_get_type"
- c:type="GstClockEntryType">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="323">The type of the clock entry</doc>
- <member name="single"
- value="0"
- c:identifier="GST_CLOCK_ENTRY_SINGLE"
- glib:nick="single">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="325">a single shot timeout</doc>
- </member>
- <member name="periodic"
- value="1"
- c:identifier="GST_CLOCK_ENTRY_PERIODIC"
- glib:nick="periodic">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="326">a periodic timeout request</doc>
- </member>
- </enumeration>
- <bitfield name="ClockFlags"
- glib:type-name="GstClockFlags"
- glib:get-type="gst_clock_flags_get_type"
- c:type="GstClockFlags">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="418">The capabilities of this clock</doc>
- <member name="can_do_single_sync"
- value="16"
- c:identifier="GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC"
- glib:nick="can-do-single-sync">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="420">clock can do a single sync timeout request</doc>
- </member>
- <member name="can_do_single_async"
- value="32"
- c:identifier="GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC"
- glib:nick="can-do-single-async">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="421">clock can do a single async timeout request</doc>
- </member>
- <member name="can_do_periodic_sync"
- value="64"
- c:identifier="GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC"
- glib:nick="can-do-periodic-sync">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="422">clock can do sync periodic timeout requests</doc>
- </member>
- <member name="can_do_periodic_async"
- value="128"
- c:identifier="GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC"
- glib:nick="can-do-periodic-async">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="423">clock can do async periodic timeout callbacks</doc>
- </member>
- <member name="can_set_resolution"
- value="256"
- c:identifier="GST_CLOCK_FLAG_CAN_SET_RESOLUTION"
- glib:nick="can-set-resolution">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="424">clock's resolution can be changed</doc>
- </member>
- <member name="can_set_master"
- value="512"
- c:identifier="GST_CLOCK_FLAG_CAN_SET_MASTER"
- glib:nick="can-set-master">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="425">clock can be slaved to a master clock</doc>
- </member>
- <member name="needs_startup_sync"
- value="1024"
- c:identifier="GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC"
- glib:nick="needs-startup-sync">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="426">clock needs to be synced before it can be used
- (Since: 1.6)</doc>
- </member>
- <member name="last"
- value="4096"
- c:identifier="GST_CLOCK_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="428">subclasses can add additional flags starting from this flag</doc>
- </member>
- </bitfield>
- <record name="ClockPrivate" c:type="GstClockPrivate" disguised="1">
- <source-position filename="gst/gstclock.h" line="282"/>
- </record>
- <enumeration name="ClockReturn"
- glib:type-name="GstClockReturn"
- glib:get-type="gst_clock_return_get_type"
- c:type="GstClockReturn">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="298">The return value of a clock operation.</doc>
- <member name="ok" value="0" c:identifier="GST_CLOCK_OK" glib:nick="ok">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="300">The operation succeeded.</doc>
- </member>
- <member name="early"
- value="1"
- c:identifier="GST_CLOCK_EARLY"
- glib:nick="early">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="301">The operation was scheduled too late.</doc>
- </member>
- <member name="unscheduled"
- value="2"
- c:identifier="GST_CLOCK_UNSCHEDULED"
- glib:nick="unscheduled">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="302">The clockID was unscheduled</doc>
- </member>
- <member name="busy"
- value="3"
- c:identifier="GST_CLOCK_BUSY"
- glib:nick="busy">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="303">The ClockID is busy</doc>
- </member>
- <member name="badtime"
- value="4"
- c:identifier="GST_CLOCK_BADTIME"
- glib:nick="badtime">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="304">A bad time was provided to a function.</doc>
- </member>
- <member name="error"
- value="5"
- c:identifier="GST_CLOCK_ERROR"
- glib:nick="error">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="305">An error occurred</doc>
- </member>
- <member name="unsupported"
- value="6"
- c:identifier="GST_CLOCK_UNSUPPORTED"
- glib:nick="unsupported">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="306">Operation is not supported</doc>
- </member>
- <member name="done"
- value="7"
- c:identifier="GST_CLOCK_DONE"
- glib:nick="done">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="307">The ClockID is done waiting</doc>
- </member>
- </enumeration>
- <enumeration name="ClockType"
- glib:type-name="GstClockType"
- glib:get-type="gst_clock_type_get_type"
- c:type="GstClockType">
- <doc xml:space="preserve"
- filename="gst/gstsystemclock.h"
- line="45">The different kind of clocks.</doc>
- <member name="realtime"
- value="0"
- c:identifier="GST_CLOCK_TYPE_REALTIME"
- glib:nick="realtime">
- <doc xml:space="preserve"
- filename="gst/gstsystemclock.h"
- line="47">time since Epoch</doc>
- </member>
- <member name="monotonic"
- value="1"
- c:identifier="GST_CLOCK_TYPE_MONOTONIC"
- glib:nick="monotonic">
- <doc xml:space="preserve"
- filename="gst/gstsystemclock.h"
- line="48">monotonic time since some unspecified starting
- point</doc>
- </member>
- <member name="other"
- value="2"
- c:identifier="GST_CLOCK_TYPE_OTHER"
- glib:nick="other">
- <doc xml:space="preserve"
- filename="gst/gstsystemclock.h"
- line="50">some other time source is used (Since: 1.0.5)</doc>
- </member>
- <member name="tai"
- value="3"
- c:identifier="GST_CLOCK_TYPE_TAI"
- glib:nick="tai">
- <doc xml:space="preserve"
- filename="gst/gstsystemclock.h"
- line="51">time since Epoch, but using International Atomic Time
- as reference (Since: 1.18)</doc>
- </member>
- </enumeration>
- <record name="Context"
- c:type="GstContext"
- version="1.2"
- glib:type-name="GstContext"
- glib:get-type="gst_context_get_type"
- c:symbol-prefix="context">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="24">#GstContext is a container object used to store contexts like a device
-context, a display server connection and similar concepts that should
-be shared between multiple elements.
-
-Applications can set a context on a complete pipeline by using
-gst_element_set_context(), which will then be propagated to all
-child elements. Elements can handle these in #GstElementClass.set_context()
-and merge them with the context information they already have.
-
-When an element needs a context it will do the following actions in this
-order until one step succeeds:
-1. Check if the element already has a context
-2. Query downstream with GST_QUERY_CONTEXT for the context
-3. Query upstream with GST_QUERY_CONTEXT for the context
-4. Post a GST_MESSAGE_NEED_CONTEXT message on the bus with the required
- context types and afterwards check if a usable context was set now
-5. Create a context by itself and post a GST_MESSAGE_HAVE_CONTEXT message
- on the bus.
-
-Bins will catch GST_MESSAGE_NEED_CONTEXT messages and will set any previously
-known context on the element that asks for it if possible. Otherwise the
-application should provide one if it can.
-
-#GstContext&lt;!-- --&gt;s can be persistent.
-A persistent #GstContext is kept in elements when they reach
-%GST_STATE_NULL, non-persistent ones will be removed.
-Also, a non-persistent context won't override a previous persistent
-context set to an element.</doc>
- <source-position filename="gst/gstcontext.h" line="31"/>
- <constructor name="new" c:identifier="gst_context_new" version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="153">Create a new context.</doc>
- <source-position filename="gst/gstcontext.h" line="137"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="160">The new context.</doc>
- <type name="Context" c:type="GstContext*"/>
- </return-value>
- <parameters>
- <parameter name="context_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="155">Context type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="persistent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="156">Persistent context</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="get_context_type"
- c:identifier="gst_context_get_context_type"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="187">Get the type of @context.</doc>
- <source-position filename="gst/gstcontext.h" line="140"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="193">The type of the context.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="context" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="189">The #GstContext.</doc>
- <type name="Context" c:type="const GstContext*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_structure"
- c:identifier="gst_context_get_structure"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="226">Access the structure of the context.</doc>
- <source-position filename="gst/gstcontext.h" line="146"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="232">The structure of the context. The structure is
-still owned by the context, which means that you should not modify it,
-free it and that the pointer becomes invalid when you free the context.</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="context" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="228">The #GstContext.</doc>
- <type name="Context" c:type="const GstContext*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_context_type"
- c:identifier="gst_context_has_context_type"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="205">Checks if @context has @context_type.</doc>
- <source-position filename="gst/gstcontext.h" line="143"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="212">%TRUE if @context has @context_type.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="context" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="207">The #GstContext.</doc>
- <type name="Context" c:type="const GstContext*"/>
- </instance-parameter>
- <parameter name="context_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="208">Context type to check.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_persistent"
- c:identifier="gst_context_is_persistent"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="268">Check if @context is persistent.</doc>
- <source-position filename="gst/gstcontext.h" line="152"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="274">%TRUE if the context is persistent.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="context" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="270">The #GstContext.</doc>
- <type name="Context" c:type="const GstContext*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="writable_structure"
- c:identifier="gst_context_writable_structure"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="246">Get a writable version of the structure.</doc>
- <source-position filename="gst/gstcontext.h" line="149"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="252">The structure of the context. The structure is still
-owned by the context, which means that you should not free it and
-that the pointer becomes invalid when you free the context.
-This function checks if @context is writable.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="context" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontext.c"
- line="248">The #GstContext.</doc>
- <type name="Context" c:type="GstContext*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <class name="ControlBinding"
- c:symbol-prefix="control_binding"
- c:type="GstControlBinding"
- parent="Object"
- abstract="1"
- glib:type-name="GstControlBinding"
- glib:get-type="gst_control_binding_get_type"
- glib:type-struct="ControlBindingClass">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="22">A base class for value mapping objects that attaches control sources to gobject
-properties. Such an object is taking one or more #GstControlSource instances,
-combines them and maps the resulting value to the type and value range of the
-bound property.</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="112"/>
- <virtual-method name="get_g_value_array" invoker="get_g_value_array">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="366">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.
-
-This function is useful if one wants to e.g. draw a graph of the control
-curve or apply a control curve sample by sample.</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="381">%TRUE if the given array could be filled, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="368">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="369">the time that should be processed</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="370">the time spacing between subsequent values</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="n_values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="371">the number of values</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="372">array to put control-values in</doc>
- <array length="2" zero-terminated="0" c:type="GValue*">
- <type name="GObject.Value" c:type="GValue"/>
- </array>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_value" invoker="get_value">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="277">Gets the value for the given controlled property at the requested time.</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="106"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="284">the GValue of the property at the given time,
-or %NULL if the property isn't controlled.</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </return-value>
- <parameters>
- <instance-parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="279">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="280">the time the control-change should be read from</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_value_array"
- invoker="get_value_array"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="307">Gets a number of values for the given controlled property starting at the
-requested time. The array @values need to hold enough space for @n_values of
-the same type as the objects property's type.
-
-This function is useful if one wants to e.g. draw a graph of the control
-curve or apply a control curve sample by sample.
-
-The values are unboxed and ready to be used. The similar function
-gst_control_binding_get_g_value_array() returns the array as #GValues and is
-more suitable for bindings.</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="107"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="326">%TRUE if the given array could be filled, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="309">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="310">the time that should be processed</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="311">the time spacing between subsequent values</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="n_values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="312">the number of values</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="values"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="313">array to put control-values in</doc>
- <array length="2" zero-terminated="0" c:type="gpointer">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sync_values" invoker="sync_values">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="239">Sets the property of the @object, according to the #GstControlSources that
-handle them and for the given timestamp.
-
-If this function fails, it is most likely the application developers fault.
-Most probably the control sources are not setup correctly.</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="105"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="252">%TRUE if the controller value could be applied to the object
-property, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="241">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </instance-parameter>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="242">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="243">the time that should be processed</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="last_sync" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="244">the last time this was called</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="get_g_value_array"
- c:identifier="gst_control_binding_get_g_value_array">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="366">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.
-
-This function is useful if one wants to e.g. draw a graph of the control
-curve or apply a control curve sample by sample.</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="131"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="381">%TRUE if the given array could be filled, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="368">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="369">the time that should be processed</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="370">the time spacing between subsequent values</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="n_values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="371">the number of values</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="372">array to put control-values in</doc>
- <array length="2" zero-terminated="0" c:type="GValue*">
- <type name="GObject.Value" c:type="GValue"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="get_value" c:identifier="gst_control_binding_get_value">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="277">Gets the value for the given controlled property at the requested time.</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="125"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="284">the GValue of the property at the given time,
-or %NULL if the property isn't controlled.</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </return-value>
- <parameters>
- <instance-parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="279">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="280">the time the control-change should be read from</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_value_array"
- c:identifier="gst_control_binding_get_value_array"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="307">Gets a number of values for the given controlled property starting at the
-requested time. The array @values need to hold enough space for @n_values of
-the same type as the objects property's type.
-
-This function is useful if one wants to e.g. draw a graph of the control
-curve or apply a control curve sample by sample.
-
-The values are unboxed and ready to be used. The similar function
-gst_control_binding_get_g_value_array() returns the array as #GValues and is
-more suitable for bindings.</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="128"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="326">%TRUE if the given array could be filled, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="309">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="310">the time that should be processed</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="311">the time spacing between subsequent values</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="n_values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="312">the number of values</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="313">array to put control-values in</doc>
- <array length="2" zero-terminated="0" c:type="gpointer">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="is_disabled"
- c:identifier="gst_control_binding_is_disabled">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="481">Check if the control binding is disabled.</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="137"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="487">%TRUE if the binding is inactive</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="483">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_disabled"
- c:identifier="gst_control_binding_set_disabled">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="464">This function is used to disable a control binding for some time, i.e.
-gst_object_sync_values() will do nothing.</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="134"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="466">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </instance-parameter>
- <parameter name="disabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="467">boolean that specifies whether to disable the controller
-or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="sync_values"
- c:identifier="gst_control_binding_sync_values">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="239">Sets the property of the @object, according to the #GstControlSources that
-handle them and for the given timestamp.
-
-If this function fails, it is most likely the application developers fault.
-Most probably the control sources are not setup correctly.</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="122"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="252">%TRUE if the controller value could be applied to the object
-property, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="241">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </instance-parameter>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="242">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="243">the time that should be processed</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="last_sync" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="244">the last time this was called</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <property name="name"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="object"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="Object"/>
- </property>
- <field name="parent">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="name">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.h"
- line="59">name of the property of this binding</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="pspec">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.h"
- line="60">#GParamSpec for this property</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </field>
- <field name="object" readable="0" private="1">
- <type name="Object" c:type="GstObject*"/>
- </field>
- <field name="disabled" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <union name="ABI" c:type="ABI">
- <source-position filename="gst/gstcontrolbinding.h" line="85"/>
- <record name="abi" c:type="abi">
- <source-position filename="gst/gstcontrolbinding.h" line="83"/>
- <field name="priv" writable="1">
- <type name="ControlBindingPrivate"
- c:type="GstControlBindingPrivate*"/>
- </field>
- </record>
- <field name="_gst_reserved" writable="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </union>
- </class>
- <record name="ControlBindingClass"
- c:type="GstControlBindingClass"
- glib:is-gtype-struct-for="ControlBinding">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.h"
- line="88">The class structure of #GstControlBinding.</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="112"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.h"
- line="90">Parent class</doc>
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="sync_values">
- <callback name="sync_values">
- <source-position filename="gst/gstcontrolbinding.h" line="105"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="252">%TRUE if the controller value could be applied to the object
-property, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="241">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </parameter>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="242">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="243">the time that should be processed</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="last_sync" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="244">the last time this was called</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_value">
- <callback name="get_value">
- <source-position filename="gst/gstcontrolbinding.h" line="106"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="284">the GValue of the property at the given time,
-or %NULL if the property isn't controlled.</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </return-value>
- <parameters>
- <parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="279">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="280">the time the control-change should be read from</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_value_array" introspectable="0">
- <callback name="get_value_array" introspectable="0">
- <source-position filename="gst/gstcontrolbinding.h" line="107"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="326">%TRUE if the given array could be filled, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="309">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="310">the time that should be processed</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="311">the time spacing between subsequent values</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="n_values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="312">the number of values</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="values"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="313">array to put control-values in</doc>
- <array length="3" zero-terminated="0" c:type="gpointer">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_g_value_array">
- <callback name="get_g_value_array">
- <source-position filename="gst/gstcontrolbinding.h" line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="381">%TRUE if the given array could be filled, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="368">the control binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="369">the time that should be processed</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="370">the time spacing between subsequent values</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="n_values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="371">the number of values</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.c"
- line="372">array to put control-values in</doc>
- <array length="3" zero-terminated="0" c:type="GValue*">
- <type name="GObject.Value" c:type="GValue"/>
- </array>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <callback name="ControlBindingConvert" c:type="GstControlBindingConvert">
- <attribute name="doc.skip" value="true"/>
- <doc xml:space="preserve"
- filename="gst/gstcontrolbinding.h"
- line="51">FIXME(2.0): remove, this is unused</doc>
- <source-position filename="gst/gstcontrolbinding.h" line="55"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="binding" transfer-ownership="none">
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </parameter>
- <parameter name="src_value" transfer-ownership="none">
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="dest_value" transfer-ownership="none">
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="ControlBindingPrivate"
- c:type="GstControlBindingPrivate"
- disguised="1">
- <source-position filename="gst/gstcontrolbinding.h" line="47"/>
- </record>
- <class name="ControlSource"
- c:symbol-prefix="control_source"
- c:type="GstControlSource"
- parent="Object"
- abstract="1"
- glib:type-name="GstControlSource"
- glib:get-type="gst_control_source_get_type"
- glib:type-struct="ControlSourceClass">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="23">The #GstControlSource is a base class for control value sources that could
-be used to get timestamp-value pairs. A control source essentially is a
-function over time.
-
-A #GstControlSource is used by first getting an instance of a specific
-control-source, creating a binding for the control-source to the target property
-of the element and then adding the binding to the element. The binding will
-convert the data types and value range to fit to the bound property.
-
-For implementing a new #GstControlSource one has to implement
-#GstControlSourceGetValue and #GstControlSourceGetValueArray functions.
-These are then used by gst_control_source_get_value() and
-gst_control_source_get_value_array() to get values for specific timestamps.</doc>
- <source-position filename="gst/gstcontrolsource.h" line="126"/>
- <method name="control_source_get_value"
- c:identifier="gst_control_source_get_value">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="72">Gets the value for this #GstControlSource at a given timestamp.</doc>
- <source-position filename="gst/gstcontrolsource.h" line="134"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="80">%FALSE if the value couldn't be returned, %TRUE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="74">the #GstControlSource object</doc>
- <type name="ControlSource" c:type="GstControlSource*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="75">the time for which the value should be returned</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="76">the value</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </method>
- <method name="control_source_get_value_array"
- c:identifier="gst_control_source_get_value_array">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="96">Gets an array of values for for this #GstControlSource. Values that are
-undefined contain NANs.</doc>
- <source-position filename="gst/gstcontrolsource.h" line="137"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="107">%TRUE if the given array could be filled, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="98">the #GstControlSource object</doc>
- <type name="ControlSource" c:type="GstControlSource*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="99">the first timestamp</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="100">the time steps</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="n_values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="101">the number of values to fetch</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.c"
- line="102">array to put control-values in</doc>
- <array length="2" zero-terminated="0" c:type="gdouble*">
- <type name="gdouble" c:type="gdouble"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <field name="parent">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="get_value">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="97">Function for returning a value for a given timestamp</doc>
- <type name="ControlSourceGetValue" c:type="GstControlSourceGetValue"/>
- </field>
- <field name="get_value_array">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="98">Function for returning a values array for a given timestamp</doc>
- <type name="ControlSourceGetValueArray"
- c:type="GstControlSourceGetValueArray"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="ControlSourceClass"
- c:type="GstControlSourceClass"
- glib:is-gtype-struct-for="ControlSource">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="113">The class structure of #GstControlSource.</doc>
- <source-position filename="gst/gstcontrolsource.h" line="126"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="115">Parent class</doc>
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <callback name="ControlSourceGetValue" c:type="GstControlSourceGetValue">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="65">Function for returning a value for a given timestamp.</doc>
- <source-position filename="gst/gstcontrolsource.h" line="76"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="73">%TRUE if the value was successfully calculated.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="67">the #GstControlSource instance</doc>
- <type name="ControlSource" c:type="GstControlSource*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="68">timestamp for which a value should be calculated</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="69">a value which will be set to the result.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="ControlSourceGetValueArray"
- c:type="GstControlSourceGetValueArray">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="79">Function for returning an array of values for starting at a given timestamp.</doc>
- <source-position filename="gst/gstcontrolsource.h" line="92"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="89">%TRUE if the values were successfully calculated.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="81">the #GstControlSource instance</doc>
- <type name="ControlSource" c:type="GstControlSource*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="82">timestamp for which a value should be calculated</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="83">the time spacing between subsequent values</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="n_values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="84">the number of values</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="85">array to put control-values in</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </callback>
- <enumeration name="CoreError"
- glib:type-name="GstCoreError"
- glib:get-type="gst_core_error_get_type"
- c:type="GstCoreError"
- glib:error-domain="gst-core-error-quark">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="37">Core errors are errors inside the core GStreamer library.</doc>
- <member name="failed"
- value="1"
- c:identifier="GST_CORE_ERROR_FAILED"
- glib:nick="failed">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="39">a general error which doesn't fit in any other
-category. Make sure you add a custom message to the error call.</doc>
- </member>
- <member name="too_lazy"
- value="2"
- c:identifier="GST_CORE_ERROR_TOO_LAZY"
- glib:nick="too-lazy">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="41">do not use this except as a placeholder for
-deciding where to go while developing code.</doc>
- </member>
- <member name="not_implemented"
- value="3"
- c:identifier="GST_CORE_ERROR_NOT_IMPLEMENTED"
- glib:nick="not-implemented">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="43">use this when you do not want to implement
-this functionality yet.</doc>
- </member>
- <member name="state_change"
- value="4"
- c:identifier="GST_CORE_ERROR_STATE_CHANGE"
- glib:nick="state-change">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="45">used for state change errors.</doc>
- </member>
- <member name="pad"
- value="5"
- c:identifier="GST_CORE_ERROR_PAD"
- glib:nick="pad">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="46">used for pad-related errors.</doc>
- </member>
- <member name="thread"
- value="6"
- c:identifier="GST_CORE_ERROR_THREAD"
- glib:nick="thread">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="47">used for thread-related errors.</doc>
- </member>
- <member name="negotiation"
- value="7"
- c:identifier="GST_CORE_ERROR_NEGOTIATION"
- glib:nick="negotiation">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="48">used for negotiation-related errors.</doc>
- </member>
- <member name="event"
- value="8"
- c:identifier="GST_CORE_ERROR_EVENT"
- glib:nick="event">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="49">used for event-related errors.</doc>
- </member>
- <member name="seek"
- value="9"
- c:identifier="GST_CORE_ERROR_SEEK"
- glib:nick="seek">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="50">used for seek-related errors.</doc>
- </member>
- <member name="caps"
- value="10"
- c:identifier="GST_CORE_ERROR_CAPS"
- glib:nick="caps">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="51">used for caps-related errors.</doc>
- </member>
- <member name="tag"
- value="11"
- c:identifier="GST_CORE_ERROR_TAG"
- glib:nick="tag">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="52">used for negotiation-related errors.</doc>
- </member>
- <member name="missing_plugin"
- value="12"
- c:identifier="GST_CORE_ERROR_MISSING_PLUGIN"
- glib:nick="missing-plugin">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="53">used if a plugin is missing.</doc>
- </member>
- <member name="clock"
- value="13"
- c:identifier="GST_CORE_ERROR_CLOCK"
- glib:nick="clock">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="54">used for clock related errors.</doc>
- </member>
- <member name="disabled"
- value="14"
- c:identifier="GST_CORE_ERROR_DISABLED"
- glib:nick="disabled">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="55">used if functionality has been disabled at
- compile time.</doc>
- </member>
- <member name="num_errors"
- value="15"
- c:identifier="GST_CORE_ERROR_NUM_ERRORS"
- glib:nick="num-errors">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="57">the number of core error types.</doc>
- </member>
- <function name="quark" c:identifier="gst_core_error_quark">
- <attribute name="doc.skip" value="true"/>
- <return-value transfer-ownership="none">
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- </enumeration>
- <record name="CustomMeta" c:type="GstCustomMeta" version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="108">Simple typing wrapper around #GstMeta</doc>
- <source-position filename="gst/gstmeta.h" line="117"/>
- <field name="meta" writable="1">
- <type name="Meta" c:type="GstMeta"/>
- </field>
- <method name="get_structure"
- c:identifier="gst_custom_meta_get_structure"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="199">Retrieve the #GstStructure backing a custom meta, the structure's mutability
-is conditioned to the writability of the #GstBuffer @meta is attached to.</doc>
- <source-position filename="gst/gstmeta.h" line="264"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="205">the #GstStructure backing @meta</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <type name="CustomMeta" c:type="GstCustomMeta*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_name"
- c:identifier="gst_custom_meta_has_name"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="218">Checks whether the name of the custom meta is @name</doc>
- <source-position filename="gst/gstmeta.h" line="267"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="223">Whether @name is the name of the custom meta</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <type name="CustomMeta" c:type="GstCustomMeta*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <callback name="CustomMetaTransformFunction"
- c:type="GstCustomMetaTransformFunction"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="192">Function called for each @meta in @buffer as a result of performing a
-transformation on @transbuf. Additional @type specific transform data
-is passed to the function as @data.
-
-Implementations should check the @type of the transform and parse
-additional type specific fields in @data that should be used to update
-the metadata on @transbuf.</doc>
- <source-position filename="gst/gstmeta.h" line="212"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="209">%TRUE if the transform could be performed</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="transbuf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="194">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="195">a #GstCustomMeta</doc>
- <type name="CustomMeta" c:type="GstCustomMeta*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="196">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="197">the transform type</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="198">transform specific data.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="5">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="199">user data passed when registering the meta</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <constant name="DEBUG_BG_MASK" value="240" c:type="GST_DEBUG_BG_MASK">
- <source-position filename="gst/gstinfo.h" line="209"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="DEBUG_BIN_TO_DOT_FILE"
- c:identifier="GST_DEBUG_BIN_TO_DOT_FILE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="75">To aid debugging applications one can use this method to write out the whole
-network of gstreamer elements that form the pipeline into an dot file.
-This file can be processed with graphviz to get an image, like this:
-|[
- dot -Tpng -oimage.png graph_lowlevel.dot
-]|
-There is also a utility called xdot which allows you to view the dot file
-directly without converting it first.
-
-The macro is only active if the environment variable GST_DEBUG_DUMP_DOT_DIR
-is set to a basepath (e.g. /tmp), and the GStreamer debugging subsystem is
-enabled (i.e., no use of `./configure --disable-gst-debug')</doc>
- <source-position filename="gst/gstdebugutils.h" line="95"/>
- <parameters>
- <parameter name="bin">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="77">the top-level pipeline that should be analyzed</doc>
- </parameter>
- <parameter name="details">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="78">details to show in the graph, e.g. #GST_DEBUG_GRAPH_SHOW_ALL or
- one or more other #GstDebugGraphDetails flags.</doc>
- </parameter>
- <parameter name="file_name">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="80">output base filename (e.g. "myplayer")</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEBUG_BIN_TO_DOT_FILE_WITH_TS"
- c:identifier="GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="97">This works like GST_DEBUG_BIN_TO_DOT_FILE(), but adds the current timestamp
-to the filename, so that it can be used to take multiple snapshots.</doc>
- <source-position filename="gst/gstdebugutils.h" line="107"/>
- <parameters>
- <parameter name="bin">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="99">the top-level pipeline that should be analyzed</doc>
- </parameter>
- <parameter name="details">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="100">details to show in the graph, e.g. #GST_DEBUG_GRAPH_SHOW_ALL or
- one or more other #GstDebugGraphDetails flags.</doc>
- </parameter>
- <parameter name="file_name">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="102">output base filename (e.g. "myplayer")</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEBUG_CATEGORY"
- c:identifier="GST_DEBUG_CATEGORY"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="557">Defines a GstDebugCategory variable.
-This macro expands to nothing if debugging is disabled.</doc>
- <source-position filename="gst/gstinfo.h" line="564"/>
- <parameters>
- <parameter name="cat">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="559">the category</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEBUG_CATEGORY_EXTERN"
- c:identifier="GST_DEBUG_CATEGORY_EXTERN"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="565">Declares a GstDebugCategory variable as extern. Use in header files.
-This macro expands to nothing if debugging is disabled.</doc>
- <source-position filename="gst/gstinfo.h" line="572"/>
- <parameters>
- <parameter name="cat">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="567">the category</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEBUG_CATEGORY_GET"
- c:identifier="GST_DEBUG_CATEGORY_GET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="617">Looks up an existing #GstDebugCategory by its @name and sets @cat. If the
-category is not found, but GST_CAT_DEFAULT is defined, that is assigned to
-@cat. Otherwise @cat will be %NULL.
-
-|[&lt;!-- language="C" --&gt;
-GST_DEBUG_CATEGORY_STATIC (gst_myplugin_debug);
-#define GST_CAT_DEFAULT gst_myplugin_debug
-GST_DEBUG_CATEGORY_STATIC (GST_CAT_PERFORMANCE);
-...
-GST_DEBUG_CATEGORY_INIT (gst_myplugin_debug, "myplugin", 0, "nice element");
-GST_DEBUG_CATEGORY_GET (GST_CAT_PERFORMANCE, "GST_PERFORMANCE");
-]|</doc>
- <source-position filename="gst/gstinfo.h" line="636"/>
- <parameters>
- <parameter name="cat">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="619">the category to initialize.</doc>
- </parameter>
- <parameter name="name">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="620">log category name</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEBUG_CATEGORY_INIT"
- c:identifier="GST_DEBUG_CATEGORY_INIT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="583">Initializes a new #GstDebugCategory with the given properties and set to
-the default threshold.
-
-&gt; This macro expands to nothing if debugging is disabled.
-&gt;
-&gt; When naming your category, please follow the following conventions to ensure
-&gt; that the pattern matching for categories works as expected. It is not
-&gt; earth-shattering if you don't follow these conventions, but it would be nice
-&gt; for everyone.
-&gt;
-&gt; If you define a category for a plugin or a feature of it, name the category
-&gt; like the feature. So if you wanted to write a "filesrc" element, you would
-&gt; name the category "filesrc". Use lowercase letters only.
-&gt; If you define more than one category for the same element, append an
-&gt; underscore and an identifier to your categories, like this: "filesrc_cache"
-&gt;
-&gt; If you create a library or an application using debugging categories, use a
-&gt; common prefix followed by an underscore for all your categories. GStreamer
-&gt; uses the GST prefix so GStreamer categories look like "GST_STATES". Be sure
-&gt; to include uppercase letters.</doc>
- <source-position filename="gst/gstinfo.h" line="612"/>
- <parameters>
- <parameter name="cat">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="585">the category to initialize.</doc>
- </parameter>
- <parameter name="name">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="586">the name of the category.</doc>
- </parameter>
- <parameter name="color">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="587">the colors to use for a color representation or 0 for no color.</doc>
- </parameter>
- <parameter name="description">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="588">optional description of the category.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEBUG_CATEGORY_STATIC"
- c:identifier="GST_DEBUG_CATEGORY_STATIC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="574">Defines a static GstDebugCategory variable.
-This macro expands to nothing if debugging is disabled.</doc>
- <source-position filename="gst/gstinfo.h" line="581"/>
- <parameters>
- <parameter name="cat">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="576">the category</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="DEBUG_FG_MASK" value="15" c:type="GST_DEBUG_FG_MASK">
- <source-position filename="gst/gstinfo.h" line="208"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="DEBUG_FORMAT_MASK"
- value="65280"
- c:type="GST_DEBUG_FORMAT_MASK">
- <source-position filename="gst/gstinfo.h" line="210"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="DEBUG_FUNCPTR"
- c:identifier="GST_DEBUG_FUNCPTR"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="1465">Register a pointer to a function with its name, so it can later be used by
-GST_DEBUG_FUNCPTR_NAME().</doc>
- <source-position filename="gst/gstinfo.h" line="1474"/>
- <parameters>
- <parameter name="ptr">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="1467">pointer to the function to register</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEBUG_FUNCPTR_NAME"
- c:identifier="GST_DEBUG_FUNCPTR_NAME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="1477">Retrieves the name of the function, if it was previously registered with
-GST_DEBUG_FUNCPTR(). If not, it returns a description of the pointer.
-
-This macro returns a constant string which must not be modified or
-freed by the caller.</doc>
- <source-position filename="gst/gstinfo.h" line="1487"/>
- <parameters>
- <parameter name="ptr">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="1479">address of the function of which to look up the name</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEBUG_PAD_NAME"
- c:identifier="GST_DEBUG_PAD_NAME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="243">Evaluates to 2 strings, that describe the pad. Often used in debugging
-statements.</doc>
- <source-position filename="gst/gstinfo.h" line="250"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="245">The pad to debug.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEBUG_REGISTER_FUNCPTR"
- c:identifier="GST_DEBUG_REGISTER_FUNCPTR"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="1454">Register a pointer to a function with its name, so it can later be used by
-GST_DEBUG_FUNCPTR_NAME().
-
-Use this variant of #GST_DEBUG_FUNCPTR if you do not need to use @ptr.</doc>
- <source-position filename="gst/gstinfo.h" line="1463"/>
- <parameters>
- <parameter name="ptr">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="1456">pointer to the function to register</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEFINE_MINI_OBJECT_TYPE"
- c:identifier="GST_DEFINE_MINI_OBJECT_TYPE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="293">Define a new mini-object type with the given name</doc>
- <source-position filename="gst/gstminiobject.h" line="300"/>
- <parameters>
- <parameter name="TypeName">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="295">name of the new type in CamelCase</doc>
- </parameter>
- <parameter name="type_name">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="296">name of the new type</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE" c:identifier="GST_DEVICE" introspectable="0">
- <source-position filename="gst/gstdevice.h" line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_CAST"
- c:identifier="GST_DEVICE_CAST"
- introspectable="0">
- <source-position filename="gst/gstdevice.h" line="43"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_CLASS"
- c:identifier="GST_DEVICE_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdevice.h" line="42"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_GET_CLASS"
- c:identifier="GST_DEVICE_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdevice.h" line="40"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_MONITOR"
- c:identifier="GST_DEVICE_MONITOR"
- introspectable="0">
- <source-position filename="gst/gstdevicemonitor.h" line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_MONITOR_CAST"
- c:identifier="GST_DEVICE_MONITOR_CAST"
- introspectable="0">
- <source-position filename="gst/gstdevicemonitor.h" line="43"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_MONITOR_CLASS"
- c:identifier="GST_DEVICE_MONITOR_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdevicemonitor.h" line="42"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_MONITOR_GET_CLASS"
- c:identifier="GST_DEVICE_MONITOR_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdevicemonitor.h" line="40"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_PROVIDER"
- c:identifier="GST_DEVICE_PROVIDER"
- introspectable="0">
- <source-position filename="gst/gstdeviceprovider.h" line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_PROVIDER_CAST"
- c:identifier="GST_DEVICE_PROVIDER_CAST"
- introspectable="0">
- <source-position filename="gst/gstdeviceprovider.h" line="43"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_PROVIDER_CLASS"
- c:identifier="GST_DEVICE_PROVIDER_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdeviceprovider.h" line="42"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_PROVIDER_FACTORY"
- c:identifier="GST_DEVICE_PROVIDER_FACTORY"
- introspectable="0">
- <source-position filename="gst/gstdeviceproviderfactory.h" line="55"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_PROVIDER_FACTORY_CAST"
- c:identifier="GST_DEVICE_PROVIDER_FACTORY_CAST"
- introspectable="0">
- <source-position filename="gst/gstdeviceproviderfactory.h" line="61"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_PROVIDER_FACTORY_CLASS"
- c:identifier="GST_DEVICE_PROVIDER_FACTORY_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdeviceproviderfactory.h" line="57"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DEVICE_PROVIDER_GET_CLASS"
- c:identifier="GST_DEVICE_PROVIDER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdeviceprovider.h" line="40"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DYNAMIC_TYPE_CLASS"
- c:identifier="GST_DYNAMIC_TYPE_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdynamictypefactory.h" line="44"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DYNAMIC_TYPE_FACTORY"
- c:identifier="GST_DYNAMIC_TYPE_FACTORY"
- introspectable="0">
- <source-position filename="gst/gstdynamictypefactory.h" line="42"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DYNAMIC_TYPE_FACTORY_CAST"
- c:identifier="GST_DYNAMIC_TYPE_FACTORY_CAST"
- introspectable="0">
- <source-position filename="gst/gstdynamictypefactory.h" line="48"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <record name="DateTime"
- c:type="GstDateTime"
- glib:type-name="GstDateTime"
- glib:get-type="gst_date_time_get_type"
- c:symbol-prefix="date_time">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="32">Struct to store date, time and timezone information altogether.
-#GstDateTime is refcounted and immutable.
-
-Date information is handled using the proleptic Gregorian calendar.
-
-Provides basic creation functions and accessor functions to its fields.</doc>
- <source-position filename="gst/gstdatetime.h" line="40"/>
- <constructor name="new" c:identifier="gst_date_time_new">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="634">Creates a new #GstDateTime using the date and times in the gregorian calendar
-in the supplied timezone.
-
-@year should be from 1 to 9999, @month should be from 1 to 12, @day from
-1 to 31, @hour from 0 to 23, @minutes and @seconds from 0 to 59.
-
-Note that @tzoffset is a float and was chosen so for being able to handle
-some fractional timezones, while it still keeps the readability of
-representing it in hours for most timezones.
-
-If value is -1 then all over value will be ignored. For example
-if @month == -1, then #GstDateTime will created only for @year. If
-@day == -1, then #GstDateTime will created for @year and @month and
-so on.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gstdatetime.h" line="132"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="661">the newly created #GstDateTime</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- <parameters>
- <parameter name="tzoffset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="636">Offset from UTC in hours.</doc>
- <type name="gfloat" c:type="gfloat"/>
- </parameter>
- <parameter name="year" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="637">the gregorian year</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="month" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="638">the gregorian month</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="day" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="639">the day of the gregorian month</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="hour" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="640">the hour of the day</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="minute" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="641">the minute of the hour</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="seconds" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="642">the second of the minute</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_g_date_time"
- c:identifier="gst_date_time_new_from_g_date_time">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="71">Creates a new #GstDateTime from a #GDateTime object.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gstdatetime.h" line="153"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="79">a newly created #GstDateTime,
-or %NULL on error</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- <parameters>
- <parameter name="dt" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="73">the #GDateTime. The new #GstDateTime takes ownership.</doc>
- <type name="GLib.DateTime" c:type="GDateTime*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_iso8601_string"
- c:identifier="gst_date_time_new_from_iso8601_string">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="800">Tries to parse common variants of ISO-8601 datetime strings into a
-#GstDateTime. Possible input formats are (for example):
-2012-06-30T22:46:43Z, 2012, 2012-06, 2012-06-30, 2012-06-30T22:46:43-0430,
-2012-06-30T22:46Z, 2012-06-30T22:46-0430, 2012-06-30 22:46,
-2012-06-30 22:46:43, 2012-06-00, 2012-00-00, 2012-00-30, 22:46:43Z, 22:46Z,
-22:46:43-0430, 22:46-0430, 22:46:30, 22:46
-If no date is provided, it is assumed to be "today" in the timezone
-provided (if any), otherwise UTC.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gstdatetime.h" line="147"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="815">a newly created #GstDateTime,
-or %NULL on error</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- <parameters>
- <parameter name="string" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="802">ISO 8601-formatted datetime string.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_unix_epoch_local_time"
- c:identifier="gst_date_time_new_from_unix_epoch_local_time">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="412">Creates a new #GstDateTime using the time since Jan 1, 1970 specified by
-@secs. The #GstDateTime is in the local timezone.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gstdatetime.h" line="103"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="421">the newly created #GstDateTime</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- <parameters>
- <parameter name="secs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="414">seconds from the Unix epoch</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_unix_epoch_local_time_usecs"
- c:identifier="gst_date_time_new_from_unix_epoch_local_time_usecs"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="452">Creates a new #GstDateTime using the time since Jan 1, 1970 specified by
-@usecs. The #GstDateTime is in the local timezone.</doc>
- <source-position filename="gst/gstdatetime.h" line="109"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="459">a newly created #GstDateTime</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- <parameters>
- <parameter name="usecs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="454">microseconds from the Unix epoch</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_unix_epoch_utc"
- c:identifier="gst_date_time_new_from_unix_epoch_utc">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="432">Creates a new #GstDateTime using the time since Jan 1, 1970 specified by
-@secs. The #GstDateTime is in the UTC timezone.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gstdatetime.h" line="106"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="441">the newly created #GstDateTime</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- <parameters>
- <parameter name="secs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="434">seconds from the Unix epoch</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_unix_epoch_utc_usecs"
- c:identifier="gst_date_time_new_from_unix_epoch_utc_usecs"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="476">Creates a new #GstDateTime using the time since Jan 1, 1970 specified by
-@usecs. The #GstDateTime is in UTC.</doc>
- <source-position filename="gst/gstdatetime.h" line="112"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="483">a newly created #GstDateTime</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- <parameters>
- <parameter name="usecs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="478">microseconds from the Unix epoch</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_local_time"
- c:identifier="gst_date_time_new_local_time">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="522">Creates a new #GstDateTime using the date and times in the gregorian calendar
-in the local timezone.
-
-@year should be from 1 to 9999, @month should be from 1 to 12, @day from
-1 to 31, @hour from 0 to 23, @minutes and @seconds from 0 to 59.
-
-If @month is -1, then the #GstDateTime created will only contain @year,
-and all other fields will be considered not set.
-
-If @day is -1, then the #GstDateTime created will only contain @year and
-@month and all other fields will be considered not set.
-
-If @hour is -1, then the #GstDateTime created will only contain @year and
-@month and @day, and the time fields will be considered not set. In this
-case @minute and @seconds should also be -1.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gstdatetime.h" line="115"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="549">the newly created #GstDateTime</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- <parameters>
- <parameter name="year" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="524">the gregorian year</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="month" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="525">the gregorian month, or -1</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="day" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="526">the day of the gregorian month, or -1</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="hour" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="527">the hour of the day, or -1</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="minute" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="528">the minute of the hour, or -1</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="seconds" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="529">the second of the minute, or -1</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_now_local_time"
- c:identifier="gst_date_time_new_now_local_time">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="578">Creates a new #GstDateTime representing the current date and time.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gstdatetime.h" line="138"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="585">the newly created #GstDateTime which should
- be freed with gst_date_time_unref().</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- </constructor>
- <constructor name="new_now_utc" c:identifier="gst_date_time_new_now_utc">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="594">Creates a new #GstDateTime that represents the current instant at Universal
-coordinated time.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gstdatetime.h" line="141"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="602">the newly created #GstDateTime which should
- be freed with gst_date_time_unref().</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- </constructor>
- <constructor name="new_y" c:identifier="gst_date_time_new_y">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="343">Creates a new #GstDateTime using the date and times in the gregorian calendar
-in the local timezone.
-
-@year should be from 1 to 9999.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gstdatetime.h" line="122"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="354">the newly created #GstDateTime</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- <parameters>
- <parameter name="year" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="345">the gregorian year</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_ym" c:identifier="gst_date_time_new_ym">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="362">Creates a new #GstDateTime using the date and times in the gregorian calendar
-in the local timezone.
-
-@year should be from 1 to 9999, @month should be from 1 to 12.
-
-If value is -1 then all over value will be ignored. For example
-if @month == -1, then #GstDateTime will created only for @year.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gstdatetime.h" line="125"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="377">the newly created #GstDateTime</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- <parameters>
- <parameter name="year" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="364">the gregorian year</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="month" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="365">the gregorian month</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_ymd" c:identifier="gst_date_time_new_ymd">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="385">Creates a new #GstDateTime using the date and times in the gregorian calendar
-in the local timezone.
-
-@year should be from 1 to 9999, @month should be from 1 to 12, @day from
-1 to 31.
-
-If value is -1 then all over value will be ignored. For example
-if @month == -1, then #GstDateTime will created only for @year. If
-@day == -1, then #GstDateTime will created for @year and @month and
-so on.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gstdatetime.h" line="128"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="404">the newly created #GstDateTime</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- <parameters>
- <parameter name="year" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="387">the gregorian year</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="month" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="388">the gregorian month</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="day" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="389">the day of the gregorian month</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="get_day" c:identifier="gst_date_time_get_day">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="229">Returns the day of the month of this #GstDateTime.
-Call gst_date_time_has_day() before, to avoid warnings.</doc>
- <source-position filename="gst/gstdatetime.h" line="83"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="236">The day of this #GstDateTime</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="231">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_hour" c:identifier="gst_date_time_get_hour">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="247">Retrieves the hour of the day represented by @datetime in the gregorian
-calendar. The return is in the range of 0 to 23.
-Call gst_date_time_has_time() before, to avoid warnings.</doc>
- <source-position filename="gst/gstdatetime.h" line="86"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="255">the hour of the day</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="249">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_microsecond"
- c:identifier="gst_date_time_get_microsecond">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="304">Retrieves the fractional part of the seconds in microseconds represented by
-@datetime in the gregorian calendar.</doc>
- <source-position filename="gst/gstdatetime.h" line="95"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="311">the microsecond of the second</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="306">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_minute" c:identifier="gst_date_time_get_minute">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="266">Retrieves the minute of the hour represented by @datetime in the gregorian
-calendar.
-Call gst_date_time_has_time() before, to avoid warnings.</doc>
- <source-position filename="gst/gstdatetime.h" line="89"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="274">the minute of the hour</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="268">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_month" c:identifier="gst_date_time_get_month">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="211">Returns the month of this #GstDateTime. January is 1, February is 2, etc..
-Call gst_date_time_has_month() before, to avoid warnings.</doc>
- <source-position filename="gst/gstdatetime.h" line="80"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="218">The month of this #GstDateTime</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="213">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_second" c:identifier="gst_date_time_get_second">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="285">Retrieves the second of the minute represented by @datetime in the gregorian
-calendar.
-Call gst_date_time_has_time() before, to avoid warnings.</doc>
- <source-position filename="gst/gstdatetime.h" line="92"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="293">the second represented by @datetime</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="287">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_time_zone_offset"
- c:identifier="gst_date_time_get_time_zone_offset">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="322">Retrieves the offset from UTC in hours that the timezone specified
-by @datetime represents. Timezones ahead (to the east) of UTC have positive
-values, timezones before (to the west) of UTC have negative values.
-If @datetime represents UTC time, then the offset is zero.</doc>
- <source-position filename="gst/gstdatetime.h" line="98"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="331">the offset from UTC in hours</doc>
- <type name="gfloat" c:type="gfloat"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="324">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_year" c:identifier="gst_date_time_get_year">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="194">Returns the year of this #GstDateTime
-Call gst_date_time_has_year() before, to avoid warnings.</doc>
- <source-position filename="gst/gstdatetime.h" line="77"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="201">The year of this #GstDateTime</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="196">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_day" c:identifier="gst_date_time_has_day">
- <source-position filename="gst/gstdatetime.h" line="66"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="155">%TRUE if @datetime&lt;!-- --&gt;'s day field is set, otherwise %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="153">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_month" c:identifier="gst_date_time_has_month">
- <source-position filename="gst/gstdatetime.h" line="63"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="141">%TRUE if @datetime&lt;!-- --&gt;'s month field is set, otherwise %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="139">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_second" c:identifier="gst_date_time_has_second">
- <source-position filename="gst/gstdatetime.h" line="72"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="184">%TRUE if @datetime&lt;!-- --&gt;'s second field is set, otherwise %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="182">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_time" c:identifier="gst_date_time_has_time">
- <source-position filename="gst/gstdatetime.h" line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="169">%TRUE if @datetime&lt;!-- --&gt;'s hour and minute fields are set,
- otherwise %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="167">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_year" c:identifier="gst_date_time_has_year">
- <source-position filename="gst/gstdatetime.h" line="60"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="126">%TRUE if @datetime&lt;!-- --&gt;'s year field is set (which should always
- be the case), otherwise %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="124">a #GstDateTime</doc>
- <type name="DateTime" c:type="const GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_date_time_ref">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="987">Atomically increments the reference count of @datetime by one.</doc>
- <source-position filename="gst/gstdatetime.h" line="158"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="993">the reference @datetime</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="989">a #GstDateTime</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="to_g_date_time"
- c:identifier="gst_date_time_to_g_date_time">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="100">Creates a new #GDateTime from a fully defined #GstDateTime object.
-
-Free-function: g_date_time_unref</doc>
- <source-position filename="gst/gstdatetime.h" line="150"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="108">a newly created #GDateTime, or
-%NULL on error</doc>
- <type name="GLib.DateTime" c:type="GDateTime*"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="102">GstDateTime.</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="to_iso8601_string"
- c:identifier="gst_date_time_to_iso8601_string">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="776">Create a minimal string compatible with ISO-8601. Possible output formats
-are (for example): 2012, 2012-06, 2012-06-23, 2012-06-23T23:30Z,
-2012-06-23T23:30+0100, 2012-06-23T23:30:59Z, 2012-06-23T23:30:59+0100</doc>
- <source-position filename="gst/gstdatetime.h" line="144"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="784">a newly allocated string formatted according
- to ISO 8601 and only including the datetime fields that are
- valid, or %NULL in case there was an error. The string should
- be freed with g_free().</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="778">GstDateTime.</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_date_time_unref">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="1001">Atomically decrements the reference count of @datetime by one. When the
-reference count reaches zero, the structure is freed.</doc>
- <source-position filename="gst/gstdatetime.h" line="161"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="datetime" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdatetime.c"
- line="1003">a #GstDateTime</doc>
- <type name="DateTime" c:type="GstDateTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <record name="DebugCategory" c:type="GstDebugCategory">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="213">This is the struct that describes the categories. Once initialized with
-#GST_DEBUG_CATEGORY_INIT, its values can't be changed anymore.</doc>
- <source-position filename="gst/gstinfo.h" line="226"/>
- <field name="threshold" readable="0" private="1">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="color" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="name" readable="0" private="1">
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="description" readable="0" private="1">
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <method name="free"
- c:identifier="gst_debug_category_free"
- deprecated="1">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1824">Removes and frees the category and all associated resources.</doc>
- <doc-deprecated xml:space="preserve">This function can easily cause memory corruption, don't use it.</doc-deprecated>
- <source-position filename="gst/gstinfo.h" line="486"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1826">#GstDebugCategory to free.</doc>
- <type name="DebugCategory" c:type="GstDebugCategory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_color" c:identifier="gst_debug_category_get_color">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1908">Returns the color of a debug category used when printing output in this
-category.</doc>
- <source-position filename="gst/gstinfo.h" line="502"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1915">the color of the category.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1910">a #GstDebugCategory to get the color of.</doc>
- <type name="DebugCategory" c:type="GstDebugCategory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_description"
- c:identifier="gst_debug_category_get_description">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1923">Returns the description of a debug category.</doc>
- <source-position filename="gst/gstinfo.h" line="505"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1929">the description of the category.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1925">a #GstDebugCategory to get the description of.</doc>
- <type name="DebugCategory" c:type="GstDebugCategory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_name" c:identifier="gst_debug_category_get_name">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1894">Returns the name of a debug category.</doc>
- <source-position filename="gst/gstinfo.h" line="499"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1900">the name of the category.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1896">a #GstDebugCategory to get name of.</doc>
- <type name="DebugCategory" c:type="GstDebugCategory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_threshold"
- c:identifier="gst_debug_category_get_threshold">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1880">Returns the threshold of a #GstDebugCategory.</doc>
- <source-position filename="gst/gstinfo.h" line="496"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1886">the #GstDebugLevel that is used as threshold.</doc>
- <type name="DebugLevel" c:type="GstDebugLevel"/>
- </return-value>
- <parameters>
- <instance-parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1882">a #GstDebugCategory to get threshold of.</doc>
- <type name="DebugCategory" c:type="GstDebugCategory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reset_threshold"
- c:identifier="gst_debug_category_reset_threshold">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1864">Resets the threshold of the category to the default level. Debug information
-will only be output if the threshold is lower or equal to the level of the
-debugging message.
-Use this function to set the threshold back to where it was after using
-gst_debug_category_set_threshold().</doc>
- <source-position filename="gst/gstinfo.h" line="493"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1866">a #GstDebugCategory to reset threshold of.</doc>
- <type name="DebugCategory" c:type="GstDebugCategory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_threshold"
- c:identifier="gst_debug_category_set_threshold">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1838">Sets the threshold of the category to the given level. Debug information will
-only be output if the threshold is lower or equal to the level of the
-debugging message.
-&gt; Do not use this function in production code, because other functions may
-&gt; change the threshold of categories as side effect. It is however a nice
-&gt; function to use when debugging (even from gdb).</doc>
- <source-position filename="gst/gstinfo.h" line="489"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1840">a #GstDebugCategory to set threshold of.</doc>
- <type name="DebugCategory" c:type="GstDebugCategory*"/>
- </instance-parameter>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1841">the #GstDebugLevel threshold to set.</doc>
- <type name="DebugLevel" c:type="GstDebugLevel"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <bitfield name="DebugColorFlags"
- glib:type-name="GstDebugColorFlags"
- glib:get-type="gst_debug_color_flags_get_type"
- c:type="GstDebugColorFlags">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="130">These are some terminal style flags you can use when creating your
-debugging categories to make them stand out in debugging output.</doc>
- <member name="fg_black"
- value="0"
- c:identifier="GST_DEBUG_FG_BLACK"
- glib:nick="fg-black">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="132">Use black as foreground color.</doc>
- </member>
- <member name="fg_red"
- value="1"
- c:identifier="GST_DEBUG_FG_RED"
- glib:nick="fg-red">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="133">Use red as foreground color.</doc>
- </member>
- <member name="fg_green"
- value="2"
- c:identifier="GST_DEBUG_FG_GREEN"
- glib:nick="fg-green">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="134">Use green as foreground color.</doc>
- </member>
- <member name="fg_yellow"
- value="3"
- c:identifier="GST_DEBUG_FG_YELLOW"
- glib:nick="fg-yellow">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="135">Use yellow as foreground color.</doc>
- </member>
- <member name="fg_blue"
- value="4"
- c:identifier="GST_DEBUG_FG_BLUE"
- glib:nick="fg-blue">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="136">Use blue as foreground color.</doc>
- </member>
- <member name="fg_magenta"
- value="5"
- c:identifier="GST_DEBUG_FG_MAGENTA"
- glib:nick="fg-magenta">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="137">Use magenta as foreground color.</doc>
- </member>
- <member name="fg_cyan"
- value="6"
- c:identifier="GST_DEBUG_FG_CYAN"
- glib:nick="fg-cyan">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="138">Use cyan as foreground color.</doc>
- </member>
- <member name="fg_white"
- value="7"
- c:identifier="GST_DEBUG_FG_WHITE"
- glib:nick="fg-white">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="139">Use white as foreground color.</doc>
- </member>
- <member name="bg_black"
- value="0"
- c:identifier="GST_DEBUG_BG_BLACK"
- glib:nick="bg-black">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="140">Use black as background color.</doc>
- </member>
- <member name="bg_red"
- value="16"
- c:identifier="GST_DEBUG_BG_RED"
- glib:nick="bg-red">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="141">Use red as background color.</doc>
- </member>
- <member name="bg_green"
- value="32"
- c:identifier="GST_DEBUG_BG_GREEN"
- glib:nick="bg-green">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="142">Use green as background color.</doc>
- </member>
- <member name="bg_yellow"
- value="48"
- c:identifier="GST_DEBUG_BG_YELLOW"
- glib:nick="bg-yellow">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="143">Use yellow as background color.</doc>
- </member>
- <member name="bg_blue"
- value="64"
- c:identifier="GST_DEBUG_BG_BLUE"
- glib:nick="bg-blue">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="144">Use blue as background color.</doc>
- </member>
- <member name="bg_magenta"
- value="80"
- c:identifier="GST_DEBUG_BG_MAGENTA"
- glib:nick="bg-magenta">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="145">Use magenta as background color.</doc>
- </member>
- <member name="bg_cyan"
- value="96"
- c:identifier="GST_DEBUG_BG_CYAN"
- glib:nick="bg-cyan">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="146">Use cyan as background color.</doc>
- </member>
- <member name="bg_white"
- value="112"
- c:identifier="GST_DEBUG_BG_WHITE"
- glib:nick="bg-white">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="147">Use white as background color.</doc>
- </member>
- <member name="bold"
- value="256"
- c:identifier="GST_DEBUG_BOLD"
- glib:nick="bold">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="148">Make the output bold.</doc>
- </member>
- <member name="underline"
- value="512"
- c:identifier="GST_DEBUG_UNDERLINE"
- glib:nick="underline">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="149">Underline the output.</doc>
- </member>
- </bitfield>
- <enumeration name="DebugColorMode"
- glib:type-name="GstDebugColorMode"
- glib:get-type="gst_debug_color_mode_get_type"
- c:type="GstDebugColorMode">
- <member name="off"
- value="0"
- c:identifier="GST_DEBUG_COLOR_MODE_OFF"
- glib:nick="off">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="196">Do not use colors in logs.</doc>
- </member>
- <member name="on"
- value="1"
- c:identifier="GST_DEBUG_COLOR_MODE_ON"
- glib:nick="on">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="197">Paint logs in a platform-specific way.</doc>
- </member>
- <member name="unix"
- value="2"
- c:identifier="GST_DEBUG_COLOR_MODE_UNIX"
- glib:nick="unix">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="198">Paint logs with UNIX terminal color codes
- no matter what platform GStreamer is running on.</doc>
- </member>
- </enumeration>
- <callback name="DebugFuncPtr" c:type="GstDebugFuncPtr">
- <attribute name="doc.skip" value="true"/>
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="396">we define this to avoid a compiler warning regarding a cast from a function
-pointer to a void pointer
-(see https://bugzilla.gnome.org/show_bug.cgi?id=309253)</doc>
- <source-position filename="gst/gstinfo.h" line="402"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </callback>
- <bitfield name="DebugGraphDetails"
- glib:type-name="GstDebugGraphDetails"
- glib:get-type="gst_debug_graph_details_get_type"
- c:type="GstDebugGraphDetails">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="32">Available details for pipeline graphs produced by GST_DEBUG_BIN_TO_DOT_FILE()
-and GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS().</doc>
- <member name="media_type"
- value="1"
- c:identifier="GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE"
- glib:nick="media-type">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="34">show caps-name on edges</doc>
- </member>
- <member name="caps_details"
- value="2"
- c:identifier="GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS"
- glib:nick="caps-details">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="35">show caps-details on edges</doc>
- </member>
- <member name="non_default_params"
- value="4"
- c:identifier="GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS"
- glib:nick="non-default-params">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="36">show modified parameters on
- elements</doc>
- </member>
- <member name="states"
- value="8"
- c:identifier="GST_DEBUG_GRAPH_SHOW_STATES"
- glib:nick="states">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="38">show element states</doc>
- </member>
- <member name="full_params"
- value="16"
- c:identifier="GST_DEBUG_GRAPH_SHOW_FULL_PARAMS"
- glib:nick="full-params">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="39">show full element parameter values even
- if they are very long</doc>
- </member>
- <member name="all"
- value="15"
- c:identifier="GST_DEBUG_GRAPH_SHOW_ALL"
- glib:nick="all">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="41">show all the typical details that one might want</doc>
- </member>
- <member name="verbose"
- value="4294967295"
- c:identifier="GST_DEBUG_GRAPH_SHOW_VERBOSE"
- glib:nick="verbose">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.h"
- line="42">show all details regardless of how large or
- verbose they make the resulting output</doc>
- </member>
- </bitfield>
- <enumeration name="DebugLevel"
- glib:type-name="GstDebugLevel"
- glib:get-type="gst_debug_level_get_type"
- c:type="GstDebugLevel">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="33">The level defines the importance of a debugging message. The more important a
-message is, the greater the probability that the debugging system outputs it.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_LEVEL_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="35">No debugging level specified or desired. Used to deactivate
- debugging output.</doc>
- </member>
- <member name="error"
- value="1"
- c:identifier="GST_LEVEL_ERROR"
- glib:nick="error">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="37">Error messages are to be used only when an error occurred
- that stops the application from keeping working correctly.
- An examples is gst_element_error, which outputs a message with this priority.
- It does not mean that the application is terminating as with g_error.</doc>
- </member>
- <member name="warning"
- value="2"
- c:identifier="GST_LEVEL_WARNING"
- glib:nick="warning">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="41">Warning messages are to inform about abnormal behaviour
- that could lead to problems or weird behaviour later on. An example of this
- would be clocking issues ("your computer is pretty slow") or broken input
- data ("Can't synchronize to stream.")</doc>
- </member>
- <member name="fixme"
- value="3"
- c:identifier="GST_LEVEL_FIXME"
- glib:nick="fixme">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="45">Fixme messages are messages that indicate that something
- in the executed code path is not fully implemented or handled yet. Note
- that this does not replace proper error handling in any way, the purpose
- of this message is to make it easier to spot incomplete/unfinished pieces
- of code when reading the debug log.</doc>
- </member>
- <member name="info"
- value="4"
- c:identifier="GST_LEVEL_INFO"
- glib:nick="info">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="50">Informational messages should be used to keep the developer
- updated about what is happening.
- Examples where this should be used are when a typefind function has
- successfully determined the type of the stream or when an mp3 plugin detects
- the format to be used. ("This file has mono sound.")</doc>
- </member>
- <member name="debug"
- value="5"
- c:identifier="GST_LEVEL_DEBUG"
- glib:nick="debug">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="55">Debugging messages should be used when something common
- happens that is not the expected default behavior, or something that's
- useful to know but doesn't happen all the time (ie. per loop iteration or
- buffer processed or event handled).
- An example would be notifications about state changes or receiving/sending
- of events.</doc>
- </member>
- <member name="log"
- value="6"
- c:identifier="GST_LEVEL_LOG"
- glib:nick="log">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="61">Log messages are messages that are very common but might be
- useful to know. As a rule of thumb a pipeline that is running as expected
- should never output anything else but LOG messages whilst processing data.
- Use this log level to log recurring information in chain functions and
- loop functions, for example.</doc>
- </member>
- <member name="trace"
- value="7"
- c:identifier="GST_LEVEL_TRACE"
- glib:nick="trace">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="66">Tracing-related messages.
- Examples for this are referencing/dereferencing of objects.</doc>
- </member>
- <member name="memdump"
- value="9"
- c:identifier="GST_LEVEL_MEMDUMP"
- glib:nick="memdump">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="68">memory dump messages are used to log (small) chunks of
- data as memory dumps in the log. They will be displayed as hexdump with
- ASCII characters.</doc>
- </member>
- <member name="count"
- value="10"
- c:identifier="GST_LEVEL_COUNT"
- glib:nick="count">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="71">The number of defined debugging levels.</doc>
- </member>
- <function name="get_name" c:identifier="gst_debug_level_get_name">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1338">Get the string representation of a debugging level</doc>
- <source-position filename="gst/gstinfo.h" line="437"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1344">the name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1340">the level to get the name for</doc>
- <type name="DebugLevel" c:type="GstDebugLevel"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <record name="DebugMessage" c:type="GstDebugMessage" disguised="1">
- <source-position filename="gst/gstinfo.h" line="331"/>
- <method name="get" c:identifier="gst_debug_message_get">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="555">Gets the string representation of a #GstDebugMessage. This function is used
-in debug handlers to extract the message.</doc>
- <source-position filename="gst/gstinfo.h" line="415"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="562">the string representation of a #GstDebugMessage.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="557">a debug message</doc>
- <type name="DebugMessage" c:type="GstDebugMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <class name="Device"
- c:symbol-prefix="device"
- c:type="GstDevice"
- version="1.4"
- parent="Object"
- abstract="1"
- glib:type-name="GstDevice"
- glib:get-type="gst_device_get_type"
- glib:type-struct="DeviceClass">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="22">#GstDevice are objects representing a device, they contain
-relevant metadata about the device, such as its class and the #GstCaps
-representing the media types it can produce or handle.
-
-#GstDevice are created by #GstDeviceProvider objects which can be
-aggregated by #GstDeviceMonitor objects.</doc>
- <source-position filename="gst/gstdevice.h" line="85"/>
- <virtual-method name="create_element"
- invoker="create_element"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="190">Creates the element with all of the required parameters set to use
-this device.</doc>
- <source-position filename="gst/gstdevice.h" line="80"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="199">a new #GstElement configured to use
-this device</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="192">a #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </instance-parameter>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="193">name of new element, or %NULL to automatically
-create a unique name.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="reconfigure_element"
- invoker="reconfigure_element"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="312">Tries to reconfigure an existing element to use the device. If this
-function fails, then one must destroy the element and create a new one
-using gst_device_create_element().
-
-Note: This should only be implemented for elements can change their
-device in the PLAYING state.</doc>
- <source-position filename="gst/gstdevice.h" line="81"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="324">%TRUE if the element could be reconfigured to use this device,
-%FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="314">a #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </instance-parameter>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="315">a #GstElement</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="create_element"
- c:identifier="gst_device_create_element"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="190">Creates the element with all of the required parameters set to use
-this device.</doc>
- <source-position filename="gst/gstdevice.h" line="91"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="199">a new #GstElement configured to use
-this device</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="192">a #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </instance-parameter>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="193">name of new element, or %NULL to automatically
-create a unique name.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_caps" c:identifier="gst_device_get_caps" version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="226">Getter for the #GstCaps that this device supports.</doc>
- <source-position filename="gst/gstdevice.h" line="94"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="232">The #GstCaps supported by this device. Unref with
-gst_caps_unref() when done.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="228">a #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_device_class"
- c:identifier="gst_device_get_device_class"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="267">Gets the "class" of a device. This is a "/" separated list of
-classes that represent this device. They are a subset of the
-classes of the #GstDeviceProvider that produced this device.</doc>
- <source-position filename="gst/gstdevice.h" line="100"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="275">The device class. Free with g_free() after use.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="269">a #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_display_name"
- c:identifier="gst_device_get_display_name"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="248">Gets the user-friendly name of the device.</doc>
- <source-position filename="gst/gstdevice.h" line="97"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="254">The device name. Free with g_free() after use.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="250">a #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_properties"
- c:identifier="gst_device_get_properties"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="290">Gets the extra properties of a device.</doc>
- <source-position filename="gst/gstdevice.h" line="103"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="296">The extra properties or %NULL when there are none.
- Free with gst_structure_free() after use.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="292">a #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_classes"
- c:identifier="gst_device_has_classes"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="385">Check if @device matches all of the given classes</doc>
- <source-position filename="gst/gstdevice.h" line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="393">%TRUE if @device matches.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="387">a #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </instance-parameter>
- <parameter name="classes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="388">a "/"-separated list of device classes to match, only match if
- all classes are matched</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="has_classesv"
- c:identifier="gst_device_has_classesv"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="342">Check if @factory matches all of the given classes</doc>
- <source-position filename="gst/gstdevice.h" line="109"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="350">%TRUE if @device matches.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="344">a #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </instance-parameter>
- <parameter name="classes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="345">a %NULL terminated array of classes
- to match, only match if all classes are matched</doc>
- <array c:type="gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="reconfigure_element"
- c:identifier="gst_device_reconfigure_element"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="312">Tries to reconfigure an existing element to use the device. If this
-function fails, then one must destroy the element and create a new one
-using gst_device_create_element().
-
-Note: This should only be implemented for elements can change their
-device in the PLAYING state.</doc>
- <source-position filename="gst/gstdevice.h" line="106"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="324">%TRUE if the element could be reconfigured to use this device,
-%FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="314">a #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </instance-parameter>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="315">a #GstElement</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </method>
- <property name="caps"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="Caps"/>
- </property>
- <property name="device-class"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="display-name"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="properties"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="Structure"/>
- </property>
- <field name="parent">
- <doc xml:space="preserve"
- filename="gst/gstdevice.h"
- line="47">The parent #GstObject structure.</doc>
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="DevicePrivate" c:type="GstDevicePrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="removed" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- </class>
- <record name="DeviceClass"
- c:type="GstDeviceClass"
- glib:is-gtype-struct-for="Device"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevice.h"
- line="63">The class structure for a #GstDevice object.</doc>
- <source-position filename="gst/gstdevice.h" line="85"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst/gstdevice.h"
- line="65">The parent #GstObjectClass structure.</doc>
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="create_element">
- <callback name="create_element">
- <source-position filename="gst/gstdevice.h" line="80"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="199">a new #GstElement configured to use
-this device</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="192">a #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </parameter>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="193">name of new element, or %NULL to automatically
-create a unique name.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="reconfigure_element">
- <callback name="reconfigure_element">
- <source-position filename="gst/gstdevice.h" line="81"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="324">%TRUE if the element could be reconfigured to use this device,
-%FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="314">a #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </parameter>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevice.c"
- line="315">a #GstElement</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="DeviceMonitor"
- c:symbol-prefix="device_monitor"
- c:type="GstDeviceMonitor"
- version="1.4"
- parent="Object"
- glib:type-name="GstDeviceMonitor"
- glib:get-type="gst_device_monitor_get_type"
- glib:type-struct="DeviceMonitorClass">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="22">Applications should create a #GstDeviceMonitor when they want
-to probe, list and monitor devices of a specific type. The
-#GstDeviceMonitor will create the appropriate
-#GstDeviceProvider objects and manage them. It will then post
-messages on its #GstBus for devices that have been added and
-removed.
-
-The device monitor will monitor all devices matching the filters that
-the application has set.
-
-The basic use pattern of a device monitor is as follows:
-|[
- static gboolean
- my_bus_func (GstBus * bus, GstMessage * message, gpointer user_data)
- {
- GstDevice *device;
- gchar *name;
-
- switch (GST_MESSAGE_TYPE (message)) {
- case GST_MESSAGE_DEVICE_ADDED:
- gst_message_parse_device_added (message, &amp;device);
- name = gst_device_get_display_name (device);
- g_print("Device added: %s\n", name);
- g_free (name);
- gst_object_unref (device);
- break;
- case GST_MESSAGE_DEVICE_REMOVED:
- gst_message_parse_device_removed (message, &amp;device);
- name = gst_device_get_display_name (device);
- g_print("Device removed: %s\n", name);
- g_free (name);
- gst_object_unref (device);
- break;
- default:
- break;
- }
-
- return G_SOURCE_CONTINUE;
- }
-
- GstDeviceMonitor *
- setup_raw_video_source_device_monitor (void) {
- GstDeviceMonitor *monitor;
- GstBus *bus;
- GstCaps *caps;
-
- monitor = gst_device_monitor_new ();
-
- bus = gst_device_monitor_get_bus (monitor);
- gst_bus_add_watch (bus, my_bus_func, NULL);
- gst_object_unref (bus);
-
- caps = gst_caps_new_empty_simple ("video/x-raw");
- gst_device_monitor_add_filter (monitor, "Video/Source", caps);
- gst_caps_unref (caps);
-
- gst_device_monitor_start (monitor);
-
- return monitor;
- }
-]|</doc>
- <source-position filename="gst/gstdevicemonitor.h" line="76"/>
- <constructor name="new"
- c:identifier="gst_device_monitor_new"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="792">Create a new #GstDeviceMonitor</doc>
- <source-position filename="gst/gstdevicemonitor.h" line="82"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="797">a new device monitor.</doc>
- <type name="DeviceMonitor" c:type="GstDeviceMonitor*"/>
- </return-value>
- </constructor>
- <method name="add_filter"
- c:identifier="gst_device_monitor_add_filter"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="621">Adds a filter for which #GstDevice will be monitored, any device that matches
-all these classes and the #GstCaps will be returned.
-
-If this function is called multiple times to add more filters, each will be
-matched independently. That is, adding more filters will not further restrict
-what devices are matched.
-
-The #GstCaps supported by the device as returned by gst_device_get_caps() are
-not intersected with caps filters added using this function.
-
-Filters must be added before the #GstDeviceMonitor is started.</doc>
- <source-position filename="gst/gstdevicemonitor.h" line="99"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="639">The id of the new filter or 0 if no provider matched the filter's
- classes.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="monitor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="623">a device monitor</doc>
- <type name="DeviceMonitor" c:type="GstDeviceMonitor*"/>
- </instance-parameter>
- <parameter name="classes"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="624">device classes to use as filter or %NULL for any class</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="625">the #GstCaps to filter or %NULL for ANY</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_bus"
- c:identifier="gst_device_monitor_get_bus"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="814">Gets the #GstBus of this #GstDeviceMonitor</doc>
- <source-position filename="gst/gstdevicemonitor.h" line="85"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="820">a #GstBus</doc>
- <type name="Bus" c:type="GstBus*"/>
- </return-value>
- <parameters>
- <instance-parameter name="monitor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="816">a #GstDeviceProvider</doc>
- <type name="DeviceMonitor" c:type="GstDeviceMonitor*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_devices"
- c:identifier="gst_device_monitor_get_devices"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="344">Gets a list of devices from all of the relevant monitors. This may actually
-probe the hardware if the monitor is not currently started.</doc>
- <source-position filename="gst/gstdevicemonitor.h" line="88"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="351">a #GList of
- #GstDevice</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Device"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="monitor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="346">A #GstDeviceProvider</doc>
- <type name="DeviceMonitor" c:type="GstDeviceMonitor*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_providers"
- c:identifier="gst_device_monitor_get_providers"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="832">Get a list of the currently selected device provider factories.
-
-This</doc>
- <source-position filename="gst/gstdevicemonitor.h" line="106"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="840">
- A list of device provider factory names that are currently being
- monitored by @monitor or %NULL when nothing is being monitored.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="monitor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="834">a #GstDeviceMonitor</doc>
- <type name="DeviceMonitor" c:type="GstDeviceMonitor*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_show_all_devices"
- c:identifier="gst_device_monitor_get_show_all_devices"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="898">Get if @monitor is currently showing all devices, even those from hidden
-providers.</doc>
- <source-position filename="gst/gstdevicemonitor.h" line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="905">%TRUE when all devices will be shown.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="monitor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="900">a #GstDeviceMonitor</doc>
- <type name="DeviceMonitor" c:type="GstDeviceMonitor*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_filter"
- c:identifier="gst_device_monitor_remove_filter"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="725">Removes a filter from the #GstDeviceMonitor using the id that was returned
-by gst_device_monitor_add_filter().</doc>
- <source-position filename="gst/gstdevicemonitor.h" line="103"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="733">%TRUE of the filter id was valid, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="monitor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="727">a device monitor</doc>
- <type name="DeviceMonitor" c:type="GstDeviceMonitor*"/>
- </instance-parameter>
- <parameter name="filter_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="728">the id of the filter</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_show_all_devices"
- c:identifier="gst_device_monitor_set_show_all_devices"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="877">Set if all devices should be visible, even those devices from hidden
-providers. Setting @show_all to true might show some devices multiple times.</doc>
- <source-position filename="gst/gstdevicemonitor.h" line="109"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="monitor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="879">a #GstDeviceMonitor</doc>
- <type name="DeviceMonitor" c:type="GstDeviceMonitor*"/>
- </instance-parameter>
- <parameter name="show_all" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="880">show all devices</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="start"
- c:identifier="gst_device_monitor_start"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="444">Starts monitoring the devices, one this has succeeded, the
-%GST_MESSAGE_DEVICE_ADDED and %GST_MESSAGE_DEVICE_REMOVED messages
-will be emitted on the bus when the list of devices changes.</doc>
- <source-position filename="gst/gstdevicemonitor.h" line="92"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="452">%TRUE if the device monitoring could be started</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="monitor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="446">A #GstDeviceMonitor</doc>
- <type name="DeviceMonitor" c:type="GstDeviceMonitor*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="stop" c:identifier="gst_device_monitor_stop" version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="551">Stops monitoring the devices.</doc>
- <source-position filename="gst/gstdevicemonitor.h" line="95"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="monitor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.c"
- line="553">A #GstDeviceProvider</doc>
- <type name="DeviceMonitor" c:type="GstDeviceMonitor*"/>
- </instance-parameter>
- </parameters>
- </method>
- <property name="show-all" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="parent">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.h"
- line="47">the parent #GstObject structure</doc>
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="DeviceMonitorPrivate" c:type="GstDeviceMonitorPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="DeviceMonitorClass"
- c:type="GstDeviceMonitorClass"
- glib:is-gtype-struct-for="DeviceMonitor"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.h"
- line="63">Opaque device monitor class structure.</doc>
- <source-position filename="gst/gstdevicemonitor.h" line="76"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst/gstdevicemonitor.h"
- line="65">the parent #GstObjectClass structure</doc>
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="DeviceMonitorPrivate"
- c:type="GstDeviceMonitorPrivate"
- disguised="1">
- <source-position filename="gst/gstdevicemonitor.h" line="34"/>
- </record>
- <record name="DevicePrivate" c:type="GstDevicePrivate" disguised="1">
- <source-position filename="gst/gstdevice.h" line="35"/>
- </record>
- <class name="DeviceProvider"
- c:symbol-prefix="device_provider"
- c:type="GstDeviceProvider"
- version="1.4"
- parent="Object"
- abstract="1"
- glib:type-name="GstDeviceProvider"
- glib:get-type="gst_device_provider_get_type"
- glib:type-struct="DeviceProviderClass">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="22">A #GstDeviceProvider subclass is provided by a plugin that handles devices
-if there is a way to programmatically list connected devices. It can also
-optionally provide updates to the list of connected devices.
-
-Each #GstDeviceProvider subclass is a singleton, a plugin should
-normally provide a single subclass for all devices.
-
-Applications would normally use a #GstDeviceMonitor to monitor devices
-from all relevant providers.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="101"/>
- <function name="register"
- c:identifier="gst_device_provider_register"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="155">Create a new device providerfactory capable of instantiating objects of the
-@type and add the factory to @plugin.</doc>
- <source-position filename="gst/gstdeviceproviderfactory.h" line="85"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="166">%TRUE, if the registering succeeded, %FALSE on error</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="plugin"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="157">#GstPlugin to register the device provider with, or %NULL for
- a static device provider.</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="159">name of device providers of this type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="rank" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="160">rank of device provider (higher rank means more importance when autoplugging)</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="161">GType of device provider to register</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="probe" introspectable="0">
- <source-position filename="gst/gstdeviceprovider.h" line="91"/>
- <return-value>
- <type name="GLib.List" c:type="GList*">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start" invoker="start" version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="436">Starts providering the devices. This will cause #GST_MESSAGE_DEVICE_ADDED
-and #GST_MESSAGE_DEVICE_REMOVED messages to be posted on the provider's bus
-when devices are added or removed from the system.
-
-Since the #GstDeviceProvider is a singleton,
-gst_device_provider_start() may already have been called by another
-user of the object, gst_device_provider_stop() needs to be called the same
-number of times.
-
-After this function has been called, gst_device_provider_get_devices() will
-return the same objects that have been received from the
-#GST_MESSAGE_DEVICE_ADDED messages and will no longer probe.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="93"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="453">%TRUE if the device providering could be started</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="438">A #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop" invoker="stop" version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="512">Decreases the use-count by one. If the use count reaches zero, this
-#GstDeviceProvider will stop providering the devices. This needs to be
-called the same number of times that gst_device_provider_start() was called.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="94"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="514">A #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <method name="can_monitor"
- c:identifier="gst_device_provider_can_monitor">
- <source-position filename="gst/gstdeviceprovider.h" line="117"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="device_add"
- c:identifier="gst_device_provider_device_add"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="611">Posts a message on the provider's #GstBus to inform applications that
-a new device has been added.
-
-This is for use by subclasses.
-
-@device's reference count will be incremented, and any floating reference
-will be removed (see gst_object_ref_sink()).</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="123"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="613">a #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- <parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="614">a #GstDevice that has been added</doc>
- <type name="Device" c:type="GstDevice*"/>
- </parameter>
- </parameters>
- </method>
- <method name="device_changed"
- c:identifier="gst_device_provider_device_changed"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="810">This function is used when @changed_device was modified into its new form
-@device. This will post a `DEVICE_CHANGED` message on the bus to let
-the application know that the device was modified. #GstDevice is immutable
-for MT. safety purposes so this is an "atomic" way of letting the application
-know when a device was modified.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="170"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- <parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="812">the new version of @changed_device</doc>
- <type name="Device" c:type="GstDevice*"/>
- </parameter>
- <parameter name="changed_device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="813">the old version of the device that has been updated</doc>
- <type name="Device" c:type="GstDevice*"/>
- </parameter>
- </parameters>
- </method>
- <method name="device_remove"
- c:identifier="gst_device_provider_device_remove"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="654">Posts a message on the provider's #GstBus to inform applications that
-a device has been removed.
-
-This is for use by subclasses.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="126"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="656">a #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- <parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="657">a #GstDevice that has been removed</doc>
- <type name="Device" c:type="GstDevice*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_bus"
- c:identifier="gst_device_provider_get_bus"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="593">Gets the #GstBus of this #GstDeviceProvider</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="120"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="599">a #GstBus</doc>
- <type name="Bus" c:type="GstBus*"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="595">a #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_devices"
- c:identifier="gst_device_provider_get_devices"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="387">Gets a list of devices that this provider understands. This may actually
-probe the hardware if the provider is not currently started.
-
-If the provider has been started, this will returned the same #GstDevice
-objedcts that have been returned by the #GST_MESSAGE_DEVICE_ADDED messages.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="108"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="397">a #GList of
- #GstDevice</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Device"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="389">A #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_factory"
- c:identifier="gst_device_provider_get_factory"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="551">Retrieves the factory that was used to create this device provider.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="177"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="557">the #GstDeviceProviderFactory used for
- creating this device provider. no refcounting is needed.</doc>
- <type name="DeviceProviderFactory"
- c:type="GstDeviceProviderFactory*"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="553">a #GstDeviceProvider to request the device provider factory of.</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_hidden_providers"
- c:identifier="gst_device_provider_get_hidden_providers"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="690">Get the provider factory names of the #GstDeviceProvider instances that
-are hidden by @provider.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="129"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="697">
- a list of hidden providers factory names or %NULL when
- nothing is hidden by @provider. Free with g_strfreev.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="692">a #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_metadata"
- c:identifier="gst_device_provider_get_metadata"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="364">Get metadata with @key in @provider.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="139"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="371">the metadata for @key.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="366">provider to get metadata for</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="367">the key to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="hide_provider"
- c:identifier="gst_device_provider_hide_provider"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="729">Make @provider hide the devices from the factory with @name.
-
-This function is used when @provider will also provide the devices reported
-by provider factory @name. A monitor should stop monitoring the
-device provider with @name to avoid duplicate devices.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="132"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="731">a #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="732">a provider factory name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_started"
- c:identifier="gst_device_provider_is_started"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="860">This function can be used to know if the @provider was successfully started.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="143"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="862">a #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="start"
- c:identifier="gst_device_provider_start"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="436">Starts providering the devices. This will cause #GST_MESSAGE_DEVICE_ADDED
-and #GST_MESSAGE_DEVICE_REMOVED messages to be posted on the provider's bus
-when devices are added or removed from the system.
-
-Since the #GstDeviceProvider is a singleton,
-gst_device_provider_start() may already have been called by another
-user of the object, gst_device_provider_stop() needs to be called the same
-number of times.
-
-After this function has been called, gst_device_provider_get_devices() will
-return the same objects that have been received from the
-#GST_MESSAGE_DEVICE_ADDED messages and will no longer probe.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="111"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="453">%TRUE if the device providering could be started</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="438">A #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="stop"
- c:identifier="gst_device_provider_stop"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="512">Decreases the use-count by one. If the use count reaches zero, this
-#GstDeviceProvider will stop providering the devices. This needs to be
-called the same number of times that gst_device_provider_start() was called.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="114"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="514">A #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unhide_provider"
- c:identifier="gst_device_provider_unhide_provider"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="768">Make @provider unhide the devices from factory @name.
-
-This function is used when @provider will no longer provide the devices
-reported by provider factory @name. A monitor should start
-monitoring the devices from provider factory @name in order to see
-all devices again.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="135"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="770">a #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="771">a provider factory name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <field name="parent">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.h"
- line="48">The parent #GstObject</doc>
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="devices">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.h"
- line="49">a #GList of the #GstDevice objects</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="DeviceProviderPrivate" c:type="GstDeviceProviderPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="provider-hidden" when="first">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="provider-unhidden" when="first">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="DeviceProviderClass"
- c:type="GstDeviceProviderClass"
- glib:is-gtype-struct-for="DeviceProvider"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.h"
- line="68">The structure of the base #GstDeviceProviderClass</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="101"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.h"
- line="70">the parent #GstObjectClass structure</doc>
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="factory">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.h"
- line="71">a pointer to the #GstDeviceProviderFactory that creates this
- provider</doc>
- <type name="DeviceProviderFactory" c:type="GstDeviceProviderFactory*"/>
- </field>
- <field name="probe" introspectable="0">
- <callback name="probe" introspectable="0">
- <source-position filename="gst/gstdeviceprovider.h" line="91"/>
- <return-value>
- <type name="GLib.List" c:type="GList*">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </return-value>
- <parameters>
- <parameter name="provider" transfer-ownership="none">
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="start">
- <callback name="start">
- <source-position filename="gst/gstdeviceprovider.h" line="93"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="453">%TRUE if the device providering could be started</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="438">A #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="gst/gstdeviceprovider.h" line="94"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="provider" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="514">A #GstDeviceProvider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="metadata" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="add_metadata"
- c:identifier="gst_device_provider_class_add_metadata"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="200">Set @key with @value as metadata in @klass.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="160"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="202">class to set metadata for</doc>
- <type name="DeviceProviderClass" c:type="GstDeviceProviderClass*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="203">the key to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="204">the value to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_static_metadata"
- c:identifier="gst_device_provider_class_add_static_metadata"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="222">Set @key with @value as metadata in @klass.
-
-Same as gst_device_provider_class_add_metadata(), but @value must be a static string
-or an inlined string, as it will not be copied. (GStreamer plugins will
-be made resident once loaded, so this function can be used even from
-dynamically loaded plugins.)</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="163"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="224">class to set metadata for</doc>
- <type name="DeviceProviderClass" c:type="GstDeviceProviderClass*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="225">the key to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="226">the value to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_metadata"
- c:identifier="gst_device_provider_class_get_metadata"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="343">Get metadata with @key in @klass.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="166"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="350">the metadata for @key.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="345">class to get metadata for</doc>
- <type name="DeviceProviderClass" c:type="GstDeviceProviderClass*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="346">the key to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_metadata"
- c:identifier="gst_device_provider_class_set_metadata"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="252">Sets the detailed information for a #GstDeviceProviderClass.
-
-&gt; This function is for use in _class_init functions only.</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="148"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="254">class to set metadata for</doc>
- <type name="DeviceProviderClass" c:type="GstDeviceProviderClass*"/>
- </instance-parameter>
- <parameter name="longname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="255">The long English name of the device provider. E.g. "File Sink"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="classification" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="256">String describing the type of device provider, as an
- unordered list separated with slashes ('/'). See draft-klass.txt of the
- design docs
-for more details and common types. E.g: "Sink/File"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="260">Sentence describing the purpose of the device provider.
-E.g: "Write stream to a file"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="author" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="262">Name and contact details of the author(s). Use \n to separate
-multiple author metadata. E.g: "Joe Bloggs &amp;lt;joe.blogs at foo.com&amp;gt;"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_static_metadata"
- c:identifier="gst_device_provider_class_set_static_metadata"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="289">Sets the detailed information for a #GstDeviceProviderClass.
-
-&gt; This function is for use in _class_init functions only.
-
-Same as gst_device_provider_class_set_metadata(), but @longname, @classification,
-@description, and @author must be static strings or inlined strings, as
-they will not be copied. (GStreamer plugins will be made resident once
-loaded, so this function can be used even from dynamically loaded plugins.)</doc>
- <source-position filename="gst/gstdeviceprovider.h" line="154"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="291">class to set metadata for</doc>
- <type name="DeviceProviderClass" c:type="GstDeviceProviderClass*"/>
- </instance-parameter>
- <parameter name="longname" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="292">The long English name of the element. E.g. "File Sink"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="classification" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="293">String describing the type of element, as
-an unordered list separated with slashes ('/'). See draft-klass.txt of the
-design docs for more details and common types. E.g: "Sink/File"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="description" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="296">Sentence describing the purpose of the
-element. E.g: "Write stream to a file"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="author" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdeviceprovider.c"
- line="298">Name and contact details of the author(s). Use \n
-to separate multiple author metadata. E.g: "Joe Bloggs &amp;lt;joe.blogs at
-foo.com&amp;gt;"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <class name="DeviceProviderFactory"
- c:symbol-prefix="device_provider_factory"
- c:type="GstDeviceProviderFactory"
- version="1.4"
- parent="PluginFeature"
- glib:type-name="GstDeviceProviderFactory"
- glib:get-type="gst_device_provider_factory_get_type"
- glib:type-struct="DeviceProviderFactoryClass">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="24">#GstDeviceProviderFactory is used to create instances of device providers. A
-GstDeviceProviderfactory can be added to a #GstPlugin as it is also a
-#GstPluginFeature.
-
-Use the gst_device_provider_factory_find() and
-gst_device_provider_factory_get() functions to create device
-provider instances or use gst_device_provider_factory_get_by_name() as a
-convenient shortcut.</doc>
- <source-position filename="gst/gstdeviceproviderfactory.h" line="45"/>
- <function name="find"
- c:identifier="gst_device_provider_factory_find"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="103">Search for an device provider factory of the given name. Refs the returned
-device provider factory; caller is responsible for unreffing.</doc>
- <source-position filename="gst/gstdeviceproviderfactory.h" line="67"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="110">#GstDeviceProviderFactory if
-found, %NULL otherwise</doc>
- <type name="DeviceProviderFactory"
- c:type="GstDeviceProviderFactory*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="105">name of factory to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_by_name"
- c:identifier="gst_device_provider_factory_get_by_name"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="339">Returns the device provider of the type defined by the given device
-provider factory.</doc>
- <source-position filename="gst/gstdeviceproviderfactory.h" line="82"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="346">a #GstDeviceProvider or %NULL
-if unable to create device provider</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </return-value>
- <parameters>
- <parameter name="factoryname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="341">a named factory to instantiate</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="list_get_device_providers"
- c:identifier="gst_device_provider_factory_list_get_device_providers"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="559">Get a list of factories with a rank greater or equal to @minrank.
-The list of factories is returned by decreasing rank.</doc>
- <source-position filename="gst/gstdeviceproviderfactory.h" line="95"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="566">
-a #GList of #GstDeviceProviderFactory device providers. Use
-gst_plugin_feature_list_free() after usage.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="DeviceProviderFactory"/>
- </type>
- </return-value>
- <parameters>
- <parameter name="minrank" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="561">Minimum rank</doc>
- <type name="Rank" c:type="GstRank"/>
- </parameter>
- </parameters>
- </function>
- <method name="get"
- c:identifier="gst_device_provider_factory_get"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="241">Returns the device provider of the type defined by the given device
-providerfactory.</doc>
- <source-position filename="gst/gstdeviceproviderfactory.h" line="79"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="248">the #GstDeviceProvider or %NULL
-if the device provider couldn't be created</doc>
- <type name="DeviceProvider" c:type="GstDeviceProvider*"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="243">factory to instantiate</doc>
- <type name="DeviceProviderFactory"
- c:type="GstDeviceProviderFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_device_provider_type"
- c:identifier="gst_device_provider_factory_get_device_provider_type"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="388">Get the #GType for device providers managed by this factory. The type can
-only be retrieved if the device provider factory is loaded, which can be
-assured with gst_plugin_feature_load().</doc>
- <source-position filename="gst/gstdeviceproviderfactory.h" line="70"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="396">the #GType for device providers managed by this factory.</doc>
- <type name="GType" c:type="GType"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="390">factory to get managed #GType from</doc>
- <type name="DeviceProviderFactory"
- c:type="GstDeviceProviderFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_metadata"
- c:identifier="gst_device_provider_factory_get_metadata"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="410">Get the metadata on @factory with @key.</doc>
- <source-position filename="gst/gstdeviceproviderfactory.h" line="73"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="417">the metadata with @key on @factory or %NULL
-when there was no metadata with the given @key.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="412">a #GstDeviceProviderFactory</doc>
- <type name="DeviceProviderFactory"
- c:type="GstDeviceProviderFactory*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="413">a key</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_metadata_keys"
- c:identifier="gst_device_provider_factory_get_metadata_keys"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="429">Get the available keys for the metadata on @factory.</doc>
- <source-position filename="gst/gstdeviceproviderfactory.h" line="76"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="435">
-a %NULL-terminated array of key strings, or %NULL when there is no
-metadata. Free with g_strfreev() when no longer needed.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="431">a #GstDeviceProviderFactory</doc>
- <type name="DeviceProviderFactory"
- c:type="GstDeviceProviderFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_classes"
- c:identifier="gst_device_provider_factory_has_classes"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="518">Check if @factory matches all of the given @classes</doc>
- <source-position filename="gst/gstdeviceproviderfactory.h" line="92"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="526">%TRUE if @factory matches or if @classes is %NULL.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="520">a #GstDeviceProviderFactory</doc>
- <type name="DeviceProviderFactory"
- c:type="GstDeviceProviderFactory*"/>
- </instance-parameter>
- <parameter name="classes"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="521">a "/" separate list of classes to match, only match
- if all classes are matched</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="has_classesv"
- c:identifier="gst_device_provider_factory_has_classesv"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="467">Check if @factory matches all of the given classes</doc>
- <source-position filename="gst/gstdeviceproviderfactory.h" line="89"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="475">%TRUE if @factory matches.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="469">a #GstDeviceProviderFactory</doc>
- <type name="DeviceProviderFactory"
- c:type="GstDeviceProviderFactory*"/>
- </instance-parameter>
- <parameter name="classes"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.c"
- line="470">a %NULL terminated array
- of classes to match, only match if all classes are matched</doc>
- <array c:type="gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- </class>
- <record name="DeviceProviderFactoryClass"
- c:type="GstDeviceProviderFactoryClass"
- disguised="1"
- glib:is-gtype-struct-for="DeviceProviderFactory"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstdeviceproviderfactory.h"
- line="37">The opaque #GstDeviceProviderFactoryClass data structure.</doc>
- <source-position filename="gst/gstdeviceproviderfactory.h" line="45"/>
- </record>
- <record name="DeviceProviderPrivate"
- c:type="GstDeviceProviderPrivate"
- disguised="1">
- <source-position filename="gst/gstdeviceprovider.h" line="33"/>
- </record>
- <class name="DoubleRange"
- c:symbol-prefix="double_range"
- glib:type-name="GstDoubleRange"
- glib:get-type="gst_double_range_get_type"
- glib:fundamental="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="261">A fundamental type that describes a #gdouble range</doc>
- </class>
- <class name="DynamicTypeFactory"
- c:symbol-prefix="dynamic_type_factory"
- c:type="GstDynamicTypeFactory"
- version="1.12"
- parent="PluginFeature"
- glib:type-name="GstDynamicTypeFactory"
- glib:get-type="gst_dynamic_type_factory_get_type"
- glib:type-struct="DynamicTypeFactoryClass">
- <doc xml:space="preserve"
- filename="gst/gstdynamictypefactory.c"
- line="22">#GstDynamicTypeFactory is used to represent a type that can be
-automatically loaded the first time it is used. For example,
-a non-standard type for use in caps fields.
-
-In general, applications and plugins don't need to use the factory
-beyond registering the type in a plugin init function. Once that is
-done, the type is stored in the registry, and ready as soon as the
-registry is loaded.
-
-## Registering a type for dynamic loading
-
-|[&lt;!-- language="C" --&gt;
-
-static gboolean
-plugin_init (GstPlugin * plugin)
-{
- return gst_dynamic_type_register (plugin, GST_TYPE_CUSTOM_CAPS_FIELD);
-}
-]|</doc>
- <source-position filename="gst/gstdynamictypefactory.h" line="33"/>
- <function name="load" c:identifier="gst_dynamic_type_factory_load">
- <source-position filename="gst/gstdynamictypefactory.h" line="54"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- <parameters>
- <parameter name="factoryname" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- </class>
- <record name="DynamicTypeFactoryClass"
- c:type="GstDynamicTypeFactoryClass"
- disguised="1"
- glib:is-gtype-struct-for="DynamicTypeFactory">
- <source-position filename="gst/gstdynamictypefactory.h" line="33"/>
- </record>
- <function-macro name="ELEMENT"
- c:identifier="GST_ELEMENT"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="62"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_BUS"
- c:identifier="GST_ELEMENT_BUS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="313">Get the message bus of this element. This is not thread-safe by default
-(i.e. you will have to make sure the object lock is taken yourself).
-If in doubt use gst_element_get_bus() instead.</doc>
- <source-position filename="gst/gstelement.h" line="321"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="315">A #GstElement to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_CAST"
- c:identifier="GST_ELEMENT_CAST"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="64"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_CLASS"
- c:identifier="GST_ELEMENT_CLASS"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="63"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_CLOCK"
- c:identifier="GST_ELEMENT_CLOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="323">Get the clock of this element.This is not thread-safe by default
-(i.e. you will have to make sure it is safe yourself).
-If in doubt use gst_element_get_clock() instead.</doc>
- <source-position filename="gst/gstelement.h" line="331"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="325">A #GstElement to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_ERROR"
- c:identifier="GST_ELEMENT_ERROR"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="406">Utility function that elements can use in case they encountered a fatal
-data processing error. The pipeline will post an error message and the
-application will be requested to stop further media processing.</doc>
- <source-position filename="gst/gstelement.h" line="420"/>
- <parameters>
- <parameter name="el">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="408">the element that generates the error</doc>
- </parameter>
- <parameter name="domain">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="409">like CORE, LIBRARY, RESOURCE or STREAM (see [GstGError](gsterror))</doc>
- </parameter>
- <parameter name="code">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="410">error code defined for that domain (see [GstGError](gsterror))</doc>
- </parameter>
- <parameter name="text">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="411">the message to display (format string and args enclosed in
- parentheses)</doc>
- </parameter>
- <parameter name="debug">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="413">debugging information for the message (format string and args
- enclosed in parentheses)</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_ERROR_WITH_DETAILS"
- c:identifier="GST_ELEMENT_ERROR_WITH_DETAILS"
- version="1.10"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="373">Utility function that elements can use in case they encountered a fatal
-data processing error. The pipeline will post an error message and the
-application will be requested to stop further media processing.</doc>
- <source-position filename="gst/gstelement.h" line="392"/>
- <parameters>
- <parameter name="el">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="375">the element that generates the error</doc>
- </parameter>
- <parameter name="domain">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="376">like CORE, LIBRARY, RESOURCE or STREAM (see [GstGError](gsterror))</doc>
- </parameter>
- <parameter name="code">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="377">error code defined for that domain (see [GstGError](gsterror))</doc>
- </parameter>
- <parameter name="text">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="378">the message to display (format string and args enclosed in
- parentheses)</doc>
- </parameter>
- <parameter name="debug">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="380">debugging information for the message (format string and args
- enclosed in parentheses)</doc>
- </parameter>
- <parameter name="args">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="382">optional name, type, value triplets, which will be stored
- in the associated GstStructure. NULL terminator required.
- Must be enclosed within parentheses.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_FACTORY"
- c:identifier="GST_ELEMENT_FACTORY"
- introspectable="0">
- <source-position filename="gst/gstelementfactory.h" line="45"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_FACTORY_CAST"
- c:identifier="GST_ELEMENT_FACTORY_CAST"
- introspectable="0">
- <source-position filename="gst/gstelementfactory.h" line="51"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_FACTORY_CLASS"
- c:identifier="GST_ELEMENT_FACTORY_CLASS"
- introspectable="0">
- <source-position filename="gst/gstelementfactory.h" line="47"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="ELEMENT_FACTORY_KLASS_DECODER"
- value="Decoder"
- c:type="GST_ELEMENT_FACTORY_KLASS_DECODER">
- <source-position filename="gst/gstelementfactory.h" line="200"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_DECRYPTOR"
- value="Decryptor"
- c:type="GST_ELEMENT_FACTORY_KLASS_DECRYPTOR">
- <source-position filename="gst/gstelementfactory.h" line="210"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_DEMUXER"
- value="Demuxer"
- c:type="GST_ELEMENT_FACTORY_KLASS_DEMUXER">
- <source-position filename="gst/gstelementfactory.h" line="205"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_DEPAYLOADER"
- value="Depayloader"
- c:type="GST_ELEMENT_FACTORY_KLASS_DEPAYLOADER">
- <source-position filename="gst/gstelementfactory.h" line="208"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_ENCODER"
- value="Encoder"
- c:type="GST_ELEMENT_FACTORY_KLASS_ENCODER">
- <source-position filename="gst/gstelementfactory.h" line="201"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_ENCRYPTOR"
- value="Encryptor"
- c:type="GST_ELEMENT_FACTORY_KLASS_ENCRYPTOR">
- <source-position filename="gst/gstelementfactory.h" line="211"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_FORMATTER"
- value="Formatter"
- c:type="GST_ELEMENT_FACTORY_KLASS_FORMATTER">
- <source-position filename="gst/gstelementfactory.h" line="209"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_HARDWARE"
- value="Hardware"
- c:type="GST_ELEMENT_FACTORY_KLASS_HARDWARE"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.h"
- line="220">Elements interacting with hardware devices should specify this classifier in
-their metadata. You may need to put the element in "READY" state to test if
-the hardware is present in the system.</doc>
- <source-position filename="gst/gstelementfactory.h" line="228"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_MEDIA_AUDIO"
- value="Audio"
- c:type="GST_ELEMENT_FACTORY_KLASS_MEDIA_AUDIO">
- <source-position filename="gst/gstelementfactory.h" line="214"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_MEDIA_IMAGE"
- value="Image"
- c:type="GST_ELEMENT_FACTORY_KLASS_MEDIA_IMAGE">
- <source-position filename="gst/gstelementfactory.h" line="215"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_MEDIA_METADATA"
- value="Metadata"
- c:type="GST_ELEMENT_FACTORY_KLASS_MEDIA_METADATA">
- <source-position filename="gst/gstelementfactory.h" line="217"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_MEDIA_SUBTITLE"
- value="Subtitle"
- c:type="GST_ELEMENT_FACTORY_KLASS_MEDIA_SUBTITLE">
- <source-position filename="gst/gstelementfactory.h" line="216"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_MEDIA_VIDEO"
- value="Video"
- c:type="GST_ELEMENT_FACTORY_KLASS_MEDIA_VIDEO">
- <source-position filename="gst/gstelementfactory.h" line="213"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_MUXER"
- value="Muxer"
- c:type="GST_ELEMENT_FACTORY_KLASS_MUXER">
- <source-position filename="gst/gstelementfactory.h" line="204"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_PARSER"
- value="Parser"
- c:type="GST_ELEMENT_FACTORY_KLASS_PARSER">
- <source-position filename="gst/gstelementfactory.h" line="206"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_PAYLOADER"
- value="Payloader"
- c:type="GST_ELEMENT_FACTORY_KLASS_PAYLOADER">
- <source-position filename="gst/gstelementfactory.h" line="207"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_SINK"
- value="Sink"
- c:type="GST_ELEMENT_FACTORY_KLASS_SINK">
- <source-position filename="gst/gstelementfactory.h" line="202"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_KLASS_SRC"
- value="Source"
- c:type="GST_ELEMENT_FACTORY_KLASS_SRC">
- <source-position filename="gst/gstelementfactory.h" line="203"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_ANY"
- value="562949953421311"
- c:type="GST_ELEMENT_FACTORY_TYPE_ANY">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.h"
- line="153">Elements of any of the defined GST_ELEMENT_FACTORY_LIST types</doc>
- <source-position filename="gst/gstelementfactory.h" line="158"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS"
- value="3940649673949188"
- c:type="GST_ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.h"
- line="185">All sinks handling audio, video or image media types</doc>
- <source-position filename="gst/gstelementfactory.h" line="190"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_AUDIO_ENCODER"
- value="1125899906842626"
- c:type="GST_ELEMENT_FACTORY_TYPE_AUDIO_ENCODER">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.h"
- line="178">All encoders handling audio media types</doc>
- <source-position filename="gst/gstelementfactory.h" line="183"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_DECODABLE"
- value="1377"
- c:type="GST_ELEMENT_FACTORY_TYPE_DECODABLE">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.h"
- line="192">All elements used to 'decode' streams (decoders, demuxers, parsers, depayloaders)</doc>
- <source-position filename="gst/gstelementfactory.h" line="197"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_DECODER"
- value="1"
- c:type="GST_ELEMENT_FACTORY_TYPE_DECODER">
- <source-position filename="gst/gstelementfactory.h" line="131"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_DECRYPTOR"
- value="1024"
- c:type="GST_ELEMENT_FACTORY_TYPE_DECRYPTOR">
- <source-position filename="gst/gstelementfactory.h" line="141"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_DEMUXER"
- value="32"
- c:type="GST_ELEMENT_FACTORY_TYPE_DEMUXER">
- <source-position filename="gst/gstelementfactory.h" line="136"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_DEPAYLOADER"
- value="256"
- c:type="GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER">
- <source-position filename="gst/gstelementfactory.h" line="139"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_ENCODER"
- value="2"
- c:type="GST_ELEMENT_FACTORY_TYPE_ENCODER">
- <source-position filename="gst/gstelementfactory.h" line="132"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_ENCRYPTOR"
- value="2048"
- c:type="GST_ELEMENT_FACTORY_TYPE_ENCRYPTOR">
- <source-position filename="gst/gstelementfactory.h" line="142"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_FORMATTER"
- value="512"
- c:type="GST_ELEMENT_FACTORY_TYPE_FORMATTER">
- <source-position filename="gst/gstelementfactory.h" line="140"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_HARDWARE"
- value="4096"
- c:type="GST_ELEMENT_FACTORY_TYPE_HARDWARE">
- <source-position filename="gst/gstelementfactory.h" line="143"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_MAX_ELEMENTS"
- value="281474976710656"
- c:type="GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS">
- <source-position filename="gst/gstelementfactory.h" line="145"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_MEDIA_ANY"
- value="18446462598732840960"
- c:type="GST_ELEMENT_FACTORY_TYPE_MEDIA_ANY">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.h"
- line="160">Elements matching any of the defined GST_ELEMENT_FACTORY_TYPE_MEDIA types
-
-Note: Do not use this if you wish to not filter against any of the defined
-media types. If you wish to do this, simply don't specify any
-GST_ELEMENT_FACTORY_TYPE_MEDIA flag.</doc>
- <source-position filename="gst/gstelementfactory.h" line="169"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_MEDIA_AUDIO"
- value="1125899906842624"
- c:type="GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO">
- <source-position filename="gst/gstelementfactory.h" line="148"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_MEDIA_IMAGE"
- value="2251799813685248"
- c:type="GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE">
- <source-position filename="gst/gstelementfactory.h" line="149"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_MEDIA_METADATA"
- value="9007199254740992"
- c:type="GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA">
- <source-position filename="gst/gstelementfactory.h" line="151"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE"
- value="4503599627370496"
- c:type="GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE">
- <source-position filename="gst/gstelementfactory.h" line="150"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_MEDIA_VIDEO"
- value="562949953421312"
- c:type="GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO">
- <source-position filename="gst/gstelementfactory.h" line="147"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_MUXER"
- value="16"
- c:type="GST_ELEMENT_FACTORY_TYPE_MUXER">
- <source-position filename="gst/gstelementfactory.h" line="135"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_PARSER"
- value="64"
- c:type="GST_ELEMENT_FACTORY_TYPE_PARSER">
- <source-position filename="gst/gstelementfactory.h" line="137"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_PAYLOADER"
- value="128"
- c:type="GST_ELEMENT_FACTORY_TYPE_PAYLOADER">
- <source-position filename="gst/gstelementfactory.h" line="138"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_SINK"
- value="4"
- c:type="GST_ELEMENT_FACTORY_TYPE_SINK">
- <source-position filename="gst/gstelementfactory.h" line="133"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_SRC"
- value="8"
- c:type="GST_ELEMENT_FACTORY_TYPE_SRC">
- <source-position filename="gst/gstelementfactory.h" line="134"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <constant name="ELEMENT_FACTORY_TYPE_VIDEO_ENCODER"
- value="2814749767106562"
- c:type="GST_ELEMENT_FACTORY_TYPE_VIDEO_ENCODER">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.h"
- line="171">All encoders handling video or image media types</doc>
- <source-position filename="gst/gstelementfactory.h" line="176"/>
- <type name="ElementFactoryListType" c:type="GstElementFactoryListType"/>
- </constant>
- <function-macro name="ELEMENT_FLOW_ERROR"
- c:identifier="GST_ELEMENT_FLOW_ERROR"
- version="1.10"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="355">Utility function that elements can use in case they encountered a fatal
-data processing error due to wrong flow processing.</doc>
- <source-position filename="gst/gstelement.h" line="365"/>
- <parameters>
- <parameter name="el">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="357">the element that generates the error</doc>
- </parameter>
- <parameter name="flow_return">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="358">the GstFlowReturn leading to that ERROR message</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_GET_CLASS"
- c:identifier="GST_ELEMENT_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="61"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_INFO"
- c:identifier="GST_ELEMENT_INFO"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="531">Utility function that elements can use in case they want to inform
-the application of something noteworthy that is not an error.
-The pipeline will post a info message and the
-application will be informed.</doc>
- <source-position filename="gst/gstelement.h" line="546"/>
- <parameters>
- <parameter name="el">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="533">the element that generates the information</doc>
- </parameter>
- <parameter name="domain">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="534">like CORE, LIBRARY, RESOURCE or STREAM (see [GstGError](gsterror))</doc>
- </parameter>
- <parameter name="code">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="535">error code defined for that domain (see [GstGError](gsterror))</doc>
- </parameter>
- <parameter name="text">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="536">the message to display (format string and args enclosed in
- parentheses)</doc>
- </parameter>
- <parameter name="debug">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="538">debugging information for the message (format string and args
- enclosed in parentheses)</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_INFO_WITH_DETAILS"
- c:identifier="GST_ELEMENT_INFO_WITH_DETAILS"
- version="1.10"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="495">Utility function that elements can use in case they want to inform
-the application of something noteworthy that is not an error.
-The pipeline will post a info message and the
-application will be informed.
-Optional name, type, value triplets may be supplied, and will be stored
-in the associated GstStructure. NULL terminator required.</doc>
- <source-position filename="gst/gstelement.h" line="517"/>
- <parameters>
- <parameter name="el">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="497">the element that generates the information</doc>
- </parameter>
- <parameter name="domain">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="498">like CORE, LIBRARY, RESOURCE or STREAM (see [GstGError](gsterror))</doc>
- </parameter>
- <parameter name="code">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="499">error code defined for that domain (see [GstGError](gsterror))</doc>
- </parameter>
- <parameter name="text">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="500">the message to display (format string and args enclosed in
- parentheses)</doc>
- </parameter>
- <parameter name="debug">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="502">debugging information for the message (format string and args
- enclosed in parentheses)</doc>
- </parameter>
- <parameter name="args">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="504">optional name, type, value triplets, which will be stored
- in the associated GstStructure. NULL terminator required.
- Must be enclosed within parentheses.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_IS_LOCKED_STATE"
- c:identifier="GST_ELEMENT_IS_LOCKED_STATE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="284">Check if the element is in the locked state and therefore will ignore state
-changes from its parent object.</doc>
- <source-position filename="gst/gstelement.h" line="291"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="286">A #GstElement to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_MESSAGE_MAKE_DETAILS"
- c:identifier="GST_ELEMENT_MESSAGE_MAKE_DETAILS"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="353"/>
- <parameters>
- <parameter name="args">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="ELEMENT_METADATA_AUTHOR"
- value="author"
- c:type="GST_ELEMENT_METADATA_AUTHOR">
- <doc xml:space="preserve"
- filename="gst/gstelementmetadata.h"
- line="52">Name and contact details of the author(s). Use \n to separate
-multiple author details.
-E.g: "Joe Bloggs &amp;lt;joe.blogs at foo.com&amp;gt;"</doc>
- <source-position filename="gst/gstelementmetadata.h" line="59"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_METADATA_DESCRIPTION"
- value="description"
- c:type="GST_ELEMENT_METADATA_DESCRIPTION">
- <doc xml:space="preserve"
- filename="gst/gstelementmetadata.h"
- line="45">Sentence describing the purpose of the element.
-E.g: "Write stream to a file"</doc>
- <source-position filename="gst/gstelementmetadata.h" line="51"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_METADATA_DOC_URI"
- value="doc-uri"
- c:type="GST_ELEMENT_METADATA_DOC_URI">
- <doc xml:space="preserve"
- filename="gst/gstelementmetadata.h"
- line="61">Set uri pointing to user documentation. Applications can use this to show
-help for e.g. effects to users.</doc>
- <source-position filename="gst/gstelementmetadata.h" line="67"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_METADATA_ICON_NAME"
- value="icon-name"
- c:type="GST_ELEMENT_METADATA_ICON_NAME">
- <doc xml:space="preserve"
- filename="gst/gstelementmetadata.h"
- line="68">Elements that bridge to certain other products can include an icon of that
-used product. Application can show the icon in menus/selectors to help
-identifying specific elements.</doc>
- <source-position filename="gst/gstelementmetadata.h" line="75"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_METADATA_KLASS"
- value="klass"
- c:type="GST_ELEMENT_METADATA_KLASS">
- <doc xml:space="preserve"
- filename="gst/gstelementmetadata.h"
- line="36">String describing the type of element, as an unordered list
-separated with slashes ('/'). See draft-klass.txt of the design docs
-for more details and common types. E.g: "Sink/File"</doc>
- <source-position filename="gst/gstelementmetadata.h" line="43"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ELEMENT_METADATA_LONGNAME"
- value="long-name"
- c:type="GST_ELEMENT_METADATA_LONGNAME">
- <doc xml:space="preserve"
- filename="gst/gstelementmetadata.h"
- line="30">The long English name of the element. E.g. "File Sink"</doc>
- <source-position filename="gst/gstelementmetadata.h" line="35"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="ELEMENT_NAME"
- c:identifier="GST_ELEMENT_NAME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="293">Gets the name of this element. This is not thread-safe by default
-(i.e. you will have to make sure the object lock is taken yourself).
-If in doubt use gst_element_get_name() instead.</doc>
- <source-position filename="gst/gstelement.h" line="301"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="295">A #GstElement to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_PADS"
- c:identifier="GST_ELEMENT_PADS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="333">Get the pads of this elements.</doc>
- <source-position filename="gst/gstelement.h" line="339"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="335">A #GstElement to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_PARENT"
- c:identifier="GST_ELEMENT_PARENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="303">Get the parent object of this element. This is not thread-safe by default
-(i.e. you will have to make sure the object lock is taken yourself).
-If in doubt use gst_object_get_parent() instead.</doc>
- <source-position filename="gst/gstelement.h" line="311"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="305">A #GstElement to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_START_TIME"
- c:identifier="GST_ELEMENT_START_TIME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="341">This macro returns the start_time of the @elem. The start_time is the
-running_time of the pipeline when the element went to PAUSED.</doc>
- <source-position filename="gst/gstelement.h" line="348"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="343">a #GstElement to return the start time for.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_WARNING"
- c:identifier="GST_ELEMENT_WARNING"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="467">Utility function that elements can use in case they encountered a non-fatal
-data processing problem. The pipeline will post a warning message and the
-application will be informed.</doc>
- <source-position filename="gst/gstelement.h" line="481"/>
- <parameters>
- <parameter name="el">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="469">the element that generates the warning</doc>
- </parameter>
- <parameter name="domain">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="470">like CORE, LIBRARY, RESOURCE or STREAM (see [GstGError](gsterror))</doc>
- </parameter>
- <parameter name="code">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="471">error code defined for that domain (see [GstGError](gsterror))</doc>
- </parameter>
- <parameter name="text">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="472">the message to display (format string and args enclosed in
- parentheses)</doc>
- </parameter>
- <parameter name="debug">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="474">debugging information for the message (format string and args
- enclosed in parentheses)</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ELEMENT_WARNING_WITH_DETAILS"
- c:identifier="GST_ELEMENT_WARNING_WITH_DETAILS"
- version="1.10"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="434">Utility function that elements can use in case they encountered a non-fatal
-data processing problem. The pipeline will post a warning message and the
-application will be informed.</doc>
- <source-position filename="gst/gstelement.h" line="453"/>
- <parameters>
- <parameter name="el">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="436">the element that generates the warning</doc>
- </parameter>
- <parameter name="domain">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="437">like CORE, LIBRARY, RESOURCE or STREAM (see [GstGError](gsterror))</doc>
- </parameter>
- <parameter name="code">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="438">error code defined for that domain (see [GstGError](gsterror))</doc>
- </parameter>
- <parameter name="text">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="439">the message to display (format string and args enclosed in
- parentheses)</doc>
- </parameter>
- <parameter name="debug">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="441">debugging information for the message (format string and args
- enclosed in parentheses)</doc>
- </parameter>
- <parameter name="args">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="443">optional name, type, value triplets, which will be stored
- in the associated GstStructure. NULL terminator required.
- Must be enclosed within parentheses.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="ERROR_SYSTEM"
- value="system error: %s"
- c:type="GST_ERROR_SYSTEM"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="237">Builds a string using errno describing the previously failed system
-call. To be used as the debug argument in #GST_ELEMENT_ERROR.</doc>
- <source-position filename="gst/gsterror.h" line="243"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="EVENT" c:identifier="GST_EVENT" introspectable="0">
- <source-position filename="gst/gstevent.h" line="238"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="EVENT_CAST"
- c:identifier="GST_EVENT_CAST"
- introspectable="0">
- <source-position filename="gst/gstevent.h" line="237"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="EVENT_IS_DOWNSTREAM"
- c:identifier="GST_EVENT_IS_DOWNSTREAM"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="282">Check if an event can travel downstream.</doc>
- <source-position filename="gst/gstevent.h" line="287"/>
- <parameters>
- <parameter name="ev">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="284">the event to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="EVENT_IS_SERIALIZED"
- c:identifier="GST_EVENT_IS_SERIALIZED"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="289">Check if an event is serialized with the data stream.</doc>
- <source-position filename="gst/gstevent.h" line="294"/>
- <parameters>
- <parameter name="ev">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="291">the event to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="EVENT_IS_STICKY"
- c:identifier="GST_EVENT_IS_STICKY"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="296">Check if an event is sticky on the pads.</doc>
- <source-position filename="gst/gstevent.h" line="301"/>
- <parameters>
- <parameter name="ev">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="298">the event to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="EVENT_IS_UPSTREAM"
- c:identifier="GST_EVENT_IS_UPSTREAM"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="275">Check if an event can travel upstream.</doc>
- <source-position filename="gst/gstevent.h" line="280"/>
- <parameters>
- <parameter name="ev">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="277">the event to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="EVENT_MAKE_TYPE"
- c:identifier="GST_EVENT_MAKE_TYPE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="62">when making custom event types, use this macro with the num and
-the given flags</doc>
- <source-position filename="gst/gstevent.h" line="69"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="64">the event number to create</doc>
- </parameter>
- <parameter name="flags">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="65">the event flags</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="EVENT_NUM_SHIFT" value="8" c:type="GST_EVENT_NUM_SHIFT">
- <source-position filename="gst/gstevent.h" line="59"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="EVENT_SEQNUM"
- c:identifier="GST_EVENT_SEQNUM"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="267">The sequence number of @event.</doc>
- <source-position filename="gst/gstevent.h" line="272"/>
- <parameters>
- <parameter name="event">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="269">the event to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="EVENT_TIMESTAMP"
- c:identifier="GST_EVENT_TIMESTAMP"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="257">Get the #GstClockTime timestamp of the event. This is the time when the event
-was created.</doc>
- <source-position filename="gst/gstevent.h" line="264"/>
- <parameters>
- <parameter name="event">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="259">the event to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="EVENT_TYPE"
- c:identifier="GST_EVENT_TYPE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="241">Get the #GstEventType of the event.</doc>
- <source-position filename="gst/gstevent.h" line="246"/>
- <parameters>
- <parameter name="event">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="243">the event to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="EVENT_TYPE_BOTH" value="3" c:type="GST_EVENT_TYPE_BOTH">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="52">The same thing as #GST_EVENT_TYPE_UPSTREAM | #GST_EVENT_TYPE_DOWNSTREAM.</doc>
- <source-position filename="gst/gstevent.h" line="57"/>
- <type name="EventTypeFlags" c:type="GstEventTypeFlags"/>
- </constant>
- <function-macro name="EVENT_TYPE_NAME"
- c:identifier="GST_EVENT_TYPE_NAME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="249">Get a constant string representation of the #GstEventType of the event.</doc>
- <source-position filename="gst/gstevent.h" line="254"/>
- <parameters>
- <parameter name="event">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="251">the event to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <class name="Element"
- c:symbol-prefix="element"
- c:type="GstElement"
- parent="Object"
- abstract="1"
- glib:type-name="GstElement"
- glib:get-type="gst_element_get_type"
- glib:type-struct="ElementClass">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="23">GstElement is the abstract base class needed to construct an element that
-can be used in a GStreamer pipeline. Please refer to the plugin writers
-guide for more information on creating #GstElement subclasses.
-
-The name of a #GstElement can be get with gst_element_get_name() and set with
-gst_element_set_name(). For speed, GST_ELEMENT_NAME() can be used in the
-core when using the appropriate locking. Do not use this in plug-ins or
-applications in order to retain ABI compatibility.
-
-Elements can have pads (of the type #GstPad). These pads link to pads on
-other elements. #GstBuffer flow between these linked pads.
-A #GstElement has a #GList of #GstPad structures for all their input (or sink)
-and output (or source) pads.
-Core and plug-in writers can add and remove pads with gst_element_add_pad()
-and gst_element_remove_pad().
-
-An existing pad of an element can be retrieved by name with
-gst_element_get_static_pad(). A new dynamic pad can be created using
-gst_element_request_pad() with a #GstPadTemplate.
-An iterator of all pads can be retrieved with gst_element_iterate_pads().
-
-Elements can be linked through their pads.
-If the link is straightforward, use the gst_element_link()
-convenience function to link two elements, or gst_element_link_many()
-for more elements in a row.
-Use gst_element_link_filtered() to link two elements constrained by
-a specified set of #GstCaps.
-For finer control, use gst_element_link_pads() and
-gst_element_link_pads_filtered() to specify the pads to link on
-each element by name.
-
-Each element has a state (see #GstState). You can get and set the state
-of an element with gst_element_get_state() and gst_element_set_state().
-Setting a state triggers a #GstStateChange. To get a string representation
-of a #GstState, use gst_element_state_get_name().
-
-You can get and set a #GstClock on an element using gst_element_get_clock()
-and gst_element_set_clock().
-Some elements can provide a clock for the pipeline if
-the #GST_ELEMENT_FLAG_PROVIDE_CLOCK flag is set. With the
-gst_element_provide_clock() method one can retrieve the clock provided by
-such an element.
-Not all elements require a clock to operate correctly. If the
-#GST_ELEMENT_FLAG_REQUIRE_CLOCK() flag is set, a clock should be set on the
-element with gst_element_set_clock().
-
-Note that clock selection and distribution is normally handled by the
-toplevel #GstPipeline so the clock functions are only to be used in very
-specific situations.</doc>
- <source-position filename="gst/gstelement.h" line="744"/>
- <function name="make_from_uri"
- c:identifier="gst_element_make_from_uri"
- throws="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="612">Creates an element for handling the given URI.</doc>
- <source-position filename="gst/gsturi.h" line="161"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="621">a new element or %NULL if none
-could be created</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="614">Whether to create a source or a sink</doc>
- <type name="URIType" c:type="const GstURIType"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="615">URI to create an element for</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="elementname"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="616">Name of created element, can be %NULL.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="register" c:identifier="gst_element_register">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="187">Create a new elementfactory capable of instantiating objects of the
-@type and add the factory to @plugin.</doc>
- <source-position filename="gst/gstelementfactory.h" line="90"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="198">%TRUE, if the registering succeeded, %FALSE on error</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="plugin"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="189">#GstPlugin to register the element with, or %NULL for
- a static element.</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="191">name of elements of this type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="rank" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="192">rank of element (higher rank means more importance when autoplugging)</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="193">GType of element to register</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </function>
- <function name="state_change_return_get_name"
- c:identifier="gst_element_state_change_return_get_name">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1304">Gets a string representing the given state change result.</doc>
- <source-position filename="gst/gstutils.h" line="996"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1310">a string with the name of the state
- result.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="state_ret" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1306">a #GstStateChangeReturn to get the name of.</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </parameter>
- </parameters>
- </function>
- <function name="state_get_name"
- c:identifier="gst_element_state_get_name">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1276">Gets a string representing the given state.</doc>
- <source-position filename="gst/gstutils.h" line="993"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1282">a string with the name of the state.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="state" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1278">a #GstState to get the name of.</doc>
- <type name="State" c:type="GstState"/>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="change_state" invoker="change_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3022">Perform @transition on @element.
-
-This function must be called with STATE_LOCK held and is mainly used
-internally.</doc>
- <source-position filename="gst/gstelement.h" line="722"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3032">the #GstStateChangeReturn of the state transition.</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3024">a #GstElement</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="transition" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3025">the requested transition</doc>
- <type name="StateChange" c:type="GstStateChange"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_state" invoker="get_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2553">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.</doc>
- <source-position filename="gst/gstelement.h" line="719"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2584">%GST_STATE_CHANGE_SUCCESS if the element has no more pending state
- 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.
-
-MT safe.</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2555">a #GstElement to get the state of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="state"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2556">a pointer to #GstState to hold the state.
- Can be %NULL.</doc>
- <type name="State" c:type="GstState*"/>
- </parameter>
- <parameter name="pending"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2558">a pointer to #GstState to hold the pending
- state. Can be %NULL.</doc>
- <type name="State" c:type="GstState*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2560">a #GstClockTime to specify the timeout for an async
- state change or %GST_CLOCK_TIME_NONE for infinite timeout.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="no_more_pads" invoker="no_more_pads">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="941">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.</doc>
- <source-position filename="gst/gstelement.h" line="706"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="943">a #GstElement</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="pad_added">
- <source-position filename="gst/gstelement.h" line="704"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="pad_removed">
- <source-position filename="gst/gstelement.h" line="705"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="post_message" invoker="post_message">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2096">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.</doc>
- <source-position filename="gst/gstelement.h" line="738"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2105">%TRUE if the message was successfully posted. The function returns
-%FALSE if the element did not have a bus.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2098">a #GstElement posting the message</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2099">a #GstMessage to post</doc>
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="provide_clock" invoker="provide_clock">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="371">Get the clock provided by the given element.
-&gt; An element is only required to provide a clock in the PAUSED
-&gt; state. Some elements can provide a clock in other states.</doc>
- <source-position filename="gst/gstelement.h" line="730"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="379">the GstClock provided by the
-element or %NULL if no clock could be provided. Unref after usage.
-
-MT safe.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="373">a #GstElement to query</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="query" invoker="query">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2021">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.
-
-Please note that some queries might need a running pipeline to work.</doc>
- <source-position filename="gst/gstelement.h" line="736"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2034">%TRUE if the query could be performed.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2023">a #GstElement to perform the query on.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2024">the #GstQuery.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="release_pad">
- <source-position filename="gst/gstelement.h" line="716"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="request_new_pad" invoker="request_pad">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1232">Retrieves a request pad from the element according to the provided template.
-Pad templates can be looked up using
-gst_element_factory_get_static_pad_templates().
-
-The pad should be released with gst_element_release_request_pad().</doc>
- <source-position filename="gst/gstelement.h" line="713"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1247">requested #GstPad if found,
- otherwise %NULL. Release after usage.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1234">a #GstElement to find a request pad of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1235">a #GstPadTemplate of which we want a pad of.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </parameter>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1236">the name of the request #GstPad
-to retrieve. Can be %NULL.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1238">the caps of the pad we want to
-request. Can be %NULL.</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="send_event" invoker="send_event">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1915">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
-downstream events or a random linked source pad for upstream events.
-
-This function takes ownership of the provided event so you should
-gst_event_ref() it if you want to reuse the event after this call.
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="734"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1929">%TRUE if the event was handled. Events that trigger a preroll (such
-as flushing seeks and steps) will emit %GST_MESSAGE_ASYNC_DONE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1917">a #GstElement to send the event to.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1918">the #GstEvent to send to the element.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_bus" invoker="set_bus">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3448">Sets the bus of the element. Increases the refcount on the bus.
-For internal use only, unless you're testing elements.
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="727"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3450">a #GstElement to set the bus of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="bus"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3451">the #GstBus to set.</doc>
- <type name="Bus" c:type="GstBus*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_clock" invoker="set_clock">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="413">Sets the clock for the element. This function increases the
-refcount on the clock. Any previously set clock on the object
-is unreffed.</doc>
- <source-position filename="gst/gstelement.h" line="731"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="422">%TRUE if the element accepted the clock. An element can refuse a
-clock when it, for example, is not able to slave its internal clock to the
-@clock or when it requires a specific clock to operate.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="415">a #GstElement to set the clock for.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="clock"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="416">the #GstClock to set for the element.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_context" invoker="set_context">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3533">Sets the context of the element. Increases the refcount of the context.
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="740"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3535">a #GstElement to set the context of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="context" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3536">the #GstContext to set.</doc>
- <type name="Context" c:type="GstContext*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_state" invoker="set_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2867">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 %GST_MESSAGE_ASYNC_DONE or
-%GST_MESSAGE_STATE_CHANGED on the bus.
-
-State changes to %GST_STATE_READY or %GST_STATE_NULL never return
-#GST_STATE_CHANGE_ASYNC.</doc>
- <source-position filename="gst/gstelement.h" line="721"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2886">Result of the state change using #GstStateChangeReturn.
-
-MT safe.</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2869">a #GstElement to change state of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="state" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2870">the element's new #GstState.</doc>
- <type name="State" c:type="GstState"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="state_changed">
- <source-position filename="gst/gstelement.h" line="723"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="oldstate" transfer-ownership="none">
- <type name="State" c:type="GstState"/>
- </parameter>
- <parameter name="newstate" transfer-ownership="none">
- <type name="State" c:type="GstState"/>
- </parameter>
- <parameter name="pending" transfer-ownership="none">
- <type name="State" c:type="GstState"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="abort_state" c:identifier="gst_element_abort_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2608">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.</doc>
- <source-position filename="gst/gstelement.h" line="1012"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2610">a #GstElement to abort the state of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="add_pad" c:identifier="gst_element_add_pad">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="719">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 automatically activated when added in the PAUSED or PLAYING
-state.
-
-The pad and the element should be unlocked when calling this function.
-
-This function will emit the #GstElement::pad-added signal on the element.</doc>
- <source-position filename="gst/gstelement.h" line="894"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="734">%TRUE if the pad could be added. This function can fail when
-a pad with the same name already existed or the pad already had another
-parent.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="721">a #GstElement to add the pad to.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="722">the #GstPad to add to the element.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_property_deep_notify_watch"
- c:identifier="gst_element_add_property_deep_notify_watch"
- version="1.10">
- <source-position filename="gst/gstelement.h" line="1051"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3733">a watch id, which can be used in connection with
- gst_element_remove_property_notify_watch() to remove the watch again.</doc>
- <type name="gulong" c:type="gulong"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3728">a #GstElement to watch (recursively) for property changes</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="property_name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3729">name of property to watch for changes, or
- NULL to watch all properties</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="include_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3731">whether to include the new property value in the message</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_property_notify_watch"
- c:identifier="gst_element_add_property_notify_watch"
- version="1.10">
- <source-position filename="gst/gstelement.h" line="1047"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3701">a watch id, which can be used in connection with
- gst_element_remove_property_notify_watch() to remove the watch again.</doc>
- <type name="gulong" c:type="gulong"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3696">a #GstElement to watch for property changes</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="property_name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3697">name of property to watch for changes, or
- NULL to watch all properties</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="include_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3699">whether to include the new property value in the message</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="call_async"
- c:identifier="gst_element_call_async"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3791">Calls @func from another thread and passes @user_data to it. This is to be
-used for cases when a state change has to be performed from a streaming
-thread, directly via gst_element_set_state() or indirectly e.g. via SEEK
-events.
-
-Calling those functions directly from the streaming thread will cause
-deadlocks in many situations, as they might involve waiting for the
-streaming thread to shut down from this very streaming thread.
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="1035"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3793">a #GstElement</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3794">Function to call asynchronously from another thread</doc>
- <type name="ElementCallAsyncFunc"
- c:type="GstElementCallAsyncFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3795">Data to pass to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="destroy_notify"
- transfer-ownership="none"
- scope="async">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3796">GDestroyNotify for @user_data</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="change_state" c:identifier="gst_element_change_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3022">Perform @transition on @element.
-
-This function must be called with STATE_LOCK held and is mainly used
-internally.</doc>
- <source-position filename="gst/gstelement.h" line="1015"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3032">the #GstStateChangeReturn of the state transition.</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3024">a #GstElement</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="transition" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3025">the requested transition</doc>
- <type name="StateChange" c:type="GstStateChange"/>
- </parameter>
- </parameters>
- </method>
- <method name="continue_state" c:identifier="gst_element_continue_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2683">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.
-
-This function must be called with STATE_LOCK held.</doc>
- <source-position filename="gst/gstelement.h" line="1019"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2702">The result of the commit state change.
-
-MT safe.</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2685">a #GstElement to continue the state change of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="ret" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2686">The previous state return value</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </parameter>
- </parameters>
- </method>
- <method name="create_all_pads"
- c:identifier="gst_element_create_all_pads">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="881">Creates a pad for each pad template that is always available.
-This function is only useful during object initialization of
-subclasses of #GstElement.</doc>
- <source-position filename="gst/gstutils.h" line="984"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="883">a #GstElement to create pads for</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="foreach_pad"
- c:identifier="gst_element_foreach_pad"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1429">Call @func with @user_data for each of @element's pads. @func will be called
-exactly once for each pad that exists at the time of this call, unless
-one of the calls to @func returns %FALSE in which case we will stop
-iterating pads and return early. If new pads are added or pads are removed
-while pads are being iterated, this will not be taken into account until
-next time this function is used.</doc>
- <source-position filename="gst/gstelement.h" line="949"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1442">%FALSE if @element had no pads or if one of the calls to @func
- returned %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1431">a #GstElement to iterate pads of</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1432">function to call for each pad</doc>
- <type name="ElementForeachPadFunc"
- c:type="GstElementForeachPadFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1433">user data passed to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="foreach_sink_pad"
- c:identifier="gst_element_foreach_sink_pad"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1377">Call @func with @user_data for each of @element's sink pads. @func will be
-called exactly once for each sink pad that exists at the time of this call,
-unless one of the calls to @func returns %FALSE in which case we will stop
-iterating pads and return early. If new sink pads are added or sink pads
-are removed while the sink pads are being iterated, this will not be taken
-into account until next time this function is used.</doc>
- <source-position filename="gst/gstelement.h" line="941"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1390">%FALSE if @element had no sink pads or if one of the calls to @func
- returned %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1379">a #GstElement to iterate sink pads of</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1380">function to call for each sink pad</doc>
- <type name="ElementForeachPadFunc"
- c:type="GstElementForeachPadFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1381">user data passed to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="foreach_src_pad"
- c:identifier="gst_element_foreach_src_pad"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1403">Call @func with @user_data for each of @element's source pads. @func will be
-called exactly once for each source pad that exists at the time of this call,
-unless one of the calls to @func returns %FALSE in which case we will stop
-iterating pads and return early. If new source pads are added or source pads
-are removed while the source pads are being iterated, this will not be taken
-into account until next time this function is used.</doc>
- <source-position filename="gst/gstelement.h" line="945"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1416">%FALSE if @element had no source pads or if one of the calls
- to @func returned %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1405">a #GstElement to iterate source pads of</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1406">function to call for each source pad</doc>
- <type name="ElementForeachPadFunc"
- c:type="GstElementForeachPadFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1407">user data passed to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_base_time" c:identifier="gst_element_get_base_time">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="502">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.</doc>
- <source-position filename="gst/gstelement.h" line="855"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="511">the base time of the element.
-
-MT safe.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="504">a #GstElement.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_bus" c:identifier="gst_element_get_bus">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3471">Returns the bus of the element. Note that only a #GstPipeline will provide a
-bus for the application.</doc>
- <source-position filename="gst/gstelement.h" line="875"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3478">the element's #GstBus. unref after
-usage.
-
-MT safe.</doc>
- <type name="Bus" c:type="GstBus*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3473">a #GstElement to get the bus of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_clock" c:identifier="gst_element_get_clock">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="447">Gets the currently configured clock of the element. This is the clock as was
-last set with gst_element_set_clock().
-
-Elements in a pipeline will only have their clock set when the
-pipeline is in the PLAYING state.</doc>
- <source-position filename="gst/gstelement.h" line="846"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="457">the #GstClock of the element. unref after usage.
-
-MT safe.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="449">a #GstElement to get the clock of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_compatible_pad"
- c:identifier="gst_element_get_compatible_pad">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1116">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.
-
-This function will first attempt to find a compatible unlinked ALWAYS pad,
-and if none can be found, it will request a compatible REQUEST pad by looking
-at the templates of @element.</doc>
- <source-position filename="gst/gstutils.h" line="987"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1130">the #GstPad to which a link
- can be made, or %NULL if one cannot be found. gst_object_unref()
- after usage.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1118">a #GstElement in which the pad should be found.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1119">the #GstPad to find a compatible one for.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1120">the #GstCaps to use as a filter.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_compatible_pad_template"
- c:identifier="gst_element_get_compatible_pad_template">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="914">Retrieves a pad template from @element that is compatible with @compattempl.
-Pads from compatible templates can be linked together.</doc>
- <source-position filename="gst/gstutils.h" line="990"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="923">a compatible #GstPadTemplate,
- or %NULL if none was found. No unreferencing is necessary.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="916">a #GstElement to get a compatible pad template for</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="compattempl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="917">the #GstPadTemplate to find a compatible
- template for</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_context"
- c:identifier="gst_element_get_context"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3625">Gets the context with @context_type set on the element or NULL.
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="886"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3634">A #GstContext or NULL</doc>
- <type name="Context" c:type="GstContext*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3627">a #GstElement to get the context of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="context_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3628">a name of a context to retrieve</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_context_unlocked"
- c:identifier="gst_element_get_context_unlocked"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3596">Gets the context with @context_type set on the element or NULL.</doc>
- <source-position filename="gst/gstelement.h" line="889"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3603">A #GstContext or NULL</doc>
- <type name="Context" c:type="GstContext*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3598">a #GstElement to get the context of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="context_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3599">a name of a context to retrieve</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_contexts"
- c:identifier="gst_element_get_contexts"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3560">Gets the contexts set on the element.
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="883"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3568">List of #GstContext</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Context"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3562">a #GstElement to set the context of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_current_clock_time"
- c:identifier="gst_element_get_current_clock_time"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="633">Returns the current clock time of the element, as in, the time of the
-element's clock, or GST_CLOCK_TIME_NONE if there is no clock.</doc>
- <source-position filename="gst/gstelement.h" line="867"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="640">the clock time of the element, or GST_CLOCK_TIME_NONE if there is
-no clock.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="635">a #GstElement.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_current_running_time"
- c:identifier="gst_element_get_current_running_time"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="592">Returns the running time of the element. The running time is the
-element's clock time minus its base time. Will return GST_CLOCK_TIME_NONE
-if the element has no clock, or if its base time has not been set.</doc>
- <source-position filename="gst/gstelement.h" line="864"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="600">the running time of the element, or GST_CLOCK_TIME_NONE if the
-element has no clock or its base time has not been set.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="594">a #GstElement.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_factory" c:identifier="gst_element_get_factory">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3317">Retrieves the factory that was used to create this element.</doc>
- <source-position filename="gst/gstelement.h" line="1042"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3323">the #GstElementFactory used for creating this
- element or %NULL if element has not been registered (static element). no refcounting is needed.</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3319">a #GstElement to request the element factory of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_metadata"
- c:identifier="gst_element_get_metadata"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1691">Get metadata with @key in @klass.</doc>
- <source-position filename="gst/gstelement.h" line="1064"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1698">the metadata for @key.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1693">class to get metadata for</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1694">the key to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pad_template"
- c:identifier="gst_element_get_pad_template"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1790">Retrieves a padtemplate from @element with the given name.</doc>
- <source-position filename="gst/gstelement.h" line="1059"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1797">the #GstPadTemplate with the
- given name, or %NULL if none was found. No unreferencing is
- necessary.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1792">a #GstElement to get the pad template of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1793">the name of the #GstPadTemplate to get.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pad_template_list"
- c:identifier="gst_element_get_pad_template_list"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1732">Retrieves a list of the pad templates associated with @element. The
-list must not be modified by the calling code.</doc>
- <source-position filename="gst/gstelement.h" line="1062"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1739">the #GList of
- pad templates.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="PadTemplate"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1734">a #GstElement to get pad templates of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_request_pad"
- c:identifier="gst_element_get_request_pad">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1170">Retrieves a pad from the element by name (e.g. "src_\%d"). This version only
-retrieves request pads. The pad should be released with
-gst_element_release_request_pad().
-
-This method is slower than manually getting the pad template and calling
-gst_element_request_pad() if the pads should have a specific name (e.g.
-@name is "src_1" instead of "src_\%u").</doc>
- <source-position filename="gst/gstelement.h" line="906"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1183">requested #GstPad if found,
- otherwise %NULL. Release after usage.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1172">a #GstElement to find a request pad of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1173">the name of the request #GstPad to retrieve.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_start_time" c:identifier="gst_element_get_start_time">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="564">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.</doc>
- <source-position filename="gst/gstelement.h" line="861"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="576">the start time of the element.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="566">a #GstElement.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_state" c:identifier="gst_element_get_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2553">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.</doc>
- <source-position filename="gst/gstelement.h" line="1004"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2584">%GST_STATE_CHANGE_SUCCESS if the element has no more pending state
- 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.
-
-MT safe.</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2555">a #GstElement to get the state of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="state"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2556">a pointer to #GstState to hold the state.
- Can be %NULL.</doc>
- <type name="State" c:type="GstState*"/>
- </parameter>
- <parameter name="pending"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2558">a pointer to #GstState to hold the pending
- state. Can be %NULL.</doc>
- <type name="State" c:type="GstState*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2560">a #GstClockTime to specify the timeout for an async
- state change or %GST_CLOCK_TIME_NONE for infinite timeout.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_static_pad" c:identifier="gst_element_get_static_pad">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="975">Retrieves a pad from @element by name. This version only retrieves
-already-existing (i.e. 'static') pads.</doc>
- <source-position filename="gst/gstelement.h" line="903"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="983">the requested #GstPad if
- found, otherwise %NULL. unref after usage.
-
-MT safe.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="977">a #GstElement to find a static pad of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="978">the name of the static #GstPad to retrieve.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_locked_state"
- c:identifier="gst_element_is_locked_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2302">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.</doc>
- <source-position filename="gst/gstelement.h" line="995"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2314">%TRUE, if the element's state is locked.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2304">a #GstElement.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="iterate_pads" c:identifier="gst_element_iterate_pads">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1275">Retrieves an iterator of @element's pads. The iterator should
-be freed after usage. Also more specialized iterators exists such as
-gst_element_iterate_src_pads() or gst_element_iterate_sink_pads().
-
-The order of pads returned by the iterator will be the order in which
-the pads were added to the element.</doc>
- <source-position filename="gst/gstelement.h" line="915"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1286">the #GstIterator of #GstPad.
-
-MT safe.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1277">a #GstElement to iterate pads of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="iterate_sink_pads"
- c:identifier="gst_element_iterate_sink_pads">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1319">Retrieves an iterator of @element's sink pads.
-
-The order of pads returned by the iterator will be the order in which
-the pads were added to the element.</doc>
- <source-position filename="gst/gstelement.h" line="921"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1328">the #GstIterator of #GstPad.
-
-MT safe.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1321">a #GstElement.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="iterate_src_pads"
- c:identifier="gst_element_iterate_src_pads">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1298">Retrieves an iterator of @element's source pads.
-
-The order of pads returned by the iterator will be the order in which
-the pads were added to the element.</doc>
- <source-position filename="gst/gstelement.h" line="918"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1307">the #GstIterator of #GstPad.
-
-MT safe.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1300">a #GstElement.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="link" c:identifier="gst_element_link">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2213">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 manually 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.</doc>
- <source-position filename="gst/gstutils.h" line="1002"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2227">%TRUE if the elements could be linked, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2215">a #GstElement containing the source pad.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2216">the #GstElement containing the destination pad.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="link_filtered" c:identifier="gst_element_link_filtered">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2273">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.</doc>
- <source-position filename="gst/gstutils.h" line="1008"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2289">%TRUE if the pads could be linked, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2275">a #GstElement containing the source pad.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2276">the #GstElement containing the destination pad.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="filter"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2277">the #GstCaps to filter the link,
- or %NULL for no filter.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="link_many"
- c:identifier="gst_element_link_many"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2235">Chain together a series of elements. Uses gst_element_link().
-Make sure you have added your elements to a bin or pipeline with
-gst_bin_add() before trying to link them.</doc>
- <source-position filename="gst/gstutils.h" line="1005"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2245">%TRUE on success, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element_1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2237">the first #GstElement in the link chain.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="element_2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2238">the second #GstElement in the link chain.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2239">the %NULL-terminated list of elements to link in order.</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="link_pads" c:identifier="gst_element_link_pads">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2102">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.</doc>
- <source-position filename="gst/gstutils.h" line="1018"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2116">%TRUE if the pads could be linked, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2104">a #GstElement containing the source pad.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="srcpadname"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2105">the name of the #GstPad in source element
- or %NULL for any pad.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2107">the #GstElement containing the destination pad.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="destpadname"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2108">the name of the #GstPad in destination element,
-or %NULL for any pad.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="link_pads_filtered"
- c:identifier="gst_element_link_pads_filtered">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2126">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.</doc>
- <source-position filename="gst/gstutils.h" line="1028"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2142">%TRUE if the pads could be linked, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2128">a #GstElement containing the source pad.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="srcpadname"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2129">the name of the #GstPad in source element
- or %NULL for any pad.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2131">the #GstElement containing the destination pad.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="destpadname"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2132">the name of the #GstPad in destination element
- or %NULL for any pad.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="filter"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2134">the #GstCaps to filter the link,
- or %NULL for no filter.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="link_pads_full" c:identifier="gst_element_link_pads_full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1779">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.
-
-Calling gst_element_link_pads_full() with @flags == %GST_PAD_LINK_CHECK_DEFAULT
-is the same as calling gst_element_link_pads() and the recommended way of
-linking pads with safety checks applied.
-
-This is a convenience function for gst_pad_link_full().</doc>
- <source-position filename="gst/gstutils.h" line="1021"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1800">%TRUE if the pads could be linked, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1781">a #GstElement containing the source pad.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="srcpadname"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1782">the name of the #GstPad in source element
- or %NULL for any pad.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1784">the #GstElement containing the destination pad.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="destpadname"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1785">the name of the #GstPad in destination element,
-or %NULL for any pad.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1787">the #GstPadLinkCheck to be performed when linking pads.</doc>
- <type name="PadLinkCheck" c:type="GstPadLinkCheck"/>
- </parameter>
- </parameters>
- </method>
- <method name="lost_state" c:identifier="gst_element_lost_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2789">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. 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.</doc>
- <source-position filename="gst/gstelement.h" line="1022"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2791">a #GstElement the state is lost of</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="message_full" c:identifier="gst_element_message_full">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2270">Post an error, warning or info message on the bus from inside an element.
-
-@type must be of #GST_MESSAGE_ERROR, #GST_MESSAGE_WARNING or
-#GST_MESSAGE_INFO.
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="981"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2272">a #GstElement to send message from</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2273">the #GstMessageType</doc>
- <type name="MessageType" c:type="GstMessageType"/>
- </parameter>
- <parameter name="domain" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2274">the GStreamer GError domain this message belongs to</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="code" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2275">the GError code belonging to the domain</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="text"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2276">an allocated text string to be used
- as a replacement for the default message connected to code,
- or %NULL</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- <parameter name="debug"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2279">an allocated debug message to be
- used as a replacement for the default debugging information,
- or %NULL</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- <parameter name="file" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2282">the source code file where the error was generated</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="function" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2283">the source code function where the error was generated</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="line" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2284">the source code line where the error was generated</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="message_full_with_details"
- c:identifier="gst_element_message_full_with_details"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2166">Post an error, warning or info message on the bus from inside an element.
-
-@type must be of #GST_MESSAGE_ERROR, #GST_MESSAGE_WARNING or
-#GST_MESSAGE_INFO.</doc>
- <source-position filename="gst/gstelement.h" line="986"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2168">a #GstElement to send message from</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2169">the #GstMessageType</doc>
- <type name="MessageType" c:type="GstMessageType"/>
- </parameter>
- <parameter name="domain" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2170">the GStreamer GError domain this message belongs to</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="code" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2171">the GError code belonging to the domain</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="text"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2172">an allocated text string to be used
- as a replacement for the default message connected to code,
- or %NULL</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- <parameter name="debug"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2175">an allocated debug message to be
- used as a replacement for the default debugging information,
- or %NULL</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- <parameter name="file" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2178">the source code file where the error was generated</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="function" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2179">the source code function where the error was generated</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="line" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2180">the source code line where the error was generated</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="structure" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2181">optional details structure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="no_more_pads" c:identifier="gst_element_no_more_pads">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="941">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.</doc>
- <source-position filename="gst/gstelement.h" line="900"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="943">a #GstElement</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="post_message" c:identifier="gst_element_post_message">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2096">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.</doc>
- <source-position filename="gst/gstelement.h" line="968"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2105">%TRUE if the message was successfully posted. The function returns
-%FALSE if the element did not have a bus.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2098">a #GstElement posting the message</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2099">a #GstMessage to post</doc>
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </method>
- <method name="provide_clock" c:identifier="gst_element_provide_clock">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="371">Get the clock provided by the given element.
-&gt; An element is only required to provide a clock in the PAUSED
-&gt; state. Some elements can provide a clock in other states.</doc>
- <source-position filename="gst/gstelement.h" line="843"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="379">the GstClock provided by the
-element or %NULL if no clock could be provided. Unref after usage.
-
-MT safe.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="373">a #GstElement to query</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="query" c:identifier="gst_element_query">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2021">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.
-
-Please note that some queries might need a running pipeline to work.</doc>
- <source-position filename="gst/gstelement.h" line="963"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2034">%TRUE if the query could be performed.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2023">a #GstElement to perform the query on.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2024">the #GstQuery.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </method>
- <method name="query_convert" c:identifier="gst_element_query_convert">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2534">Queries an element to convert @src_val in @src_format to @dest_format.</doc>
- <source-position filename="gst/gstutils.h" line="1060"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2544">%TRUE if the query could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2536">a #GstElement to invoke the convert query on.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="src_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2537">a #GstFormat to convert from.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="src_val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2538">a value to convert.</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="dest_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2539">the #GstFormat to convert to.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="dest_val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2540">a pointer to the result.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="query_duration" c:identifier="gst_element_query_duration">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2493">Queries an element (usually top-level pipeline or playbin element) for the
-total stream duration in nanoseconds. This query will only work once the
-pipeline is prerolled (i.e. reached PAUSED or PLAYING state). The application
-will receive an ASYNC_DONE message on the pipeline bus when that is the case.
-
-If the duration changes for some reason, you will get a DURATION_CHANGED
-message on the pipeline bus, in which case you should re-query the duration
-using this function.</doc>
- <source-position filename="gst/gstutils.h" line="1057"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2508">%TRUE if the query could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2495">a #GstElement to invoke the duration query on.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2496">the #GstFormat requested</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="duration"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2497">A location in which to store the total duration, or %NULL.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="query_position" c:identifier="gst_element_query_position">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2450">Queries an element (usually top-level pipeline or playbin element) for the
-stream position in nanoseconds. This will be a value between 0 and the
-stream duration (if the stream duration is known). This query will usually
-only work once the pipeline is prerolled (i.e. reached PAUSED or PLAYING
-state). The application will receive an ASYNC_DONE message on the pipeline
-bus when that is the case.
-
-If one repeatedly calls this function one can also create a query and reuse
-it in gst_element_query().</doc>
- <source-position filename="gst/gstutils.h" line="1054"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2467">%TRUE if the query could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2452">a #GstElement to invoke the position query on.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2453">the #GstFormat requested</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="cur"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2454">a location in which to store the current
- position, or %NULL.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="release_request_pad"
- c:identifier="gst_element_release_request_pad">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="335">Makes the element free the previously requested pad as obtained
-with gst_element_request_pad().
-
-This does not unref the pad. If the pad was created by using
-gst_element_request_pad(), gst_element_release_request_pad() needs to be
-followed by gst_object_unref() to free the @pad.
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="912"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="337">a #GstElement to release the request pad of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="338">the #GstPad to release.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_pad" c:identifier="gst_element_remove_pad">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="831">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_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.</doc>
- <source-position filename="gst/gstelement.h" line="897"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="853">%TRUE if the pad could be removed. Can return %FALSE if the
-pad does not belong to the provided element.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="833">a #GstElement to remove pad from.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="834">the #GstPad to remove from the element.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_property_notify_watch"
- c:identifier="gst_element_remove_property_notify_watch"
- version="1.10">
- <source-position filename="gst/gstelement.h" line="1055"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3760">a #GstElement being watched for property changes</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="watch_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3761">watch id to remove</doc>
- <type name="gulong" c:type="gulong"/>
- </parameter>
- </parameters>
- </method>
- <method name="request_pad" c:identifier="gst_element_request_pad">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1232">Retrieves a request pad from the element according to the provided template.
-Pad templates can be looked up using
-gst_element_factory_get_static_pad_templates().
-
-The pad should be released with gst_element_release_request_pad().</doc>
- <source-position filename="gst/gstelement.h" line="909"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1247">requested #GstPad if found,
- otherwise %NULL. Release after usage.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1234">a #GstElement to find a request pad of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1235">a #GstPadTemplate of which we want a pad of.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </parameter>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1236">the name of the request #GstPad
-to retrieve. Can be %NULL.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1238">the caps of the pad we want to
-request. Can be %NULL.</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="seek" c:identifier="gst_element_seek">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1956">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.</doc>
- <source-position filename="gst/gstelement.h" line="958"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1973">%TRUE if the event was handled. Flushing seeks will trigger a
-preroll, which will emit %GST_MESSAGE_ASYNC_DONE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1958">a #GstElement to send the event to.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1959">The new playback rate</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1960">The format of the seek values</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1961">The optional seek flags.</doc>
- <type name="SeekFlags" c:type="GstSeekFlags"/>
- </parameter>
- <parameter name="start_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1962">The type and flags for the new start position</doc>
- <type name="SeekType" c:type="GstSeekType"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1963">The value of the new start position</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="stop_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1964">The type and flags for the new stop position</doc>
- <type name="SeekType" c:type="GstSeekType"/>
- </parameter>
- <parameter name="stop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1965">The value of the new stop position</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="seek_simple" c:identifier="gst_element_seek_simple">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2573">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. For more complex
-operations like segment seeks (e.g. for looping) or changing the playback
-rate or seeking relative to the last configured playback segment you should
-use gst_element_seek().
-
-In a completely prerolled PAUSED or PLAYING pipeline, seeking is always
-guaranteed to return %TRUE on a seekable media type or %FALSE when the media
-type is certainly not seekable (such as a live stream).
-
-Some elements allow for seeking in the READY state, in this
-case they will store the seek event and execute it when they are put to
-PAUSED. If the element supports seek in READY, it will always return %TRUE when
-it receives the event in the READY state.</doc>
- <source-position filename="gst/gstutils.h" line="1032"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2599">%TRUE if the seek operation succeeded. Flushing seeks will trigger a
-preroll, which will emit %GST_MESSAGE_ASYNC_DONE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2575">a #GstElement to seek on</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2576">a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="seek_flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2577">seek options; playback applications will usually want to use
- GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_KEY_UNIT here</doc>
- <type name="SeekFlags" c:type="GstSeekFlags"/>
- </parameter>
- <parameter name="seek_pos" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2579">position to seek to (relative to the start); if you are doing
- a seek in #GST_FORMAT_TIME this value is in nanoseconds -
- multiply with #GST_SECOND to convert seconds to nanoseconds or
- with #GST_MSECOND to convert milliseconds to nanoseconds.</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="send_event" c:identifier="gst_element_send_event">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1915">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
-downstream events or a random linked source pad for upstream events.
-
-This function takes ownership of the provided event so you should
-gst_event_ref() it if you want to reuse the event after this call.
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="955"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1929">%TRUE if the event was handled. Events that trigger a preroll (such
-as flushing seeks and steps) will emit %GST_MESSAGE_ASYNC_DONE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1917">a #GstElement to send the event to.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1918">the #GstEvent to send to the element.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_base_time" c:identifier="gst_element_set_base_time">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="476">Set the base time of an element. See gst_element_get_base_time().
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="852"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="478">a #GstElement.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="479">the base time to set.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_bus" c:identifier="gst_element_set_bus">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3448">Sets the bus of the element. Increases the refcount on the bus.
-For internal use only, unless you're testing elements.
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="872"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3450">a #GstElement to set the bus of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="bus"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3451">the #GstBus to set.</doc>
- <type name="Bus" c:type="GstBus*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_clock" c:identifier="gst_element_set_clock">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="413">Sets the clock for the element. This function increases the
-refcount on the clock. Any previously set clock on the object
-is unreffed.</doc>
- <source-position filename="gst/gstelement.h" line="849"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="422">%TRUE if the element accepted the clock. An element can refuse a
-clock when it, for example, is not able to slave its internal clock to the
-@clock or when it requires a specific clock to operate.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="415">a #GstElement to set the clock for.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="clock"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="416">the #GstClock to set for the element.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_context" c:identifier="gst_element_set_context">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3533">Sets the context of the element. Increases the refcount of the context.
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="880"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3535">a #GstElement to set the context of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="context" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3536">the #GstContext to set.</doc>
- <type name="Context" c:type="GstContext*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_locked_state"
- c:identifier="gst_element_set_locked_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2330">Locks the state of an element, so state changes of the parent don't affect
-this element anymore.
-
-Note that this is racy if the state lock of the parent bin is not taken.
-The parent bin might've just checked the flag in another thread and as the
-next step proceed to change the child element's state.
-
-MT safe.</doc>
- <source-position filename="gst/gstelement.h" line="998"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2344">%TRUE if the state was changed, %FALSE if bad parameters were given
-or the elements state-locking needed no change.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2332">a #GstElement</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="locked_state" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2333">%TRUE to lock the element's state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_start_time" c:identifier="gst_element_set_start_time">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="529">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.</doc>
- <source-position filename="gst/gstelement.h" line="858"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="531">a #GstElement.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="532">the base time to set.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_state" c:identifier="gst_element_set_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2867">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 %GST_MESSAGE_ASYNC_DONE or
-%GST_MESSAGE_STATE_CHANGED on the bus.
-
-State changes to %GST_STATE_READY or %GST_STATE_NULL never return
-#GST_STATE_CHANGE_ASYNC.</doc>
- <source-position filename="gst/gstelement.h" line="1009"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2886">Result of the state change using #GstStateChangeReturn.
-
-MT safe.</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2869">a #GstElement to change state of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="state" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2870">the element's new #GstState.</doc>
- <type name="State" c:type="GstState"/>
- </parameter>
- </parameters>
- </method>
- <method name="sync_state_with_parent"
- c:identifier="gst_element_sync_state_with_parent">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2384">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.</doc>
- <source-position filename="gst/gstelement.h" line="1001"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2391">%TRUE, if the element's state could be synced to the parent's state.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2386">a #GstElement.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unlink" c:identifier="gst_element_unlink">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2383">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().</doc>
- <source-position filename="gst/gstutils.h" line="1012"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2385">the source #GstElement to unlink.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2386">the sink #GstElement to unlink.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </method>
- <method name="unlink_many"
- c:identifier="gst_element_unlink_many"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2355">Unlinks a series of elements. Uses gst_element_unlink().</doc>
- <source-position filename="gst/gstutils.h" line="1015"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="element_1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2357">the first #GstElement in the link chain.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="element_2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2358">the second #GstElement in the link chain.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2359">the %NULL-terminated list of elements to unlink in order.</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="unlink_pads" c:identifier="gst_element_unlink_pads">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2298">Unlinks the two named pads of the source and destination elements.
-
-This is a convenience function for gst_pad_unlink().</doc>
- <source-position filename="gst/gstutils.h" line="1025"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2300">a (transfer none): #GstElement containing the source pad.</doc>
- <type name="Element" c:type="GstElement*"/>
- </instance-parameter>
- <parameter name="srcpadname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2301">the name of the #GstPad in source element.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2302">a #GstElement containing the destination pad.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="destpadname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2303">the name of the #GstPad in destination element.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <field name="object">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="state_lock">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="590">Used to serialize execution of gst_element_set_state()</doc>
- <type name="GLib.RecMutex" c:type="GRecMutex"/>
- </field>
- <field name="state_cond">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="591">Used to signal completion of a state change</doc>
- <type name="GLib.Cond" c:type="GCond"/>
- </field>
- <field name="state_cookie">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="592">Used to detect concurrent execution of
-gst_element_set_state() and gst_element_get_state()</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="target_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="594">the target state of an element as set by the application</doc>
- <type name="State" c:type="GstState"/>
- </field>
- <field name="current_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="595">the current state of an element</doc>
- <type name="State" c:type="GstState"/>
- </field>
- <field name="next_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="596">the next state of an element, can be #GST_STATE_VOID_PENDING if
-the element is in the correct state.</doc>
- <type name="State" c:type="GstState"/>
- </field>
- <field name="pending_state">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="598">the final state the element should go to, can be
-#GST_STATE_VOID_PENDING if the element is in the correct state</doc>
- <type name="State" c:type="GstState"/>
- </field>
- <field name="last_return">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="600">the last return value of an element state change</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </field>
- <field name="bus">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="601">the bus of the element. This bus is provided to the element by the
-parent element or the application. A #GstPipeline has a bus of its own.</doc>
- <type name="Bus" c:type="GstBus*"/>
- </field>
- <field name="clock">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="603">the clock of the element. This clock is usually provided to the
-element by the toplevel #GstPipeline.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </field>
- <field name="base_time">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="605">the time of the clock right before the element is set to
-PLAYING. Subtracting @base_time from the current clock time in the PLAYING
-state will yield the running_time against the clock.</doc>
- <type name="ClockTimeDiff" c:type="GstClockTimeDiff"/>
- </field>
- <field name="start_time">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="608">the running_time of the last PAUSED state</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="numpads">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="609">number of pads of the element, includes both source and sink pads.</doc>
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="pads">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="610">list of pads</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Pad"/>
- </type>
- </field>
- <field name="numsrcpads">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="611">number of source pads of the element.</doc>
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="srcpads">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="612">list of source pads</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Pad"/>
- </type>
- </field>
- <field name="numsinkpads">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="613">number of sink pads of the element.</doc>
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="sinkpads">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="614">list of sink pads</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Pad"/>
- </type>
- </field>
- <field name="pads_cookie">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="615">updated whenever the a pad is added or removed</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="contexts">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="616">list of contexts</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Context"/>
- </type>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="no-more-pads" when="last">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="252">This signals that the element will not generate more dynamic pads.
-Note that this signal will usually be emitted from the context of
-the streaming thread.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="pad-added" when="last">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="226">a new #GstPad has been added to the element. Note that this signal will
-usually be emitted from the context of the streaming thread. Also keep in
-mind that if you add new elements to the pipeline in the signal handler
-you will need to set them to the desired target state with
-gst_element_set_state() or gst_element_sync_state_with_parent().</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="new_pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="229">the pad that has been added</doc>
- <type name="Pad"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="pad-removed" when="last">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="241">a #GstPad has been removed from the element</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="old_pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="244">the pad that has been removed</doc>
- <type name="Pad"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <callback name="ElementCallAsyncFunc" c:type="GstElementCallAsyncFunc">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="1025">Callback prototype used in #gst_element_call_async</doc>
- <source-position filename="gst/gstelement.h" line="1032"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="1027">The #GstElement this function has been called against</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="1028">Data passed in the function where that callback has been passed</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="ElementClass"
- c:type="GstElementClass"
- glib:is-gtype-struct-for="Element">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="660">GStreamer element class. Override the vmethods to implement the element
-functionality.</doc>
- <source-position filename="gst/gstelement.h" line="744"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="662">the parent class structure</doc>
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="metadata">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="663">metadata for elements of this class</doc>
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="elementfactory">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="664">the #GstElementFactory that creates these elements</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </field>
- <field name="padtemplates">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="665">a #GList of #GstPadTemplate</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </field>
- <field name="numpadtemplates">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="666">the number of padtemplates</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="pad_templ_cookie">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="667">changed whenever the padtemplates change</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="pad_added">
- <callback name="pad_added">
- <source-position filename="gst/gstelement.h" line="704"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="pad_removed">
- <callback name="pad_removed">
- <source-position filename="gst/gstelement.h" line="705"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="no_more_pads">
- <callback name="no_more_pads">
- <source-position filename="gst/gstelement.h" line="706"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="943">a #GstElement</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="request_new_pad">
- <callback name="request_new_pad">
- <source-position filename="gst/gstelement.h" line="713"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1247">requested #GstPad if found,
- otherwise %NULL. Release after usage.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1234">a #GstElement to find a request pad of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1235">a #GstPadTemplate of which we want a pad of.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </parameter>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1236">the name of the request #GstPad
-to retrieve. Can be %NULL.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1238">the caps of the pad we want to
-request. Can be %NULL.</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="release_pad">
- <callback name="release_pad">
- <source-position filename="gst/gstelement.h" line="716"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_state">
- <callback name="get_state">
- <source-position filename="gst/gstelement.h" line="719"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2584">%GST_STATE_CHANGE_SUCCESS if the element has no more pending state
- 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.
-
-MT safe.</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2555">a #GstElement to get the state of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="state"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2556">a pointer to #GstState to hold the state.
- Can be %NULL.</doc>
- <type name="State" c:type="GstState*"/>
- </parameter>
- <parameter name="pending"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2558">a pointer to #GstState to hold the pending
- state. Can be %NULL.</doc>
- <type name="State" c:type="GstState*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2560">a #GstClockTime to specify the timeout for an async
- state change or %GST_CLOCK_TIME_NONE for infinite timeout.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_state">
- <callback name="set_state">
- <source-position filename="gst/gstelement.h" line="721"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2886">Result of the state change using #GstStateChangeReturn.
-
-MT safe.</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2869">a #GstElement to change state of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="state" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2870">the element's new #GstState.</doc>
- <type name="State" c:type="GstState"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="change_state">
- <callback name="change_state">
- <source-position filename="gst/gstelement.h" line="722"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3032">the #GstStateChangeReturn of the state transition.</doc>
- <type name="StateChangeReturn" c:type="GstStateChangeReturn"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3024">a #GstElement</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="transition" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3025">the requested transition</doc>
- <type name="StateChange" c:type="GstStateChange"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="state_changed">
- <callback name="state_changed">
- <source-position filename="gst/gstelement.h" line="723"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="oldstate" transfer-ownership="none">
- <type name="State" c:type="GstState"/>
- </parameter>
- <parameter name="newstate" transfer-ownership="none">
- <type name="State" c:type="GstState"/>
- </parameter>
- <parameter name="pending" transfer-ownership="none">
- <type name="State" c:type="GstState"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_bus">
- <callback name="set_bus">
- <source-position filename="gst/gstelement.h" line="727"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3450">a #GstElement to set the bus of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="bus"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3451">the #GstBus to set.</doc>
- <type name="Bus" c:type="GstBus*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="provide_clock">
- <callback name="provide_clock">
- <source-position filename="gst/gstelement.h" line="730"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="379">the GstClock provided by the
-element or %NULL if no clock could be provided. Unref after usage.
-
-MT safe.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="373">a #GstElement to query</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_clock">
- <callback name="set_clock">
- <source-position filename="gst/gstelement.h" line="731"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="422">%TRUE if the element accepted the clock. An element can refuse a
-clock when it, for example, is not able to slave its internal clock to the
-@clock or when it requires a specific clock to operate.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="415">a #GstElement to set the clock for.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="clock"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="416">the #GstClock to set for the element.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="send_event">
- <callback name="send_event">
- <source-position filename="gst/gstelement.h" line="734"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1929">%TRUE if the event was handled. Events that trigger a preroll (such
-as flushing seeks and steps) will emit %GST_MESSAGE_ASYNC_DONE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1917">a #GstElement to send the event to.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="event" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1918">the #GstEvent to send to the element.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="query">
- <callback name="query">
- <source-position filename="gst/gstelement.h" line="736"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2034">%TRUE if the query could be performed.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2023">a #GstElement to perform the query on.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2024">the #GstQuery.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="post_message">
- <callback name="post_message">
- <source-position filename="gst/gstelement.h" line="738"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2105">%TRUE if the message was successfully posted. The function returns
-%FALSE if the element did not have a bus.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2098">a #GstElement posting the message</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="message" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="2099">a #GstMessage to post</doc>
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_context">
- <callback name="set_context">
- <source-position filename="gst/gstelement.h" line="740"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3535">a #GstElement to set the context of.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="context" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3536">the #GstContext to set.</doc>
- <type name="Context" c:type="GstContext*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="18">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="add_metadata"
- c:identifier="gst_element_class_add_metadata">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1541">Set @key with @value as metadata in @klass.</doc>
- <source-position filename="gst/gstelement.h" line="780"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1543">class to set metadata for</doc>
- <type name="ElementClass" c:type="GstElementClass*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1544">the key to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1545">the value to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_pad_template"
- c:identifier="gst_element_class_add_pad_template">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1455">Adds a padtemplate to an element class. This is mainly used in the _class_init
-functions of classes. If a pad template with the same name as an already
-existing one is added the old one is replaced by the new one.
-
-@templ's reference count will be incremented, and any floating
-reference will be removed (see gst_object_ref_sink())</doc>
- <source-position filename="gst/gstelement.h" line="749"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1457">the #GstElementClass to add the pad template to.</doc>
- <type name="ElementClass" c:type="GstElementClass*"/>
- </instance-parameter>
- <parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1458">a #GstPadTemplate to add to the element class.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_static_metadata"
- c:identifier="gst_element_class_add_static_metadata">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1561">Set @key with @value as metadata in @klass.
-
-Same as gst_element_class_add_metadata(), but @value must be a static string
-or an inlined string, as it will not be copied. (GStreamer plugins will
-be made resident once loaded, so this function can be used even from
-dynamically loaded plugins.)</doc>
- <source-position filename="gst/gstelement.h" line="783"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1563">class to set metadata for</doc>
- <type name="ElementClass" c:type="GstElementClass*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1564">the key to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1565">the value to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_static_pad_template"
- c:identifier="gst_element_class_add_static_pad_template"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1499">Adds a pad template to an element class based on the static pad template
-@templ. This is mainly used in the _class_init functions of element
-implementations. If a pad template with the same name already exists,
-the old one is replaced by the new one.</doc>
- <source-position filename="gst/gstelement.h" line="752"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1501">the #GstElementClass to add the pad template to.</doc>
- <type name="ElementClass" c:type="GstElementClass*"/>
- </instance-parameter>
- <parameter name="static_templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1502">#GstStaticPadTemplate to add as pad template to the element class.</doc>
- <type name="StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_static_pad_template_with_gtype"
- c:identifier="gst_element_class_add_static_pad_template_with_gtype"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1519">Adds a pad template to an element class based on the static pad template
-@templ. This is mainly used in the _class_init functions of element
-implementations. If a pad template with the same name already exists,
-the old one is replaced by the new one.</doc>
- <source-position filename="gst/gstelement.h" line="755"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1521">the #GstElementClass to add the pad template to.</doc>
- <type name="ElementClass" c:type="GstElementClass*"/>
- </instance-parameter>
- <parameter name="static_templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1522">#GstStaticPadTemplate to add as pad template to the element class.</doc>
- <type name="StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
- </parameter>
- <parameter name="pad_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1523">The #GType of the pad to create</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_metadata"
- c:identifier="gst_element_class_get_metadata">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1673">Get metadata with @key in @klass.</doc>
- <source-position filename="gst/gstelement.h" line="786"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1680">the metadata for @key.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1675">class to get metadata for</doc>
- <type name="ElementClass" c:type="GstElementClass*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1676">the key to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pad_template"
- c:identifier="gst_element_class_get_pad_template">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1753">Retrieves a padtemplate from @element_class with the given name.
-&gt; If you use this function in the #GInstanceInitFunc of an object class
-&gt; that has subclasses, make sure to pass the g_class parameter of the
-&gt; #GInstanceInitFunc here.</doc>
- <source-position filename="gst/gstelement.h" line="760"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1763">the #GstPadTemplate with the
- given name, or %NULL if none was found. No unreferencing is
- necessary.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </return-value>
- <parameters>
- <instance-parameter name="element_class" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1755">a #GstElementClass to get the pad template of.</doc>
- <type name="ElementClass" c:type="GstElementClass*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1756">the name of the #GstPadTemplate to get.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pad_template_list"
- c:identifier="gst_element_class_get_pad_template_list">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1711">Retrieves a list of the pad templates associated with @element_class. The
-list must not be modified by the calling code.
-&gt; If you use this function in the #GInstanceInitFunc of an object class
-&gt; that has subclasses, make sure to pass the g_class parameter of the
-&gt; #GInstanceInitFunc here.</doc>
- <source-position filename="gst/gstelement.h" line="763"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1721">the #GList of
- pad templates.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="PadTemplate"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="element_class" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1713">a #GstElementClass to get pad templates of.</doc>
- <type name="ElementClass" c:type="GstElementClass*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_metadata"
- c:identifier="gst_element_class_set_metadata">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1589">Sets the detailed information for a #GstElementClass.
-&gt; This function is for use in _class_init functions only.</doc>
- <source-position filename="gst/gstelement.h" line="768"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1591">class to set metadata for</doc>
- <type name="ElementClass" c:type="GstElementClass*"/>
- </instance-parameter>
- <parameter name="longname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1592">The long English name of the element. E.g. "File Sink"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="classification" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1593">String describing the type of element, as an unordered list
-separated with slashes ('/'). See draft-klass.txt of the design docs
-for more details and common types. E.g: "Sink/File"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1596">Sentence describing the purpose of the element.
-E.g: "Write stream to a file"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="author" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1598">Name and contact details of the author(s). Use \n to separate
-multiple author metadata. E.g: "Joe Bloggs &amp;lt;joe.blogs at foo.com&amp;gt;"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_static_metadata"
- c:identifier="gst_element_class_set_static_metadata">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1622">Sets the detailed information for a #GstElementClass.
-
-&gt; This function is for use in _class_init functions only.
-
-Same as gst_element_class_set_metadata(), but @longname, @classification,
-@description, and @author must be static strings or inlined strings, as
-they will not be copied. (GStreamer plugins will be made resident once
-loaded, so this function can be used even from dynamically loaded plugins.)</doc>
- <source-position filename="gst/gstelement.h" line="774"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1624">class to set metadata for</doc>
- <type name="ElementClass" c:type="GstElementClass*"/>
- </instance-parameter>
- <parameter name="longname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1625">The long English name of the element. E.g. "File Sink"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="classification" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1626">String describing the type of element, as an unordered list
-separated with slashes ('/'). See draft-klass.txt of the design docs
-for more details and common types. E.g: "Sink/File"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1629">Sentence describing the purpose of the element.
-E.g: "Write stream to a file"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="author" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="1631">Name and contact details of the author(s). Use \n to separate
-multiple author metadata. E.g: "Joe Bloggs &amp;lt;joe.blogs at foo.com&amp;gt;"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <class name="ElementFactory"
- c:symbol-prefix="element_factory"
- c:type="GstElementFactory"
- parent="PluginFeature"
- glib:type-name="GstElementFactory"
- glib:get-type="gst_element_factory_get_type"
- glib:type-struct="ElementFactoryClass">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="24">#GstElementFactory is used to create instances of elements. A
-GstElementFactory can be added to a #GstPlugin as it is also a
-#GstPluginFeature.
-
-Use the gst_element_factory_find() and gst_element_factory_create()
-functions to create element instances or use gst_element_factory_make() as a
-convenient shortcut.
-
-The following code example shows you how to create a GstFileSrc element.
-
-## Using an element factory
-|[&lt;!-- language="C" --&gt;
- #include &amp;lt;gst/gst.h&amp;gt;
-
- GstElement *src;
- GstElementFactory *srcfactory;
-
- gst_init (&amp;amp;argc, &amp;amp;argv);
-
- srcfactory = gst_element_factory_find ("filesrc");
- g_return_if_fail (srcfactory != NULL);
- src = gst_element_factory_create (srcfactory, "src");
- g_return_if_fail (src != NULL);
- ...
-]|</doc>
- <source-position filename="gst/gstelementfactory.h" line="33"/>
- <function name="find" c:identifier="gst_element_factory_find">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="118">Search for an element factory of the given name. Refs the returned
-element factory; caller is responsible for unreffing.</doc>
- <source-position filename="gst/gstelementfactory.h" line="57"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="125">#GstElementFactory if found,
-%NULL otherwise</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="120">name of factory to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="list_filter"
- c:identifier="gst_element_factory_list_filter">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="827">Filter out all the elementfactories in @list that can handle @caps in
-the given direction.
-
-If @subsetonly is %TRUE, then only the elements whose pads templates
-are a complete superset of @caps will be returned. Else any element
-whose pad templates caps can intersect with @caps will be returned.</doc>
- <source-position filename="gst/gstelementfactory.h" line="241"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="842">a #GList of
- #GstElementFactory elements that match the given requisites.
- Use #gst_plugin_feature_list_free after usage.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="ElementFactory"/>
- </type>
- </return-value>
- <parameters>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="829">a #GList of
- #GstElementFactory to filter</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="ElementFactory"/>
- </type>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="831">a #GstCaps</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- <parameter name="direction" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="832">a #GstPadDirection to filter on</doc>
- <type name="PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="subsetonly" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="833">whether to filter on caps subsets or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="list_get_elements"
- c:identifier="gst_element_factory_list_get_elements">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="793">Get a list of factories that match the given @type. Only elements
-with a rank greater or equal to @minrank will be returned.
-The list of factories is returned by decreasing rank.</doc>
- <source-position filename="gst/gstelementfactory.h" line="236"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="802">a #GList of
- #GstElementFactory elements. Use gst_plugin_feature_list_free() after
- usage.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="ElementFactory"/>
- </type>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="795">a #GstElementFactoryListType</doc>
- <type name="ElementFactoryListType"
- c:type="GstElementFactoryListType"/>
- </parameter>
- <parameter name="minrank" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="796">Minimum rank</doc>
- <type name="Rank" c:type="GstRank"/>
- </parameter>
- </parameters>
- </function>
- <function name="make" c:identifier="gst_element_factory_make">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="425">Create a new element of the type defined by the given element factory.
-If name is %NULL, then the element will receive a guaranteed unique name,
-consisting of the element factory name and a number.
-If name is given, it will be given the name supplied.</doc>
- <source-position filename="gst/gstelementfactory.h" line="87"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="436">new #GstElement or %NULL
-if unable to create element</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="factoryname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="427">a named factory to instantiate</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="428">name of new element, or %NULL to automatically create
- a unique name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <method name="can_sink_all_caps"
- c:identifier="gst_element_factory_can_sink_all_caps">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1430">Checks if the factory can sink all possible capabilities.</doc>
- <source-position filename="gst/gstutils.h" line="1040"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1437">%TRUE if the caps are fully compatible.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1432">factory to query</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1433">the caps to check</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="can_sink_any_caps"
- c:identifier="gst_element_factory_can_sink_any_caps">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1464">Checks if the factory can sink any possible capability.</doc>
- <source-position filename="gst/gstutils.h" line="1046"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1471">%TRUE if the caps have a common subset.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1466">factory to query</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1467">the caps to check</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="can_src_all_caps"
- c:identifier="gst_element_factory_can_src_all_caps">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1447">Checks if the factory can src all possible capabilities.</doc>
- <source-position filename="gst/gstutils.h" line="1043"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1454">%TRUE if the caps are fully compatible.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1449">factory to query</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1450">the caps to check</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="can_src_any_caps"
- c:identifier="gst_element_factory_can_src_any_caps">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1481">Checks if the factory can src any possible capability.</doc>
- <source-position filename="gst/gstutils.h" line="1049"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1488">%TRUE if the caps have a common subset.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1483">factory to query</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1484">the caps to check</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="create" c:identifier="gst_element_factory_create">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="328">Create a new element of the type defined by the given elementfactory.
-It will be given the name supplied, since all elements require a name as
-their first argument.</doc>
- <source-position filename="gst/gstelementfactory.h" line="84"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="338">new #GstElement or %NULL
- if the element couldn't be created</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="330">factory to instantiate</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="331">name of new element, or %NULL to automatically create
- a unique name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_element_type"
- c:identifier="gst_element_factory_get_element_type">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="490">Get the #GType for elements managed by this factory. The type can
-only be retrieved if the element factory is loaded, which can be
-assured with gst_plugin_feature_load().</doc>
- <source-position filename="gst/gstelementfactory.h" line="60"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="498">the #GType for elements managed by this factory or 0 if
-the factory is not loaded.</doc>
- <type name="GType" c:type="GType"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="492">factory to get managed #GType from</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_metadata"
- c:identifier="gst_element_factory_get_metadata">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="509">Get the metadata on @factory with @key.</doc>
- <source-position filename="gst/gstelementfactory.h" line="63"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="516">the metadata with @key on @factory or %NULL
-when there was no metadata with the given @key.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="511">a #GstElementFactory</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="512">a key</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_metadata_keys"
- c:identifier="gst_element_factory_get_metadata_keys">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="528">Get the available keys for the metadata on @factory.</doc>
- <source-position filename="gst/gstelementfactory.h" line="66"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="534">
-a %NULL-terminated array of key strings, or %NULL when there is no
-metadata. Free with g_strfreev() when no longer needed.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="530">a #GstElementFactory</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_num_pad_templates"
- c:identifier="gst_element_factory_get_num_pad_templates">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="563">Gets the number of pad_templates in this factory.</doc>
- <source-position filename="gst/gstelementfactory.h" line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="569">the number of pad_templates</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="565">a #GstElementFactory</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_static_pad_templates"
- c:identifier="gst_element_factory_get_static_pad_templates">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="600">Gets the #GList of #GstStaticPadTemplate for this factory.</doc>
- <source-position filename="gst/gstelementfactory.h" line="72"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="606">the
- static pad templates</doc>
- <type name="GLib.List" c:type="const GList*">
- <type name="StaticPadTemplate"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="602">a #GstElementFactory</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_uri_protocols"
- c:identifier="gst_element_factory_get_uri_protocols">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="633">Gets a %NULL-terminated array of protocols this element supports or %NULL if
-no protocols are supported. You may not change the contents of the returned
-array, as it is still owned by the element factory. Use g_strdupv() to
-make a copy of the protocol string array if you need to.</doc>
- <source-position filename="gst/gstelementfactory.h" line="78"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="642">the supported protocols
- or %NULL</doc>
- <array c:type="const gchar* const*">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="635">a #GstElementFactory</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_uri_type"
- c:identifier="gst_element_factory_get_uri_type">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="617">Gets the type of URIs the element supports or #GST_URI_UNKNOWN if none.</doc>
- <source-position filename="gst/gstelementfactory.h" line="75"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="623">type of URIs this element supports</doc>
- <type name="URIType" c:type="GstURIType"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="619">a #GstElementFactory</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_interface"
- c:identifier="gst_element_factory_has_interface">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="653">Check if @factory implements the interface with name @interfacename.</doc>
- <source-position filename="gst/gstelementfactory.h" line="81"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="660">%TRUE when @factory implement the interface.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="655">a #GstElementFactory</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- <parameter name="interfacename" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="656">an interface name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="list_is_type"
- c:identifier="gst_element_factory_list_is_type">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="687">Check if @factory is of the given types.</doc>
- <source-position filename="gst/gstelementfactory.h" line="232"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="694">%TRUE if @factory is of @type.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="689">a #GstElementFactory</doc>
- <type name="ElementFactory" c:type="GstElementFactory*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelementfactory.c"
- line="690">a #GstElementFactoryListType</doc>
- <type name="ElementFactoryListType"
- c:type="GstElementFactoryListType"/>
- </parameter>
- </parameters>
- </method>
- </class>
- <record name="ElementFactoryClass"
- c:type="GstElementFactoryClass"
- disguised="1"
- glib:is-gtype-struct-for="ElementFactory">
- <source-position filename="gst/gstelementfactory.h" line="33"/>
- </record>
- <bitfield name="ElementFlags"
- glib:type-name="GstElementFlags"
- glib:get-type="gst_element_flags_get_type"
- c:type="GstElementFlags">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="260">The standard flags that an element may have.</doc>
- <member name="locked_state"
- value="16"
- c:identifier="GST_ELEMENT_FLAG_LOCKED_STATE"
- glib:nick="locked-state">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="262">ignore state changes from parent</doc>
- </member>
- <member name="sink"
- value="32"
- c:identifier="GST_ELEMENT_FLAG_SINK"
- glib:nick="sink">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="263">the element is a sink</doc>
- </member>
- <member name="source"
- value="64"
- c:identifier="GST_ELEMENT_FLAG_SOURCE"
- glib:nick="source">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="264">the element is a source.</doc>
- </member>
- <member name="provide_clock"
- value="128"
- c:identifier="GST_ELEMENT_FLAG_PROVIDE_CLOCK"
- glib:nick="provide-clock">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="265">the element can provide a clock</doc>
- </member>
- <member name="require_clock"
- value="256"
- c:identifier="GST_ELEMENT_FLAG_REQUIRE_CLOCK"
- glib:nick="require-clock">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="266">the element requires a clock</doc>
- </member>
- <member name="indexable"
- value="512"
- c:identifier="GST_ELEMENT_FLAG_INDEXABLE"
- glib:nick="indexable">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="267">the element can use an index</doc>
- </member>
- <member name="last"
- value="16384"
- c:identifier="GST_ELEMENT_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="268">offset to define more flags</doc>
- </member>
- </bitfield>
- <callback name="ElementForeachPadFunc"
- c:type="GstElementForeachPadFunc"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="923">Function called for each pad when using gst_element_foreach_sink_pad(),
-gst_element_foreach_src_pad(), or gst_element_foreach_pad().</doc>
- <source-position filename="gst/gstelement.h" line="936"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="932">%FALSE to stop iterating pads, %TRUE to continue</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="925">the #GstElement</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="926">a #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="927">user data passed to the foreach function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="Event"
- c:type="GstEvent"
- glib:type-name="GstEvent"
- glib:get-type="gst_event_get_type"
- c:symbol-prefix="event">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="24">The event class provides factory methods to construct events for sending
-and functions to query (parse) received events.
-
-Events are usually created with gst_event_new_*() which takes event-type
-specific parameters as arguments.
-To send an event application will usually use gst_element_send_event() and
-elements will use gst_pad_send_event() or gst_pad_push_event().
-The event should be unreffed with gst_event_unref() if it has not been sent.
-
-Events that have been received can be parsed with their respective
-gst_event_parse_*() functions. It is valid to pass %NULL for unwanted details.
-
-Events are passed between elements in parallel to the data stream. Some events
-are serialized with buffers, others are not. Some events only travel downstream,
-others only upstream. Some events can travel both upstream and downstream.
-
-The events are used to signal special conditions in the datastream such as
-EOS (end of stream) or the start of a new stream-segment.
-Events are also used to flush the pipeline of any pending data.
-
-Most of the event API is used inside plugins. Applications usually only
-construct and use seek events.
-To do that gst_event_new_seek() is used to create a seek event. It takes
-the needed parameters to specify seeking time and mode.
-|[&lt;!-- language="C" --&gt;
- GstEvent *event;
- gboolean result;
- ...
- // construct a seek event to play the media from second 2 to 5, flush
- // the pipeline to decrease latency.
- event = gst_event_new_seek (1.0,
- GST_FORMAT_TIME,
- GST_SEEK_FLAG_FLUSH,
- GST_SEEK_TYPE_SET, 2 * GST_SECOND,
- GST_SEEK_TYPE_SET, 5 * GST_SECOND);
- ...
- result = gst_element_send_event (pipeline, event);
- if (!result)
- g_warning ("seek failed");
- ...
-]|</doc>
- <source-position filename="gst/gstevent.h" line="438"/>
- <field name="mini_object" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="423">the parent structure</doc>
- <type name="MiniObject" c:type="GstMiniObject"/>
- </field>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="424">the #GstEventType of the event</doc>
- <type name="EventType" c:type="GstEventType"/>
- </field>
- <field name="timestamp" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="425">the timestamp of the event</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="seqnum" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="426">the sequence number of the event</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <constructor name="new_buffer_size"
- c:identifier="gst_event_new_buffer_size">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1081">Create a new buffersize event. The event is sent downstream and notifies
-elements that they should provide a buffer of the specified dimensions.
-
-When the @async flag is set, a thread boundary is preferred.</doc>
- <source-position filename="gst/gstevent.h" line="683"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1093">a new #GstEvent</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1083">buffer format</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="minsize" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1084">minimum buffer size</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="maxsize" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1085">maximum buffer size</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="async" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1086">thread behavior</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_caps" c:identifier="gst_event_new_caps">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="870">Create a new CAPS event for @caps. The caps event can only travel downstream
-synchronized with the buffer flow and contains the format of the buffers
-that will follow after the event.</doc>
- <source-position filename="gst/gstevent.h" line="639"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="878">the new CAPS event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="872">a #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_custom" c:identifier="gst_event_new_custom">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="284">Create a new custom-typed event. This can be used for anything not
-handled by other event-specific functions to pass an event to another
-element.
-
-Make sure to allocate an event type with the #GST_EVENT_MAKE_TYPE macro,
-assigning a free number and filling in the correct direction and
-serialization flags.
-
-New custom events can also be created by subclassing the event type if
-needed.</doc>
- <source-position filename="gst/gstevent.h" line="521"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="301">the new custom event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="286">The type of the new event</doc>
- <type name="EventType" c:type="GstEventType"/>
- </parameter>
- <parameter name="structure" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="287">the structure for the event. The event will
- take ownership of the structure.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_eos" c:identifier="gst_event_new_eos">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="746">Create a new EOS event. The eos event can only travel downstream
-synchronized with the buffer flow. Elements that receive the EOS
-event on a pad can return #GST_FLOW_EOS as a #GstFlowReturn
-when data after the EOS event arrives.
-
-The EOS event will travel down to the sink elements in the pipeline
-which will then post the #GST_MESSAGE_EOS on the bus after they have
-finished playing any buffered data.
-
-When all sinks have posted an EOS message, an EOS message is
-forwarded to the application.
-
-The EOS event itself will not cause any state transitions of the pipeline.</doc>
- <source-position filename="gst/gstevent.h" line="616"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="763">the new EOS event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- </constructor>
- <constructor name="new_flush_start"
- c:identifier="gst_event_new_flush_start">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="534">Allocate a new flush start event. The flush start event can be sent
-upstream and downstream and travels out-of-bounds with the dataflow.
-
-It marks pads as being flushing and will make them return
-#GST_FLOW_FLUSHING when used for data flow with gst_pad_push(),
-gst_pad_chain(), gst_pad_get_range() and gst_pad_pull_range().
-Any event (except a #GST_EVENT_FLUSH_STOP) received
-on a flushing pad will return %FALSE immediately.
-
-Elements should unlock any blocking functions and exit their streaming
-functions as fast as possible when this event is received.
-
-This event is typically generated after a seek to flush out all queued data
-in the pipeline so that the new media is played as soon as possible.</doc>
- <source-position filename="gst/gstevent.h" line="581"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="552">a new flush start event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- </constructor>
- <constructor name="new_flush_stop"
- c:identifier="gst_event_new_flush_stop">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="560">Allocate a new flush stop event. The flush stop event can be sent
-upstream and downstream and travels serialized with the dataflow.
-It is typically sent after sending a FLUSH_START event to make the
-pads accept data again.
-
-Elements can process this event synchronized with the dataflow since
-the preceding FLUSH_START event stopped the dataflow.
-
-This event is typically generated to complete a seek and to resume
-dataflow.</doc>
- <source-position filename="gst/gstevent.h" line="584"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="575">a new flush stop event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="reset_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="562">if time should be reset</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_gap" c:identifier="gst_event_new_gap">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="771">Create a new GAP event. A gap event can be thought of as conceptually
-equivalent to a buffer to signal that there is no data for a certain
-amount of time. This is useful to signal a gap to downstream elements
-which may wait for data, such as muxers or mixers or overlays, especially
-for sparse streams such as subtitle streams.</doc>
- <source-position filename="gst/gstevent.h" line="621"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="782">the new GAP event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="773">the start time (pts) of the gap</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="774">the duration of the gap</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_instant_rate_change"
- c:identifier="gst_event_new_instant_rate_change"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2244">Create a new instant-rate-change event. This event is sent by seek
-handlers (e.g. demuxers) when receiving a seek with the
-%GST_SEEK_FLAG_INSTANT_RATE_CHANGE and signals to downstream elements that
-the playback rate in the existing segment should be immediately multiplied
-by the @rate_multiplier factor.
-
-The flags provided replace any flags in the existing segment, for the
-flags within the %GST_SEGMENT_INSTANT_FLAGS set. Other GstSegmentFlags
-are ignored and not transferred in the event.</doc>
- <source-position filename="gst/gstevent.h" line="770"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2259">the new instant-rate-change event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="rate_multiplier" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2246">the multiplier to be applied to the playback rate</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="new_flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2247">A new subset of segment flags to replace in segments</doc>
- <type name="SegmentFlags" c:type="GstSegmentFlags"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_instant_rate_sync_time"
- c:identifier="gst_event_new_instant_rate_sync_time"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2311">Create a new instant-rate-sync-time event. This event is sent by the
-pipeline to notify elements handling the instant-rate-change event about
-the running-time when the new rate should be applied. The running time
-may be in the past when elements handle this event, which can lead to
-switching artifacts. The magnitude of those depends on the exact timing
-of event delivery to each element and the magnitude of the change in
-playback rate being applied.
-
-The @running_time and @upstream_running_time are the same if this
-is the first instant-rate adjustment, but will differ for later ones
-to compensate for the accumulated offset due to playing at a rate
-different to the one indicated in the playback segments.</doc>
- <source-position filename="gst/gstevent.h" line="779"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2331">the new instant-rate-sync-time event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="rate_multiplier" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2313">the new playback rate multiplier to be applied</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="running_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2314">Running time when the rate change should be applied</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="upstream_running_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2315">The upstream-centric running-time when the
- rate change should be applied.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_latency" c:identifier="gst_event_new_latency">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1502">Create a new latency event. The event is sent upstream from the sinks and
-notifies elements that they should add an additional @latency to the
-running time before synchronising against the clock.
-
-The latency is mostly used in live sinks and is always expressed in
-the time format.</doc>
- <source-position filename="gst/gstevent.h" line="732"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1513">a new #GstEvent</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="latency" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1504">the new latency value</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_navigation"
- c:identifier="gst_event_new_navigation">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1485">Create a new navigation event from the given description.</doc>
- <source-position filename="gst/gstevent.h" line="727"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1492">a new #GstEvent</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="structure" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1487">description of the event. The event will take
- ownership of the structure.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_protection"
- c:identifier="gst_event_new_protection"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2074">Creates a new event containing information specific to a particular
-protection system (uniquely identified by @system_id), by which that
-protection system can acquire key(s) to decrypt a protected stream.
-
-In order for a decryption element to decrypt media
-protected using a specific system, it first needs all the
-protection system specific information necessary to acquire the decryption
-key(s) for that stream. The functions defined here enable this information
-to be passed in events from elements that extract it
-(e.g., ISOBMFF demuxers, MPEG DASH demuxers) to protection decrypter
-elements that use it.
-
-Events containing protection system specific information are created using
-#gst_event_new_protection, and they can be parsed by downstream elements
-using #gst_event_parse_protection.
-
-In Common Encryption, protection system specific information may be located
-within ISOBMFF files, both in movie (moov) boxes and movie fragment (moof)
-boxes; it may also be contained in ContentProtection elements within MPEG
-DASH MPDs. The events created by #gst_event_new_protection contain data
-identifying from which of these locations the encapsulated protection system
-specific information originated. This origin information is required as
-some protection systems use different encodings depending upon where the
-information originates.
-
-The events returned by gst_event_new_protection() are implemented
-in such a way as to ensure that the most recently-pushed protection info
-event of a particular @origin and @system_id will
-be stuck to the output pad of the sending element.</doc>
- <source-position filename="gst/gstevent.h" line="674"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2114">a #GST_EVENT_PROTECTION event, if successful; %NULL
-if unsuccessful.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="system_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2076">a string holding a UUID that uniquely
-identifies a protection system.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2078">a #GstBuffer holding protection system specific
-information. The reference count of the buffer will be incremented by one.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="origin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2080">a string indicating where the protection
-information carried in the event was extracted from. The allowed values
-of this string will depend upon the protection scheme.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_qos" c:identifier="gst_event_new_qos">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1155">Allocate a new qos event with the given values.
-The QOS event is generated in an element that wants an upstream
-element to either reduce or increase its rate because of
-high/low CPU load or other resource usage such as network performance or
-throttling. Typically sinks generate these events for each buffer
-they receive.
-
-@type indicates the reason for the QoS event. #GST_QOS_TYPE_OVERFLOW is
-used when a buffer arrived in time or when the sink cannot keep up with
-the upstream datarate. #GST_QOS_TYPE_UNDERFLOW is when the sink is not
-receiving buffers fast enough and thus has to drop late buffers.
-#GST_QOS_TYPE_THROTTLE is used when the datarate is artificially limited
-by the application, for example to reduce power consumption.
-
-@proportion indicates the real-time performance of the streaming in the
-element that generated the QoS event (usually the sink). The value is
-generally computed based on more long term statistics about the streams
-timestamps compared to the clock.
-A value &lt; 1.0 indicates that the upstream element is producing data faster
-than real-time. A value &gt; 1.0 indicates that the upstream element is not
-producing data fast enough. 1.0 is the ideal @proportion value. The
-proportion value can safely be used to lower or increase the quality of
-the element.
-
-@diff is the difference against the clock in running time of the last
-buffer that caused the element to generate the QOS event. A negative value
-means that the buffer with @timestamp arrived in time. A positive value
-indicates how late the buffer with @timestamp was. When throttling is
-enabled, @diff will be set to the requested throttling interval.
-
-@timestamp is the timestamp of the last buffer that cause the element
-to generate the QOS event. It is expressed in running time and thus an ever
-increasing value.
-
-The upstream element can use the @diff and @timestamp values to decide
-whether to process more buffers. For positive @diff, all buffers with
-timestamp &lt;= @timestamp + @diff will certainly arrive late in the sink
-as well. A (negative) @diff value so that @timestamp + @diff would yield a
-result smaller than 0 is not allowed.
-
-The application can use general event probes to intercept the QoS
-event and implement custom application specific QoS handling.</doc>
- <source-position filename="gst/gstevent.h" line="700"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1205">a new QOS event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1157">the QoS type</doc>
- <type name="QOSType" c:type="GstQOSType"/>
- </parameter>
- <parameter name="proportion" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1158">the proportion of the qos message</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="diff" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1159">The time difference of the last Clock sync</doc>
- <type name="ClockTimeDiff" c:type="GstClockTimeDiff"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1160">The timestamp of the buffer</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_reconfigure"
- c:identifier="gst_event_new_reconfigure">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1636">Create a new reconfigure event. The purpose of the reconfigure event is
-to travel upstream and make elements renegotiate their caps or reconfigure
-their buffer pools. This is useful when changing properties on elements
-or changing the topology of the pipeline.</doc>
- <source-position filename="gst/gstevent.h" line="749"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1644">a new #GstEvent</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- </constructor>
- <constructor name="new_seek" c:identifier="gst_event_new_seek">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1289">Allocate a new seek event with the given parameters.
-
-The seek event configures playback of the pipeline between @start to @stop
-at the speed given in @rate, also called a playback segment.
-The @start and @stop values are expressed in @format.
-
-A @rate of 1.0 means normal playback rate, 2.0 means double speed.
-Negatives values means backwards playback. A value of 0.0 for the
-rate is not allowed and should be accomplished instead by PAUSING the
-pipeline.
-
-A pipeline has a default playback segment configured with a start
-position of 0, a stop position of -1 and a rate of 1.0. The currently
-configured playback segment can be queried with #GST_QUERY_SEGMENT.
-
-@start_type and @stop_type specify how to adjust the currently configured
-start and stop fields in playback segment. Adjustments can be made relative
-or absolute to the last configured values. A type of #GST_SEEK_TYPE_NONE
-means that the position should not be updated.
-
-When the rate is positive and @start has been updated, playback will start
-from the newly configured start position.
-
-For negative rates, playback will start from the newly configured stop
-position (if any). If the stop position is updated, it must be different from
--1 (#GST_CLOCK_TIME_NONE) for negative rates.
-
-It is not possible to seek relative to the current playback position, to do
-this, PAUSE the pipeline, query the current playback position with
-#GST_QUERY_POSITION and update the playback segment current position with a
-#GST_SEEK_TYPE_SET to the desired position.</doc>
- <source-position filename="gst/gstevent.h" line="709"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1331">a new seek event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1291">The new playback rate</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1292">The format of the seek values</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1293">The optional seek flags</doc>
- <type name="SeekFlags" c:type="GstSeekFlags"/>
- </parameter>
- <parameter name="start_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1294">The type and flags for the new start position</doc>
- <type name="SeekType" c:type="GstSeekType"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1295">The value of the new start position</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="stop_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1296">The type and flags for the new stop position</doc>
- <type name="SeekType" c:type="GstSeekType"/>
- </parameter>
- <parameter name="stop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1297">The value of the new stop position</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_segment" c:identifier="gst_event_new_segment">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="920">Create a new SEGMENT event for @segment. The segment event can only travel
-downstream synchronized with the buffer flow and contains timing information
-and playback properties for the buffers that will follow.
-
-The segment event marks the range of buffers to be processed. All
-data not within the segment range is not to be processed. This can be
-used intelligently by plugins to apply more efficient methods of skipping
-unneeded data. The valid range is expressed with the @start and @stop
-values.
-
-The time value of the segment is used in conjunction with the start
-value to convert the buffer timestamps into the stream time. This is
-usually done in sinks to report the current stream_time.
-@time represents the stream_time of a buffer carrying a timestamp of
-@start. @time cannot be -1.
-
-@start cannot be -1, @stop can be -1. If there
-is a valid @stop given, it must be greater or equal the @start, including
-when the indicated playback @rate is &lt; 0.
-
-The @applied_rate value provides information about any rate adjustment that
-has already been made to the timestamps and content on the buffers of the
-stream. (@rate * @applied_rate) should always equal the rate that has been
-requested for playback. For example, if an element has an input segment
-with intended playback @rate of 2.0 and applied_rate of 1.0, it can adjust
-incoming timestamps and buffer content by half and output a segment event
-with @rate of 1.0 and @applied_rate of 2.0
-
-After a segment event, the buffer stream time is calculated with:
-
- time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)</doc>
- <source-position filename="gst/gstevent.h" line="647"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="956">the new SEGMENT event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="922">a #GstSegment</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_segment_done"
- c:identifier="gst_event_new_segment_done">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2187">Create a new segment-done event. This event is sent by elements that
-finish playback of a segment as a result of a segment seek.</doc>
- <source-position filename="gst/gstevent.h" line="762"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2195">a new #GstEvent</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2189">The format of the position being done</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2190">The position of the segment being done</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_select_streams"
- c:identifier="gst_event_new_select_streams"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="613">Allocate a new select-streams event.
-
-The select-streams event requests the specified @streams to be activated.
-
-The list of @streams corresponds to the "Stream ID" of each stream to be
-activated. Those ID can be obtained via the #GstStream objects present
-in #GST_EVENT_STREAM_START, #GST_EVENT_STREAM_COLLECTION or
-#GST_MESSAGE_STREAM_COLLECTION.
-
-Note: The list of @streams can not be empty.</doc>
- <source-position filename="gst/gstevent.h" line="600"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="629">a new select-streams event or %NULL in case of
-an error (like an empty streams list).</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="streams" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="615">the list of streams to
-activate</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="utf8"/>
- </type>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_sink_message"
- c:identifier="gst_event_new_sink_message">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1658">Create a new sink-message event. The purpose of the sink-message event is
-to instruct a sink to post the message contained in the event synchronized
-with the stream.
-
-@name is used to store multiple sticky events on one pad.</doc>
- <source-position filename="gst/gstevent.h" line="692"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1669">a new #GstEvent</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1660">a name for the event</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1661">the #GstMessage to be posted</doc>
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_step" c:identifier="gst_event_new_step">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1550">Create a new step event. The purpose of the step event is to instruct a sink
-to skip @amount (expressed in @format) of media. It can be used to implement
-stepping through the video frame by frame or for doing fast trick modes.
-
-A rate of &lt;= 0.0 is not allowed. Pause the pipeline, for the effect of rate
-= 0.0 or first reverse the direction of playback using a seek event to get
-the same effect as rate &lt; 0.0.
-
-The @flush flag will clear any pending data in the pipeline before starting
-the step operation.
-
-The @intermediate flag instructs the pipeline that this step operation is
-part of a larger step operation.</doc>
- <source-position filename="gst/gstevent.h" line="740"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1572">a new #GstEvent</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1552">the format of @amount</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="amount" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1553">the amount of data to step</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1554">the step rate</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="flush" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1555">flushing steps</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="intermediate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1556">intermediate steps</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_stream_collection"
- c:identifier="gst_event_new_stream_collection"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1910">Create a new STREAM_COLLECTION event. The stream collection event can only
-travel downstream synchronized with the buffer flow.
-
-Source elements, demuxers and other elements that manage collections
-of streams and post #GstStreamCollection messages on the bus also send
-this event downstream on each pad involved in the collection, so that
-activation of a new collection can be tracked through the downstream
-data flow.</doc>
- <source-position filename="gst/gstevent.h" line="592"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1923">the new STREAM_COLLECTION event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="collection" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1912">Active collection for this data flow</doc>
- <type name="StreamCollection" c:type="GstStreamCollection*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_stream_group_done"
- c:identifier="gst_event_new_stream_group_done"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="693">Create a new Stream Group Done event. The stream-group-done event can
-only travel downstream synchronized with the buffer flow. Elements
-that receive the event on a pad should handle it mostly like EOS,
-and emit any data or pending buffers that would depend on more data
-arriving and unblock, since there won't be any more data.
-
-This event is followed by EOS at some point in the future, and is
-generally used when switching pads - to unblock downstream so that
-new pads can be exposed before sending EOS on the existing pads.</doc>
- <source-position filename="gst/gstevent.h" line="608"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="707">the new stream-group-done event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="group_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="695">the group id of the stream group which is ending</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_stream_start"
- c:identifier="gst_event_new_stream_start">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1711">Create a new STREAM_START event. The stream start event can only
-travel downstream synchronized with the buffer flow. It is expected
-to be the first event that is sent for a new stream.
-
-Source elements, demuxers and other elements that create new streams
-are supposed to send this event as the first event of a new stream. It
-should not be sent after a flushing seek or in similar situations
-and is used to mark the beginning of a new logical stream. Elements
-combining multiple streams must ensure that this event is only forwarded
-downstream once and not for every single input stream.
-
-The @stream_id should be a unique string that consists of the upstream
-stream-id, / as separator and a unique stream-id for this specific
-stream. A new stream-id should only be created for a stream if the upstream
-stream is split into (potentially) multiple new streams, e.g. in a demuxer,
-but not for every single element in the pipeline.
-gst_pad_create_stream_id() or gst_pad_create_stream_id_printf() can be
-used to create a stream-id. There are no particular semantics for the
-stream-id, though it should be deterministic (to support stream matching)
-and it might be used to order streams (besides any information conveyed by
-stream flags).</doc>
- <source-position filename="gst/gstevent.h" line="555"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1737">the new STREAM_START event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="stream_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1713">Identifier for this stream</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_tag" c:identifier="gst_event_new_tag">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1024">Generates a metadata tag event from the given @taglist.
-
-The scope of the taglist specifies if the taglist applies to the
-complete medium or only to this specific stream. As the tag event
-is a sticky event, elements should merge tags received from
-upstream with a given scope with their own tags with the same
-scope and create a new tag event from it.</doc>
- <source-position filename="gst/gstevent.h" line="658"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1037">a new #GstEvent</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="taglist" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1026">metadata list. The event will take ownership
- of the taglist.</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_toc" c:identifier="gst_event_new_toc">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1967">Generate a TOC event from the given @toc. The purpose of the TOC event is to
-inform elements that some kind of the TOC was found.</doc>
- <source-position filename="gst/gstevent.h" line="666"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1975">a new #GstEvent.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="toc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1969">#GstToc structure.</doc>
- <type name="Toc" c:type="GstToc*"/>
- </parameter>
- <parameter name="updated" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1970">whether @toc was updated or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_toc_select"
- c:identifier="gst_event_new_toc_select">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2025">Generate a TOC select event with the given @uid. The purpose of the
-TOC select event is to start playback based on the TOC's entry with the
-given @uid.</doc>
- <source-position filename="gst/gstevent.h" line="754"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2033">a new #GstEvent.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="uid" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2027">UID in the TOC to start playback from.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="copy" c:identifier="gst_event_copy" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="500">Copy the event using the event specific copy function.</doc>
- <source-position filename="gst/gstevent.h" line="508"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="506">the new event</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="502">The event to copy</doc>
- <type name="Event" c:type="const GstEvent*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="copy_segment" c:identifier="gst_event_copy_segment">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1002">Parses a segment @event and copies the #GstSegment into the location
-given by @segment.</doc>
- <source-position filename="gst/gstevent.h" line="653"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1004">The event to parse</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1005">a pointer to a #GstSegment</doc>
- <type name="Segment" c:type="GstSegment*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_running_time_offset"
- c:identifier="gst_event_get_running_time_offset"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="485">Retrieve the accumulated running time offset of the event.
-
-Events passing through #GstPads that have a running time
-offset set via gst_pad_set_offset() will get their offset
-adjusted according to the pad's offset.
-
-If the event contains any information that related to the
-running time, this information will need to be updated
-before usage with this offset.</doc>
- <source-position filename="gst/gstevent.h" line="547"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="499">The event's running time offset
-
-MT safe.</doc>
- <type name="gint64" c:type="gint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="487">A #GstEvent.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_seqnum" c:identifier="gst_event_get_seqnum">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="433">Retrieve the sequence number of a event.
-
-Events have ever-incrementing sequence numbers, which may also be set
-explicitly via gst_event_set_seqnum(). Sequence numbers are typically used to
-indicate that a event corresponds to some other set of events or messages,
-for example an EOS event corresponding to a SEEK event. It is considered good
-practice to make this correspondence when possible, though it is not
-required.
-
-Note that events and messages share the same sequence number incrementor;
-two events or messages will never have the same sequence number unless
-that correspondence was made explicitly.</doc>
- <source-position filename="gst/gstevent.h" line="539"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="450">The event's sequence number.
-
-MT safe.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="435">A #GstEvent.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_structure" c:identifier="gst_event_get_structure">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="335">Access the structure of the event.</doc>
- <source-position filename="gst/gstevent.h" line="525"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="341">The structure of the event. The
-structure is still owned by the event, which means that you should not free
-it and that the pointer becomes invalid when you free the event.
-
-MT safe.</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="337">The #GstEvent.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_name" c:identifier="gst_event_has_name">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="389">Checks if @event has the given @name. This function is usually used to
-check the name of a custom event.</doc>
- <source-position filename="gst/gstevent.h" line="531"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="397">%TRUE if @name matches the name of the event structure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="391">The #GstEvent.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="392">name to check</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="has_name_id"
- c:identifier="gst_event_has_name_id"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="410">Checks if @event has the given @name. This function is usually used to
-check the name of a custom event.</doc>
- <source-position filename="gst/gstevent.h" line="534"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="418">%TRUE if @name matches the name of the event structure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="412">The #GstEvent.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="413">name to check as a GQuark</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_buffer_size"
- c:identifier="gst_event_parse_buffer_size">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1117">Get the format, minsize, maxsize and async-flag in the buffersize event.</doc>
- <source-position filename="gst/gstevent.h" line="686"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1119">The event to query</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1120">A pointer to store the format in</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="minsize"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1121">A pointer to store the minsize in</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- <parameter name="maxsize"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1122">A pointer to store the maxsize in</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- <parameter name="async"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1123">A pointer to store the async-flag in</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_caps" c:identifier="gst_event_parse_caps">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="897">Get the caps from @event. The caps remains valid as long as @event remains
-valid.</doc>
- <source-position filename="gst/gstevent.h" line="642"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="899">The event to parse</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="caps"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="900">A pointer to the caps</doc>
- <type name="Caps" c:type="GstCaps**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_flush_stop"
- c:identifier="gst_event_parse_flush_stop">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="591">Parse the FLUSH_STOP event and retrieve the @reset_time member.</doc>
- <source-position filename="gst/gstevent.h" line="587"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="593">The event to parse</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="reset_time"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="594">if time should be reset</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_gap" c:identifier="gst_event_parse_gap">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="804">Extract timestamp and duration from a new GAP event.</doc>
- <source-position filename="gst/gstevent.h" line="624"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="806">a #GstEvent of type #GST_EVENT_GAP</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="timestamp"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="807">location where to store the
- start time (pts) of the gap, or %NULL</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="duration"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="809">location where to store the duration of
- the gap, or %NULL</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_gap_flags"
- c:identifier="gst_event_parse_gap_flags"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="850">Retrieve the gap flags that may have been set on a gap event with
-gst_event_set_gap_flags().</doc>
- <source-position filename="gst/gstevent.h" line="633"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="852">a #GstEvent of type #GST_EVENT_GAP</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="flags"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="853">a #GstGapFlags or %NULL</doc>
- <type name="GapFlags" c:type="GstGapFlags*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_group_id"
- c:identifier="gst_event_parse_group_id"
- version="1.2">
- <source-position filename="gst/gstevent.h" line="576"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1890">%TRUE if a group id was set on the event and could be parsed,
- %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1887">a stream-start event</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="group_id"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1888">address of variable where to store the group id</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_instant_rate_change"
- c:identifier="gst_event_parse_instant_rate_change"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2284">Extract rate and flags from an instant-rate-change event.</doc>
- <source-position filename="gst/gstevent.h" line="773"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2286">a #GstEvent of type #GST_EVENT_INSTANT_RATE_CHANGE</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="rate_multiplier"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2287">location in which to store the rate
- multiplier of the instant-rate-change event, or %NULL</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="new_flags"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2289">location in which to store the new
- segment flags of the instant-rate-change event, or %NULL</doc>
- <type name="SegmentFlags" c:type="GstSegmentFlags*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_instant_rate_sync_time"
- c:identifier="gst_event_parse_instant_rate_sync_time"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2360">Extract the rate multiplier and running times from an instant-rate-sync-time event.</doc>
- <source-position filename="gst/gstevent.h" line="784"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2362">a #GstEvent of type #GST_EVENT_INSTANT_RATE_CHANGE</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="rate_multiplier"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2363">location where to store the rate of
- the instant-rate-sync-time event, or %NULL</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="running_time"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2365">location in which to store the running time
- of the instant-rate-sync-time event, or %NULL</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="upstream_running_time"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2367">location in which to store the
- upstream running time of the instant-rate-sync-time event, or %NULL</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_latency" c:identifier="gst_event_parse_latency">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1531">Get the latency in the latency event.</doc>
- <source-position filename="gst/gstevent.h" line="735"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1533">The event to query</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="latency"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1534">A pointer to store the latency in.</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_protection"
- c:identifier="gst_event_parse_protection"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2146">Parses an event containing protection system specific information and stores
-the results in @system_id, @data and @origin. The data stored in @system_id,
-@origin and @data are valid until @event is released.</doc>
- <source-position filename="gst/gstevent.h" line="677"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2148">a #GST_EVENT_PROTECTION event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="system_id"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2149">pointer to store the UUID
-string uniquely identifying a content protection system.</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2151">pointer to store a #GstBuffer
-holding protection system specific information.</doc>
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- <parameter name="origin"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2153">pointer to store a value that
-indicates where the protection information carried by @event was extracted
-from.</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_qos" c:identifier="gst_event_parse_qos">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1232">Get the type, proportion, diff and timestamp in the qos event. See
-gst_event_new_qos() for more information about the different QoS values.
-
-@timestamp will be adjusted for any pad offsets of pads it was passing through.</doc>
- <source-position filename="gst/gstevent.h" line="703"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1234">The event to query</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="type"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1235">A pointer to store the QoS type in</doc>
- <type name="QOSType" c:type="GstQOSType*"/>
- </parameter>
- <parameter name="proportion"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1236">A pointer to store the proportion in</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="diff"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1237">A pointer to store the diff in</doc>
- <type name="ClockTimeDiff" c:type="GstClockTimeDiff*"/>
- </parameter>
- <parameter name="timestamp"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1238">A pointer to store the timestamp in</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_seek" c:identifier="gst_event_parse_seek">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1389">Parses a seek @event and stores the results in the given result locations.</doc>
- <source-position filename="gst/gstevent.h" line="713"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1391">a seek event</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="rate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1392">result location for the rate</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1393">result location for the stream format</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="flags"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1394">result location for the #GstSeekFlags</doc>
- <type name="SeekFlags" c:type="GstSeekFlags*"/>
- </parameter>
- <parameter name="start_type"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1395">result location for the #GstSeekType of the start position</doc>
- <type name="SeekType" c:type="GstSeekType*"/>
- </parameter>
- <parameter name="start"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1396">result location for the start position expressed in @format</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- <parameter name="stop_type"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1397">result location for the #GstSeekType of the stop position</doc>
- <type name="SeekType" c:type="GstSeekType*"/>
- </parameter>
- <parameter name="stop"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1398">result location for the stop position expressed in @format</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_seek_trickmode_interval"
- c:identifier="gst_event_parse_seek_trickmode_interval"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1464">Retrieve the trickmode interval that may have been set on a
-seek event with gst_event_set_seek_trickmode_interval().</doc>
- <source-position filename="gst/gstevent.h" line="722"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="interval"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_segment" c:identifier="gst_event_parse_segment">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="978">Parses a segment @event and stores the result in the given @segment location.
-@segment remains valid only until the @event is freed. Don't modify the segment
-and make a copy if you want to modify it or store it for later use.</doc>
- <source-position filename="gst/gstevent.h" line="650"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="980">The event to parse</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="segment"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="981">a pointer to a #GstSegment</doc>
- <type name="Segment" c:type="const GstSegment**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_segment_done"
- c:identifier="gst_event_parse_segment_done">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2214">Extracts the position and format from the segment done message.</doc>
- <source-position filename="gst/gstevent.h" line="765"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2216">A valid #GstEvent of type GST_EVENT_SEGMENT_DONE.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2217">Result location for the format, or %NULL</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="position"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2218">Result location for the position, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_select_streams"
- c:identifier="gst_event_parse_select_streams"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="661">Parse the SELECT_STREAMS event and retrieve the contained streams.</doc>
- <source-position filename="gst/gstevent.h" line="603"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="663">The event to parse</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="streams"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="664">the streams</doc>
- <type name="GLib.List" c:type="GList**">
- <type name="utf8"/>
- </type>
- </parameter>
- </parameters>
- </method>
- <method name="parse_sink_message"
- c:identifier="gst_event_parse_sink_message">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1689">Parse the sink-message event. Unref @msg after usage.</doc>
- <source-position filename="gst/gstevent.h" line="695"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1691">The event to query</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="msg"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1692">a pointer to store the #GstMessage in.</doc>
- <type name="Message" c:type="GstMessage**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_step" c:identifier="gst_event_parse_step">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1596">Parse the step event.</doc>
- <source-position filename="gst/gstevent.h" line="743"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1598">The event to query</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1599">a pointer to store the format in</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="amount"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1600">a pointer to store the amount in</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="rate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1601">a pointer to store the rate in</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="flush"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1602">a pointer to store the flush boolean in</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="intermediate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1603">a pointer to store the intermediate
- boolean in</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_stream"
- c:identifier="gst_event_parse_stream"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1799">Parse a stream-start @event and extract the #GstStream from it.</doc>
- <source-position filename="gst/gstevent.h" line="564"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1801">a stream-start event</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="stream"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1802">address of variable to store the stream</doc>
- <type name="Stream" c:type="GstStream**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_stream_collection"
- c:identifier="gst_event_parse_stream_collection"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1941">Retrieve new #GstStreamCollection from STREAM_COLLECTION event @event.</doc>
- <source-position filename="gst/gstevent.h" line="595"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1943">a stream-collection event</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="collection"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1944">pointer to store the collection</doc>
- <type name="StreamCollection" c:type="GstStreamCollection**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_stream_flags"
- c:identifier="gst_event_parse_stream_flags"
- version="1.2">
- <source-position filename="gst/gstevent.h" line="570"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1841">a stream-start event</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="flags"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1842">address of variable where to store the stream flags</doc>
- <type name="StreamFlags" c:type="GstStreamFlags*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_stream_group_done"
- c:identifier="gst_event_parse_stream_group_done"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="724">Parse a stream-group-done @event and store the result in the given
-@group_id location.</doc>
- <source-position filename="gst/gstevent.h" line="611"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="726">a stream-group-done event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="group_id"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="727">address of variable to store the group id into</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_stream_start"
- c:identifier="gst_event_parse_stream_start">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1753">Parse a stream-id @event and store the result in the given @stream_id
-location. The string stored in @stream_id must not be modified and will
-remain valid only until @event gets freed. Make a copy if you want to
-modify it or store it for later use.</doc>
- <source-position filename="gst/gstevent.h" line="558"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1755">a stream-start event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="stream_id"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1756">pointer to store the stream-id</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_tag" c:identifier="gst_event_parse_tag">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1055">Parses a tag @event and stores the results in the given @taglist location.
-No reference to the taglist will be returned, it remains valid only until
-the @event is freed. Don't modify or free the taglist, make a copy if you
-want to modify it or store it for later use.</doc>
- <source-position filename="gst/gstevent.h" line="661"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1057">a tag event</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="taglist"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1058">pointer to metadata list</doc>
- <type name="TagList" c:type="GstTagList**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_toc" c:identifier="gst_event_parse_toc">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2001">Parse a TOC @event and store the results in the given @toc and @updated locations.</doc>
- <source-position filename="gst/gstevent.h" line="669"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2003">a TOC event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="toc"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2004">pointer to #GstToc structure.</doc>
- <type name="Toc" c:type="GstToc**"/>
- </parameter>
- <parameter name="updated"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2005">pointer to store TOC updated flag.</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_toc_select"
- c:identifier="gst_event_parse_toc_select">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2050">Parse a TOC select @event and store the results in the given @uid location.</doc>
- <source-position filename="gst/gstevent.h" line="757"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2052">a TOC select event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="uid"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="2053">storage for the selection UID.</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_event_ref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="452">Increase the refcount of this event.</doc>
- <source-position filename="gst/gstevent.h" line="460"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="458">@event (for convenience when doing assignments)</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="454">The event to refcount</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_gap_flags"
- c:identifier="gst_event_set_gap_flags"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="829">Sets @flags on @event to give additional information about the reason for
-the #GST_EVENT_GAP.</doc>
- <source-position filename="gst/gstevent.h" line="629"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="831">a #GstEvent of type #GST_EVENT_GAP</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="832">a #GstGapFlags</doc>
- <type name="GapFlags" c:type="GstGapFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_group_id"
- c:identifier="gst_event_set_group_id"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1858">All streams that have the same group id are supposed to be played
-together, i.e. all streams inside a container file should have the
-same group id but different stream ids. The group id should change
-each time the stream is started, resulting in different group ids
-each time a file is played for example.
-
-Use gst_util_group_id_next() to get a new group id.</doc>
- <source-position filename="gst/gstevent.h" line="573"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1860">a stream-start event</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="group_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1861">the group id to set</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_running_time_offset"
- c:identifier="gst_event_set_running_time_offset"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="513">Set the running time offset of a event. See
-gst_event_get_running_time_offset() for more information.
-
-MT safe.</doc>
- <source-position filename="gst/gstevent.h" line="550"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="515">A #GstEvent.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="516">A the new running time offset</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_seek_trickmode_interval"
- c:identifier="gst_event_set_seek_trickmode_interval"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1443">Sets a trickmode interval on a (writable) seek event. Elements
-that support TRICKMODE_KEY_UNITS seeks SHOULD use this as the minimal
-interval between each frame they may output.</doc>
- <source-position filename="gst/gstevent.h" line="719"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="interval" transfer-ownership="none">
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_seqnum" c:identifier="gst_event_set_seqnum">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="462">Set the sequence number of a event.
-
-This function might be called by the creator of a event to indicate that the
-event relates to other events or messages. See gst_event_get_seqnum() for
-more information.
-
-MT safe.</doc>
- <source-position filename="gst/gstevent.h" line="542"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="464">A #GstEvent.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="seqnum" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="465">A sequence number.</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_stream"
- c:identifier="gst_event_set_stream"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1779">Set the @stream on the stream-start @event</doc>
- <source-position filename="gst/gstevent.h" line="561"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1781">a stream-start event</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1782">the stream object to set</doc>
- <type name="Stream" c:type="GstStream*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_stream_flags"
- c:identifier="gst_event_set_stream_flags"
- version="1.2">
- <source-position filename="gst/gstevent.h" line="567"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1823">a stream-start event</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="1824">the stream flags to set</doc>
- <type name="StreamFlags" c:type="GstStreamFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_event_unref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="467">Decrease the refcount of an event, freeing it if the refcount reaches 0.</doc>
- <source-position filename="gst/gstevent.h" line="473"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="469">the event to refcount</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="writable_structure"
- c:identifier="gst_event_writable_structure">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="355">Get a writable version of the structure.</doc>
- <source-position filename="gst/gstevent.h" line="528"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="361">The structure of the event. The structure
-is still owned by the event, which means that you should not free
-it and that the pointer becomes invalid when you free the event.
-This function checks if @event is writable and will never return
-%NULL.
-
-MT safe.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="357">The #GstEvent.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="replace"
- c:identifier="gst_event_replace"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="324">Modifies a pointer to a #GstEvent to point to a different #GstEvent. The
-modification is done atomically (so this is useful for ensuring thread safety
-in some cases), and the reference counts are updated appropriately (the old
-event is unreffed, the new one is reffed).
-
-Either @new_event or the #GstEvent pointed to by @old_event may be %NULL.</doc>
- <source-position filename="gst/gstevent.h" line="340"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="338">%TRUE if @new_event was different from @old_event</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="old_event"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="326">pointer to a
- pointer to a #GstEvent to be replaced.</doc>
- <type name="Event" c:type="GstEvent**"/>
- </parameter>
- <parameter name="new_event"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="328">pointer to a #GstEvent that will
- replace the event pointed to by @old_event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </function>
- <function name="steal" c:identifier="gst_event_steal" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="347">Atomically replace the #GstEvent pointed to by @old_event with %NULL and
-return the original event.</doc>
- <source-position filename="gst/gstevent.h" line="357"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="355">the #GstEvent that was in @old_event</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="old_event"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="349">pointer to a
- pointer to a #GstEvent to be stolen.</doc>
- <type name="Event" c:type="GstEvent**"/>
- </parameter>
- </parameters>
- </function>
- <function name="take" c:identifier="gst_event_take" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="364">Modifies a pointer to a #GstEvent to point to a different #GstEvent. This
-function is similar to gst_event_replace() except that it takes ownership of
-@new_event.
-
-Either @new_event or the #GstEvent pointed to by @old_event may be %NULL.</doc>
- <source-position filename="gst/gstevent.h" line="379"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="377">%TRUE if @new_event was different from @old_event</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="old_event"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="366">pointer to a
- pointer to a #GstEvent to be stolen.</doc>
- <type name="Event" c:type="GstEvent**"/>
- </parameter>
- <parameter name="new_event"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="368">pointer to a #GstEvent that will
- replace the event pointed to by @old_event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <enumeration name="EventType"
- glib:type-name="GstEventType"
- glib:get-type="gst_event_type_get_type"
- c:type="GstEventType">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="75">#GstEventType lists the standard event types that can be sent in a pipeline.
-
-The custom event types can be used for private messages between elements
-that can't be expressed using normal
-GStreamer buffer passing semantics. Custom events carry an arbitrary
-#GstStructure.
-Specific custom events are distinguished by the name of the structure.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_EVENT_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="77">unknown event.</doc>
- </member>
- <member name="flush_start"
- value="2563"
- c:identifier="GST_EVENT_FLUSH_START"
- glib:nick="flush-start">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="78">Start a flush operation. This event clears all data
- from the pipeline and unblock all streaming threads.</doc>
- </member>
- <member name="flush_stop"
- value="5127"
- c:identifier="GST_EVENT_FLUSH_STOP"
- glib:nick="flush-stop">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="80">Stop a flush operation. This event resets the
- running-time of the pipeline.</doc>
- </member>
- <member name="stream_start"
- value="10254"
- c:identifier="GST_EVENT_STREAM_START"
- glib:nick="stream-start">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="83">Event to mark the start of a new stream. Sent before any
- other serialized event and only sent at the start of a new stream,
- not after flushing seeks.</doc>
- </member>
- <member name="caps"
- value="12814"
- c:identifier="GST_EVENT_CAPS"
- glib:nick="caps">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="86">#GstCaps event. Notify the pad of a new media type.</doc>
- </member>
- <member name="segment"
- value="17934"
- c:identifier="GST_EVENT_SEGMENT"
- glib:nick="segment">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="87">A new media segment follows in the dataflow. The
- segment events contains information for clipping buffers and
- converting buffer timestamps to running-time and
- stream-time.</doc>
- </member>
- <member name="stream_collection"
- value="19230"
- c:identifier="GST_EVENT_STREAM_COLLECTION"
- glib:nick="stream-collection">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="91">A new #GstStreamCollection is available (Since: 1.10)</doc>
- </member>
- <member name="tag"
- value="20510"
- c:identifier="GST_EVENT_TAG"
- glib:nick="tag">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="92">A new set of metadata tags has been found in the stream.</doc>
- </member>
- <member name="buffersize"
- value="23054"
- c:identifier="GST_EVENT_BUFFERSIZE"
- glib:nick="buffersize">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="93">Notification of buffering requirements. Currently not
- used yet.</doc>
- </member>
- <member name="sink_message"
- value="25630"
- c:identifier="GST_EVENT_SINK_MESSAGE"
- glib:nick="sink-message">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="95">An event that sinks turn into a message. Used to
- send messages that should be emitted in sync with
- rendering.</doc>
- </member>
- <member name="stream_group_done"
- value="26894"
- c:identifier="GST_EVENT_STREAM_GROUP_DONE"
- glib:nick="stream-group-done">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="98">Indicates that there is no more data for
- the stream group ID in the message. Sent before EOS
- in some instances and should be handled mostly the same. (Since: 1.10)</doc>
- </member>
- <member name="eos"
- value="28174"
- c:identifier="GST_EVENT_EOS"
- glib:nick="eos">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="101">End-Of-Stream. No more data is to be expected to follow
- without either a STREAM_START event, or a FLUSH_STOP and a SEGMENT
- event.</doc>
- </member>
- <member name="toc"
- value="30750"
- c:identifier="GST_EVENT_TOC"
- glib:nick="toc">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="106">An event which indicates that a new table of contents (TOC)
- was found or updated.</doc>
- </member>
- <member name="protection"
- value="33310"
- c:identifier="GST_EVENT_PROTECTION"
- glib:nick="protection">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="108">An event which indicates that new or updated
- encryption information has been found in the stream.</doc>
- </member>
- <member name="segment_done"
- value="38406"
- c:identifier="GST_EVENT_SEGMENT_DONE"
- glib:nick="segment-done">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="104">Marks the end of a segment playback.</doc>
- </member>
- <member name="gap"
- value="40966"
- c:identifier="GST_EVENT_GAP"
- glib:nick="gap">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="105">Marks a gap in the datastream.</doc>
- </member>
- <member name="instant_rate_change"
- value="46090"
- c:identifier="GST_EVENT_INSTANT_RATE_CHANGE"
- glib:nick="instant-rate-change">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="124">Notify downstream that a playback rate override
- should be applied as soon as possible. (Since: 1.18)</doc>
- </member>
- <member name="qos"
- value="48641"
- c:identifier="GST_EVENT_QOS"
- glib:nick="qos">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="110">A quality message. Used to indicate to upstream elements
- that the downstream elements should adjust their processing
- rate.</doc>
- </member>
- <member name="seek"
- value="51201"
- c:identifier="GST_EVENT_SEEK"
- glib:nick="seek">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="113">A request for a new playback position and rate.</doc>
- </member>
- <member name="navigation"
- value="53761"
- c:identifier="GST_EVENT_NAVIGATION"
- glib:nick="navigation">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="114">Navigation events are usually used for communicating
- user requests, such as mouse or keyboard movements,
- to upstream elements.</doc>
- </member>
- <member name="latency"
- value="56321"
- c:identifier="GST_EVENT_LATENCY"
- glib:nick="latency">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="117">Notification of new latency adjustment. Sinks will use
- the latency information to adjust their synchronisation.</doc>
- </member>
- <member name="step"
- value="58881"
- c:identifier="GST_EVENT_STEP"
- glib:nick="step">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="119">A request for stepping through the media. Sinks will usually
- execute the step operation.</doc>
- </member>
- <member name="reconfigure"
- value="61441"
- c:identifier="GST_EVENT_RECONFIGURE"
- glib:nick="reconfigure">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="121">A request for upstream renegotiating caps and reconfiguring.</doc>
- </member>
- <member name="toc_select"
- value="64001"
- c:identifier="GST_EVENT_TOC_SELECT"
- glib:nick="toc-select">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="122">A request for a new playback position based on TOC
- entry's UID.</doc>
- </member>
- <member name="select_streams"
- value="66561"
- c:identifier="GST_EVENT_SELECT_STREAMS"
- glib:nick="select-streams">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="82">A request to select one or more streams (Since: 1.10)</doc>
- </member>
- <member name="instant_rate_sync_time"
- value="66817"
- c:identifier="GST_EVENT_INSTANT_RATE_SYNC_TIME"
- glib:nick="instant-rate-sync-time">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="126">Sent by the pipeline to notify elements that handle the
- instant-rate-change event about the running-time when
- the rate multiplier should be applied (or was applied). (Since: 1.18)</doc>
- </member>
- <member name="custom_upstream"
- value="69121"
- c:identifier="GST_EVENT_CUSTOM_UPSTREAM"
- glib:nick="custom-upstream">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="129">Upstream custom event</doc>
- </member>
- <member name="custom_downstream"
- value="71686"
- c:identifier="GST_EVENT_CUSTOM_DOWNSTREAM"
- glib:nick="custom-downstream">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="130">Downstream custom event that travels in the
- data flow.</doc>
- </member>
- <member name="custom_downstream_oob"
- value="74242"
- c:identifier="GST_EVENT_CUSTOM_DOWNSTREAM_OOB"
- glib:nick="custom-downstream-oob">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="132">Custom out-of-band downstream event.</doc>
- </member>
- <member name="custom_downstream_sticky"
- value="76830"
- c:identifier="GST_EVENT_CUSTOM_DOWNSTREAM_STICKY"
- glib:nick="custom-downstream-sticky">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="133">Custom sticky downstream event.</doc>
- </member>
- <member name="custom_both"
- value="79367"
- c:identifier="GST_EVENT_CUSTOM_BOTH"
- glib:nick="custom-both">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="134">Custom upstream or downstream event.
- In-band when travelling downstream.</doc>
- </member>
- <member name="custom_both_oob"
- value="81923"
- c:identifier="GST_EVENT_CUSTOM_BOTH_OOB"
- glib:nick="custom-both-oob">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="136">Custom upstream or downstream out-of-band event.</doc>
- </member>
- <function name="get_flags" c:identifier="gst_event_type_get_flags">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="198">Gets the #GstEventTypeFlags associated with @type.</doc>
- <source-position filename="gst/gstevent.h" line="448"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="204">a #GstEventTypeFlags.</doc>
- <type name="EventTypeFlags" c:type="GstEventTypeFlags"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="200">a #GstEventType</doc>
- <type name="EventType" c:type="GstEventType"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_name" c:identifier="gst_event_type_get_name">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="158">Get a printable name for the given event type. Do not modify or free.</doc>
- <source-position filename="gst/gstevent.h" line="441"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="164">a reference to the static name of the event.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="160">the event type</doc>
- <type name="EventType" c:type="GstEventType"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_quark" c:identifier="gst_event_type_to_quark">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="178">Get the unique quark for the given event type.</doc>
- <source-position filename="gst/gstevent.h" line="444"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="184">the quark associated with the event type</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="180">the event type</doc>
- <type name="EventType" c:type="GstEventType"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <bitfield name="EventTypeFlags"
- glib:type-name="GstEventTypeFlags"
- glib:get-type="gst_event_type_flags_get_type"
- c:type="GstEventTypeFlags">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="30">#GstEventTypeFlags indicate the aspects of the different #GstEventType
-values. You can get the type flags of a #GstEventType with the
-gst_event_type_get_flags() function.</doc>
- <member name="upstream"
- value="1"
- c:identifier="GST_EVENT_TYPE_UPSTREAM"
- glib:nick="upstream">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="32">Set if the event can travel upstream.</doc>
- </member>
- <member name="downstream"
- value="2"
- c:identifier="GST_EVENT_TYPE_DOWNSTREAM"
- glib:nick="downstream">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="33">Set if the event can travel downstream.</doc>
- </member>
- <member name="serialized"
- value="4"
- c:identifier="GST_EVENT_TYPE_SERIALIZED"
- glib:nick="serialized">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="34">Set if the event should be serialized with data
- flow.</doc>
- </member>
- <member name="sticky"
- value="8"
- c:identifier="GST_EVENT_TYPE_STICKY"
- glib:nick="sticky">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="36">Set if the event is sticky on the pads.</doc>
- </member>
- <member name="sticky_multi"
- value="16"
- c:identifier="GST_EVENT_TYPE_STICKY_MULTI"
- glib:nick="sticky-multi">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="37">Multiple sticky events can be on a pad, each
- identified by the event name.</doc>
- </member>
- </bitfield>
- <constant name="FLAG_SET_MASK_EXACT"
- value="4294967295"
- c:type="GST_FLAG_SET_MASK_EXACT"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="214">A mask value with all bits set, for use as a
-GstFlagSet mask where all flag bits must match
-exactly</doc>
- <source-position filename="gst/gstvalue.h" line="223"/>
- <type name="guint" c:type="guint"/>
- </constant>
- <constant name="FORMAT_PERCENT_MAX"
- value="1000000"
- c:type="GST_FORMAT_PERCENT_MAX">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="62">The PERCENT format is between 0 and this value</doc>
- <source-position filename="gst/gstformat.h" line="67"/>
- <type name="gint64" c:type="gint64"/>
- </constant>
- <constant name="FORMAT_PERCENT_SCALE"
- value="10000"
- c:type="GST_FORMAT_PERCENT_SCALE">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="68">The value used to scale down the reported PERCENT format value to
-its real value.</doc>
- <source-position filename="gst/gstformat.h" line="74"/>
- <type name="gint64" c:type="gint64"/>
- </constant>
- <function-macro name="FOURCC_ARGS"
- c:identifier="GST_FOURCC_ARGS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="77">Can be used together with #GST_FOURCC_FORMAT to properly output a
-#guint32 fourcc value in a printf\()-style text message.</doc>
- <source-position filename="gst/gstvalue.h" line="87"/>
- <parameters>
- <parameter name="fourcc">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="79">a #guint32 fourcc value to output</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="FOURCC_FORMAT"
- value="c%c%c%c"
- c:type="GST_FOURCC_FORMAT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="64">Can be used together with #GST_FOURCC_ARGS to properly output a
-#guint32 fourcc value in a printf\()-style text message.
-
-|[
-printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));
-]|</doc>
- <source-position filename="gst/gstvalue.h" line="75"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <class name="FlagSet"
- c:symbol-prefix="flagset"
- glib:type-name="GstFlagSet"
- glib:get-type="gst_flagset_get_type"
- glib:fundamental="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="376">A fundamental type that describes a 32-bit flag bitfield, with 32-bit
-mask indicating which of the bits in the field are explicitly set.</doc>
- <function name="register"
- c:identifier="gst_flagset_register"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="8091">Create a new sub-class of #GST_TYPE_FLAG_SET
-which will pretty-print the human-readable flags
-when serializing, for easier debugging.</doc>
- <source-position filename="gst/gstvalue.h" line="815"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- <parameters>
- <parameter name="flags_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="8093">a #GType of a #G_TYPE_FLAGS type.</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </function>
- </class>
- <enumeration name="FlowReturn"
- glib:type-name="GstFlowReturn"
- glib:get-type="gst_flow_return_get_type"
- c:type="GstFlowReturn">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="132">The result of passing data to a pad.
-
-Note that the custom return values should not be exposed outside of the
-element scope.</doc>
- <member name="custom_success_2"
- value="102"
- c:identifier="GST_FLOW_CUSTOM_SUCCESS_2"
- glib:nick="custom-success-2">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="149">Pre-defined custom success code.</doc>
- </member>
- <member name="custom_success_1"
- value="101"
- c:identifier="GST_FLOW_CUSTOM_SUCCESS_1"
- glib:nick="custom-success-1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="146">Pre-defined custom success code (define your
- custom success code to this to avoid compiler
- warnings).</doc>
- </member>
- <member name="custom_success"
- value="100"
- c:identifier="GST_FLOW_CUSTOM_SUCCESS"
- glib:nick="custom-success">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="143">Elements can use values starting from
- this (and higher) to define custom success
- codes.</doc>
- </member>
- <member name="ok" value="0" c:identifier="GST_FLOW_OK" glib:nick="ok">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="134">Data passing was ok.</doc>
- </member>
- <member name="not_linked"
- value="-1"
- c:identifier="GST_FLOW_NOT_LINKED"
- glib:nick="not-linked">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="135">Pad is not linked.</doc>
- </member>
- <member name="flushing"
- value="-2"
- c:identifier="GST_FLOW_FLUSHING"
- glib:nick="flushing">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="136">Pad is flushing.</doc>
- </member>
- <member name="eos"
- value="-3"
- c:identifier="GST_FLOW_EOS"
- glib:nick="eos">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="137">Pad is EOS.</doc>
- </member>
- <member name="not_negotiated"
- value="-4"
- c:identifier="GST_FLOW_NOT_NEGOTIATED"
- glib:nick="not-negotiated">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="138">Pad is not negotiated.</doc>
- </member>
- <member name="error"
- value="-5"
- c:identifier="GST_FLOW_ERROR"
- glib:nick="error">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="139">Some (fatal) error occurred. Element generating
- this error should post an error message using
- GST_ELEMENT_ERROR() with more details.</doc>
- </member>
- <member name="not_supported"
- value="-6"
- c:identifier="GST_FLOW_NOT_SUPPORTED"
- glib:nick="not-supported">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="142">This operation is not supported.</doc>
- </member>
- <member name="custom_error"
- value="-100"
- c:identifier="GST_FLOW_CUSTOM_ERROR"
- glib:nick="custom-error">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="150">Elements can use values starting from
- this (and lower) to define custom error codes.</doc>
- </member>
- <member name="custom_error_1"
- value="-101"
- c:identifier="GST_FLOW_CUSTOM_ERROR_1"
- glib:nick="custom-error-1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="152">Pre-defined custom error code (define your
- custom error code to this to avoid compiler
- warnings).</doc>
- </member>
- <member name="custom_error_2"
- value="-102"
- c:identifier="GST_FLOW_CUSTOM_ERROR_2"
- glib:nick="custom-error-2">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="155">Pre-defined custom error code.</doc>
- </member>
- </enumeration>
- <enumeration name="Format"
- glib:type-name="GstFormat"
- glib:get-type="gst_format_get_type"
- c:type="GstFormat">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="34">Standard predefined formats</doc>
- <member name="undefined"
- value="0"
- c:identifier="GST_FORMAT_UNDEFINED"
- glib:nick="undefined">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="36">undefined format</doc>
- </member>
- <member name="default"
- value="1"
- c:identifier="GST_FORMAT_DEFAULT"
- glib:nick="default">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="37">the default format of the pad/element. This can be
- samples for raw audio, frames/fields for raw video (some, but not all,
- elements support this; use @GST_FORMAT_TIME if you don't have a good
- reason to query for samples/frames)</doc>
- </member>
- <member name="bytes"
- value="2"
- c:identifier="GST_FORMAT_BYTES"
- glib:nick="bytes">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="41">bytes</doc>
- </member>
- <member name="time"
- value="3"
- c:identifier="GST_FORMAT_TIME"
- glib:nick="time">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="42">time in nanoseconds</doc>
- </member>
- <member name="buffers"
- value="4"
- c:identifier="GST_FORMAT_BUFFERS"
- glib:nick="buffers">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="43">buffers (few, if any, elements implement this as of
- May 2009)</doc>
- </member>
- <member name="percent"
- value="5"
- c:identifier="GST_FORMAT_PERCENT"
- glib:nick="percent">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="45">percentage of stream (few, if any, elements implement
- this as of May 2009)</doc>
- </member>
- <function name="get_by_nick" c:identifier="gst_format_get_by_nick">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="172">Return the format registered with the given nick.</doc>
- <source-position filename="gst/gstformat.h" line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="178">The format with @nick or GST_FORMAT_UNDEFINED
-if the format was not registered.</doc>
- <type name="Format" c:type="GstFormat"/>
- </return-value>
- <parameters>
- <parameter name="nick" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="174">The nick of the format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_details" c:identifier="gst_format_get_details">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="223">Get details about the given format.</doc>
- <source-position filename="gst/gstformat.h" line="119"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="229">The #GstFormatDefinition for @format or %NULL
-on failure.
-
-MT safe.</doc>
- <type name="FormatDefinition" c:type="const GstFormatDefinition*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="225">The format to get details of</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_name" c:identifier="gst_format_get_name">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="83">Get a printable name for the given format. Do not modify or free.</doc>
- <source-position filename="gst/gstformat.h" line="96"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="89">a reference to the static name of the format
-or %NULL if the format is unknown.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="85">a #GstFormat</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="iterate_definitions"
- c:identifier="gst_format_iterate_definitions">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="246">Iterate all the registered formats. The format definition is read
-only.</doc>
- <source-position filename="gst/gstformat.h" line="122"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="252">a GstIterator of #GstFormatDefinition.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- </function>
- <function name="register" c:identifier="gst_format_register">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="129">Create a new GstFormat based on the nick or return an
-already registered format with that nick.</doc>
- <source-position filename="gst/gstformat.h" line="104"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="137">A new GstFormat or an already registered format
-with the same nick.
-
-MT safe.</doc>
- <type name="Format" c:type="GstFormat"/>
- </return-value>
- <parameters>
- <parameter name="nick" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="131">The nick of the new format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="132">The description of the new format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_quark" c:identifier="gst_format_to_quark">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="106">Get the unique quark for the given format.</doc>
- <source-position filename="gst/gstformat.h" line="99"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="112">the quark associated with the format or 0 if the format
-is unknown.</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="108">a #GstFormat</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <record name="FormatDefinition" c:type="GstFormatDefinition">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="78">A format definition</doc>
- <source-position filename="gst/gstformat.h" line="93"/>
- <field name="value" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="80">The unique id of this format</doc>
- <type name="Format" c:type="GstFormat"/>
- </field>
- <field name="nick" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="81">A short nick of the format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="description" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="82">A longer description of the format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="quark" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstformat.h"
- line="83">A quark for the nick</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </field>
- </record>
- <class name="Fraction"
- c:symbol-prefix="fraction"
- glib:type-name="GstFraction"
- glib:get-type="gst_fraction_get_type"
- glib:fundamental="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="338">A fundamental type that describes a fraction of an integer numerator
-over an integer denominator</doc>
- </class>
- <class name="FractionRange"
- c:symbol-prefix="fraction_range"
- glib:type-name="GstFractionRange"
- glib:get-type="gst_fraction_range_get_type"
- glib:fundamental="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="278">A fundamental type that describes a #GstFractionRange range</doc>
- </class>
- <function-macro name="GHOST_PAD"
- c:identifier="GST_GHOST_PAD"
- introspectable="0">
- <source-position filename="gst/gstghostpad.h" line="84"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="GHOST_PAD_CAST"
- c:identifier="GST_GHOST_PAD_CAST"
- introspectable="0">
- <source-position filename="gst/gstghostpad.h" line="86"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="GHOST_PAD_CLASS"
- c:identifier="GST_GHOST_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst/gstghostpad.h" line="85"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="GROUP_ID_INVALID"
- value="0"
- c:type="GST_GROUP_ID_INVALID"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="120">A value which is guaranteed to never be returned by
-gst_util_group_id_next().
-
-Can be used as a default value in variables used to store group_id.</doc>
- <source-position filename="gst/gstutils.h" line="130"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <bitfield name="GapFlags"
- version="1.20"
- glib:type-name="GstGapFlags"
- glib:get-type="gst_gap_flags_get_type"
- c:type="GstGapFlags">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="407">The different flags that can be set on #GST_EVENT_GAP events. See
-gst_event_set_gap_flags() for details.</doc>
- <member name="data"
- value="1"
- c:identifier="GST_GAP_FLAG_MISSING_DATA"
- glib:nick="data">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="409">The #GST_EVENT_GAP signals missing data,
- for example because of packet loss.</doc>
- </member>
- </bitfield>
- <class name="GhostPad"
- c:symbol-prefix="ghost_pad"
- c:type="GstGhostPad"
- parent="ProxyPad"
- glib:type-name="GstGhostPad"
- glib:get-type="gst_ghost_pad_get_type"
- glib:type-struct="GhostPadClass">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="25">GhostPads are useful when organizing pipelines with #GstBin like elements.
-The idea here is to create hierarchical element graphs. The bin element
-contains a sub-graph. Now one would like to treat the bin-element like any
-other #GstElement. This is where GhostPads come into play. A GhostPad acts as
-a proxy for another pad. Thus the bin can have sink and source ghost-pads
-that are associated with sink and source pads of the child elements.
-
-If the target pad is known at creation time, gst_ghost_pad_new() is the
-function to use to get a ghost-pad. Otherwise one can use gst_ghost_pad_new_no_target()
-to create the ghost-pad and use gst_ghost_pad_set_target() to establish the
-association later on.
-
-Note that GhostPads add overhead to the data processing of a pipeline.</doc>
- <source-position filename="gst/gstghostpad.h" line="111"/>
- <constructor name="new" c:identifier="gst_ghost_pad_new">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="653">Create a new ghostpad with @target as the target. The direction will be taken
-from the target pad. @target must be unlinked.
-
-Will ref the target.</doc>
- <source-position filename="gst/gstghostpad.h" line="118"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="663">a new #GstPad, or %NULL in
-case of an error.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="655">the name of the new pad, or %NULL to assign a default name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="656">the pad to ghost.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_template"
- c:identifier="gst_ghost_pad_new_from_template">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="693">Create a new ghostpad with @target as the target. The direction will be taken
-from the target pad. The template used on the ghostpad will be @template.
-
-Will ref the target.</doc>
- <source-position filename="gst/gstghostpad.h" line="124"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="704">a new #GstPad, or %NULL in
-case of an error.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="695">the name of the new pad, or %NULL to assign a default name.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="696">the pad to ghost.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="697">the #GstPadTemplate to use on the ghostpad.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_no_target"
- c:identifier="gst_ghost_pad_new_no_target">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="625">Create a new ghostpad without a target with the given direction.
-A target can be set on the ghostpad later with the
-gst_ghost_pad_set_target() function.
-
-The created ghostpad will not have a padtemplate.</doc>
- <source-position filename="gst/gstghostpad.h" line="121"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="636">a new #GstPad, or %NULL in
-case of an error.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="627">the name of the new pad, or %NULL to assign a default name.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dir" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="628">the direction of the ghostpad</doc>
- <type name="PadDirection" c:type="GstPadDirection"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_no_target_from_template"
- c:identifier="gst_ghost_pad_new_no_target_from_template">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="739">Create a new ghostpad based on @templ, without setting a target. The
-direction will be taken from the @templ.</doc>
- <source-position filename="gst/gstghostpad.h" line="127"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="747">a new #GstPad, or %NULL in
-case of an error.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="741">the name of the new pad, or %NULL to assign a default name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="742">the #GstPadTemplate to create the ghostpad from.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </parameter>
- </parameters>
- </constructor>
- <function name="activate_mode_default"
- c:identifier="gst_ghost_pad_activate_mode_default">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="413">Invoke the default activate mode function of a ghost pad.</doc>
- <source-position filename="gst/gstghostpad.h" line="139"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="422">%TRUE if the operation was successful.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="415">the #GstPad to activate or deactivate.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="416">the parent of @pad or %NULL</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="417">the requested activation mode</doc>
- <type name="PadMode" c:type="GstPadMode"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="418">whether the pad should be active or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="internal_activate_mode_default"
- c:identifier="gst_ghost_pad_internal_activate_mode_default">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="322">Invoke the default activate mode function of a proxy pad that is
-owned by a ghost pad.</doc>
- <source-position filename="gst/gstghostpad.h" line="142"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="332">%TRUE if the operation was successful.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="324">the #GstPad to activate or deactivate.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="325">the parent of @pad or %NULL</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="326">the requested activation mode</doc>
- <type name="PadMode" c:type="GstPadMode"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="327">whether the pad should be active or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <method name="construct"
- c:identifier="gst_ghost_pad_construct"
- deprecated="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="577">Finish initialization of a newly allocated ghost pad.
-
-This function is most useful in language bindings and when subclassing
-#GstGhostPad; plugin and application developers normally will not call this
-function. Call this function directly after a call to g_object_new
-(GST_TYPE_GHOST_PAD, "direction", @dir, ..., NULL).</doc>
- <doc-deprecated xml:space="preserve">This function is deprecated since 1.18 and does nothing
-anymore.</doc-deprecated>
- <source-position filename="gst/gstghostpad.h" line="136"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="591">%TRUE if the construction succeeds, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="gpad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="579">the newly allocated ghost pad</doc>
- <type name="GhostPad" c:type="GstGhostPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_target" c:identifier="gst_ghost_pad_get_target">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="764">Get the target pad of @gpad. Unref target pad after usage.</doc>
- <source-position filename="gst/gstghostpad.h" line="130"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="770">the target #GstPad, can be
-%NULL if the ghostpad has no target set. Unref target pad after
-usage.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <instance-parameter name="gpad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="766">the #GstGhostPad</doc>
- <type name="GhostPad" c:type="GstGhostPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_target" c:identifier="gst_ghost_pad_set_target">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="788">Set the new target of the ghostpad @gpad. Any existing target
-is unlinked and links to the new target are established. if @newtarget is
-%NULL the target will be cleared.</doc>
- <source-position filename="gst/gstghostpad.h" line="133"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="797">%TRUE if the new target could be set. This function
- can return %FALSE when the internal pads could not be linked.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="gpad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="790">the #GstGhostPad</doc>
- <type name="GhostPad" c:type="GstGhostPad*"/>
- </instance-parameter>
- <parameter name="newtarget"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="791">the new pad target</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <field name="pad">
- <type name="ProxyPad" c:type="GstProxyPad"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="GhostPadPrivate" c:type="GstGhostPadPrivate*"/>
- </field>
- </class>
- <record name="GhostPadClass"
- c:type="GstGhostPadClass"
- glib:is-gtype-struct-for="GhostPad">
- <source-position filename="gst/gstghostpad.h" line="111"/>
- <field name="parent_class">
- <type name="ProxyPadClass" c:type="GstProxyPadClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="GhostPadPrivate" c:type="GstGhostPadPrivate" disguised="1">
- <source-position filename="gst/gstghostpad.h" line="94"/>
- </record>
- <function-macro name="IS_ALLOCATOR"
- c:identifier="GST_IS_ALLOCATOR"
- introspectable="0">
- <source-position filename="gst/gstallocator.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ALLOCATOR_CLASS"
- c:identifier="GST_IS_ALLOCATOR_CLASS"
- introspectable="0">
- <source-position filename="gst/gstallocator.h" line="36"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BIN" c:identifier="GST_IS_BIN" introspectable="0">
- <source-position filename="gst/gstbin.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BIN_CLASS"
- c:identifier="GST_IS_BIN_CLASS"
- introspectable="0">
- <source-position filename="gst/gstbin.h" line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BUFFER"
- c:identifier="GST_IS_BUFFER"
- introspectable="0">
- <source-position filename="gst/gstbuffer.h" line="42"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BUFFER_LIST"
- c:identifier="GST_IS_BUFFER_LIST"
- introspectable="0">
- <source-position filename="gst/gstbufferlist.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BUFFER_POOL"
- c:identifier="GST_IS_BUFFER_POOL"
- introspectable="0">
- <source-position filename="gst/gstbufferpool.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BUFFER_POOL_CLASS"
- c:identifier="GST_IS_BUFFER_POOL_CLASS"
- introspectable="0">
- <source-position filename="gst/gstbufferpool.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BUS" c:identifier="GST_IS_BUS" introspectable="0">
- <source-position filename="gst/gstbus.h" line="37"/>
- <parameters>
- <parameter name="bus">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BUS_CLASS"
- c:identifier="GST_IS_BUS_CLASS"
- introspectable="0">
- <source-position filename="gst/gstbus.h" line="39"/>
- <parameters>
- <parameter name="bclass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_CAPS"
- c:identifier="GST_IS_CAPS"
- introspectable="0">
- <source-position filename="gst/gstcaps.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_CAPS_FEATURES"
- c:identifier="GST_IS_CAPS_FEATURES"
- introspectable="0">
- <source-position filename="gst/gstcapsfeatures.h" line="36"/>
- <parameters>
- <parameter name="object">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_CHILD_PROXY"
- c:identifier="GST_IS_CHILD_PROXY"
- introspectable="0">
- <source-position filename="gst/gstchildproxy.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_CLOCK"
- c:identifier="GST_IS_CLOCK"
- introspectable="0">
- <source-position filename="gst/gstclock.h" line="35"/>
- <parameters>
- <parameter name="clock">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_CLOCK_CLASS"
- c:identifier="GST_IS_CLOCK_CLASS"
- introspectable="0">
- <source-position filename="gst/gstclock.h" line="37"/>
- <parameters>
- <parameter name="cclass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_CONTEXT"
- c:identifier="GST_IS_CONTEXT"
- introspectable="0">
- <source-position filename="gst/gstcontext.h" line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_CONTROL_BINDING"
- c:identifier="GST_IS_CONTROL_BINDING"
- introspectable="0">
- <source-position filename="gst/gstcontrolbinding.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_CONTROL_BINDING_CLASS"
- c:identifier="GST_IS_CONTROL_BINDING_CLASS"
- introspectable="0">
- <source-position filename="gst/gstcontrolbinding.h" line="39"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_CONTROL_SOURCE"
- c:identifier="GST_IS_CONTROL_SOURCE"
- introspectable="0">
- <source-position filename="gst/gstcontrolsource.h" line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_CONTROL_SOURCE_CLASS"
- c:identifier="GST_IS_CONTROL_SOURCE_CLASS"
- introspectable="0">
- <source-position filename="gst/gstcontrolsource.h" line="41"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DEVICE"
- c:identifier="GST_IS_DEVICE"
- introspectable="0">
- <source-position filename="gst/gstdevice.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DEVICE_CLASS"
- c:identifier="GST_IS_DEVICE_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdevice.h" line="39"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DEVICE_MONITOR"
- c:identifier="GST_IS_DEVICE_MONITOR"
- introspectable="0">
- <source-position filename="gst/gstdevicemonitor.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DEVICE_MONITOR_CLASS"
- c:identifier="GST_IS_DEVICE_MONITOR_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdevicemonitor.h" line="39"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DEVICE_PROVIDER"
- c:identifier="GST_IS_DEVICE_PROVIDER"
- introspectable="0">
- <source-position filename="gst/gstdeviceprovider.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DEVICE_PROVIDER_CLASS"
- c:identifier="GST_IS_DEVICE_PROVIDER_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdeviceprovider.h" line="39"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DEVICE_PROVIDER_FACTORY"
- c:identifier="GST_IS_DEVICE_PROVIDER_FACTORY"
- introspectable="0">
- <source-position filename="gst/gstdeviceproviderfactory.h" line="59"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DEVICE_PROVIDER_FACTORY_CLASS"
- c:identifier="GST_IS_DEVICE_PROVIDER_FACTORY_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdeviceproviderfactory.h" line="60"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DYNAMIC_TYPE_FACTORY"
- c:identifier="GST_IS_DYNAMIC_TYPE_FACTORY"
- introspectable="0">
- <source-position filename="gst/gstdynamictypefactory.h" line="46"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DYNAMIC_TYPE_FACTORY_CLASS"
- c:identifier="GST_IS_DYNAMIC_TYPE_FACTORY_CLASS"
- introspectable="0">
- <source-position filename="gst/gstdynamictypefactory.h" line="47"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ELEMENT"
- c:identifier="GST_IS_ELEMENT"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="59"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ELEMENT_CLASS"
- c:identifier="GST_IS_ELEMENT_CLASS"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="60"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ELEMENT_FACTORY"
- c:identifier="GST_IS_ELEMENT_FACTORY"
- introspectable="0">
- <source-position filename="gst/gstelementfactory.h" line="49"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ELEMENT_FACTORY_CLASS"
- c:identifier="GST_IS_ELEMENT_FACTORY_CLASS"
- introspectable="0">
- <source-position filename="gst/gstelementfactory.h" line="50"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_EVENT"
- c:identifier="GST_IS_EVENT"
- introspectable="0">
- <source-position filename="gst/gstevent.h" line="236"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_GHOST_PAD"
- c:identifier="GST_IS_GHOST_PAD"
- introspectable="0">
- <source-position filename="gst/gstghostpad.h" line="82"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_GHOST_PAD_CLASS"
- c:identifier="GST_IS_GHOST_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst/gstghostpad.h" line="83"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_MESSAGE"
- c:identifier="GST_IS_MESSAGE"
- introspectable="0">
- <source-position filename="gst/gstmessage.h" line="200"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_MINI_OBJECT_TYPE"
- c:identifier="GST_IS_MINI_OBJECT_TYPE"
- introspectable="0">
- <source-position filename="gst/gstminiobject.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- <parameter name="type">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_OBJECT"
- c:identifier="GST_IS_OBJECT"
- introspectable="0">
- <source-position filename="gst/gstobject.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_OBJECT_CLASS"
- c:identifier="GST_IS_OBJECT_CLASS"
- introspectable="0">
- <source-position filename="gst/gstobject.h" line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PAD" c:identifier="GST_IS_PAD" introspectable="0">
- <source-position filename="gst/gstpad.h" line="84"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PAD_CLASS"
- c:identifier="GST_IS_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="85"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PAD_TEMPLATE"
- c:identifier="GST_IS_PAD_TEMPLATE"
- introspectable="0">
- <source-position filename="gst/gstpadtemplate.h" line="47"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PAD_TEMPLATE_CLASS"
- c:identifier="GST_IS_PAD_TEMPLATE_CLASS"
- introspectable="0">
- <source-position filename="gst/gstpadtemplate.h" line="48"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PARAM_SPEC_ARRAY_LIST"
- c:identifier="GST_IS_PARAM_SPEC_ARRAY_LIST"
- introspectable="0">
- <source-position filename="gst/gstparamspecs.h" line="117"/>
- <parameters>
- <parameter name="pspec">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PARAM_SPEC_FRACTION"
- c:identifier="GST_IS_PARAM_SPEC_FRACTION"
- introspectable="0">
- <source-position filename="gst/gstparamspecs.h" line="104"/>
- <parameters>
- <parameter name="pspec">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PIPELINE"
- c:identifier="GST_IS_PIPELINE"
- introspectable="0">
- <source-position filename="gst/gstpipeline.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PIPELINE_CLASS"
- c:identifier="GST_IS_PIPELINE_CLASS"
- introspectable="0">
- <source-position filename="gst/gstpipeline.h" line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PLUGIN"
- c:identifier="GST_IS_PLUGIN"
- introspectable="0">
- <source-position filename="gst/gstplugin.h" line="189"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PLUGIN_CLASS"
- c:identifier="GST_IS_PLUGIN_CLASS"
- introspectable="0">
- <source-position filename="gst/gstplugin.h" line="190"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PLUGIN_FEATURE"
- c:identifier="GST_IS_PLUGIN_FEATURE"
- introspectable="0">
- <source-position filename="gst/gstpluginfeature.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PLUGIN_FEATURE_CLASS"
- c:identifier="GST_IS_PLUGIN_FEATURE_CLASS"
- introspectable="0">
- <source-position filename="gst/gstpluginfeature.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PRESET"
- c:identifier="GST_IS_PRESET"
- introspectable="0">
- <source-position filename="gst/gstpreset.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PROXY_PAD"
- c:identifier="GST_IS_PROXY_PAD"
- introspectable="0">
- <source-position filename="gst/gstghostpad.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PROXY_PAD_CLASS"
- c:identifier="GST_IS_PROXY_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst/gstghostpad.h" line="36"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_QUERY"
- c:identifier="GST_IS_QUERY"
- introspectable="0">
- <source-position filename="gst/gstquery.h" line="134"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_REGISTRY"
- c:identifier="GST_IS_REGISTRY"
- introspectable="0">
- <source-position filename="gst/gstregistry.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_REGISTRY_CLASS"
- c:identifier="GST_IS_REGISTRY_CLASS"
- introspectable="0">
- <source-position filename="gst/gstregistry.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_SAMPLE"
- c:identifier="GST_IS_SAMPLE"
- introspectable="0">
- <source-position filename="gst/gstsample.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_SHARED_TASK_POOL"
- c:identifier="GST_IS_SHARED_TASK_POOL"
- introspectable="0">
- <source-position filename="gst/gsttaskpool.h" line="128"/>
- <parameters>
- <parameter name="pool">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_SHARED_TASK_POOL_CLASS"
- c:identifier="GST_IS_SHARED_TASK_POOL_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttaskpool.h" line="130"/>
- <parameters>
- <parameter name="pclass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_STREAM"
- c:identifier="GST_IS_STREAM"
- introspectable="0">
- <source-position filename="gst/gststreams.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_STREAM_CLASS"
- c:identifier="GST_IS_STREAM_CLASS"
- introspectable="0">
- <source-position filename="gst/gststreams.h" line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_STREAM_COLLECTION"
- c:identifier="GST_IS_STREAM_COLLECTION"
- introspectable="0">
- <source-position filename="gst/gststreamcollection.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_STREAM_COLLECTION_CLASS"
- c:identifier="GST_IS_STREAM_COLLECTION_CLASS"
- introspectable="0">
- <source-position filename="gst/gststreamcollection.h" line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_STRUCTURE"
- c:identifier="GST_IS_STRUCTURE"
- introspectable="0">
- <source-position filename="gst/gststructure.h" line="36"/>
- <parameters>
- <parameter name="object">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_SYSTEM_CLOCK"
- c:identifier="GST_IS_SYSTEM_CLOCK"
- introspectable="0">
- <source-position filename="gst/gstsystemclock.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_SYSTEM_CLOCK_CLASS"
- c:identifier="GST_IS_SYSTEM_CLOCK_CLASS"
- introspectable="0">
- <source-position filename="gst/gstsystemclock.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TAG_LIST"
- c:identifier="GST_IS_TAG_LIST"
- introspectable="0">
- <source-position filename="gst/gsttaglist.h" line="112"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TAG_SETTER"
- c:identifier="GST_IS_TAG_SETTER"
- introspectable="0">
- <source-position filename="gst/gsttagsetter.h" line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TASK"
- c:identifier="GST_IS_TASK"
- introspectable="0">
- <source-position filename="gst/gsttask.h" line="43"/>
- <parameters>
- <parameter name="task">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TASK_CLASS"
- c:identifier="GST_IS_TASK_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttask.h" line="45"/>
- <parameters>
- <parameter name="tclass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TASK_POOL"
- c:identifier="GST_IS_TASK_POOL"
- introspectable="0">
- <source-position filename="gst/gsttaskpool.h" line="32"/>
- <parameters>
- <parameter name="pool">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TASK_POOL_CLASS"
- c:identifier="GST_IS_TASK_POOL_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttaskpool.h" line="34"/>
- <parameters>
- <parameter name="pclass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TOC_SETTER"
- c:identifier="GST_IS_TOC_SETTER"
- introspectable="0">
- <source-position filename="gst/gsttocsetter.h" line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TRACER"
- c:identifier="GST_IS_TRACER"
- introspectable="0">
- <source-position filename="gst/gsttracer.h" line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TRACER_CLASS"
- c:identifier="GST_IS_TRACER_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttracer.h" line="40"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TRACER_FACTORY"
- c:identifier="GST_IS_TRACER_FACTORY"
- introspectable="0">
- <source-position filename="gst/gsttracerfactory.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TRACER_FACTORY_CLASS"
- c:identifier="GST_IS_TRACER_FACTORY_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttracerfactory.h" line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TRACER_RECORD"
- c:identifier="GST_IS_TRACER_RECORD"
- introspectable="0">
- <source-position filename="gst/gsttracerrecord.h" line="42"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TRACER_RECORD_CLASS"
- c:identifier="GST_IS_TRACER_RECORD_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttracerrecord.h" line="43"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TYPE_FIND_FACTORY"
- c:identifier="GST_IS_TYPE_FIND_FACTORY"
- introspectable="0">
- <source-position filename="gst/gsttypefindfactory.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TYPE_FIND_FACTORY_CLASS"
- c:identifier="GST_IS_TYPE_FIND_FACTORY_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttypefindfactory.h" line="36"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_URI" c:identifier="GST_IS_URI" introspectable="0">
- <source-position filename="gst/gsturi.h" line="189"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_URI_HANDLER"
- c:identifier="GST_IS_URI_HANDLER"
- introspectable="0">
- <source-position filename="gst/gsturi.h" line="94"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ITERATOR"
- c:identifier="GST_ITERATOR"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="153">Macro to cast to a #GstIterator</doc>
- <source-position filename="gst/gstiterator.h" line="159"/>
- <parameters>
- <parameter name="it">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="155">the #GstIterator value</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ITERATOR_COOKIE"
- c:identifier="GST_ITERATOR_COOKIE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="167">Macro to get the cookie of a #GstIterator. The cookie of the
-iterator is the value of the master cookie when the iterator
-was created.
-Whenever the iterator is iterated, the value is compared to the
-value of the master cookie. If they are different, a concurrent
-modification happened to the iterator and a resync is needed.</doc>
- <source-position filename="gst/gstiterator.h" line="178"/>
- <parameters>
- <parameter name="it">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="169">the #GstIterator to get the cookie of</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ITERATOR_LOCK"
- c:identifier="GST_ITERATOR_LOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="160">Macro to get the lock protecting the datastructure being iterated.</doc>
- <source-position filename="gst/gstiterator.h" line="166"/>
- <parameters>
- <parameter name="it">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="162">the #GstIterator to get the lock of</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ITERATOR_ORIG_COOKIE"
- c:identifier="GST_ITERATOR_ORIG_COOKIE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="179">Macro to get a pointer to where the master cookie is stored. The
-master cookie protects the structure being iterated and gets updated
-whenever the datastructure changes.</doc>
- <source-position filename="gst/gstiterator.h" line="187"/>
- <parameters>
- <parameter name="it">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="181">the #GstIterator to get the master cookie of</doc>
- </parameter>
- </parameters>
- </function-macro>
- <class name="Int64Range"
- c:symbol-prefix="int64_range"
- glib:type-name="GstInt64Range"
- glib:get-type="gst_int64_range_get_type"
- glib:fundamental="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="244">A fundamental type that describes a #gint64 range</doc>
- </class>
- <class name="IntRange"
- c:symbol-prefix="int_range"
- glib:type-name="GstIntRange"
- glib:get-type="gst_int_range_get_type"
- glib:fundamental="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="227">A fundamental type that describes a #gint range</doc>
- </class>
- <record name="Iterator"
- c:type="GstIterator"
- glib:type-name="GstIterator"
- glib:get-type="gst_iterator_get_type"
- c:symbol-prefix="iterator">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="23">A GstIterator is used to retrieve multiple objects from another object in
-a threadsafe way.
-
-Various GStreamer objects provide access to their internal structures using
-an iterator.
-
-Note that if calling a GstIterator function results in your code receiving
-a refcounted object (with, say, g_value_get_object()), the refcount for that
-object will not be increased. Your code is responsible for taking a reference
-if it wants to continue using it later.
-
-The basic use pattern of an iterator is as follows:
-|[&lt;!-- language="C" --&gt;
- GstIterator *it = _get_iterator(object);
- GValue item = G_VALUE_INIT;
- done = FALSE;
- while (!done) {
- switch (gst_iterator_next (it, &amp;amp;item)) {
- case GST_ITERATOR_OK:
- ...get/use/change item here...
- g_value_reset (&amp;amp;item);
- break;
- case GST_ITERATOR_RESYNC:
- ...rollback changes to items...
- gst_iterator_resync (it);
- break;
- case GST_ITERATOR_ERROR:
- ...wrong parameters were given...
- done = TRUE;
- break;
- case GST_ITERATOR_DONE:
- done = TRUE;
- break;
- }
- }
- g_value_unset (&amp;amp;item);
- gst_iterator_free (it);
-]|</doc>
- <source-position filename="gst/gstiterator.h" line="226"/>
- <field name="copy" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="191">The function to copy the iterator</doc>
- <type name="IteratorCopyFunction" c:type="GstIteratorCopyFunction"/>
- </field>
- <field name="next" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="192">The function to get the next item in the iterator</doc>
- <type name="IteratorNextFunction" c:type="GstIteratorNextFunction"/>
- </field>
- <field name="item" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="193">The function to be called for each item retrieved</doc>
- <type name="IteratorItemFunction" c:type="GstIteratorItemFunction"/>
- </field>
- <field name="resync" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="194">The function to call when a resync is needed.</doc>
- <type name="IteratorResyncFunction"
- c:type="GstIteratorResyncFunction"/>
- </field>
- <field name="free" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="195">The function to call when the iterator is freed</doc>
- <type name="IteratorFreeFunction" c:type="GstIteratorFreeFunction"/>
- </field>
- <field name="pushed" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="196">The iterator that is currently pushed with gst_iterator_push()</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </field>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="197">The type of the object that this iterator will return</doc>
- <type name="GType" c:type="GType"/>
- </field>
- <field name="lock" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="198">The lock protecting the data structure and the cookie.</doc>
- <type name="GLib.Mutex" c:type="GMutex*"/>
- </field>
- <field name="cookie" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="199">The cookie; the value of the master_cookie when this iterator was
- created.</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="master_cookie" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="201">A pointer to the master cookie.</doc>
- <type name="guint32" c:type="guint32*"/>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="202">the size of the iterator</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <constructor name="new"
- c:identifier="gst_iterator_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="120">Create a new iterator. This function is mainly used for objects
-implementing the next/resync/free function to iterate a data structure.
-
-For each item retrieved, the @item function is called with the lock
-held. The @free function is called when the iterator is freed.</doc>
- <source-position filename="gst/gstiterator.h" line="234"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="139">the new #GstIterator.
-
-MT safe.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="122">the size of the iterator structure</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="123">#GType of children</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="lock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="124">pointer to a #GMutex.</doc>
- <type name="GLib.Mutex" c:type="GMutex*"/>
- </parameter>
- <parameter name="master_cookie" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="125">pointer to a guint32 that is changed when the items in the
- iterator changed.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="copy" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="127">copy function</doc>
- <type name="IteratorCopyFunction"
- c:type="GstIteratorCopyFunction"/>
- </parameter>
- <parameter name="next" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="128">function to get next item</doc>
- <type name="IteratorNextFunction"
- c:type="GstIteratorNextFunction"/>
- </parameter>
- <parameter name="item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="129">function to call on each item retrieved</doc>
- <type name="IteratorItemFunction"
- c:type="GstIteratorItemFunction"/>
- </parameter>
- <parameter name="resync" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="130">function to resync the iterator</doc>
- <type name="IteratorResyncFunction"
- c:type="GstIteratorResyncFunction"/>
- </parameter>
- <parameter name="free" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="131">function to free the iterator</doc>
- <type name="IteratorFreeFunction"
- c:type="GstIteratorFreeFunction"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_list"
- c:identifier="gst_iterator_new_list"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="218">Create a new iterator designed for iterating @list.
-
-The list you iterate is usually part of a data structure @owner and is
-protected with @lock.
-
-The iterator will use @lock to retrieve the next item of the list and it
-will then call the @item function before releasing @lock again.
-
-When a concurrent update to the list is performed, usually by @owner while
-holding @lock, @master_cookie will be updated. The iterator implementation
-will notice the update of the cookie and will return %GST_ITERATOR_RESYNC to
-the user of the iterator in the next call to gst_iterator_next().</doc>
- <source-position filename="gst/gstiterator.h" line="244"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="241">the new #GstIterator for @list.
-
-MT safe.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="220">#GType of elements</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="lock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="221">pointer to a #GMutex protecting the list.</doc>
- <type name="GLib.Mutex" c:type="GMutex*"/>
- </parameter>
- <parameter name="master_cookie" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="222">pointer to a guint32 that is incremented when the list
- is changed.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="224">pointer to the list</doc>
- <type name="GLib.List" c:type="GList**">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </parameter>
- <parameter name="owner" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="225">object owning the list</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="226">function to call on each item retrieved</doc>
- <type name="IteratorItemFunction"
- c:type="GstIteratorItemFunction"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_single" c:identifier="gst_iterator_new_single">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="796">This #GstIterator is a convenient iterator for the common
-case where a #GstIterator needs to be returned but only
-a single object has to be considered. This happens often
-for the #GstPadIterIntLinkFunction.</doc>
- <source-position filename="gst/gstiterator.h" line="251"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="806">the new #GstIterator for @object.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="798">#GType of the passed object</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="799">object that this iterator should return</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="copy" c:identifier="gst_iterator_copy">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="73">Copy the iterator and its state.</doc>
- <source-position filename="gst/gstiterator.h" line="254"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="79">a new copy of @it.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="75">a #GstIterator</doc>
- <type name="Iterator" c:type="const GstIterator*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="filter" c:identifier="gst_iterator_filter">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="527">Create a new iterator from an existing iterator. The new iterator
-will only return those elements that match the given compare function @func.
-The first parameter that is passed to @func is the #GValue of the current
-iterator element and the second parameter is @user_data. @func should
-return 0 for elements that should be included in the filtered iterator.
-
-When this iterator is freed, @it will also be freed.</doc>
- <source-position filename="gst/gstiterator.h" line="273"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="541">a new #GstIterator.
-
-MT safe.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="529">The #GstIterator to filter</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </instance-parameter>
- <parameter name="func" transfer-ownership="none" scope="call">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="530">the compare function to select elements</doc>
- <type name="GLib.CompareFunc" c:type="GCompareFunc"/>
- </parameter>
- <parameter name="user_data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="531">user data passed to the compare function</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="find_custom" c:identifier="gst_iterator_find_custom">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="697">Find the first element in @it that matches the compare function @func.
-@func should return 0 when the element is found. The first parameter
-to @func will be the current element of the iterator and the
-second parameter will be @user_data.
-The result will be stored in @elem if a result is found.
-
-The iterator will not be freed.
-
-This function will return %FALSE if an error happened to the iterator
-or if the element wasn't found.</doc>
- <source-position filename="gst/gstiterator.h" line="283"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="715">Returns %TRUE if the element was found, else %FALSE.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="699">The #GstIterator to iterate</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="700">the compare function to use</doc>
- <type name="GLib.CompareFunc" c:type="GCompareFunc"/>
- </parameter>
- <parameter name="elem"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="701">pointer to a #GValue where to store the result</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="702">user data passed to the compare function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="fold" c:identifier="gst_iterator_fold">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="577">Folds @func over the elements of @iter. That is to say, @func will be called
-as @func (object, @ret, @user_data) for each object in @it. The normal use
-of this procedure is to accumulate the results of operating on the objects in
-@ret.
-
-This procedure can be used (and is used internally) to implement the
-gst_iterator_foreach() and gst_iterator_find_custom() operations.
-
-The fold will proceed as long as @func returns %TRUE. When the iterator has no
-more arguments, %GST_ITERATOR_DONE will be returned. If @func returns %FALSE,
-the fold will stop, and %GST_ITERATOR_OK will be returned. Errors or resyncs
-will cause fold to return %GST_ITERATOR_ERROR or %GST_ITERATOR_RESYNC as
-appropriate.
-
-The iterator will not be freed.</doc>
- <source-position filename="gst/gstiterator.h" line="276"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="600">A #GstIteratorResult, as described above.
-
-MT safe.</doc>
- <type name="IteratorResult" c:type="GstIteratorResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="579">The #GstIterator to fold over</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="580">the fold function</doc>
- <type name="IteratorFoldFunction"
- c:type="GstIteratorFoldFunction"/>
- </parameter>
- <parameter name="ret" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="581">the seed value passed to the fold function</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="582">user data passed to the fold function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="foreach" c:identifier="gst_iterator_foreach">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="650">Iterate over all element of @it and call the given function @func for
-each element.</doc>
- <source-position filename="gst/gstiterator.h" line="280"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="659">the result call to gst_iterator_fold(). The iterator will not be
-freed.
-
-MT safe.</doc>
- <type name="IteratorResult" c:type="GstIteratorResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="652">The #GstIterator to iterate</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="653">the function to call for each element.</doc>
- <type name="IteratorForeachFunction"
- c:type="GstIteratorForeachFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="654">user data passed to the function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_iterator_free">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="408">Free the iterator.
-
-MT safe.</doc>
- <source-position filename="gst/gstiterator.h" line="265"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="410">The #GstIterator to free</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="next" c:identifier="gst_iterator_next">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="295">Get the next item from the iterator in @elem.
-
-Only when this function returns %GST_ITERATOR_OK, @elem will contain a valid
-value. @elem must have been initialized to the type of the iterator or
-initialized to zeroes with g_value_unset(). The caller is responsible for
-unsetting or resetting @elem with g_value_unset() or g_value_reset()
-after usage.
-
-When this function returns %GST_ITERATOR_DONE, no more elements can be
-retrieved from @it.
-
-A return value of %GST_ITERATOR_RESYNC indicates that the element list was
-concurrently updated. The user of @it should call gst_iterator_resync() to
-get the newly updated list.
-
-A return value of %GST_ITERATOR_ERROR indicates an unrecoverable fatal error.</doc>
- <source-position filename="gst/gstiterator.h" line="259"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="317">The result of the iteration. Unset @elem after usage.
-
-MT safe.</doc>
- <type name="IteratorResult" c:type="GstIteratorResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="297">The #GstIterator to iterate</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </instance-parameter>
- <parameter name="elem"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="298">pointer to hold next element</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="push" c:identifier="gst_iterator_push">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="428">Pushes @other iterator onto @it. All calls performed on @it are
-forwarded to @other. If @other returns %GST_ITERATOR_DONE, it is
-popped again and calls are handled by @it again.
-
-This function is mainly used by objects implementing the iterator
-next function to recurse into substructures.
-
-When gst_iterator_resync() is called on @it, @other will automatically be
-popped.
-
-MT safe.</doc>
- <source-position filename="gst/gstiterator.h" line="268"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="430">The #GstIterator to use</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </instance-parameter>
- <parameter name="other" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="431">The #GstIterator to push</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </parameter>
- </parameters>
- </method>
- <method name="resync" c:identifier="gst_iterator_resync">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="381">Resync the iterator. this function is mostly called
-after gst_iterator_next() returned %GST_ITERATOR_RESYNC.
-
-When an iterator was pushed on @it, it will automatically be popped again
-with this function.
-
-MT safe.</doc>
- <source-position filename="gst/gstiterator.h" line="262"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.c"
- line="383">The #GstIterator to resync</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <callback name="IteratorCopyFunction" c:type="GstIteratorCopyFunction">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="65">This function will be called when creating a copy of @it and should
-create a copy of all custom iterator fields or increase their
-reference counts.</doc>
- <source-position filename="gst/gstiterator.h" line="74"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="67">The original iterator</doc>
- <type name="Iterator" c:type="const GstIterator*"/>
- </parameter>
- <parameter name="copy" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="68">The copied iterator</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="IteratorFoldFunction" c:type="GstIteratorFoldFunction">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="141">A function to be passed to gst_iterator_fold().</doc>
- <source-position filename="gst/gstiterator.h" line="151"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="149">%TRUE if the fold should continue, %FALSE if it should stop.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="143">the item to fold</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="ret" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="144">a #GValue collecting the result</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="145">data passed to gst_iterator_fold()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="IteratorForeachFunction"
- c:type="GstIteratorForeachFunction">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="132">A function that is called by gst_iterator_foreach() for every element.</doc>
- <source-position filename="gst/gstiterator.h" line="139"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="134">The item</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="135">User data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="IteratorFreeFunction" c:type="GstIteratorFreeFunction">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="120">This function will be called when the iterator is freed.
-
-Implementors of a #GstIterator should implement this
-function and pass it to the constructor of the custom iterator.
-The function will be called with the iterator lock held.</doc>
- <source-position filename="gst/gstiterator.h" line="130"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="122">the iterator</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </parameter>
- </parameters>
- </callback>
- <enumeration name="IteratorItem"
- glib:type-name="GstIteratorItem"
- glib:get-type="gst_iterator_item_get_type"
- c:type="GstIteratorItem">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="51">The result of a #GstIteratorItemFunction.</doc>
- <member name="skip"
- value="0"
- c:identifier="GST_ITERATOR_ITEM_SKIP"
- glib:nick="skip">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="53">Skip this item</doc>
- </member>
- <member name="pass"
- value="1"
- c:identifier="GST_ITERATOR_ITEM_PASS"
- glib:nick="pass">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="54">Return item</doc>
- </member>
- <member name="end"
- value="2"
- c:identifier="GST_ITERATOR_ITEM_END"
- glib:nick="end">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="55">Stop after this item.</doc>
- </member>
- </enumeration>
- <callback name="IteratorItemFunction" c:type="GstIteratorItemFunction">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="76">The function that will be called after the next item of the iterator
-has been retrieved. This function can be used to skip items or stop
-the iterator.
-
-The function will be called with the iterator lock held.</doc>
- <source-position filename="gst/gstiterator.h" line="89"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="87">the result of the operation.</doc>
- <type name="IteratorItem" c:type="GstIteratorItem"/>
- </return-value>
- <parameters>
- <parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="78">the iterator</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </parameter>
- <parameter name="item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="79">the item being retrieved.</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="IteratorNextFunction" c:type="GstIteratorNextFunction">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="91">The function that will be called when the next element of the iterator
-should be retrieved.
-
-Implementors of a #GstIterator should implement this
-function and pass it to the constructor of the custom iterator.
-The function will be called with the iterator lock held.</doc>
- <source-position filename="gst/gstiterator.h" line="105"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="103">the result of the operation.</doc>
- <type name="IteratorResult" c:type="GstIteratorResult"/>
- </return-value>
- <parameters>
- <parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="93">the iterator</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </parameter>
- <parameter name="result" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="94">a pointer to hold the next item</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </callback>
- <enumeration name="IteratorResult"
- glib:type-name="GstIteratorResult"
- glib:get-type="gst_iterator_result_get_type"
- c:type="GstIteratorResult">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="33">The result of gst_iterator_next().</doc>
- <member name="done"
- value="0"
- c:identifier="GST_ITERATOR_DONE"
- glib:nick="done">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="35">No more items in the iterator</doc>
- </member>
- <member name="ok"
- value="1"
- c:identifier="GST_ITERATOR_OK"
- glib:nick="ok">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="36">An item was retrieved</doc>
- </member>
- <member name="resync"
- value="2"
- c:identifier="GST_ITERATOR_RESYNC"
- glib:nick="resync">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="37">Datastructure changed while iterating</doc>
- </member>
- <member name="error"
- value="3"
- c:identifier="GST_ITERATOR_ERROR"
- glib:nick="error">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="38">An error happened</doc>
- </member>
- </enumeration>
- <callback name="IteratorResyncFunction" c:type="GstIteratorResyncFunction">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="106">This function will be called whenever a concurrent update happened
-to the iterated datastructure. The implementor of the iterator should
-restart the iterator from the beginning and clean up any state it might
-have.
-
-Implementors of a #GstIterator should implement this
-function and pass it to the constructor of the custom iterator.
-The function will be called with the iterator lock held.</doc>
- <source-position filename="gst/gstiterator.h" line="119"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="it" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstiterator.h"
- line="108">the iterator</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </parameter>
- </parameters>
- </callback>
- <constant name="LICENSE_UNKNOWN"
- value="unknown"
- c:type="GST_LICENSE_UNKNOWN">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="290">To be used in GST_PLUGIN_DEFINE if unsure about the licence.</doc>
- <source-position filename="gst/gstplugin.h" line="295"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="LOCK_FLAG_READWRITE"
- value="3"
- c:type="GST_LOCK_FLAG_READWRITE">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="169">GstLockFlags value alias for GST_LOCK_FLAG_READ | GST_LOCK_FLAG_WRITE</doc>
- <source-position filename="gst/gstminiobject.h" line="174"/>
- <type name="LockFlags" c:type="GstLockFlags"/>
- </constant>
- <enumeration name="LibraryError"
- glib:type-name="GstLibraryError"
- glib:get-type="gst_library_error_get_type"
- c:type="GstLibraryError"
- glib:error-domain="gst-library-error-quark">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="82">Library errors are for errors from the library being used by elements
-(initializing, finalizing, settings, ...)</doc>
- <member name="failed"
- value="1"
- c:identifier="GST_LIBRARY_ERROR_FAILED"
- glib:nick="failed">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="84">a general error which doesn't fit in any other
-category. Make sure you add a custom message to the error call.</doc>
- </member>
- <member name="too_lazy"
- value="2"
- c:identifier="GST_LIBRARY_ERROR_TOO_LAZY"
- glib:nick="too-lazy">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="86">do not use this except as a placeholder for
-deciding where to go while developing code.</doc>
- </member>
- <member name="init"
- value="3"
- c:identifier="GST_LIBRARY_ERROR_INIT"
- glib:nick="init">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="88">used when the library could not be opened.</doc>
- </member>
- <member name="shutdown"
- value="4"
- c:identifier="GST_LIBRARY_ERROR_SHUTDOWN"
- glib:nick="shutdown">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="89">used when the library could not be closed.</doc>
- </member>
- <member name="settings"
- value="5"
- c:identifier="GST_LIBRARY_ERROR_SETTINGS"
- glib:nick="settings">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="90">used when the library doesn't accept settings.</doc>
- </member>
- <member name="encode"
- value="6"
- c:identifier="GST_LIBRARY_ERROR_ENCODE"
- glib:nick="encode">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="91">used when the library generated an encoding error.</doc>
- </member>
- <member name="num_errors"
- value="7"
- c:identifier="GST_LIBRARY_ERROR_NUM_ERRORS"
- glib:nick="num-errors">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="92">the number of library error types.</doc>
- </member>
- <function name="quark" c:identifier="gst_library_error_quark">
- <attribute name="doc.skip" value="true"/>
- <return-value transfer-ownership="none">
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- </enumeration>
- <bitfield name="LockFlags"
- glib:type-name="GstLockFlags"
- glib:get-type="gst_lock_flags_get_type"
- c:type="GstLockFlags">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="152">Flags used when locking miniobjects</doc>
- <member name="read"
- value="1"
- c:identifier="GST_LOCK_FLAG_READ"
- glib:nick="read">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="154">lock for read access</doc>
- </member>
- <member name="write"
- value="2"
- c:identifier="GST_LOCK_FLAG_WRITE"
- glib:nick="write">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="155">lock for write access</doc>
- </member>
- <member name="exclusive"
- value="4"
- c:identifier="GST_LOCK_FLAG_EXCLUSIVE"
- glib:nick="exclusive">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="156">lock for exclusive access</doc>
- </member>
- <member name="last"
- value="256"
- c:identifier="GST_LOCK_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="157">first flag that can be used for custom purposes</doc>
- </member>
- </bitfield>
- <callback name="LogFunction" c:type="GstLogFunction">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="333">Function prototype for a logging function that can be registered with
-gst_debug_add_log_function().
-Use G_GNUC_NO_INSTRUMENT on that function.</doc>
- <source-position filename="gst/gstinfo.h" line="348"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="335">a #GstDebugCategory</doc>
- <type name="DebugCategory" c:type="GstDebugCategory*"/>
- </parameter>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="336">a #GstDebugLevel</doc>
- <type name="DebugLevel" c:type="GstDebugLevel"/>
- </parameter>
- <parameter name="file" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="337">file name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="function" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="338">function name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="line" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="339">line number</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="340">a #GObject</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="341">the message</doc>
- <type name="DebugMessage" c:type="GstDebugMessage*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="7">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="342">user data for the log function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <function-macro name="MAKE_FOURCC"
- c:identifier="GST_MAKE_FOURCC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="30">Transform four characters into a #guint32 fourcc value with host
-endianness.
-
-|[
-guint32 fourcc = GST_MAKE_FOURCC ('M', 'J', 'P', 'G');
-]|</doc>
- <source-position filename="gst/gstvalue.h" line="45"/>
- <parameters>
- <parameter name="a">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="32">the first character</doc>
- </parameter>
- <parameter name="b">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="33">the second character</doc>
- </parameter>
- <parameter name="c">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="34">the third character</doc>
- </parameter>
- <parameter name="d">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="35">the fourth character</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="MAP_READWRITE" value="3" c:type="GST_MAP_READWRITE">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="188">GstMapFlags value alias for GST_MAP_READ | GST_MAP_WRITE</doc>
- <source-position filename="gst/gstmemory.h" line="193"/>
- <type name="MapFlags" c:type="GstMapFlags"/>
- </constant>
- <function-macro name="MEMDUMP"
- c:identifier="GST_MEMDUMP"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="1065">Output a hexdump of @data.
-
-There is no need to finish the end of the message string with a newline
-character, a newline character will be added automatically.</doc>
- <source-position filename="gst/gstinfo.h" line="734"/>
- <parameters>
- <parameter name="msg">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="1067">message string to log with the data</doc>
- </parameter>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="1068">pointer to the data to output</doc>
- </parameter>
- <parameter name="length">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="1069">length of the data to output</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MEMDUMP_OBJECT"
- c:identifier="GST_MEMDUMP_OBJECT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="988">Output a logging message belonging to the given object in the default category.
-
-There is no need to finish the end of the message string with a newline
-character, a newline character will be added automatically.</doc>
- <source-position filename="gst/gstinfo.h" line="732"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="990">the #GObject the message belongs to</doc>
- </parameter>
- <parameter name="msg">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="991">message string to log with the data</doc>
- </parameter>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="992">pointer to the data to output</doc>
- </parameter>
- <parameter name="length">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="993">length of the data to output</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MEMORY_CAST"
- c:identifier="GST_MEMORY_CAST"
- introspectable="0">
- <source-position filename="gst/gstmemory.h" line="43"/>
- <parameters>
- <parameter name="mem">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MEMORY_FLAGS"
- c:identifier="GST_MEMORY_FLAGS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="75">A flags word containing #GstMemoryFlags flags set on @mem</doc>
- <source-position filename="gst/gstmemory.h" line="81"/>
- <parameters>
- <parameter name="mem">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="77">a #GstMemory.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MEMORY_FLAG_IS_SET"
- c:identifier="GST_MEMORY_FLAG_IS_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="82">Gives the status of a specific flag on a @mem.</doc>
- <source-position filename="gst/gstmemory.h" line="89"/>
- <parameters>
- <parameter name="mem">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="84">a #GstMemory.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="85">the #GstMemoryFlags to check.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MEMORY_FLAG_UNSET"
- c:identifier="GST_MEMORY_FLAG_UNSET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="90">Clear a specific flag on a @mem.</doc>
- <source-position filename="gst/gstmemory.h" line="97"/>
- <parameters>
- <parameter name="mem">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="92">a #GstMemory.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="93">the #GstMemoryFlags to clear.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MEMORY_IS_NOT_MAPPABLE"
- c:identifier="GST_MEMORY_IS_NOT_MAPPABLE"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="138">Check if @mem can't be mapped via gst_memory_map() without any preconditions</doc>
- <source-position filename="gst/gstmemory.h" line="146"/>
- <parameters>
- <parameter name="mem">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="140">a #GstMemory.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MEMORY_IS_NO_SHARE"
- c:identifier="GST_MEMORY_IS_NO_SHARE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="106">Check if @mem cannot be shared between buffers</doc>
- <source-position filename="gst/gstmemory.h" line="112"/>
- <parameters>
- <parameter name="mem">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="108">a #GstMemory.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MEMORY_IS_PHYSICALLY_CONTIGUOUS"
- c:identifier="GST_MEMORY_IS_PHYSICALLY_CONTIGUOUS"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="128">Check if @mem is physically contiguous.</doc>
- <source-position filename="gst/gstmemory.h" line="136"/>
- <parameters>
- <parameter name="mem">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="130">a #GstMemory.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MEMORY_IS_READONLY"
- c:identifier="GST_MEMORY_IS_READONLY"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="99">Check if @mem is readonly.</doc>
- <source-position filename="gst/gstmemory.h" line="105"/>
- <parameters>
- <parameter name="mem">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="101">a #GstMemory.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MEMORY_IS_ZERO_PADDED"
- c:identifier="GST_MEMORY_IS_ZERO_PADDED"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="120">Check if the padding in @mem is 0 filled.</doc>
- <source-position filename="gst/gstmemory.h" line="126"/>
- <parameters>
- <parameter name="mem">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="122">a #GstMemory.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MEMORY_IS_ZERO_PREFIXED"
- c:identifier="GST_MEMORY_IS_ZERO_PREFIXED"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="113">Check if the prefix in @mem is 0 filled.</doc>
- <source-position filename="gst/gstmemory.h" line="119"/>
- <parameters>
- <parameter name="mem">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="115">a #GstMemory.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE"
- c:identifier="GST_MESSAGE"
- introspectable="0">
- <source-position filename="gst/gstmessage.h" line="202"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_CAST"
- c:identifier="GST_MESSAGE_CAST"
- introspectable="0">
- <source-position filename="gst/gstmessage.h" line="201"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_GET_COND"
- c:identifier="GST_MESSAGE_GET_COND"
- introspectable="0">
- <source-position filename="gst/gstmessage.h" line="210"/>
- <parameters>
- <parameter name="message">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_GET_LOCK"
- c:identifier="GST_MESSAGE_GET_LOCK"
- introspectable="0">
- <source-position filename="gst/gstmessage.h" line="207"/>
- <parameters>
- <parameter name="message">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_LOCK"
- c:identifier="GST_MESSAGE_LOCK"
- introspectable="0">
- <source-position filename="gst/gstmessage.h" line="208"/>
- <parameters>
- <parameter name="message">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_SEQNUM"
- c:identifier="GST_MESSAGE_SEQNUM"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="253">Get the sequence number of @message.</doc>
- <source-position filename="gst/gstmessage.h" line="259"/>
- <parameters>
- <parameter name="message">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="255">a #GstMessage</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_SIGNAL"
- c:identifier="GST_MESSAGE_SIGNAL"
- introspectable="0">
- <source-position filename="gst/gstmessage.h" line="212"/>
- <parameters>
- <parameter name="message">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_SRC"
- c:identifier="GST_MESSAGE_SRC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="245">Get the object that posted @message.</doc>
- <source-position filename="gst/gstmessage.h" line="251"/>
- <parameters>
- <parameter name="message">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="247">a #GstMessage</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_SRC_NAME"
- c:identifier="GST_MESSAGE_SRC_NAME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="261">Get the name of the object that posted @message. Returns "(NULL)" if
-the message has no source object set.</doc>
- <source-position filename="gst/gstmessage.h" line="268"/>
- <parameters>
- <parameter name="message">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="263">a #GstMessage</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_TIMESTAMP"
- c:identifier="GST_MESSAGE_TIMESTAMP"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="237">Get the timestamp of @message. This is the timestamp when the message
-was created.</doc>
- <source-position filename="gst/gstmessage.h" line="244"/>
- <parameters>
- <parameter name="message">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="239">a #GstMessage</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_TYPE"
- c:identifier="GST_MESSAGE_TYPE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="214">Get the #GstMessageType of @message.</doc>
- <source-position filename="gst/gstmessage.h" line="220"/>
- <parameters>
- <parameter name="message">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="216">a #GstMessage</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_TYPE_IS_EXTENDED"
- c:identifier="GST_MESSAGE_TYPE_IS_EXTENDED"
- version="1.4"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="221">Check if the message is in the extended message group</doc>
- <source-position filename="gst/gstmessage.h" line="228"/>
- <parameters>
- <parameter name="message">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="223">a #GstMessage</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_TYPE_NAME"
- c:identifier="GST_MESSAGE_TYPE_NAME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="230">Get a constant string representation of the #GstMessageType of @message.</doc>
- <source-position filename="gst/gstmessage.h" line="236"/>
- <parameters>
- <parameter name="message">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="232">a #GstMessage</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_UNLOCK"
- c:identifier="GST_MESSAGE_UNLOCK"
- introspectable="0">
- <source-position filename="gst/gstmessage.h" line="209"/>
- <parameters>
- <parameter name="message">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MESSAGE_WAIT"
- c:identifier="GST_MESSAGE_WAIT"
- introspectable="0">
- <source-position filename="gst/gstmessage.h" line="211"/>
- <parameters>
- <parameter name="message">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="META_CAST"
- c:identifier="GST_META_CAST"
- introspectable="0">
- <source-position filename="gst/gstmeta.h" line="33"/>
- <parameters>
- <parameter name="meta">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="META_FLAGS"
- c:identifier="GST_META_FLAGS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="54">A flags word containing #GstMetaFlags flags set on @meta</doc>
- <source-position filename="gst/gstmeta.h" line="60"/>
- <parameters>
- <parameter name="meta">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="56">a #GstMeta.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="META_FLAG_IS_SET"
- c:identifier="GST_META_FLAG_IS_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="61">Gives the status of a specific flag on a metadata.</doc>
- <source-position filename="gst/gstmeta.h" line="68"/>
- <parameters>
- <parameter name="meta">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="63">a #GstMeta.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="64">the #GstMetaFlags to check.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="META_FLAG_SET"
- c:identifier="GST_META_FLAG_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="69">Sets a metadata flag on a metadata.</doc>
- <source-position filename="gst/gstmeta.h" line="76"/>
- <parameters>
- <parameter name="meta">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="71">a #GstMeta.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="72">the #GstMetaFlags to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="META_FLAG_UNSET"
- c:identifier="GST_META_FLAG_UNSET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="77">Clears a metadata flag.</doc>
- <source-position filename="gst/gstmeta.h" line="84"/>
- <parameters>
- <parameter name="meta">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="79">a #GstMeta.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="80">the #GstMetaFlags to clear.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="META_TAG_MEMORY_STR"
- value="memory"
- c:type="GST_META_TAG_MEMORY_STR"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="86">This metadata stays relevant as long as memory layout is unchanged.</doc>
- <source-position filename="gst/gstmeta.h" line="93"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="META_TRANSFORM_IS_COPY"
- c:identifier="GST_META_TRANSFORM_IS_COPY"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="148">Check if the transform type is a copy transform</doc>
- <source-position filename="gst/gstmeta.h" line="154"/>
- <parameters>
- <parameter name="type">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="150">a transform type</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MINI_OBJECT"
- c:identifier="GST_MINI_OBJECT"
- introspectable="0">
- <source-position filename="gst/gstminiobject.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MINI_OBJECT_CAST"
- c:identifier="GST_MINI_OBJECT_CAST"
- introspectable="0">
- <source-position filename="gst/gstminiobject.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MINI_OBJECT_CONST_CAST"
- c:identifier="GST_MINI_OBJECT_CONST_CAST"
- introspectable="0">
- <source-position filename="gst/gstminiobject.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MINI_OBJECT_FLAGS"
- c:identifier="GST_MINI_OBJECT_FLAGS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="89">This macro returns the entire set of flags for the mini-object.</doc>
- <source-position filename="gst/gstminiobject.h" line="95"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="91">MiniObject to return flags for.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MINI_OBJECT_FLAG_IS_SET"
- c:identifier="GST_MINI_OBJECT_FLAG_IS_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="96">This macro checks to see if the given flag is set.</doc>
- <source-position filename="gst/gstminiobject.h" line="103"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="98">MiniObject to check for flags.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="99">Flag to check for</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MINI_OBJECT_FLAG_SET"
- c:identifier="GST_MINI_OBJECT_FLAG_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="104">This macro sets the given bits.</doc>
- <source-position filename="gst/gstminiobject.h" line="111"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="106">MiniObject to set flag in.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="107">Flag to set, can by any number of bits in guint32.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MINI_OBJECT_FLAG_UNSET"
- c:identifier="GST_MINI_OBJECT_FLAG_UNSET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="112">This macro unsets the given bits.</doc>
- <source-position filename="gst/gstminiobject.h" line="119"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="114">MiniObject to unset flag in.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="115">Flag to set, must be a single bit in guint32.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MINI_OBJECT_IS_LOCKABLE"
- c:identifier="GST_MINI_OBJECT_IS_LOCKABLE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="143">Check if @obj is lockable. A lockable object can be locked and unlocked with
-gst_mini_object_lock() and gst_mini_object_unlock().</doc>
- <source-position filename="gst/gstminiobject.h" line="150"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="145">a #GstMiniObject</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MINI_OBJECT_REFCOUNT"
- c:identifier="GST_MINI_OBJECT_REFCOUNT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="176">Get access to the reference count field of the mini-object.</doc>
- <source-position filename="gst/gstminiobject.h" line="182"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="178">a #GstMiniObject</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MINI_OBJECT_REFCOUNT_VALUE"
- c:identifier="GST_MINI_OBJECT_REFCOUNT_VALUE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="183">Get the reference count value of the mini-object.</doc>
- <source-position filename="gst/gstminiobject.h" line="189"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="185">a #GstMiniObject</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="MINI_OBJECT_TYPE"
- c:identifier="GST_MINI_OBJECT_TYPE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="81">This macro returns the type of the mini-object.</doc>
- <source-position filename="gst/gstminiobject.h" line="87"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="83">MiniObject to return type for.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="MSECOND" value="1000000" c:type="GST_MSECOND">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="104">Constant that defines one GStreamer millisecond.</doc>
- <source-position filename="gst/gstclock.h" line="109"/>
- <type name="ClockTimeDiff" c:type="GstClockTimeDiff"/>
- </constant>
- <bitfield name="MapFlags"
- glib:type-name="GstMapFlags"
- glib:get-type="gst_map_flags_get_type"
- c:type="GstMapFlags">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="173">Flags used when mapping memory</doc>
- <member name="read"
- value="1"
- c:identifier="GST_MAP_READ"
- glib:nick="read">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="175">map for read access</doc>
- </member>
- <member name="write"
- value="2"
- c:identifier="GST_MAP_WRITE"
- glib:nick="write">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="176">map for write access</doc>
- </member>
- <member name="flag_last"
- value="65536"
- c:identifier="GST_MAP_FLAG_LAST"
- glib:nick="flag-last">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="177">first flag that can be used for custom purposes</doc>
- </member>
- </bitfield>
- <record name="MapInfo" c:type="GstMapInfo">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="196">A structure containing the result of a map operation such as
-gst_memory_map(). It contains the data and size.</doc>
- <source-position filename="gst/gstmemory.h" line="220"/>
- <field name="memory" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="198">a pointer to the mapped memory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </field>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="199">flags used when mapping the memory</doc>
- <type name="MapFlags" c:type="GstMapFlags"/>
- </field>
- <field name="data" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="200">a pointer to the mapped data</doc>
- <array length="3" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="201">the valid size in @data</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="maxsize" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="202">the maximum bytes in @data</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="user_data" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="203">extra private user_data that the implementation of the memory
- can use to store extra info.</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="Memory"
- c:type="GstMemory"
- glib:type-name="GstMemory"
- glib:get-type="gst_memory_get_type"
- c:symbol-prefix="memory">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="22">GstMemory is a lightweight refcounted object that wraps a region of memory.
-They are typically used to manage the data of a #GstBuffer.
-
-A GstMemory object has an allocated region of memory of maxsize. The maximum
-size does not change during the lifetime of the memory object. The memory
-also has an offset and size property that specifies the valid range of memory
-in the allocated region.
-
-Memory is usually created by allocators with a gst_allocator_alloc()
-method call. When %NULL is used as the allocator, the default allocator will
-be used.
-
-New allocators can be registered with gst_allocator_register().
-Allocators are identified by name and can be retrieved with
-gst_allocator_find(). gst_allocator_set_default() can be used to change the
-default allocator.
-
-New memory can be created with gst_memory_new_wrapped() that wraps the memory
-allocated elsewhere.
-
-Refcounting of the memory block is performed with gst_memory_ref() and
-gst_memory_unref().
-
-The size of the memory can be retrieved and changed with
-gst_memory_get_sizes() and gst_memory_resize() respectively.
-
-Getting access to the data of the memory is performed with gst_memory_map().
-The call will return a pointer to offset bytes into the region of memory.
-After the memory access is completed, gst_memory_unmap() should be called.
-
-Memory can be copied with gst_memory_copy(), which will return a writable
-copy. gst_memory_share() will create a new memory block that shares the
-memory with an existing memory block at a custom offset and with a custom
-size.
-
-Memory can be efficiently merged when gst_memory_is_span() returns %TRUE.</doc>
- <source-position filename="gst/gstmemory.h" line="171"/>
- <field name="mini_object" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="150">parent structure</doc>
- <type name="MiniObject" c:type="GstMiniObject"/>
- </field>
- <field name="allocator" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="151">pointer to the #GstAllocator</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </field>
- <field name="parent" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="152">parent memory block</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </field>
- <field name="maxsize" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="153">the maximum size allocated</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="align" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="154">the alignment of the memory</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="offset" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="155">the offset where valid data starts</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="156">the size of valid data</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <constructor name="new_wrapped" c:identifier="gst_memory_new_wrapped">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="614">Allocate a new memory block that wraps the given @data.
-
-The prefix/padding must be filled with 0 if @flags contains
-#GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively.</doc>
- <source-position filename="gst/gstallocator.h" line="190"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="630">a new #GstMemory.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="616">#GstMemoryFlags</doc>
- <type name="MemoryFlags" c:type="GstMemoryFlags"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="617">data to
- wrap</doc>
- <array length="4" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="maxsize" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="619">allocated size of @data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="620">offset in @data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="621">size of valid data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="622">user_data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="async"
- closure="5">
- <doc xml:space="preserve"
- filename="gst/gstallocator.c"
- line="623">called with @user_data when the memory is freed</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="copy" c:identifier="gst_memory_copy">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="355">Return a copy of @size bytes from @mem starting from @offset. This copy is
-guaranteed to be writable. @size can be set to -1 to return a copy
-from @offset to the end of the memory region.</doc>
- <source-position filename="gst/gstmemory.h" line="382"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="365">a new #GstMemory.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <instance-parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="357">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="358">offset to copy from</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="359">size to copy, or -1 to copy to the end of the memory region</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_sizes" c:identifier="gst_memory_get_sizes">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="164">Get the current @size, @offset and @maxsize of @mem.</doc>
- <source-position filename="gst/gstmemory.h" line="358"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="172">the current size of @mem</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="166">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </instance-parameter>
- <parameter name="offset"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="167">pointer to offset</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- <parameter name="maxsize"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="168">pointer to maxsize</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_memory_init" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="102">Initializes a newly allocated @mem with the given parameters. This function
-will call gst_mini_object_init() with the default memory parameters.</doc>
- <source-position filename="gst/gstmemory.h" line="319"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="104">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="105">#GstMemoryFlags</doc>
- <type name="MemoryFlags" c:type="GstMemoryFlags"/>
- </parameter>
- <parameter name="allocator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="106">the #GstAllocator</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </parameter>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="107">the parent of @mem</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- <parameter name="maxsize" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="108">the total size of the memory</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="109">the alignment of the memory</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="110">The offset in the memory</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="111">the size of valid data in the memory</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_span" c:identifier="gst_memory_is_span">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="426">Check if @mem1 and mem2 share the memory with a common parent memory object
-and that the memory is contiguous.
-
-If this is the case, the memory of @mem1 and @mem2 can be merged
-efficiently by performing gst_memory_share() on the parent object from
-the returned @offset.</doc>
- <source-position filename="gst/gstmemory.h" line="390"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="439">%TRUE if the memory is contiguous and of a common parent.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="mem1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="428">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </instance-parameter>
- <parameter name="mem2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="429">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- <parameter name="offset"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="430">a pointer to a result offset</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_type" c:identifier="gst_memory_is_type" version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="143">Check if @mem if allocated with an allocator for @mem_type.</doc>
- <source-position filename="gst/gstmemory.h" line="324"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="150">%TRUE if @mem was allocated from an allocator for @mem_type.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="145">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </instance-parameter>
- <parameter name="mem_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="146">a memory type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="make_mapped" c:identifier="gst_memory_make_mapped">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="219">Create a #GstMemory object that is mapped with @flags. If @mem is mappable
-with @flags, this function returns the mapped @mem directly. Otherwise a
-mapped copy of @mem is returned.
-
-This function takes ownership of old @mem and returns a reference to a new
-#GstMemory.</doc>
- <source-position filename="gst/gstmemory.h" line="371"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="232">a #GstMemory object mapped
-with @flags or %NULL when a mapping is not possible.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <instance-parameter name="mem" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="221">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </instance-parameter>
- <parameter name="info"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="222">pointer for info</doc>
- <type name="MapInfo" c:type="GstMapInfo*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="223">mapping flags</doc>
- <type name="MapFlags" c:type="GstMapFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="map" c:identifier="gst_memory_map">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="269">Fill @info with the pointer and sizes of the memory in @mem that can be
-accessed according to @flags.
-
-This function can return %FALSE for various reasons:
-- the memory backed by @mem is not accessible with the given @flags.
-- the memory was already mapped with a different mapping.
-
-@info and its contents remain valid for as long as @mem is valid and
-until gst_memory_unmap() is called.
-
-For each gst_memory_map() call, a corresponding gst_memory_unmap() call
-should be done.</doc>
- <source-position filename="gst/gstmemory.h" line="374"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="288">%TRUE if the map operation was successful.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="271">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </instance-parameter>
- <parameter name="info"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="272">pointer for info</doc>
- <type name="MapInfo" c:type="GstMapInfo*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="273">mapping flags</doc>
- <type name="MapFlags" c:type="GstMapFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_memory_ref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="327">Increase the refcount of this memory.</doc>
- <source-position filename="gst/gstmemory.h" line="335"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="333">@memory (for convenience when doing assignments)</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <instance-parameter name="memory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="329">The memory to refcount</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="resize" c:identifier="gst_memory_resize">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="187">Resize the memory region. @mem should be writable and offset + size should be
-less than the maxsize of @mem.
-
-#GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED will be
-cleared when offset or padding is increased respectively.</doc>
- <source-position filename="gst/gstmemory.h" line="361"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="189">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="190">a new offset</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="191">a new size</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="share" c:identifier="gst_memory_share">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="379">Return a shared copy of @size bytes from @mem starting from @offset. No
-memory copy is performed and the memory region is simply shared. The result
-is guaranteed to be non-writable. @size can be set to -1 to return a shared
-copy from @offset to the end of the memory region.</doc>
- <source-position filename="gst/gstmemory.h" line="385"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="390">a new #GstMemory.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <instance-parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="381">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="382">offset to share from</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="383">size to share, or -1 to share to the end of the memory region</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- </parameters>
- </method>
- <method name="unmap" c:identifier="gst_memory_unmap">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="334">Release the memory obtained with gst_memory_map()</doc>
- <source-position filename="gst/gstmemory.h" line="377"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="336">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.c"
- line="337">a #GstMapInfo</doc>
- <type name="MapInfo" c:type="GstMapInfo*"/>
- </parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_memory_unref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="342">Decrease the refcount of a memory, freeing it if the refcount reaches 0.</doc>
- <source-position filename="gst/gstmemory.h" line="348"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="memory" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="344">the memory to refcount</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <callback name="MemoryCopyFunction" c:type="GstMemoryCopyFunction">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="276">Copy @size bytes from @mem starting at @offset and return them wrapped in a
-new GstMemory object.
-If @size is set to -1, all bytes starting at @offset are copied.</doc>
- <source-position filename="gst/gstmemory.h" line="289"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="286">a new #GstMemory object wrapping a copy of the requested region in
-@mem.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="278">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="279">an offset</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="280">a size or -1</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- </parameters>
- </callback>
- <bitfield name="MemoryFlags"
- glib:type-name="GstMemoryFlags"
- glib:get-type="gst_memory_flags_get_type"
- c:type="GstMemoryFlags">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="45">Flags for wrapped memory.</doc>
- <member name="readonly"
- value="2"
- c:identifier="GST_MEMORY_FLAG_READONLY"
- glib:nick="readonly">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="47">memory is readonly. It is not allowed to map the
-memory with #GST_MAP_WRITE.</doc>
- </member>
- <member name="no_share"
- value="16"
- c:identifier="GST_MEMORY_FLAG_NO_SHARE"
- glib:nick="no-share">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="49">memory must not be shared. Copies will have to be
-made when this memory needs to be shared between buffers. (DEPRECATED:
-do not use in new code, instead you should create a custom GstAllocator for
-memory pooling instead of relying on the GstBuffer they were originally
-attached to.)</doc>
- </member>
- <member name="zero_prefixed"
- value="32"
- c:identifier="GST_MEMORY_FLAG_ZERO_PREFIXED"
- glib:nick="zero-prefixed">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="54">the memory prefix is filled with 0 bytes</doc>
- </member>
- <member name="zero_padded"
- value="64"
- c:identifier="GST_MEMORY_FLAG_ZERO_PADDED"
- glib:nick="zero-padded">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="55">the memory padding is filled with 0 bytes</doc>
- </member>
- <member name="physically_contiguous"
- value="128"
- c:identifier="GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS"
- glib:nick="physically-contiguous">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="56">the memory is physically
-contiguous. (Since: 1.2)</doc>
- </member>
- <member name="not_mappable"
- value="256"
- c:identifier="GST_MEMORY_FLAG_NOT_MAPPABLE"
- glib:nick="not-mappable">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="58">the memory can't be mapped via
-gst_memory_map() without any preconditions. (Since: 1.2)</doc>
- </member>
- <member name="last"
- value="1048576"
- c:identifier="GST_MEMORY_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="60">first flag that can be used for custom purposes</doc>
- </member>
- </bitfield>
- <callback name="MemoryIsSpanFunction" c:type="GstMemoryIsSpanFunction">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="305">Check if @mem1 and @mem2 occupy contiguous memory and return the offset of
-@mem1 in the parent buffer in @offset.</doc>
- <source-position filename="gst/gstmemory.h" line="316"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="314">%TRUE if @mem1 and @mem2 are in contiguous memory.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="mem1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="307">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- <parameter name="mem2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="308">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="309">a result offset</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="MemoryMapFullFunction" c:type="GstMemoryMapFullFunction">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="244">Get the memory of @mem that can be accessed according to the mode specified
-in @info's flags. The function should return a pointer that contains at least
-@maxsize bytes.</doc>
- <source-position filename="gst/gstmemory.h" line="257"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="254">a pointer to memory of which at least @maxsize bytes can be
-accessed according to the access pattern in @info's flags.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="246">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="247">the #GstMapInfo to map with</doc>
- <type name="MapInfo" c:type="GstMapInfo*"/>
- </parameter>
- <parameter name="maxsize" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="248">size to map</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="MemoryMapFunction" c:type="GstMemoryMapFunction">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="229">Get the memory of @mem that can be accessed according to the mode specified
-in @flags. The function should return a pointer that contains at least
-@maxsize bytes.</doc>
- <source-position filename="gst/gstmemory.h" line="242"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="239">a pointer to memory of which at least @maxsize bytes can be
-accessed according to the access pattern in @flags.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="231">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- <parameter name="maxsize" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="232">size to map</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="233">access mode for the memory</doc>
- <type name="MapFlags" c:type="GstMapFlags"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="MemoryShareFunction" c:type="GstMemoryShareFunction">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="291">Share @size bytes from @mem starting at @offset and return them wrapped in a
-new GstMemory object. If @size is set to -1, all bytes starting at @offset are
-shared. This function does not make a copy of the bytes in @mem.</doc>
- <source-position filename="gst/gstmemory.h" line="303"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="301">a new #GstMemory object sharing the requested region in @mem.</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </return-value>
- <parameters>
- <parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="293">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="294">an offset</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="295">a size or -1</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="MemoryUnmapFullFunction"
- c:type="GstMemoryUnmapFullFunction">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="267">Release the pointer previously retrieved with gst_memory_map() with @info.</doc>
- <source-position filename="gst/gstmemory.h" line="274"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="269">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="270">a #GstMapInfo</doc>
- <type name="MapInfo" c:type="GstMapInfo*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="MemoryUnmapFunction" c:type="GstMemoryUnmapFunction">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="259">Release the pointer previously retrieved with gst_memory_map().</doc>
- <source-position filename="gst/gstmemory.h" line="265"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmemory.h"
- line="261">a #GstMemory</doc>
- <type name="Memory" c:type="GstMemory*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="Message"
- c:type="GstMessage"
- glib:type-name="GstMessage"
- glib:get-type="gst_message_get_type"
- c:symbol-prefix="message">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="22">Messages are implemented as a subclass of #GstMiniObject with a generic
-#GstStructure as the content. This allows for writing custom messages without
-requiring an API change while allowing a wide range of different types
-of messages.
-
-Messages are posted by objects in the pipeline and are passed to the
-application using the #GstBus.
-
-The basic use pattern of posting a message on a #GstBus is as follows:
-|[&lt;!-- language="C" --&gt;
- gst_bus_post (bus, gst_message_new_eos());
-]|
-
-A #GstElement usually posts messages on the bus provided by the parent
-container using gst_element_post_message().</doc>
- <source-position filename="gst/gstmessage.h" line="350"/>
- <field name="mini_object" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="329">the parent structure</doc>
- <type name="MiniObject" c:type="GstMiniObject"/>
- </field>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="330">the #GstMessageType of the message</doc>
- <type name="MessageType" c:type="GstMessageType"/>
- </field>
- <field name="timestamp" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="331">the timestamp of the message</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="src" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="332">the src of the message</doc>
- <type name="Object" c:type="GstObject*"/>
- </field>
- <field name="seqnum" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="333">the sequence number of the message</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="lock" readable="0" private="1">
- <type name="GLib.Mutex" c:type="GMutex"/>
- </field>
- <field name="cond" readable="0" private="1">
- <type name="GLib.Cond" c:type="GCond"/>
- </field>
- <constructor name="new_application"
- c:identifier="gst_message_new_application">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="984">Create a new application-typed message. GStreamer will never create these
-messages; they are a gift from us to you. Enjoy.</doc>
- <source-position filename="gst/gstmessage.h" line="644"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="993">The new application message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="986">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="structure" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="987">the structure for the message. The message
- will take ownership of the structure.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_async_done"
- c:identifier="gst_message_new_async_done">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1072">The message is posted when elements completed an ASYNC state change.
-@running_time contains the time of the desired running_time when this
-elements goes to PLAYING. A value of #GST_CLOCK_TIME_NONE for @running_time
-means that the element has no clock interaction and thus doesn't care about
-the running_time of the pipeline.</doc>
- <source-position filename="gst/gstmessage.h" line="687"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1083">The new async_done message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1074">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="running_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1075">the desired running_time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_async_start"
- c:identifier="gst_message_new_async_start">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1052">This message is posted by elements when they start an ASYNC state change.</doc>
- <source-position filename="gst/gstmessage.h" line="682"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1058">The new async_start message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1054">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_buffering"
- c:identifier="gst_message_new_buffering">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="705">Create a new buffering message. This message can be posted by an element that
-needs to buffer data before it can continue processing. @percent should be a
-value between 0 and 100. A value of 100 means that the buffering completed.
-
-When @percent is &lt; 100 the application should PAUSE a PLAYING pipeline. When
-@percent is 100, the application can set the pipeline (back) to PLAYING.
-The application must be prepared to receive BUFFERING messages in the
-PREROLLING state and may only set the pipeline to PLAYING after receiving a
-message with @percent set to 100, which can happen after the pipeline
-completed prerolling.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="578"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="723">The new buffering message.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="707">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="percent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="708">The buffering percent</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_clock_lost"
- c:identifier="gst_message_new_clock_lost">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="831">Create a clock lost message. This message is posted whenever the
-clock is not valid anymore.
-
-If this message is posted by the pipeline, the pipeline will
-select a new clock again when it goes to PLAYING. It might therefore
-be needed to set the pipeline to PAUSED and PLAYING again.</doc>
- <source-position filename="gst/gstmessage.h" line="628"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="843">The new clock lost message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="833">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="834">the clock that was lost</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_clock_provide"
- c:identifier="gst_message_new_clock_provide">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="799">Create a clock provide message. This message is posted whenever an
-element is ready to provide a clock or lost its ability to provide
-a clock (maybe because it paused or became EOS).
-
-This message is mainly used internally to manage the clock
-selection.</doc>
- <source-position filename="gst/gstmessage.h" line="619"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="812">the new provide clock message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="801">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="802">the clock it provides</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- <parameter name="ready" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="803">%TRUE if the sender can provide a clock</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_custom" c:identifier="gst_message_new_custom">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="281">Create a new custom-typed message. This can be used for anything not
-handled by other message-specific functions to pass a message to the
-app. The structure field can be %NULL.</doc>
- <source-position filename="gst/gstmessage.h" line="499"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="292">The new message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="283">The #GstMessageType to distinguish messages</doc>
- <type name="MessageType" c:type="GstMessageType"/>
- </parameter>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="284">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="structure"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="285">the structure for the
- message. The message will take ownership of the structure.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_device_added"
- c:identifier="gst_message_new_device_added"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2592">Creates a new device-added message. The device-added message is produced by
-#GstDeviceProvider or a #GstDeviceMonitor. They announce the appearance
-of monitored devices.</doc>
- <source-position filename="gst/gstmessage.h" line="809"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2601">a newly allocated #GstMessage</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2594">The #GstObject that created the message</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2595">The new #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_device_changed"
- c:identifier="gst_message_new_device_changed"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2696">Creates a new device-changed message. The device-changed message is produced
-by #GstDeviceProvider or a #GstDeviceMonitor. They announce that a device
-properties has changed and @device represent the new modified version of @changed_device.</doc>
- <source-position filename="gst/gstmessage.h" line="825"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2706">a newly allocated #GstMessage</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2698">The #GstObject that created the message</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2699">The newly created device representing @replaced_device
- with its new configuration.</doc>
- <type name="Device" c:type="GstDevice*"/>
- </parameter>
- <parameter name="changed_device" transfer-ownership="none">
- <type name="Device" c:type="GstDevice*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_device_removed"
- c:identifier="gst_message_new_device_removed"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2644">Creates a new device-removed message. The device-removed message is produced
-by #GstDeviceProvider or a #GstDeviceMonitor. They announce the
-disappearance of monitored devices.</doc>
- <source-position filename="gst/gstmessage.h" line="817"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2653">a newly allocated #GstMessage</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2646">The #GstObject that created the message</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="device" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2647">The removed #GstDevice</doc>
- <type name="Device" c:type="GstDevice*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_duration_changed"
- c:identifier="gst_message_new_duration_changed">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1028">Create a new duration changed message. This message is posted by elements
-that know the duration of a stream when the duration changes. This message
-is received by bins and is used to calculate the total duration of a
-pipeline.</doc>
- <source-position filename="gst/gstmessage.h" line="672"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1037">The new duration-changed message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1030">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_element" c:identifier="gst_message_new_element">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1005">Create a new element-specific message. This is meant as a generic way of
-allowing one-way communication from an element to an application, for example
-"the firewire cable was unplugged". The format of the message should be
-documented in the element's documentation. The structure field can be %NULL.</doc>
- <source-position filename="gst/gstmessage.h" line="649"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1016">The new element message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1007">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="structure" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1008">The structure for the
- message. The message will take ownership of the structure.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_eos" c:identifier="gst_message_new_eos">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="380">Create a new eos message. This message is generated and posted in
-the sink elements of a GstBin. The bin will only forward the EOS
-message to the application if all sinks have posted an EOS message.</doc>
- <source-position filename="gst/gstmessage.h" line="523"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="388">The new eos message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="382">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_error" c:identifier="gst_message_new_error">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="447">Create a new error message. The message will copy @error and
-@debug. This message is posted by element when a fatal event
-occurred. The pipeline will probably (partially) stop. The application
-receiving this message should stop the pipeline.</doc>
- <source-position filename="gst/gstmessage.h" line="528"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="458">the new error message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="449">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="error" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="450">The GError for this message.</doc>
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- <parameter name="debug" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="451">A debugging string.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_error_with_details"
- c:identifier="gst_message_new_error_with_details"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="402">Create a new error message. The message will copy @error and
-@debug. This message is posted by element when a fatal event
-occurred. The pipeline will probably (partially) stop. The application
-receiving this message should stop the pipeline.</doc>
- <source-position filename="gst/gstmessage.h" line="531"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="414">the new error message.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="404">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="error" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="405">The GError for this message.</doc>
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- <parameter name="debug" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="406">A debugging string.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="details"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="407">A GstStructure with details</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_have_context"
- c:identifier="gst_message_new_have_context"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2542">This message is posted when an element has a new local #GstContext.</doc>
- <source-position filename="gst/gstmessage.h" line="801"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2549">The new have-context message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2544">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="context" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2545">the context</doc>
- <type name="Context" c:type="GstContext*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_info" c:identifier="gst_message_new_info">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="629">Create a new info message. The message will make copies of @error and
-@debug.</doc>
- <source-position filename="gst/gstmessage.h" line="556"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="638">the new info message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="631">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="error" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="632">The GError for this message.</doc>
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- <parameter name="debug" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="633">A debugging string.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_info_with_details"
- c:identifier="gst_message_new_info_with_details"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="586">Create a new info message. The message will make copies of @error and
-@debug.</doc>
- <source-position filename="gst/gstmessage.h" line="559"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="596">the new warning message.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="588">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="error" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="589">The GError for this message.</doc>
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- <parameter name="debug" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="590">A debugging string.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="details"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="591">A GstStructure with details</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_instant_rate_request"
- c:identifier="gst_message_new_instant_rate_request"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3272">Creates a new instant-rate-request message. Elements handling the
-instant-rate-change event must post this message. The message is
-handled at the pipeline, and allows the pipeline to select the
-running time when the rate change should happen and to send an
-@GST_EVENT_INSTANT_RATE_SYNC_TIME event to notify the elements
-in the pipeline.</doc>
- <source-position filename="gst/gstmessage.h" line="881"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3284">a newly allocated #GstMessage</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3274">The #GstObject that posted the message</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="rate_multiplier" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3275">the rate multiplier factor that should be applied</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_latency" c:identifier="gst_message_new_latency">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1100">This message can be posted by elements when their latency requirements have
-changed.</doc>
- <source-position filename="gst/gstmessage.h" line="677"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1107">The new latency message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1102">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_need_context"
- c:identifier="gst_message_new_need_context"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2483">This message is posted when an element needs a specific #GstContext.</doc>
- <source-position filename="gst/gstmessage.h" line="793"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2490">The new need-context message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2485">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="context_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2486">The context type that is needed</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_new_clock"
- c:identifier="gst_message_new_new_clock">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="860">Create a new clock message. This message is posted whenever the
-pipeline selects a new clock for the pipeline.</doc>
- <source-position filename="gst/gstmessage.h" line="636"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="868">The new new clock message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="862">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="863">the new selected clock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_progress" c:identifier="gst_message_new_progress">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2223">Progress messages are posted by elements when they use an asynchronous task
-to perform actions triggered by a state change.
-
-@code contains a well defined string describing the action.
-@text should contain a user visible string detailing the current action.</doc>
- <source-position filename="gst/gstmessage.h" line="757"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2236">The new qos message.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2225">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2226">a #GstProgressType</doc>
- <type name="ProgressType" c:type="GstProgressType"/>
- </parameter>
- <parameter name="code" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2227">a progress code</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="text" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2228">free, user visible text describing the progress</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_property_notify"
- c:identifier="gst_message_new_property_notify"
- version="1.10">
- <source-position filename="gst/gstmessage.h" line="834"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2765">a newly allocated #GstMessage</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2761">The #GstObject whose property changed (may or may not be a #GstElement)</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2762">name of the property that changed</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="val"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2763">new property value, or %NULL</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_qos" c:identifier="gst_message_new_qos">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2001">A QOS message is posted on the bus whenever an element decides to drop a
-buffer because of QoS reasons or whenever it changes its processing strategy
-because of QoS reasons (quality adjustments such as processing at lower
-accuracy).
-
-This message can be posted by an element that performs synchronisation against the
-clock (live) or it could be dropped by an element that performs QoS because of QOS
-events received from a downstream element (!live).
-
-@running_time, @stream_time, @timestamp, @duration should be set to the
-respective running-time, stream-time, timestamp and duration of the (dropped)
-buffer that generated the QoS event. Values can be left to
-GST_CLOCK_TIME_NONE when unknown.</doc>
- <source-position filename="gst/gstmessage.h" line="737"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2024">The new qos message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2003">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="live" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2004">if the message was generated by a live element</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="running_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2005">the running time of the buffer that generated the message</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="stream_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2006">the stream time of the buffer that generated the message</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2007">the timestamps of the buffer that generated the message</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2008">the duration of the buffer that generated the message</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_redirect"
- c:identifier="gst_message_new_redirect"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3032">Creates a new redirect message and adds a new entry to it. Redirect messages
-are posted when an element detects that the actual data has to be retrieved
-from a different location. This is useful if such a redirection cannot be
-handled inside a source element, for example when HTTP 302/303 redirects
-return a non-HTTP URL.
-
-The redirect message can hold multiple entries. The first one is added
-when the redirect message is created, with the given location, tag_list,
-entry_struct arguments. Use gst_message_add_redirect_entry() to add more
-entries.
-
-Each entry has a location, a tag list, and a structure. All of these are
-optional. The tag list and structure are useful for additional metadata,
-such as bitrate statistics for the given location.
-
-By default, message recipients should treat entries in the order they are
-stored. The recipient should therefore try entry \#0 first, and if this
-entry is not acceptable or working, try entry \#1 etc. Senders must make
-sure that they add entries in this order. However, recipients are free to
-ignore the order and pick an entry that is "best" for them. One example
-would be a recipient that scans the entries for the one with the highest
-bitrate tag.
-
-The specified location string is copied. However, ownership over the tag
-list and structure are transferred to the message.</doc>
- <source-position filename="gst/gstmessage.h" line="867"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3065">a newly allocated #GstMessage</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3034">The #GstObject whose property changed (may or may not be a #GstElement)</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="location" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3035">location string for the new entry</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="tag_list"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3036">tag list for the new entry</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </parameter>
- <parameter name="entry_struct"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3037">structure for the new entry</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_request_state"
- c:identifier="gst_message_new_request_state">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1121">This message can be posted by elements when they want to have their state
-changed. A typical use case would be an audio server that wants to pause the
-pipeline because a higher priority stream is being played.</doc>
- <source-position filename="gst/gstmessage.h" line="718"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1130">the new request state message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1123">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="state" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1124">The new requested state</doc>
- <type name="State" c:type="GstState"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_reset_time"
- c:identifier="gst_message_new_reset_time">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2339">This message is posted when the pipeline running-time should be reset to
-@running_time, like after a flushing seek.</doc>
- <source-position filename="gst/gstmessage.h" line="774"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2347">The new reset_time message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2341">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="running_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2342">the requested running-time</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_segment_done"
- c:identifier="gst_message_new_segment_done">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="954">Create a new segment done message. This message is posted by elements that
-finish playback of a segment as a result of a segment seek. This message
-is received by the application after all elements that posted a segment_start
-have posted the segment_done.</doc>
- <source-position filename="gst/gstmessage.h" line="663"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="965">the new segment done message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="956">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="957">The format of the position being done</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="958">The position of the segment being done</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_segment_start"
- c:identifier="gst_message_new_segment_start">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="924">Create a new segment message. This message is posted by elements that
-start playback of a segment as a result of a segment seek. This message
-is not received by the application but is used for maintenance reasons in
-container elements.</doc>
- <source-position filename="gst/gstmessage.h" line="654"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="935">the new segment start message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="926">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="927">The format of the position being played</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="928">The position of the segment being played</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_state_changed"
- c:identifier="gst_message_new_state_changed">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="747">Create a state change message. This message is posted whenever an element
-changed its state.</doc>
- <source-position filename="gst/gstmessage.h" line="595"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="757">the new state change message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="749">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="oldstate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="750">the previous state</doc>
- <type name="State" c:type="GstState"/>
- </parameter>
- <parameter name="newstate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="751">the new (current) state</doc>
- <type name="State" c:type="GstState"/>
- </parameter>
- <parameter name="pending" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="752">the pending (target) state</doc>
- <type name="State" c:type="GstState"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_state_dirty"
- c:identifier="gst_message_new_state_dirty">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="777">Create a state dirty message. This message is posted whenever an element
-changed its state asynchronously and is used internally to update the
-states of container objects.</doc>
- <source-position filename="gst/gstmessage.h" line="604"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="785">the new state dirty message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="779">The object originating the message</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_step_done"
- c:identifier="gst_message_new_step_done">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1845">This message is posted by elements when they complete a part, when @intermediate set
-to %TRUE, or a complete step operation.
-
-@duration will contain the amount of time (in GST_FORMAT_TIME) of the stepped
-@amount of media in format @format.</doc>
- <source-position filename="gst/gstmessage.h" line="609"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1862">the new step_done message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1847">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1848">the format of @amount</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="amount" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1849">the amount of stepped data</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1850">the rate of the stepped amount</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="flush" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1851">is this an flushing step</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="intermediate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1852">is this an intermediate step</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1853">the duration of the data</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="eos" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1854">the step caused EOS</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_step_start"
- c:identifier="gst_message_new_step_start">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1923">This message is posted by elements when they accept or activate a new step
-event for @amount in @format.
-
-@active is set to %FALSE when the element accepted the new step event and has
-queued it for execution in the streaming threads.
-
-@active is set to %TRUE when the element has activated the step operation and
-is now ready to start executing the step in the streaming thread. After this
-message is emitted, the application can queue a new step operation in the
-element.</doc>
- <source-position filename="gst/gstmessage.h" line="726"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1944">The new step_start message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1925">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1926">if the step is active or queued</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1927">the format of @amount</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="amount" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1928">the amount of stepped data</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1929">the rate of the stepped amount</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="flush" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1930">is this an flushing step</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="intermediate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1931">is this an intermediate step</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_stream_collection"
- c:identifier="gst_message_new_stream_collection"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2831">Creates a new stream-collection message. The message is used to announce new
-#GstStreamCollection</doc>
- <source-position filename="gst/gstmessage.h" line="842"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2839">a newly allocated #GstMessage</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2833">The #GstObject that created the message</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="collection" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2834">The #GstStreamCollection</doc>
- <type name="StreamCollection" c:type="GstStreamCollection*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_stream_start"
- c:identifier="gst_message_new_stream_start">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2389">Create a new stream_start message. This message is generated and posted in
-the sink elements of a GstBin. The bin will only forward the STREAM_START
-message to the application if all sinks have posted an STREAM_START message.</doc>
- <source-position filename="gst/gstmessage.h" line="782"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2397">The new stream_start message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2391">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_stream_status"
- c:identifier="gst_message_new_stream_status">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1735">Create a new stream status message. This message is posted when a streaming
-thread is created/destroyed or when the state changed.</doc>
- <source-position filename="gst/gstmessage.h" line="704"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1744">the new stream status message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1737">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1738">The stream status type.</doc>
- <type name="StreamStatusType" c:type="GstStreamStatusType"/>
- </parameter>
- <parameter name="owner" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1739">the owner element of @src.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_streams_selected"
- c:identifier="gst_message_new_streams_selected"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2885">Creates a new steams-selected message. The message is used to announce
-that an array of streams has been selected. This is generally in response
-to a #GST_EVENT_SELECT_STREAMS event, or when an element (such as decodebin3)
-makes an initial selection of streams.
-
-The message also contains the #GstStreamCollection to which the various streams
-belong to.
-
-Users of gst_message_new_streams_selected() can add the selected streams with
-gst_message_streams_selected_add().</doc>
- <source-position filename="gst/gstmessage.h" line="850"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2901">a newly allocated #GstMessage</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2887">The #GstObject that created the message</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="collection" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2888">The #GstStreamCollection</doc>
- <type name="StreamCollection" c:type="GstStreamCollection*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_structure_change"
- c:identifier="gst_message_new_structure_change">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="885">Create a new structure change message. This message is posted when the
-structure of a pipeline is in the process of being changed, for example
-when pads are linked or unlinked.
-
-@src should be the sinkpad that unlinked or linked.</doc>
- <source-position filename="gst/gstmessage.h" line="695"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="898">the new structure change message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="887">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="888">The change type.</doc>
- <type name="StructureChangeType" c:type="GstStructureChangeType"/>
- </parameter>
- <parameter name="owner" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="889">The owner element of @src.</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="busy" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="890">Whether the structure change is busy.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_tag" c:identifier="gst_message_new_tag">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="676">Create a new tag message. The message will take ownership of the tag list.
-The message is posted by elements that discovered a new taglist.</doc>
- <source-position filename="gst/gstmessage.h" line="570"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="684">the new tag message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="678">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="tag_list" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="679">the tag list for the message.</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_toc" c:identifier="gst_message_new_toc">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2288">Create a new TOC message. The message is posted by elements
-that discovered or updated a TOC.</doc>
- <source-position filename="gst/gstmessage.h" line="766"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2297">a new TOC message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2290">the object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="toc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2291">#GstToc structure for the message.</doc>
- <type name="Toc" c:type="GstToc*"/>
- </parameter>
- <parameter name="updated" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2292">whether TOC was updated or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_warning" c:identifier="gst_message_new_warning">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="539">Create a new warning message. The message will make copies of @error and
-@debug.</doc>
- <source-position filename="gst/gstmessage.h" line="542"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="548">the new warning message.
-
-MT safe.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="541">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="error" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="542">The GError for this message.</doc>
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- <parameter name="debug" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="543">A debugging string.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_warning_with_details"
- c:identifier="gst_message_new_warning_with_details"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="496">Create a new warning message. The message will make copies of @error and
-@debug.</doc>
- <source-position filename="gst/gstmessage.h" line="545"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="506">the new warning message.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="498">The object originating the message.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="error" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="499">The GError for this message.</doc>
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- <parameter name="debug" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="500">A debugging string.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="details"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="501">A GstStructure with details</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="add_redirect_entry"
- c:identifier="gst_message_add_redirect_entry"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3101">Creates and appends a new entry.
-
-The specified location string is copied. However, ownership over the tag
-list and structure are transferred to the message.</doc>
- <source-position filename="gst/gstmessage.h" line="870"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3103">a #GstMessage of type %GST_MESSAGE_REDIRECT</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="location" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3104">location string for the new entry</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="tag_list"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3105">tag list for the new entry</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </parameter>
- <parameter name="entry_struct"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3106">structure for the new entry</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_message_copy" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="413">Creates a copy of the message. Returns a copy of the message.</doc>
- <source-position filename="gst/gstmessage.h" line="423"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="419">a new copy of @msg.
-
-MT safe</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="415">the message to copy</doc>
- <type name="Message" c:type="const GstMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_num_redirect_entries"
- c:identifier="gst_message_get_num_redirect_entries"
- version="1.10">
- <source-position filename="gst/gstmessage.h" line="876"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3232">the number of entries stored in the message</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3230">a #GstMessage of type %GST_MESSAGE_REDIRECT</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_seqnum" c:identifier="gst_message_get_seqnum">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="329">Retrieve the sequence number of a message.
-
-Messages have ever-incrementing sequence numbers, which may also be set
-explicitly via gst_message_set_seqnum(). Sequence numbers are typically used
-to indicate that a message corresponds to some other set of messages or
-events, for example a SEGMENT_DONE message corresponding to a SEEK event. It
-is considered good practice to make this correspondence when possible, though
-it is not required.
-
-Note that events and messages share the same sequence number incrementor;
-two events or messages will never have the same sequence number unless
-that correspondence was made explicitly.</doc>
- <source-position filename="gst/gstmessage.h" line="515"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="346">The message's sequence number.
-
-MT safe.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="331">A #GstMessage.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_status_object"
- c:identifier="gst_message_get_stream_status_object">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1818">Extracts the object managing the streaming thread from @message.</doc>
- <source-position filename="gst/gstmessage.h" line="713"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1824">a GValue containing the object that manages the
-streaming thread. This object is usually of type GstTask but other types can
-be added in the future. The object remains valid as long as @message is
-valid.</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1820">A valid #GstMessage of type GST_MESSAGE_STREAM_STATUS.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_structure" c:identifier="gst_message_get_structure">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1147">Access the structure of the message.</doc>
- <source-position filename="gst/gstmessage.h" line="504"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1153">The structure of the message. The
-structure is still owned by the message, which means that you should not
-free it and that the pointer becomes invalid when you free the message.
-
-MT safe.</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1149">The #GstMessage.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_name" c:identifier="gst_message_has_name">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1204">Checks if @message has the given @name. This function is usually used to
-check the name of a custom message.</doc>
- <source-position filename="gst/gstmessage.h" line="510"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1212">%TRUE if @name matches the name of the message structure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1206">The #GstMessage.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1207">name to check</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_async_done"
- c:identifier="gst_message_parse_async_done">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1687">Extract the running_time from the async_done message.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="690"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1689">A valid #GstMessage of type GST_MESSAGE_ASYNC_DONE.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="running_time"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1690">Result location for the running_time or %NULL</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_buffering"
- c:identifier="gst_message_parse_buffering">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1267">Extracts the buffering percent from the GstMessage. see also
-gst_message_new_buffering().
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="581"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1269">A valid #GstMessage of type GST_MESSAGE_BUFFERING.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="percent"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1270">Return location for the percent.</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_buffering_stats"
- c:identifier="gst_message_parse_buffering_stats">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1313">Extracts the buffering stats values from @message.</doc>
- <source-position filename="gst/gstmessage.h" line="588"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1315">A valid #GstMessage of type GST_MESSAGE_BUFFERING.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="mode"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1316">a buffering mode, or %NULL</doc>
- <type name="BufferingMode" c:type="GstBufferingMode*"/>
- </parameter>
- <parameter name="avg_in"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1317">the average input rate, or %NULL</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="avg_out"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1318">the average output rate, or %NULL</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="buffering_left"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1319">amount of buffering time left in
- milliseconds, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_clock_lost"
- c:identifier="gst_message_parse_clock_lost">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1439">Extracts the lost clock from the GstMessage.
-The clock object returned remains valid until the message is freed.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="631"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1441">A valid #GstMessage of type GST_MESSAGE_CLOCK_LOST.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="clock"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1442">a pointer to hold the lost clock</doc>
- <type name="Clock" c:type="GstClock**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_clock_provide"
- c:identifier="gst_message_parse_clock_provide">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1404">Extracts the clock and ready flag from the GstMessage.
-The clock object returned remains valid until the message is freed.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="622"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1406">A valid #GstMessage of type GST_MESSAGE_CLOCK_PROVIDE.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="clock"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1407">a pointer to hold a clock
- object, or %NULL</doc>
- <type name="Clock" c:type="GstClock**"/>
- </parameter>
- <parameter name="ready"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1409">a pointer to hold the ready flag, or %NULL</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_context_type"
- c:identifier="gst_message_parse_context_type"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2511">Parse a context type from an existing GST_MESSAGE_NEED_CONTEXT message.</doc>
- <source-position filename="gst/gstmessage.h" line="796"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2518">a #gboolean indicating if the parsing succeeded.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2513">a GST_MESSAGE_NEED_CONTEXT type message</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="context_type"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2514">the context type, or %NULL</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_device_added"
- c:identifier="gst_message_parse_device_added"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2621">Parses a device-added message. The device-added message is produced by
-#GstDeviceProvider or a #GstDeviceMonitor. It announces the appearance
-of monitored devices.</doc>
- <source-position filename="gst/gstmessage.h" line="812"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2623">a #GstMessage of type %GST_MESSAGE_DEVICE_ADDED</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="device"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2624">A location where to store a
- pointer to the new #GstDevice, or %NULL</doc>
- <type name="Device" c:type="GstDevice**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_device_changed"
- c:identifier="gst_message_parse_device_changed"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2728">Parses a device-changed message. The device-changed message is produced by
-#GstDeviceProvider or a #GstDeviceMonitor. It announces the
-disappearance of monitored devices. * It announce that a device properties has
-changed and @device represents the new modified version of @changed_device.</doc>
- <source-position filename="gst/gstmessage.h" line="828"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2730">a #GstMessage of type %GST_MESSAGE_DEVICE_CHANGED</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="device"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2731">A location where to store a
- pointer to the updated version of the #GstDevice, or %NULL</doc>
- <type name="Device" c:type="GstDevice**"/>
- </parameter>
- <parameter name="changed_device"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2733">A location where to store a
- pointer to the old version of the #GstDevice, or %NULL</doc>
- <type name="Device" c:type="GstDevice**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_device_removed"
- c:identifier="gst_message_parse_device_removed"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2673">Parses a device-removed message. The device-removed message is produced by
-#GstDeviceProvider or a #GstDeviceMonitor. It announces the
-disappearance of monitored devices.</doc>
- <source-position filename="gst/gstmessage.h" line="820"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2675">a #GstMessage of type %GST_MESSAGE_DEVICE_REMOVED</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="device"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2676">A location where to store a
- pointer to the removed #GstDevice, or %NULL</doc>
- <type name="Device" c:type="GstDevice**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_error" c:identifier="gst_message_parse_error">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1536">Extracts the GError and debug string from the GstMessage. The values returned
-in the output arguments are copies; the caller must free them when done.
-
-Typical usage of this function might be:
-|[&lt;!-- language="C" --&gt;
- ...
- switch (GST_MESSAGE_TYPE (msg)) {
- case GST_MESSAGE_ERROR: {
- GError *err = NULL;
- gchar *dbg_info = NULL;
-
- gst_message_parse_error (msg, &amp;amp;err, &amp;amp;dbg_info);
- g_printerr ("ERROR from element %s: %s\n",
- GST_OBJECT_NAME (msg-&gt;src), err-&gt;message);
- g_printerr ("Debugging info: %s\n", (dbg_info) ? dbg_info : "none");
- g_error_free (err);
- g_free (dbg_info);
- break;
- }
- ...
- }
- ...
-]|
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="534"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1538">A valid #GstMessage of type GST_MESSAGE_ERROR.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="gerror"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1539">location for the GError</doc>
- <type name="GLib.Error" c:type="GError**"/>
- </parameter>
- <parameter name="debug"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1540">location for the debug message,
- or %NULL</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_error_details"
- c:identifier="gst_message_parse_error_details"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="468">Returns the optional details structure, may be NULL if none.
-The returned structure must not be freed.</doc>
- <source-position filename="gst/gstmessage.h" line="537"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="470">The message object</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="structure"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="471">A pointer to the returned details</doc>
- <type name="Structure" c:type="const GstStructure**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_group_id"
- c:identifier="gst_message_parse_group_id"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2446">Extract the group from the STREAM_START message.</doc>
- <source-position filename="gst/gstmessage.h" line="788"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2454">%TRUE if the message had a group id set, %FALSE otherwise
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2448">A valid #GstMessage of type GST_MESSAGE_STREAM_START.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="group_id"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2449">Result location for the group id or
- %NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_have_context"
- c:identifier="gst_message_parse_have_context"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2569">Extract the context from the HAVE_CONTEXT message.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="804"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2571">A valid #GstMessage of type GST_MESSAGE_HAVE_CONTEXT.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="context"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2572">Result location for the
- context or %NULL</doc>
- <type name="Context" c:type="GstContext**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_info" c:identifier="gst_message_parse_info">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1604">Extracts the GError and debug string from the GstMessage. The values returned
-in the output arguments are copies; the caller must free them when done.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="562"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1606">A valid #GstMessage of type GST_MESSAGE_INFO.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="gerror"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1607">location for the GError</doc>
- <type name="GLib.Error" c:type="GError**"/>
- </parameter>
- <parameter name="debug"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1608">location for the debug message,
- or %NULL</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_info_details"
- c:identifier="gst_message_parse_info_details"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="648">Returns the optional details structure, may be NULL if none
-The returned structure must not be freed.</doc>
- <source-position filename="gst/gstmessage.h" line="565"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="650">The message object</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="structure"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="651">A pointer to the returned details structure</doc>
- <type name="Structure" c:type="const GstStructure**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_instant_rate_request"
- c:identifier="gst_message_parse_instant_rate_request"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3304">Parses the rate_multiplier from the instant-rate-request message.</doc>
- <source-position filename="gst/gstmessage.h" line="883"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3306">a #GstMessage of type %GST_MESSAGE_INSTANT_RATE_REQUEST</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="rate_multiplier"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3307">return location for the rate, or %NULL</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_new_clock"
- c:identifier="gst_message_parse_new_clock">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1467">Extracts the new clock from the GstMessage.
-The clock object returned remains valid until the message is freed.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="639"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1469">A valid #GstMessage of type GST_MESSAGE_NEW_CLOCK.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="clock"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1470">a pointer to hold the selected
- new clock</doc>
- <type name="Clock" c:type="GstClock**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_progress" c:identifier="gst_message_parse_progress">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2263">Parses the progress @type, @code and @text.</doc>
- <source-position filename="gst/gstmessage.h" line="760"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2265">A valid #GstMessage of type GST_MESSAGE_PROGRESS.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="type"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2266">location for the type</doc>
- <type name="ProgressType" c:type="GstProgressType*"/>
- </parameter>
- <parameter name="code"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2267">location for the code</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- <parameter name="text"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2268">location for the text</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_property_notify"
- c:identifier="gst_message_parse_property_notify"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2789">Parses a property-notify message. These will be posted on the bus only
-when set up with gst_element_add_property_notify_watch() or
-gst_element_add_property_deep_notify_watch().</doc>
- <source-position filename="gst/gstmessage.h" line="837"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2791">a #GstMessage of type %GST_MESSAGE_PROPERTY_NOTIFY</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="object"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2792">location where to store a
- pointer to the object whose property got changed, or %NULL</doc>
- <type name="Object" c:type="GstObject**"/>
- </parameter>
- <parameter name="property_name"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2794">return location for
- the name of the property that got changed, or %NULL</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- <parameter name="property_value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2796">return location for
- the new value of the property that got changed, or %NULL. This will
- only be set if the property notify watch was told to include the value
- when it was set up</doc>
- <type name="GObject.Value" c:type="const GValue**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_qos" c:identifier="gst_message_parse_qos">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2116">Extract the timestamps and live status from the QoS message.
-
-The returned values give the running_time, stream_time, timestamp and
-duration of the dropped buffer. Values of GST_CLOCK_TIME_NONE mean unknown
-values.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="746"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2118">A valid #GstMessage of type GST_MESSAGE_QOS.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="live"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2119">if the message was generated by a live element</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="running_time"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2120">the running time of the buffer that
- generated the message</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="stream_time"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2122">the stream time of the buffer that
- generated the message</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="timestamp"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2124">the timestamps of the buffer that
- generated the message</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="duration"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2126">the duration of the buffer that
- generated the message</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_qos_stats"
- c:identifier="gst_message_parse_qos_stats">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2187">Extract the QoS stats representing the history of the current continuous
-pipeline playback period.
-
-When @format is @GST_FORMAT_UNDEFINED both @dropped and @processed are
-invalid. Values of -1 for either @processed or @dropped mean unknown values.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="752"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2189">A valid #GstMessage of type GST_MESSAGE_QOS.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2190">Units of the 'processed' and 'dropped' fields.
- Video sinks and video filters will use GST_FORMAT_BUFFERS (frames).
- Audio sinks and audio filters will likely use GST_FORMAT_DEFAULT
- (samples).</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="processed"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2194">Total number of units correctly processed
- since the last state change to READY or a flushing operation.</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="dropped"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2196">Total number of units dropped since the last
- state change to READY or a flushing operation.</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_qos_values"
- c:identifier="gst_message_parse_qos_values">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2156">Extract the QoS values that have been calculated/analysed from the QoS data
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="749"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2158">A valid #GstMessage of type GST_MESSAGE_QOS.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="jitter"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2159">The difference of the running-time against
- the deadline.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- <parameter name="proportion"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2161">Long term prediction of the ideal rate
- relative to normal rate to get optimal quality.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="quality"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2163">An element dependent integer value that
- specifies the current quality level of the element. The default
- maximum quality is 1000000.</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_redirect_entry"
- c:identifier="gst_message_parse_redirect_entry"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3160">Parses the location and/or structure from the entry with the given index.
-The index must be between 0 and gst_message_get_num_redirect_entries() - 1.
-Returned pointers are valid for as long as this message exists.</doc>
- <source-position filename="gst/gstmessage.h" line="873"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3162">a #GstMessage of type %GST_MESSAGE_REDIRECT</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="entry_index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3163">index of the entry to parse</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="location"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3164">return location for
- the pointer to the entry's location string, or %NULL</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- <parameter name="tag_list"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3166">return location for
- the pointer to the entry's tag list, or %NULL</doc>
- <type name="TagList" c:type="GstTagList**"/>
- </parameter>
- <parameter name="entry_struct"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3168">return location
- for the pointer to the entry's structure, or %NULL</doc>
- <type name="Structure" c:type="const GstStructure**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_request_state"
- c:identifier="gst_message_parse_request_state">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1711">Extract the requested state from the request_state message.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="721"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1713">A valid #GstMessage of type GST_MESSAGE_REQUEST_STATE.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="state"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1714">Result location for the requested state or %NULL</doc>
- <type name="State" c:type="GstState*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_reset_time"
- c:identifier="gst_message_parse_reset_time">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2364">Extract the running-time from the RESET_TIME message.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="777"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2366">A valid #GstMessage of type GST_MESSAGE_RESET_TIME.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="running_time"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2367">Result location for the running_time or
- %NULL</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_segment_done"
- c:identifier="gst_message_parse_segment_done">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1657">Extracts the position and format from the segment done message.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="666"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1659">A valid #GstMessage of type GST_MESSAGE_SEGMENT_DONE.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1660">Result location for the format, or %NULL</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="position"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1661">Result location for the position, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_segment_start"
- c:identifier="gst_message_parse_segment_start">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1627">Extracts the position and format from the segment start message.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="657"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1629">A valid #GstMessage of type GST_MESSAGE_SEGMENT_START.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1630">Result location for the format, or %NULL</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="position"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1631">Result location for the position, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_state_changed"
- c:identifier="gst_message_parse_state_changed">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1350">Extracts the old and new states from the GstMessage.
-
-Typical usage of this function might be:
-|[&lt;!-- language="C" --&gt;
- ...
- switch (GST_MESSAGE_TYPE (msg)) {
- case GST_MESSAGE_STATE_CHANGED: {
- GstState old_state, new_state;
-
- gst_message_parse_state_changed (msg, &amp;amp;old_state, &amp;amp;new_state, NULL);
- g_print ("Element %s changed state from %s to %s.\n",
- GST_OBJECT_NAME (msg-&gt;src),
- gst_element_state_get_name (old_state),
- gst_element_state_get_name (new_state));
- break;
- }
- ...
- }
- ...
-]|
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="598"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1352">a valid #GstMessage of type GST_MESSAGE_STATE_CHANGED</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="oldstate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1353">the previous state, or %NULL</doc>
- <type name="State" c:type="GstState*"/>
- </parameter>
- <parameter name="newstate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1354">the new (current) state, or %NULL</doc>
- <type name="State" c:type="GstState*"/>
- </parameter>
- <parameter name="pending"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1355">the pending (target) state, or %NULL</doc>
- <type name="State" c:type="GstState*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_step_done"
- c:identifier="gst_message_parse_step_done">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1887">Extract the values the step_done message.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="613"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1889">A valid #GstMessage of type GST_MESSAGE_STEP_DONE.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1890">result location for the format</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="amount"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1891">result location for the amount</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="rate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1892">result location for the rate</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="flush"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1893">result location for the flush flag</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="intermediate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1894">result location for the intermediate flag</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="duration"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1895">result location for the duration</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="eos"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1896">result location for the EOS flag</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_step_start"
- c:identifier="gst_message_parse_step_start">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1967">Extract the values from step_start message.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="730"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1969">A valid #GstMessage of type GST_MESSAGE_STEP_DONE.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="active"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1970">result location for the active flag</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1971">result location for the format</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="amount"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1972">result location for the amount</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="rate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1973">result location for the rate</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="flush"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1974">result location for the flush flag</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="intermediate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1975">result location for the intermediate flag</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_stream_collection"
- c:identifier="gst_message_parse_stream_collection"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2862">Parses a stream-collection message.</doc>
- <source-position filename="gst/gstmessage.h" line="845"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2864">a #GstMessage of type %GST_MESSAGE_STREAM_COLLECTION</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="collection"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2865">A location where to store a
- pointer to the #GstStreamCollection, or %NULL</doc>
- <type name="StreamCollection" c:type="GstStreamCollection**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_stream_status"
- c:identifier="gst_message_parse_stream_status">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1763">Extracts the stream status type and owner the GstMessage. The returned
-owner remains valid for as long as the reference to @message is valid and
-should thus not be unreffed.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="707"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1765">A valid #GstMessage of type GST_MESSAGE_STREAM_STATUS.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="type"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1766">A pointer to hold the status type</doc>
- <type name="StreamStatusType" c:type="GstStreamStatusType*"/>
- </parameter>
- <parameter name="owner"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1767">The owner element of the message source</doc>
- <type name="Element" c:type="GstElement**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_streams_selected"
- c:identifier="gst_message_parse_streams_selected"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3010">Parses a streams-selected message.</doc>
- <source-position filename="gst/gstmessage.h" line="856"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3012">a #GstMessage of type %GST_MESSAGE_STREAMS_SELECTED</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="collection"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="3013">A location where to store a
- pointer to the #GstStreamCollection, or %NULL</doc>
- <type name="StreamCollection" c:type="GstStreamCollection**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_structure_change"
- c:identifier="gst_message_parse_structure_change">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1496">Extracts the change type and completion status from the GstMessage.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="698"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1498">A valid #GstMessage of type GST_MESSAGE_STRUCTURE_CHANGE.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="type"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1499">A pointer to hold the change type</doc>
- <type name="StructureChangeType" c:type="GstStructureChangeType*"/>
- </parameter>
- <parameter name="owner"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1500">The owner element of the
- message source</doc>
- <type name="Element" c:type="GstElement**"/>
- </parameter>
- <parameter name="busy"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1502">a pointer to hold whether the change is in
- progress or has been completed</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_tag" c:identifier="gst_message_parse_tag">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1228">Extracts the tag list from the GstMessage. The tag list returned in the
-output argument is a copy; the caller must free it when done.
-
-Typical usage of this function might be:
-|[&lt;!-- language="C" --&gt;
- ...
- switch (GST_MESSAGE_TYPE (msg)) {
- case GST_MESSAGE_TAG: {
- GstTagList *tags = NULL;
-
- gst_message_parse_tag (msg, &amp;amp;tags);
- g_print ("Got tags from element %s\n", GST_OBJECT_NAME (msg-&gt;src));
- handle_tags (tags);
- gst_tag_list_unref (tags);
- break;
- }
- ...
- }
- ...
-]|
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="573"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1230">A valid #GstMessage of type GST_MESSAGE_TAG.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="tag_list"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1231">return location for the tag-list.</doc>
- <type name="TagList" c:type="GstTagList**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_toc" c:identifier="gst_message_parse_toc">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2315">Extract the TOC from the #GstMessage. The TOC returned in the
-output argument is a copy; the caller must free it with
-gst_toc_unref() when done.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="769"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2317">a valid #GstMessage of type GST_MESSAGE_TOC.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="toc"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2318">return location for the TOC.</doc>
- <type name="Toc" c:type="GstToc**"/>
- </parameter>
- <parameter name="updated"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2319">return location for the updated flag.</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_warning" c:identifier="gst_message_parse_warning">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1580">Extracts the GError and debug string from the GstMessage. The values returned
-in the output arguments are copies; the caller must free them when done.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="548"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1582">A valid #GstMessage of type GST_MESSAGE_WARNING.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="gerror"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1583">location for the GError</doc>
- <type name="GLib.Error" c:type="GError**"/>
- </parameter>
- <parameter name="debug"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1584">location for the debug message,
- or %NULL</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_warning_details"
- c:identifier="gst_message_parse_warning_details"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="558">Returns the optional details structure, may be NULL if none
-The returned structure must not be freed.</doc>
- <source-position filename="gst/gstmessage.h" line="551"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="560">The message object</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="structure"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="561">A pointer to the returned details structure</doc>
- <type name="Structure" c:type="const GstStructure**"/>
- </parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_message_ref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="364">Convenience macro to increase the reference count of the message.</doc>
- <source-position filename="gst/gstmessage.h" line="372"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="370">@msg (for convenience when doing assignments)</doc>
- <type name="Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="366">the message to ref</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_buffering_stats"
- c:identifier="gst_message_set_buffering_stats">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1289">Configures the buffering stats values in @message.</doc>
- <source-position filename="gst/gstmessage.h" line="584"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1291">A valid #GstMessage of type GST_MESSAGE_BUFFERING.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1292">a buffering mode</doc>
- <type name="BufferingMode" c:type="GstBufferingMode"/>
- </parameter>
- <parameter name="avg_in" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1293">the average input rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="avg_out" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1294">the average output rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="buffering_left" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1295">amount of buffering time left in milliseconds</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_group_id"
- c:identifier="gst_message_set_group_id"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2414">Sets the group id on the stream-start message.
-
-All streams that have the same group id are supposed to be played
-together, i.e. all streams inside a container file should have the
-same group id but different stream ids. The group id should change
-each time the stream is started, resulting in different group ids
-each time a file is played for example.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="785"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2416">the message</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="group_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2417">the group id</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_qos_stats" c:identifier="gst_message_set_qos_stats">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2081">Set the QoS stats representing the history of the current continuous pipeline
-playback period.
-
-When @format is @GST_FORMAT_UNDEFINED both @dropped and @processed are
-invalid. Values of -1 for either @processed or @dropped mean unknown values.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="743"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2083">A valid #GstMessage of type GST_MESSAGE_QOS.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2084">Units of the 'processed' and 'dropped' fields. Video sinks and video
-filters will use GST_FORMAT_BUFFERS (frames). Audio sinks and audio filters
-will likely use GST_FORMAT_DEFAULT (samples).</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="processed" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2087">Total number of units correctly processed since the last state
-change to READY or a flushing operation.</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="dropped" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2089">Total number of units dropped since the last state change to READY
-or a flushing operation.</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_qos_values" c:identifier="gst_message_set_qos_values">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2052">Set the QoS values that have been calculated/analysed from the QoS data
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="740"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2054">A valid #GstMessage of type GST_MESSAGE_QOS.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="jitter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2055">The difference of the running-time against the deadline.</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="proportion" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2056">Long term prediction of the ideal rate relative to normal rate
-to get optimal quality.</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="quality" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2058">An element dependent integer value that specifies the current
-quality level of the element. The default maximum quality is 1000000.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_seqnum" c:identifier="gst_message_set_seqnum">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="358">Set the sequence number of a message.
-
-This function might be called by the creator of a message to indicate that
-the message relates to other messages or events. See gst_message_get_seqnum()
-for more information.
-
-MT safe.</doc>
- <source-position filename="gst/gstmessage.h" line="518"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="360">A #GstMessage.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="seqnum" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="361">A sequence number.</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_stream_status_object"
- c:identifier="gst_message_set_stream_status_object">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1797">Configures the object handling the streaming thread. This is usually a
-GstTask object but other objects might be added in the future.</doc>
- <source-position filename="gst/gstmessage.h" line="710"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1799">A valid #GstMessage of type GST_MESSAGE_STREAM_STATUS.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1800">the object controlling the streaming</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="streams_selected_add"
- c:identifier="gst_message_streams_selected_add"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2952">Adds the @stream to the @message.</doc>
- <source-position filename="gst/gstmessage.h" line="853"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2954">a #GstMessage of type %GST_MESSAGE_STREAMS_SELECTED</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2955">a #GstStream to add to @message</doc>
- <type name="Stream" c:type="GstStream*"/>
- </parameter>
- </parameters>
- </method>
- <method name="streams_selected_get_size"
- c:identifier="gst_message_streams_selected_get_size"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2927">Returns the number of streams contained in the @message.</doc>
- <source-position filename="gst/gstmessage.h" line="859"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2933">The number of streams contained within.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2929">a #GstMessage of type %GST_MESSAGE_STREAMS_SELECTED</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="streams_selected_get_stream"
- c:identifier="gst_message_streams_selected_get_stream"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2979">Retrieves the #GstStream with index @index from the @message.</doc>
- <source-position filename="gst/gstmessage.h" line="862"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2986">A #GstStream</doc>
- <type name="Stream" c:type="GstStream*"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2981">a #GstMessage of type %GST_MESSAGE_STREAMS_SELECTED</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="2982">Index of the stream to retrieve</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_message_unref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="379">Convenience macro to decrease the reference count of the message, possibly
-freeing it.</doc>
- <source-position filename="gst/gstmessage.h" line="386"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="381">the message to unref</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="writable_structure"
- c:identifier="gst_message_writable_structure"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1167">Get a writable version of the structure.</doc>
- <source-position filename="gst/gstmessage.h" line="507"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1173">The structure of the message. The structure
-is still owned by the message, which means that you should not free
-it and that the pointer becomes invalid when you free the message.
-This function checks if @message is writable and will never return
-%NULL.
-
-MT safe.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="1169">The #GstMessage.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="replace"
- c:identifier="gst_message_replace"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="450">Modifies a pointer to a #GstMessage to point to a different #GstMessage. The
-modification is done atomically (so this is useful for ensuring thread safety
-in some cases), and the reference counts are updated appropriately (the old
-message is unreffed, the new one is reffed).
-
-Either @new_message or the #GstMessage pointed to by @old_message may be %NULL.</doc>
- <source-position filename="gst/gstmessage.h" line="466"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="464">%TRUE if @new_message was different from @old_message</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="old_message"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="452">pointer to a
- pointer to a #GstMessage to be replaced.</doc>
- <type name="Message" c:type="GstMessage**"/>
- </parameter>
- <parameter name="new_message"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="454">pointer to a #GstMessage that will
- replace the message pointed to by @old_message.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <bitfield name="MessageType"
- glib:type-name="GstMessageType"
- glib:get-type="gst_message_type_get_type"
- c:type="GstMessageType">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="31">The different message types that are available.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_MESSAGE_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="33">an undefined message</doc>
- </member>
- <member name="eos"
- value="1"
- c:identifier="GST_MESSAGE_EOS"
- glib:nick="eos">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="34">end-of-stream reached in a pipeline. The application will
-only receive this message in the PLAYING state and every time it sets a
-pipeline to PLAYING that is in the EOS state. The application can perform a
-flushing seek in the pipeline, which will undo the EOS state again.</doc>
- </member>
- <member name="error"
- value="2"
- c:identifier="GST_MESSAGE_ERROR"
- glib:nick="error">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="38">an error occurred. When the application receives an error
-message it should stop playback of the pipeline and not assume that more
-data will be played. It is possible to specify a redirection url to the error
-messages by setting a `redirect-location` field into the error message, application
-or high level bins might use the information as required.</doc>
- </member>
- <member name="warning"
- value="4"
- c:identifier="GST_MESSAGE_WARNING"
- glib:nick="warning">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="43">a warning occurred.</doc>
- </member>
- <member name="info"
- value="8"
- c:identifier="GST_MESSAGE_INFO"
- glib:nick="info">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="44">an info message occurred</doc>
- </member>
- <member name="tag"
- value="16"
- c:identifier="GST_MESSAGE_TAG"
- glib:nick="tag">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="45">a tag was found.</doc>
- </member>
- <member name="buffering"
- value="32"
- c:identifier="GST_MESSAGE_BUFFERING"
- glib:nick="buffering">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="46">the pipeline is buffering. When the application
-receives a buffering message in the PLAYING state for a non-live pipeline it
-must PAUSE the pipeline until the buffering completes, when the percentage
-field in the message is 100%. For live pipelines, no action must be
-performed and the buffering percentage can be used to inform the user about
-the progress.</doc>
- </member>
- <member name="state_changed"
- value="64"
- c:identifier="GST_MESSAGE_STATE_CHANGED"
- glib:nick="state-changed">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="52">a state change happened</doc>
- </member>
- <member name="state_dirty"
- value="128"
- c:identifier="GST_MESSAGE_STATE_DIRTY"
- glib:nick="state-dirty">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="53">an element changed state in a streaming thread.
-This message is deprecated.</doc>
- </member>
- <member name="step_done"
- value="256"
- c:identifier="GST_MESSAGE_STEP_DONE"
- glib:nick="step-done">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="55">a stepping operation finished.</doc>
- </member>
- <member name="clock_provide"
- value="512"
- c:identifier="GST_MESSAGE_CLOCK_PROVIDE"
- glib:nick="clock-provide">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="56">an element notifies its capability of providing
- a clock. This message is used internally and
- never forwarded to the application.</doc>
- </member>
- <member name="clock_lost"
- value="1024"
- c:identifier="GST_MESSAGE_CLOCK_LOST"
- glib:nick="clock-lost">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="59">The current clock as selected by the pipeline became
- unusable. The pipeline will select a new clock on
- the next PLAYING state change. The application
- should set the pipeline to PAUSED and back to
- PLAYING when this message is received.</doc>
- </member>
- <member name="new_clock"
- value="2048"
- c:identifier="GST_MESSAGE_NEW_CLOCK"
- glib:nick="new-clock">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="64">a new clock was selected in the pipeline.</doc>
- </member>
- <member name="structure_change"
- value="4096"
- c:identifier="GST_MESSAGE_STRUCTURE_CHANGE"
- glib:nick="structure-change">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="65">the structure of the pipeline changed. This
-message is used internally and never forwarded to the application.</doc>
- </member>
- <member name="stream_status"
- value="8192"
- c:identifier="GST_MESSAGE_STREAM_STATUS"
- glib:nick="stream-status">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="67">status about a stream, emitted when it starts,
- stops, errors, etc..</doc>
- </member>
- <member name="application"
- value="16384"
- c:identifier="GST_MESSAGE_APPLICATION"
- glib:nick="application">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="69">message posted by the application, possibly
- via an application-specific element.</doc>
- </member>
- <member name="element"
- value="32768"
- c:identifier="GST_MESSAGE_ELEMENT"
- glib:nick="element">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="71">element-specific message, see the specific element's
- documentation</doc>
- </member>
- <member name="segment_start"
- value="65536"
- c:identifier="GST_MESSAGE_SEGMENT_START"
- glib:nick="segment-start">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="73">pipeline started playback of a segment. This
-message is used internally and never forwarded to the application.</doc>
- </member>
- <member name="segment_done"
- value="131072"
- c:identifier="GST_MESSAGE_SEGMENT_DONE"
- glib:nick="segment-done">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="75">pipeline completed playback of a segment. This
-message is forwarded to the application after all elements that posted
-@GST_MESSAGE_SEGMENT_START posted a GST_MESSAGE_SEGMENT_DONE message.</doc>
- </member>
- <member name="duration_changed"
- value="262144"
- c:identifier="GST_MESSAGE_DURATION_CHANGED"
- glib:nick="duration-changed">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="78">The duration of a pipeline changed. The
-application can get the new duration with a duration query.</doc>
- </member>
- <member name="latency"
- value="524288"
- c:identifier="GST_MESSAGE_LATENCY"
- glib:nick="latency">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="86">Posted by elements when their latency changes. The
-application should recalculate and distribute a new latency.</doc>
- </member>
- <member name="async_start"
- value="1048576"
- c:identifier="GST_MESSAGE_ASYNC_START"
- glib:nick="async-start">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="80">Posted by elements when they start an ASYNC
-#GstStateChange. This message is not forwarded to the application but is used
-internally.</doc>
- </member>
- <member name="async_done"
- value="2097152"
- c:identifier="GST_MESSAGE_ASYNC_DONE"
- glib:nick="async-done">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="83">Posted by elements when they complete an ASYNC
-#GstStateChange. The application will only receive this message from the toplevel
-pipeline.</doc>
- </member>
- <member name="request_state"
- value="4194304"
- c:identifier="GST_MESSAGE_REQUEST_STATE"
- glib:nick="request-state">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="88">Posted by elements when they want the pipeline to
-change state. This message is a suggestion to the application which can
-decide to perform the state change on (part of) the pipeline.</doc>
- </member>
- <member name="step_start"
- value="8388608"
- c:identifier="GST_MESSAGE_STEP_START"
- glib:nick="step-start">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="91">A stepping operation was started.</doc>
- </member>
- <member name="qos"
- value="16777216"
- c:identifier="GST_MESSAGE_QOS"
- glib:nick="qos">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="92">A buffer was dropped or an element changed its processing
-strategy for Quality of Service reasons.</doc>
- </member>
- <member name="progress"
- value="33554432"
- c:identifier="GST_MESSAGE_PROGRESS"
- glib:nick="progress">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="94">A progress message.</doc>
- </member>
- <member name="toc"
- value="67108864"
- c:identifier="GST_MESSAGE_TOC"
- glib:nick="toc">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="95">A new table of contents (TOC) was found or previously found TOC
-was updated.</doc>
- </member>
- <member name="reset_time"
- value="134217728"
- c:identifier="GST_MESSAGE_RESET_TIME"
- glib:nick="reset-time">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="97">Message to request resetting the pipeline's
- running time from the pipeline. This is an internal message which
- applications will likely never receive.</doc>
- </member>
- <member name="stream_start"
- value="268435456"
- c:identifier="GST_MESSAGE_STREAM_START"
- glib:nick="stream-start">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="100">Message indicating start of a new stream. Useful
- e.g. when using playbin in gapless playback mode, to get notified when
- the next title actually starts playing (which will be some time after
- the URI for the next title has been set).</doc>
- </member>
- <member name="need_context"
- value="536870912"
- c:identifier="GST_MESSAGE_NEED_CONTEXT"
- glib:nick="need-context">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="104">Message indicating that an element wants a specific context (Since: 1.2)</doc>
- </member>
- <member name="have_context"
- value="1073741824"
- c:identifier="GST_MESSAGE_HAVE_CONTEXT"
- glib:nick="have-context">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="105">Message indicating that an element created a context (Since: 1.2)</doc>
- </member>
- <member name="extended"
- value="2147483648"
- c:identifier="GST_MESSAGE_EXTENDED"
- glib:nick="extended">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="106">Message is an extended message type (see below).
- These extended message IDs can't be used directly with mask-based API
- like gst_bus_poll() or gst_bus_timed_pop_filtered(), but you can still
- filter for GST_MESSAGE_EXTENDED and then check the result for the
- specific type. (Since: 1.4)</doc>
- </member>
- <member name="device_added"
- value="2147483649"
- c:identifier="GST_MESSAGE_DEVICE_ADDED"
- glib:nick="device-added">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="111">Message indicating a #GstDevice was added to
- a #GstDeviceProvider (Since: 1.4)</doc>
- </member>
- <member name="device_removed"
- value="2147483650"
- c:identifier="GST_MESSAGE_DEVICE_REMOVED"
- glib:nick="device-removed">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="113">Message indicating a #GstDevice was removed
- from a #GstDeviceProvider (Since: 1.4)</doc>
- </member>
- <member name="property_notify"
- value="2147483651"
- c:identifier="GST_MESSAGE_PROPERTY_NOTIFY"
- glib:nick="property-notify">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="115">Message indicating a #GObject property has
- changed (Since: 1.10)</doc>
- </member>
- <member name="stream_collection"
- value="2147483652"
- c:identifier="GST_MESSAGE_STREAM_COLLECTION"
- glib:nick="stream-collection">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="117">Message indicating a new #GstStreamCollection
- is available (Since: 1.10)</doc>
- </member>
- <member name="streams_selected"
- value="2147483653"
- c:identifier="GST_MESSAGE_STREAMS_SELECTED"
- glib:nick="streams-selected">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="119">Message indicating the active selection of
- #GstStreams has changed (Since: 1.10)</doc>
- </member>
- <member name="redirect"
- value="2147483654"
- c:identifier="GST_MESSAGE_REDIRECT"
- glib:nick="redirect">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="121">Message indicating to request the application to
- try to play the given URL(s). Useful if for example a HTTP 302/303
- response is received with a non-HTTP URL inside. (Since: 1.10)</doc>
- </member>
- <member name="device_changed"
- value="2147483655"
- c:identifier="GST_MESSAGE_DEVICE_CHANGED"
- glib:nick="device-changed">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="124">Message indicating a #GstDevice was changed
- a #GstDeviceProvider (Since: 1.16)</doc>
- </member>
- <member name="instant_rate_request"
- value="2147483656"
- c:identifier="GST_MESSAGE_INSTANT_RATE_REQUEST"
- glib:nick="instant-rate-request">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="126">Message sent by elements to request the
- running time from the pipeline when an instant rate change should
- be applied (which may be in the past when the answer arrives). (Since: 1.18)</doc>
- </member>
- <member name="any"
- value="4294967295"
- c:identifier="GST_MESSAGE_ANY"
- glib:nick="any">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="129">mask for all of the above messages.</doc>
- </member>
- <function name="get_name" c:identifier="gst_message_type_get_name">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="140">Get a printable name for the given message type. Do not modify or free.</doc>
- <source-position filename="gst/gstmessage.h" line="358"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="146">a reference to the static name of the message.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="142">the message type</doc>
- <type name="MessageType" c:type="GstMessageType"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_quark" c:identifier="gst_message_type_to_quark">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="160">Get the unique quark for the given message type.</doc>
- <source-position filename="gst/gstmessage.h" line="361"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="166">the quark associated with the message type</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="162">the message type</doc>
- <type name="MessageType" c:type="GstMessageType"/>
- </parameter>
- </parameters>
- </function>
- </bitfield>
- <record name="Meta" c:type="GstMeta">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="22">The #GstMeta structure should be included as the first member of a #GstBuffer
-metadata structure. The structure defines the API of the metadata and should
-be accessible to all elements using the metadata.
-
-A metadata API is registered with gst_meta_api_type_register() which takes a
-name for the metadata API and some tags associated with the metadata.
-With gst_meta_api_type_has_tag() one can check if a certain metadata API
-contains a given tag.
-
-Multiple implementations of a metadata API can be registered.
-To implement a metadata API, gst_meta_register() should be used. This
-function takes all parameters needed to create, free and transform metadata
-along with the size of the metadata. The function returns a #GstMetaInfo
-structure that contains the information for the implementation of the API.
-
-A specific implementation can be retrieved by name with gst_meta_get_info().
-
-See #GstBuffer for how the metadata can be added, retrieved and removed from
-buffers.</doc>
- <source-position filename="gst/gstmeta.h" line="106"/>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="97">extra flags for the metadata</doc>
- <type name="MetaFlags" c:type="GstMetaFlags"/>
- </field>
- <field name="info" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="98">pointer to the #GstMetaInfo</doc>
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </field>
- <method name="compare_seqnum"
- c:identifier="gst_meta_compare_seqnum"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="461">Meta sequence number compare function. Can be used as #GCompareFunc
-or a #GCompareDataFunc.</doc>
- <source-position filename="gst/gstmeta.h" line="279"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="469">a negative number if @meta1 comes before @meta2, 0 if both metas
- have an equal sequence number, or a positive integer if @meta1 comes
- after @meta2.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="463">a #GstMeta</doc>
- <type name="Meta" c:type="const GstMeta*"/>
- </instance-parameter>
- <parameter name="meta2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="464">a #GstMeta</doc>
- <type name="Meta" c:type="const GstMeta*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_seqnum"
- c:identifier="gst_meta_get_seqnum"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="439">Gets seqnum for this meta.</doc>
- <source-position filename="gst/gstmeta.h" line="276"/>
- <return-value transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="441">a #GstMeta</doc>
- <type name="Meta" c:type="const GstMeta*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="api_type_get_tags"
- c:identifier="gst_meta_api_type_get_tags"
- version="1.2">
- <source-position filename="gst/gstmeta.h" line="273"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="335">an array of tags as strings.</doc>
- <array c:type="const gchar* const*">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <parameter name="api" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="333">an API</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </function>
- <function name="api_type_has_tag"
- c:identifier="gst_meta_api_type_has_tag">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="313">Check if @api was registered with @tag.</doc>
- <source-position filename="gst/gstmeta.h" line="246"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="320">%TRUE if @api was registered with @tag.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="api" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="315">an API</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="316">the tag to check</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- </parameters>
- </function>
- <function name="api_type_register"
- c:identifier="gst_meta_api_type_register">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="115">Register and return a GType for the @api and associate it with
-@tags.</doc>
- <source-position filename="gst/gstmeta.h" line="243"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="123">a unique GType for @api.</doc>
- <type name="GType" c:type="GType"/>
- </return-value>
- <parameters>
- <parameter name="api" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="117">an API to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="tags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="118">tags for @api</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="get_info" c:identifier="gst_meta_get_info">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="415">Lookup a previously registered meta info structure by its implementation name
-@impl.</doc>
- <source-position filename="gst/gstmeta.h" line="270"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="422">a #GstMetaInfo with @impl, or
-%NULL when no such metainfo exists.</doc>
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- <parameters>
- <parameter name="impl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="417">the name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="register" c:identifier="gst_meta_register">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="353">Register a new #GstMeta implementation.
-
-The same @info can be retrieved later with gst_meta_get_info() by using
-@impl as the key.</doc>
- <source-position filename="gst/gstmeta.h" line="249"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="367">a #GstMetaInfo that can be used to
-access metadata.</doc>
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- <parameters>
- <parameter name="api" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="355">the type of the #GstMeta API</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="impl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="356">the name of the #GstMeta implementation</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="357">the size of the #GstMeta structure</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="init_func" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="358">a #GstMetaInitFunction</doc>
- <type name="MetaInitFunction" c:type="GstMetaInitFunction"/>
- </parameter>
- <parameter name="free_func" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="359">a #GstMetaFreeFunction</doc>
- <type name="MetaFreeFunction" c:type="GstMetaFreeFunction"/>
- </parameter>
- <parameter name="transform_func"
- transfer-ownership="none"
- scope="async">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="360">a #GstMetaTransformFunction</doc>
- <type name="MetaTransformFunction"
- c:type="GstMetaTransformFunction"/>
- </parameter>
- </parameters>
- </function>
- <function name="register_custom"
- c:identifier="gst_meta_register_custom"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="236">Register a new custom #GstMeta implementation, backed by an opaque
-structure holding a #GstStructure.
-
-The registered info can be retrieved later with gst_meta_get_info() by using
-@name as the key.
-
-The backing #GstStructure can be retrieved with
-gst_custom_meta_get_structure(), its mutability is conditioned by the
-writability of the buffer the meta is attached to.
-
-When @transform_func is %NULL, the meta and its backing #GstStructure
-will always be copied when the transform operation is copy, other operations
-are discarded, copy regions are ignored.</doc>
- <source-position filename="gst/gstmeta.h" line="256"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="258">a #GstMetaInfo that can be used to
-access metadata.</doc>
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="238">the name of the #GstMeta implementation</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="tags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="239">tags for @api</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- <parameter name="transform_func"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="notified"
- closure="3"
- destroy="4">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="240">a #GstMetaTransformFunction</doc>
- <type name="CustomMetaTransformFunction"
- c:type="GstCustomMetaTransformFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="241">user data passed to @transform_func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="destroy_data"
- transfer-ownership="none"
- scope="async">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="242">#GDestroyNotify for user_data</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <bitfield name="MetaFlags"
- glib:type-name="GstMetaFlags"
- glib:get-type="gst_meta_flags_get_type"
- c:type="GstMetaFlags">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="35">Extra metadata flags.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_META_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="37">no flags</doc>
- </member>
- <member name="readonly"
- value="1"
- c:identifier="GST_META_FLAG_READONLY"
- glib:nick="readonly">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="38">metadata should not be modified</doc>
- </member>
- <member name="pooled"
- value="2"
- c:identifier="GST_META_FLAG_POOLED"
- glib:nick="pooled">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="39">metadata is managed by a bufferpool</doc>
- </member>
- <member name="locked"
- value="4"
- c:identifier="GST_META_FLAG_LOCKED"
- glib:nick="locked">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="40">metadata should not be removed</doc>
- </member>
- <member name="last"
- value="65536"
- c:identifier="GST_META_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="41">additional flags can be added starting from this flag.</doc>
- </member>
- </bitfield>
- <callback name="MetaFreeFunction" c:type="GstMetaFreeFunction">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="131">Function called when @meta is freed in @buffer.</doc>
- <source-position filename="gst/gstmeta.h" line="138"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="133">a #GstMeta</doc>
- <type name="Meta" c:type="GstMeta*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="134">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="MetaInfo" c:type="GstMetaInfo">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="216">The #GstMetaInfo provides information about a specific metadata
-structure.</doc>
- <source-position filename="gst/gstmeta.h" line="240"/>
- <field name="api" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="218">tag identifying the metadata structure and api</doc>
- <type name="GType" c:type="GType"/>
- </field>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="219">type identifying the implementor of the api</doc>
- <type name="GType" c:type="GType"/>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="220">size of the metadata</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="init_func" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="221">function for initializing the metadata</doc>
- <type name="MetaInitFunction" c:type="GstMetaInitFunction"/>
- </field>
- <field name="free_func" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="222">function for freeing the metadata</doc>
- <type name="MetaFreeFunction" c:type="GstMetaFreeFunction"/>
- </field>
- <field name="transform_func" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="223">function for transforming the metadata</doc>
- <type name="MetaTransformFunction" c:type="GstMetaTransformFunction"/>
- </field>
- <method name="is_custom"
- c:identifier="gst_meta_info_is_custom"
- version="1.20">
- <source-position filename="gst/gstmeta.h" line="261"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="301">whether @info was registered as a #GstCustomMeta with
- gst_meta_register_custom()</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <callback name="MetaInitFunction" c:type="GstMetaInitFunction">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="121">Function called when @meta is initialized in @buffer.</doc>
- <source-position filename="gst/gstmeta.h" line="129"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="123">a #GstMeta</doc>
- <type name="Meta" c:type="GstMeta*"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="124">parameters passed to the init function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="125">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="MetaTransformCopy" c:type="GstMetaTransformCopy">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="156">Extra data passed to a "gst-copy" transform #GstMetaTransformFunction.</doc>
- <source-position filename="gst/gstmeta.h" line="168"/>
- <field name="region" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="158">%TRUE if only region is copied</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="offset" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="159">the offset to copy, 0 if @region is %FALSE, otherwise &gt; 0</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="160">the size to copy, -1 or the buffer size when @region is %FALSE</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- </record>
- <callback name="MetaTransformFunction" c:type="GstMetaTransformFunction">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="170">Function called for each @meta in @buffer as a result of performing a
-transformation on @transbuf. Additional @type specific transform data
-is passed to the function as @data.
-
-Implementations should check the @type of the transform and parse
-additional type specific fields in @data that should be used to update
-the metadata on @transbuf.</doc>
- <source-position filename="gst/gstmeta.h" line="188"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="186">%TRUE if the transform could be performed</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="transbuf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="172">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="173">a #GstMeta</doc>
- <type name="Meta" c:type="GstMeta*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="174">a #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="175">the transform type</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.h"
- line="176">transform specific data.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="MiniObject" c:type="GstMiniObject">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="21">#GstMiniObject is a simple structure that can be used to implement refcounted
-types.
-
-Subclasses will include #GstMiniObject as the first member in their structure
-and then call gst_mini_object_init() to initialize the #GstMiniObject fields.
-
-gst_mini_object_ref() and gst_mini_object_unref() increment and decrement the
-refcount respectively. When the refcount of a mini-object reaches 0, the
-dispose function is called first and when this returns %TRUE, the free
-function of the miniobject is called.
-
-A copy can be made with gst_mini_object_copy().
-
-gst_mini_object_is_writable() will return %TRUE when the refcount of the
-object is exactly 1 and there is no parent or a single parent exists and is
-writable itself, meaning the current caller has the only reference to the
-object. gst_mini_object_make_writable() will return a writable version of
-the object, which might be a new copy when the refcount was not 1.
-
-Opaque data can be associated with a #GstMiniObject with
-gst_mini_object_set_qdata() and gst_mini_object_get_qdata(). The data is
-meant to be specific to the particular object and is not automatically copied
-with gst_mini_object_copy() or similar methods.
-
-A weak reference can be added and remove with gst_mini_object_weak_ref()
-and gst_mini_object_weak_unref() respectively.</doc>
- <source-position filename="gst/gstminiobject.h" line="219"/>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="193">the GType of the object</doc>
- <type name="GType" c:type="GType"/>
- </field>
- <field name="refcount" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="194">atomic refcount</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="lockstate" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="195">atomic state of the locks</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="196">extra flags.</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="copy" introspectable="0" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="197">a copy function</doc>
- <type name="MiniObjectCopyFunction"
- c:type="GstMiniObjectCopyFunction"/>
- </field>
- <field name="dispose" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="198">a dispose function</doc>
- <type name="MiniObjectDisposeFunction"
- c:type="GstMiniObjectDisposeFunction"/>
- </field>
- <field name="free" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="199">the free function</doc>
- <type name="MiniObjectFreeFunction"
- c:type="GstMiniObjectFreeFunction"/>
- </field>
- <field name="priv_uint" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="priv_pointer" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <method name="add_parent"
- c:identifier="gst_mini_object_add_parent"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="984">This adds @parent as a parent for @object. Having one ore more parents affects the
-writability of @object: if a @parent is not writable, @object is also not
-writable, regardless of its refcount. @object is only writable if all
-the parents are writable and its own refcount is exactly 1.
-
-Note: This function does not take ownership of @parent and also does not
-take an additional reference. It is the responsibility of the caller to
-remove the parent again at a later time.</doc>
- <source-position filename="gst/gstminiobject.h" line="280"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="986">a #GstMiniObject</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="987">a parent #GstMiniObject</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy"
- c:identifier="gst_mini_object_copy"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="169">Creates a copy of the mini-object.
-
-MT safe</doc>
- <source-position filename="gst/gstminiobject.h" line="267"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="177">the new mini-object if copying is
-possible, %NULL otherwise.</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </return-value>
- <parameters>
- <instance-parameter name="mini_object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="171">the mini-object to copy</doc>
- <type name="MiniObject" c:type="const GstMiniObject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_qdata" c:identifier="gst_mini_object_get_qdata">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="918">This function gets back user data pointers stored via
-gst_mini_object_set_qdata().</doc>
- <source-position filename="gst/gstminiobject.h" line="274"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="926">The user data pointer set, or
-%NULL</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="920">The GstMiniObject to get a stored user data pointer from</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- <parameter name="quark" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="921">A #GQuark, naming the user data pointer</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- </parameters>
- </method>
- <method name="init"
- c:identifier="gst_mini_object_init"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="135">Initializes a mini-object with the desired type and copy/dispose/free
-functions.</doc>
- <source-position filename="gst/gstminiobject.h" line="222"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="mini_object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="137">a #GstMiniObject</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="138">initial #GstMiniObjectFlags</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="139">the #GType of the mini-object to create</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="copy_func"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="140">the copy function, or %NULL</doc>
- <type name="MiniObjectCopyFunction"
- c:type="GstMiniObjectCopyFunction"/>
- </parameter>
- <parameter name="dispose_func"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="141">the dispose function, or %NULL</doc>
- <type name="MiniObjectDisposeFunction"
- c:type="GstMiniObjectDisposeFunction"/>
- </parameter>
- <parameter name="free_func"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="142">the free function or %NULL</doc>
- <type name="MiniObjectFreeFunction"
- c:type="GstMiniObjectFreeFunction"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_writable" c:identifier="gst_mini_object_is_writable">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="328">If @mini_object has the LOCKABLE flag set, check if the current EXCLUSIVE
-lock on @object is the only one, this means that changes to the object will
-not be visible to any other object.
-
-If the LOCKABLE flag is not set, check if the refcount of @mini_object is
-exactly 1, meaning that no other reference exists to the object and that the
-object is therefore writable.
-
-Modification of a mini-object should only be done after verifying that it
-is writable.</doc>
- <source-position filename="gst/gstminiobject.h" line="259"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="343">%TRUE if the object is writable.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="mini_object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="330">the mini-object to check</doc>
- <type name="MiniObject" c:type="const GstMiniObject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="lock" c:identifier="gst_mini_object_lock">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="195">Lock the mini-object with the specified access mode in @flags.</doc>
- <source-position filename="gst/gstminiobject.h" line="253"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="202">%TRUE if @object could be locked.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="197">the mini-object to lock</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="198">#GstLockFlags</doc>
- <type name="LockFlags" c:type="GstLockFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="make_writable"
- c:identifier="gst_mini_object_make_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="403">Checks if a mini-object is writable. If not, a writable copy is made and
-returned. This gives away the reference to the original mini object,
-and returns a reference to the new object.
-
-MT safe</doc>
- <source-position filename="gst/gstminiobject.h" line="262"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="413">a mini-object (possibly the same pointer) that
- is writable.</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </return-value>
- <parameters>
- <instance-parameter name="mini_object" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="405">the mini-object to make writable</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_mini_object_ref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="435">Increase the reference count of the mini-object.
-
-Note that the refcount affects the writability
-of @mini-object, see gst_mini_object_is_writable(). It is
-important to note that keeping additional references to
-GstMiniObject instances can potentially increase the number
-of memcpy operations in a pipeline, especially if the miniobject
-is a #GstBuffer.</doc>
- <source-position filename="gst/gstminiobject.h" line="232"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="448">the mini-object.</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </return-value>
- <parameters>
- <instance-parameter name="mini_object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="437">the mini-object</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_parent"
- c:identifier="gst_mini_object_remove_parent"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="1052">This removes @parent as a parent for @object. See
-gst_mini_object_add_parent().</doc>
- <source-position filename="gst/gstminiobject.h" line="282"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="1054">a #GstMiniObject</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="1055">a parent #GstMiniObject</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_qdata" c:identifier="gst_mini_object_set_qdata">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="868">This sets an opaque, named pointer on a miniobject.
-The name is specified through a #GQuark (retrieved e.g. via
-g_quark_from_static_string()), and the pointer
-can be gotten back from the @object with gst_mini_object_get_qdata()
-until the @object is disposed.
-Setting a previously set user data pointer, overrides (frees)
-the old pointer set, using %NULL as pointer essentially
-removes the data stored.
-
-@destroy may be specified which is called with @data as argument
-when the @object is disposed, or the data is being overwritten by
-a call to gst_mini_object_set_qdata() with the same @quark.</doc>
- <source-position filename="gst/gstminiobject.h" line="271"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="870">a #GstMiniObject</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- <parameter name="quark" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="871">A #GQuark, naming the user data pointer</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="872">An opaque user data pointer</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="destroy" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="873">Function to invoke with @data as argument, when @data
- needs to be freed</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="steal_qdata" c:identifier="gst_mini_object_steal_qdata">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="950">This function gets back user data pointers stored via gst_mini_object_set_qdata()
-and removes the data from @object without invoking its `destroy()` function (if
-any was set).</doc>
- <source-position filename="gst/gstminiobject.h" line="277"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="959">The user data pointer set, or
-%NULL</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="952">The GstMiniObject to get a stored user data pointer from</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- <parameter name="quark" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="953">A #GQuark, naming the user data pointer</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- </parameters>
- </method>
- <method name="unlock" c:identifier="gst_mini_object_unlock">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="261">Unlock the mini-object with the specified access mode in @flags.</doc>
- <source-position filename="gst/gstminiobject.h" line="256"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="263">the mini-object to unlock</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="264">#GstLockFlags</doc>
- <type name="LockFlags" c:type="GstLockFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="unref"
- c:identifier="gst_mini_object_unref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="627">Decreases the reference count of the mini-object, possibly freeing
-the mini-object.</doc>
- <source-position filename="gst/gstminiobject.h" line="235"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="mini_object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="629">the mini-object</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="weak_ref"
- c:identifier="gst_mini_object_weak_ref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="815">Adds a weak reference callback to a mini object. Weak references are
-used for notification when a mini object is finalized. They are called
-"weak references" because they allow you to safely hold a pointer
-to the mini object without calling gst_mini_object_ref()
-(gst_mini_object_ref() adds a strong reference, that is, forces the object
-to stay alive).</doc>
- <source-position filename="gst/gstminiobject.h" line="242"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="817">#GstMiniObject to reference weakly</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- <parameter name="notify" transfer-ownership="none" closure="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="818">callback to invoke before the mini object is freed</doc>
- <type name="MiniObjectNotify" c:type="GstMiniObjectNotify"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="819">extra data to pass to notify</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="weak_unref"
- c:identifier="gst_mini_object_weak_unref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="841">Removes a weak reference callback from a mini object.</doc>
- <source-position filename="gst/gstminiobject.h" line="246"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="843">#GstMiniObject to remove a weak reference from</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </instance-parameter>
- <parameter name="notify" transfer-ownership="none" closure="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="844">callback to search for</doc>
- <type name="MiniObjectNotify" c:type="GstMiniObjectNotify"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="845">data to search for</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <function name="replace" c:identifier="gst_mini_object_replace">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="700">Atomically modifies a pointer to point to a new mini-object.
-The reference count of @olddata is decreased and the reference count of
-@newdata is increased.
-
-Either @newdata and the value pointed to by @olddata may be %NULL.</doc>
- <source-position filename="gst/gstminiobject.h" line="285"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="712">%TRUE if @newdata was different from @olddata</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="olddata"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="702">pointer to a pointer to a
- mini-object to be replaced</doc>
- <type name="MiniObject" c:type="GstMiniObject**"/>
- </parameter>
- <parameter name="newdata"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="704">pointer to new mini-object</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </parameter>
- </parameters>
- </function>
- <function name="steal"
- c:identifier="gst_mini_object_steal"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="746">Replace the current #GstMiniObject pointer to by @olddata with %NULL and
-return the old value.</doc>
- <source-position filename="gst/gstminiobject.h" line="291"/>
- <return-value nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="754">the #GstMiniObject at @oldata</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </return-value>
- <parameters>
- <parameter name="olddata"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="748">pointer to a pointer to a mini-object to
- be stolen</doc>
- <type name="MiniObject" c:type="GstMiniObject**"/>
- </parameter>
- </parameters>
- </function>
- <function name="take" c:identifier="gst_mini_object_take">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="776">Modifies a pointer to point to a new mini-object. The modification
-is done atomically. This version is similar to gst_mini_object_replace()
-except that it does not increase the refcount of @newdata and thus
-takes ownership of @newdata.
-
-Either @newdata and the value pointed to by @olddata may be %NULL.</doc>
- <source-position filename="gst/gstminiobject.h" line="288"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="789">%TRUE if @newdata was different from @olddata</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="olddata"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="778">pointer to a pointer to a mini-object to
- be replaced</doc>
- <type name="MiniObject" c:type="GstMiniObject**"/>
- </parameter>
- <parameter name="newdata" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="780">pointer to new mini-object</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <callback name="MiniObjectCopyFunction"
- c:type="GstMiniObjectCopyFunction"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="39">Function prototype for methods to create copies of instances.</doc>
- <source-position filename="gst/gstminiobject.h" line="47"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="45">reference to cloned instance.</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </return-value>
- <parameters>
- <parameter name="obj" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="41">MiniObject to copy</doc>
- <type name="MiniObject" c:type="const GstMiniObject*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="MiniObjectDisposeFunction"
- c:type="GstMiniObjectDisposeFunction">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="48">Function prototype for when a miniobject has lost its last refcount.
-Implementation of the mini object are allowed to revive the
-passed object by doing a gst_mini_object_ref(). If the object is not
-revived after the dispose function, the function should return %TRUE
-and the memory associated with the object is freed.</doc>
- <source-position filename="gst/gstminiobject.h" line="60"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="58">%TRUE if the object should be cleaned up.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="obj" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="50">MiniObject to dispose</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </parameter>
- </parameters>
- </callback>
- <bitfield name="MiniObjectFlags"
- glib:type-name="GstMiniObjectFlags"
- glib:get-type="gst_mini_object_flags_get_type"
- c:type="GstMiniObjectFlags">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="121">Flags for the mini object</doc>
- <member name="lockable"
- value="1"
- c:identifier="GST_MINI_OBJECT_FLAG_LOCKABLE"
- glib:nick="lockable">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="123">the object can be locked and unlocked with
-gst_mini_object_lock() and gst_mini_object_unlock().</doc>
- </member>
- <member name="lock_readonly"
- value="2"
- c:identifier="GST_MINI_OBJECT_FLAG_LOCK_READONLY"
- glib:nick="lock-readonly">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="125">the object is permanently locked in
-READONLY mode. Only read locks can be performed on the object.</doc>
- </member>
- <member name="may_be_leaked"
- value="4"
- c:identifier="GST_MINI_OBJECT_FLAG_MAY_BE_LEAKED"
- glib:nick="may-be-leaked">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="127">the object is expected to stay alive
-even after gst_deinit() has been called and so should be ignored by leak
-detection tools. (Since: 1.10)</doc>
- </member>
- <member name="last"
- value="16"
- c:identifier="GST_MINI_OBJECT_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="130">first flag that can be used by subclasses.</doc>
- </member>
- </bitfield>
- <callback name="MiniObjectFreeFunction" c:type="GstMiniObjectFreeFunction">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="61">Virtual function prototype for methods to free resources used by
-mini-objects.</doc>
- <source-position filename="gst/gstminiobject.h" line="68"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="obj" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="63">MiniObject to free</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="MiniObjectNotify" c:type="GstMiniObjectNotify">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="70">A #GstMiniObjectNotify function can be added to a mini object as a
-callback that gets triggered when gst_mini_object_unref() drops the
-last ref and @obj is about to be freed.</doc>
- <source-position filename="gst/gstminiobject.h" line="79"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="72">data that was provided when the notify was added</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="obj" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.h"
- line="73">the mini object</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </parameter>
- </parameters>
- </callback>
- <constant name="NSECOND" value="1" c:type="GST_NSECOND">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="116">Constant that defines one GStreamer nanosecond</doc>
- <source-position filename="gst/gstclock.h" line="121"/>
- <type name="ClockTimeDiff" c:type="GstClockTimeDiff"/>
- </constant>
- <function-macro name="OBJECT" c:identifier="GST_OBJECT" introspectable="0">
- <source-position filename="gst/gstobject.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_CAST"
- c:identifier="GST_OBJECT_CAST"
- introspectable="0">
- <source-position filename="gst/gstobject.h" line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_CLASS"
- c:identifier="GST_OBJECT_CLASS"
- introspectable="0">
- <source-position filename="gst/gstobject.h" line="38"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_CLASS_CAST"
- c:identifier="GST_OBJECT_CLASS_CAST"
- introspectable="0">
- <source-position filename="gst/gstobject.h" line="40"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_FLAGS"
- c:identifier="GST_OBJECT_FLAGS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="128">This macro returns the entire set of flags for the object.</doc>
- <source-position filename="gst/gstobject.h" line="134"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="130">a #GstObject</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_FLAG_IS_SET"
- c:identifier="GST_OBJECT_FLAG_IS_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="135">This macro checks to see if the given flag is set.</doc>
- <source-position filename="gst/gstobject.h" line="142"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="137">a #GstObject</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="138">Flag to check for</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_FLAG_SET"
- c:identifier="GST_OBJECT_FLAG_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="143">This macro sets the given bits.</doc>
- <source-position filename="gst/gstobject.h" line="150"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="145">a #GstObject</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="146">Flag to set</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_FLAG_UNSET"
- c:identifier="GST_OBJECT_FLAG_UNSET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="151">This macro unsets the given bits.</doc>
- <source-position filename="gst/gstobject.h" line="158"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="153">a #GstObject</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="154">Flag to set</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_GET_CLASS"
- c:identifier="GST_OBJECT_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstobject.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_GET_LOCK"
- c:identifier="GST_OBJECT_GET_LOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="76">Acquire a reference to the mutex of this object.</doc>
- <source-position filename="gst/gstobject.h" line="82"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="78">a #GstObject</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_LOCK"
- c:identifier="GST_OBJECT_LOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="83">This macro will obtain a lock on the object, making serialization possible.
-It blocks until the lock can be obtained.</doc>
- <source-position filename="gst/gstobject.h" line="90"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="85">a #GstObject to lock</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_NAME"
- c:identifier="GST_OBJECT_NAME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="108">Get the name of this object. This is not thread-safe by default
-(i.e. you will have to make sure the object lock is taken yourself).
-If in doubt use gst_object_get_name() instead.</doc>
- <source-position filename="gst/gstobject.h" line="116"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="110">a #GstObject</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_PARENT"
- c:identifier="GST_OBJECT_PARENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="117">Get the parent of this object. This is not thread-safe by default
-(i.e. you will have to make sure the object lock is taken yourself).
-If in doubt use gst_object_get_parent() instead.</doc>
- <source-position filename="gst/gstobject.h" line="125"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="119">a #GstObject</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_REFCOUNT"
- c:identifier="GST_OBJECT_REFCOUNT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="58">Get access to the reference count field of the object.</doc>
- <source-position filename="gst/gstobject.h" line="64"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="60">a #GstObject</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_REFCOUNT_VALUE"
- c:identifier="GST_OBJECT_REFCOUNT_VALUE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="65">Get the reference count value of the object.</doc>
- <source-position filename="gst/gstobject.h" line="71"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="67">a #GstObject</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_TRYLOCK"
- c:identifier="GST_OBJECT_TRYLOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="91">This macro will try to obtain a lock on the object, but will return with
-%FALSE if it can't get it immediately.</doc>
- <source-position filename="gst/gstobject.h" line="98"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="93">a #GstObject.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="OBJECT_UNLOCK"
- c:identifier="GST_OBJECT_UNLOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="99">This macro releases a lock on the object.</doc>
- <source-position filename="gst/gstobject.h" line="105"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="101">a #GstObject to unlock.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <class name="Object"
- c:symbol-prefix="object"
- c:type="GstObject"
- parent="GObject.InitiallyUnowned"
- abstract="1"
- glib:type-name="GstObject"
- glib:get-type="gst_object_get_type"
- glib:type-struct="ObjectClass">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="24">#GstObject provides a root for the object hierarchy tree filed in by the
-GStreamer library. It is currently a thin wrapper on top of
-#GInitiallyUnowned. It is an abstract class that is not very usable on its own.
-
-#GstObject gives us basic refcounting, parenting functionality and locking.
-Most of the functions are just extended for special GStreamer needs and can be
-found under the same name in the base class of #GstObject which is #GObject
-(e.g. g_object_ref() becomes gst_object_ref()).
-
-Since #GstObject derives from #GInitiallyUnowned, it also inherits the
-floating reference. Be aware that functions such as gst_bin_add() and
-gst_element_add_pad() take ownership of the floating reference.
-
-In contrast to #GObject instances, #GstObject adds a name property. The functions
-gst_object_set_name() and gst_object_get_name() are used to set/get the name
-of the object.
-
-## controlled properties
-
-Controlled properties offers a lightweight way to adjust gobject properties
-over stream-time. It works by using time-stamped value pairs that are queued
-for element-properties. At run-time the elements continuously pull value
-changes for the current stream-time.
-
-What needs to be changed in a #GstElement?
-Very little - it is just two steps to make a plugin controllable!
-
- * mark gobject-properties paramspecs that make sense to be controlled,
- by GST_PARAM_CONTROLLABLE.
-
- * when processing data (get, chain, loop function) at the beginning call
- gst_object_sync_values(element,timestamp).
- This will make the controller update all GObject properties that are
- under its control with the current values based on the timestamp.
-
-What needs to be done in applications? Again it's not a lot to change.
-
- * create a #GstControlSource.
- csource = gst_interpolation_control_source_new ();
- g_object_set (csource, "mode", GST_INTERPOLATION_MODE_LINEAR, NULL);
-
- * Attach the #GstControlSource on the controller to a property.
- gst_object_add_control_binding (object, gst_direct_control_binding_new (object, "prop1", csource));
-
- * Set the control values
- gst_timed_value_control_source_set ((GstTimedValueControlSource *)csource,0 * GST_SECOND, value1);
- gst_timed_value_control_source_set ((GstTimedValueControlSource *)csource,1 * GST_SECOND, value2);
-
- * start your pipeline</doc>
- <source-position filename="gst/gstobject.h" line="210"/>
- <function name="check_uniqueness"
- c:identifier="gst_object_check_uniqueness">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="885">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.</doc>
- <source-position filename="gst/gstobject.h" line="277"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="897">%TRUE if a #GstObject named @name does not appear in @list,
-%FALSE if it does.
-
-MT safe. Grabs and releases the LOCK of each object in the list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="887">a list of #GstObject to
- check through</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Object"/>
- </type>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="889">the name to search for</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="default_deep_notify"
- c:identifier="gst_object_default_deep_notify">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="488">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.
-
-MT safe. This function grabs and releases @object's LOCK for getting its
- path string.</doc>
- <source-position filename="gst/gstobject.h" line="246"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="490">the #GObject that signalled the notify.</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="orig" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="491">a #GstObject that initiated the notify.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="pspec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="492">a #GParamSpec of the property.</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- <parameter name="excluded_props"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="493">
- a set of user-specified properties to exclude or %NULL to show
- all changes.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="ref_sink"
- c:identifier="gst_object_ref_sink"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="270">Increase the reference count of @object, and possibly remove the floating
-reference, if @object has a floating reference.
-
-In other words, if the object is floating, then this call "assumes ownership"
-of the floating reference, converting it to a normal reference by clearing
-the floating flag while leaving the reference count unchanged. If the object
-is not floating, then this call adds a new normal reference increasing the
-reference count by one.
-
-For more background on "floating references" please see the #GObject
-documentation.</doc>
- <source-position filename="gst/gstobject.h" line="262"/>
- <return-value transfer-ownership="none" nullable="1">
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <parameter name="object"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="272">a #GstObject to sink</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="replace" c:identifier="gst_object_replace">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="323">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.
-
-Either @newobj and the value pointed to by @oldobj may be %NULL.</doc>
- <source-position filename="gst/gstobject.h" line="267"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="335">%TRUE if @newobj was different from @oldobj</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="oldobj"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="325">pointer to a place of
- a #GstObject to replace</doc>
- <type name="Object" c:type="GstObject**"/>
- </parameter>
- <parameter name="newobj"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="327">a new #GstObject</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="deep_notify">
- <source-position filename="gst/gstobject.h" line="203"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="orig" transfer-ownership="none">
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="pspec" transfer-ownership="none">
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add_control_binding"
- c:identifier="gst_object_add_control_binding">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1239">Attach the #GstControlBinding to the object. If there already was a
-#GstControlBinding for this property it will be replaced.
-
-The object's reference count will be incremented, and any floating
-reference will be removed (see gst_object_ref_sink())</doc>
- <source-position filename="gst/gstobject.h" line="301"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1250">%FALSE if the given @binding has not been setup for this object or
-has been setup for a non suitable property, %TRUE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1241">the controller object</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1242">the #GstControlBinding that should be used</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </parameter>
- </parameters>
- </method>
- <method name="default_error" c:identifier="gst_object_default_error">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2660">A default error function that uses g_printerr() to display the error message
-and the optional debug string..
-
-The default handler will simply print the error string using g_print.</doc>
- <source-position filename="gst/gstutils.h" line="977"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2662">the #GstObject that initiated the error.</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="error" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2663">the GError.</doc>
- <type name="GLib.Error" c:type="const GError*"/>
- </parameter>
- <parameter name="debug"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2664">an additional debug information string, or %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_control_binding"
- c:identifier="gst_object_get_control_binding">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1276">Gets the corresponding #GstControlBinding for the property. This should be
-unreferenced again after use.</doc>
- <source-position filename="gst/gstobject.h" line="305"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1284">the #GstControlBinding for
-@property_name or %NULL if the property is not controlled.</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1278">the object</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1279">name of the property</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_control_rate"
- c:identifier="gst_object_get_control_rate">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1455">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_sync_values() in between. The length of the processing segment
-should be up to @control-rate nanoseconds.
-
-If the @object is not under property control, this will return
-%GST_CLOCK_TIME_NONE. This allows the element to avoid the sub-dividing.
-
-The control-rate is not expected to change if the element is in
-%GST_STATE_PAUSED or %GST_STATE_PLAYING.</doc>
- <source-position filename="gst/gstobject.h" line="322"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1470">the control rate in nanoseconds</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1457">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_g_value_array"
- c:identifier="gst_object_get_g_value_array">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1413">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.
-
-This function is useful if one wants to e.g. draw a graph of the control
-curve or apply a control curve sample by sample.</doc>
- <source-position filename="gst/gstobject.h" line="318"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1429">%TRUE if the given array could be filled, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1415">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1416">the name of the property to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1417">the time that should be processed</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1418">the time spacing between subsequent values</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="n_values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1419">the number of values</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1420">array to put control-values in</doc>
- <array length="3" zero-terminated="0" c:type="GValue*">
- <type name="GObject.Value" c:type="GValue"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="get_name" c:identifier="gst_object_get_name">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="658">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.
-
-Free-function: g_free</doc>
- <source-position filename="gst/gstobject.h" line="223"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="669">the name of @object. g_free()
-after usage.
-
-MT safe. This function grabs and releases @object's LOCK.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="660">a #GstObject</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_parent" c:identifier="gst_object_get_parent">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="740">Returns the parent of @object. This function increases the refcount
-of the parent object so you should gst_object_unref() it after usage.</doc>
- <source-position filename="gst/gstobject.h" line="231"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="747">parent of @object, this can be
- %NULL if @object has no parent. unref after usage.
-
-MT safe. Grabs and releases @object's LOCK.</doc>
- <type name="Object" c:type="GstObject*"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="742">a #GstObject</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_path_string" c:identifier="gst_object_get_path_string">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="970">Generates a string describing the path of @object in
-the object hierarchy. Only useful (or used) for debugging.
-
-Free-function: g_free</doc>
- <source-position filename="gst/gstobject.h" line="272"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="979">a string describing the path of @object. You must
- g_free() the string after usage.
-
-MT safe. Grabs and releases the #GstObject's LOCK for all objects
- in the hierarchy.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="972">a #GstObject</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_value" c:identifier="gst_object_get_value">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1337">Gets the value for the given controlled property at the requested time.</doc>
- <source-position filename="gst/gstobject.h" line="311"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1345">the GValue of the property at the given time,
-or %NULL if the property isn't controlled.</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1339">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1340">the name of the property to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1341">the time the control-change should be read from</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_value_array"
- c:identifier="gst_object_get_value_array"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1368">Gets a number of values for the given controlled property starting at the
-requested time. The array @values need to hold enough space for @n_values of
-the same type as the objects property's type.
-
-This function is useful if one wants to e.g. draw a graph of the control
-curve or apply a control curve sample by sample.
-
-The values are unboxed and ready to be used. The similar function
-gst_object_get_g_value_array() returns the array as #GValues and is
-better suites for bindings.</doc>
- <source-position filename="gst/gstobject.h" line="314"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1388">%TRUE if the given array could be filled, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1370">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1371">the name of the property to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1372">the time that should be processed</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1373">the time spacing between subsequent values</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="n_values" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1374">the number of values</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="values"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1375">array to put control-values in</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="has_active_control_bindings"
- c:identifier="gst_object_has_active_control_bindings">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1163">Check if the @object has active controlled properties.</doc>
- <source-position filename="gst/gstobject.h" line="290"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1169">%TRUE if the object has active controlled properties</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1165">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_ancestor"
- c:identifier="gst_object_has_ancestor"
- deprecated="1">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="863">Check if @object has an ancestor @ancestor somewhere up in
-the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.</doc>
- <doc-deprecated xml:space="preserve">Use gst_object_has_as_ancestor() instead.
-
-MT safe. Grabs and releases @object's locks.</doc-deprecated>
- <source-position filename="gst/gstobject.h" line="243"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="871">%TRUE if @ancestor is an ancestor of @object.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="865">a #GstObject to check</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="ancestor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="866">a #GstObject to check as ancestor</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </method>
- <method name="has_as_ancestor" c:identifier="gst_object_has_as_ancestor">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="828">Check if @object has an ancestor @ancestor somewhere up in
-the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.</doc>
- <source-position filename="gst/gstobject.h" line="240"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="836">%TRUE if @ancestor is an ancestor of @object.
-
-MT safe. Grabs and releases @object's locks.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="830">a #GstObject to check</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="ancestor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="831">a #GstObject to check as ancestor</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </method>
- <method name="has_as_parent"
- c:identifier="gst_object_has_as_parent"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="800">Check if @parent is the parent of @object.
-E.g. a #GstElement can check if it owns a given #GstPad.</doc>
- <source-position filename="gst/gstobject.h" line="237"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="808">%FALSE if either @object or @parent is %NULL. %TRUE if @parent is
- the parent of @object. Otherwise %FALSE.
-
-MT safe. Grabs and releases @object's locks.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="802">a #GstObject to check</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="803">a #GstObject to check as parent</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_object_ref">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="216">Increments the reference count on @object. This function
-does not take the lock on @object because it relies on
-atomic refcounting.
-
-This object returns the input parameter to ease writing
-constructs like :
- result = gst_object_ref (object-&gt;parent);</doc>
- <source-position filename="gst/gstobject.h" line="252"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="228">A pointer to @object</doc>
- <type name="Object" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="218">a #GstObject to reference</doc>
- <type name="Object" c:type="gpointer"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_control_binding"
- c:identifier="gst_object_remove_control_binding">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1304">Removes the corresponding #GstControlBinding. If it was the
-last ref of the binding, it will be disposed.</doc>
- <source-position filename="gst/gstobject.h" line="308"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1312">%TRUE if the binding could be removed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1306">the object</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="binding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1307">the binding</doc>
- <type name="ControlBinding" c:type="GstControlBinding*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_control_binding_disabled"
- c:identifier="gst_object_set_control_binding_disabled">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1211">This function is used to disable the control bindings on a property for
-some time, i.e. gst_object_sync_values() will do nothing for the
-property.</doc>
- <source-position filename="gst/gstobject.h" line="296"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1213">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1214">property to disable</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="disabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1215">boolean that specifies whether to disable the controller
-or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_control_bindings_disabled"
- c:identifier="gst_object_set_control_bindings_disabled">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1187">This function is used to disable all controlled properties of the @object for
-some time, i.e. gst_object_sync_values() will do nothing.</doc>
- <source-position filename="gst/gstobject.h" line="293"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1189">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="disabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1190">boolean that specifies whether to disable the controller
-or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_control_rate"
- c:identifier="gst_object_set_control_rate">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1480">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_sync_values() in between. The length of the processing segment
-should be up to @control-rate nanoseconds.
-
-The control-rate should not change if the element is in %GST_STATE_PAUSED or
-%GST_STATE_PLAYING.</doc>
- <source-position filename="gst/gstobject.h" line="325"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1482">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="control_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1483">the new control-rate in nanoseconds.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_name" c:identifier="gst_object_set_name">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="630">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.</doc>
- <source-position filename="gst/gstobject.h" line="220"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="640">%TRUE if the name could be set. Since Objects that have
-a parent cannot be renamed, this function returns %FALSE in those
-cases.
-
-MT safe. This function grabs and releases @object's LOCK.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="632">a #GstObject</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="633">new name of object</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_parent" c:identifier="gst_object_set_parent">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="688">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_ref_sink()).</doc>
- <source-position filename="gst/gstobject.h" line="228"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="696">%TRUE if @parent could be set or %FALSE when @object
-already had a parent or @object and @parent are the same.
-
-MT safe. Grabs and releases @object's LOCK.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="690">a #GstObject</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="691">new parent of object</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </method>
- <method name="suggest_next_sync"
- c:identifier="gst_object_suggest_next_sync">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1089">Returns a suggestion for timestamps where buffers should be split
-to get best controller results.</doc>
- <source-position filename="gst/gstobject.h" line="284"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1096">Returns the suggested timestamp or %GST_CLOCK_TIME_NONE
-if no control-rate was set.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1091">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="sync_values" c:identifier="gst_object_sync_values">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1121">Sets the properties of the object, according to the #GstControlSources that
-(maybe) handle them and for the given timestamp.
-
-If this function fails, it is most likely the application developers fault.
-Most probably the control sources are not setup correctly.</doc>
- <source-position filename="gst/gstobject.h" line="287"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1132">%TRUE if the controller values could be applied to the object
-properties, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1123">the object that has controlled properties</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="1124">the time that should be processed</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="unparent" c:identifier="gst_object_unparent">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="768">Clear the parent of @object, removing the associated reference.
-This function decreases the refcount of @object.
-
-MT safe. Grabs and releases @object's lock.</doc>
- <source-position filename="gst/gstobject.h" line="234"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="770">a #GstObject to unparent</doc>
- <type name="Object" c:type="GstObject*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_object_unref">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="245">Decrements the reference count on @object. If reference count hits
-zero, destroy @object. This function does not take the lock
-on @object as it relies on atomic refcounting.
-
-The unref method should never be called with the LOCK held since
-this might deadlock the dispose function.</doc>
- <source-position filename="gst/gstobject.h" line="255"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="247">a #GstObject to unreference</doc>
- <type name="Object" c:type="gpointer"/>
- </instance-parameter>
- </parameters>
- </method>
- <property name="name"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="parent" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="159">The parent of the object. Please note, that when changing the 'parent'
-property, we don't emit #GObject::notify and #GstObject::deep-notify
-signals due to locking issues. In some cases one can use
-#GstBin::element-added or #GstBin::element-removed signals on the parent to
-achieve a similar effect.</doc>
- <type name="Object"/>
- </property>
- <field name="object">
- <type name="GObject.InitiallyUnowned" c:type="GInitiallyUnowned"/>
- </field>
- <field name="lock">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="165">object LOCK</doc>
- <type name="GLib.Mutex" c:type="GMutex"/>
- </field>
- <field name="name">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="166">The name of the object</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="parent">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="167">this object's parent, weak ref</doc>
- <type name="Object" c:type="GstObject*"/>
- </field>
- <field name="flags">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="168">flags for this object</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="control_bindings" readable="0" private="1">
- <type name="GLib.List" c:type="GList*">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </field>
- <field name="control_rate" readable="0" private="1">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="last_sync" readable="0" private="1">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <glib:signal name="deep-notify"
- when="first"
- no-recurse="1"
- detailed="1"
- no-hooks="1">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="175">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.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="prop_object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="178">the object that originated the signal</doc>
- <type name="Object"/>
- </parameter>
- <parameter name="prop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="179">the property that changed</doc>
- <type name="GObject.ParamSpec"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="ObjectClass"
- c:type="GstObjectClass"
- glib:is-gtype-struct-for="Object">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="189">GStreamer base object class.</doc>
- <source-position filename="gst/gstobject.h" line="210"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="191">parent</doc>
- <type name="GObject.InitiallyUnownedClass"
- c:type="GInitiallyUnownedClass"/>
- </field>
- <field name="path_string_separator">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="192">separator used by gst_object_get_path_string()</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="deep_notify">
- <callback name="deep_notify">
- <source-position filename="gst/gstobject.h" line="203"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="orig" transfer-ownership="none">
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="pspec" transfer-ownership="none">
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <bitfield name="ObjectFlags"
- glib:type-name="GstObjectFlags"
- glib:get-type="gst_object_flags_get_type"
- c:type="GstObjectFlags">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="42">The standard flags that an gstobject may have.</doc>
- <member name="may_be_leaked"
- value="1"
- c:identifier="GST_OBJECT_FLAG_MAY_BE_LEAKED"
- glib:nick="may-be-leaked">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="44">the object is expected to stay alive even
-after gst_deinit() has been called and so should be ignored by leak
-detection tools. (Since: 1.10)</doc>
- </member>
- <member name="last"
- value="16"
- c:identifier="GST_OBJECT_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstobject.h"
- line="47">subclasses can add additional flags starting from this flag</doc>
- </member>
- </bitfield>
- <function-macro name="PAD" c:identifier="GST_PAD" introspectable="0">
- <source-position filename="gst/gstpad.h" line="86"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_ACTIVATEFUNC"
- c:identifier="GST_PAD_ACTIVATEFUNC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="882">Get the #GstPadActivateFunction from @pad.</doc>
- <source-position filename="gst/gstpad.h" line="888"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="884">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_ACTIVATEMODEFUNC"
- c:identifier="GST_PAD_ACTIVATEMODEFUNC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="889">Get the #GstPadActivateModeFunction from the given @pad.</doc>
- <source-position filename="gst/gstpad.h" line="895"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="891">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_BLOCK_BROADCAST"
- c:identifier="GST_PAD_BLOCK_BROADCAST"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="1277"/>
- <parameters>
- <parameter name="pad">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_BLOCK_GET_COND"
- c:identifier="GST_PAD_BLOCK_GET_COND"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="1274"/>
- <parameters>
- <parameter name="pad">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_BLOCK_SIGNAL"
- c:identifier="GST_PAD_BLOCK_SIGNAL"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="1276"/>
- <parameters>
- <parameter name="pad">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_BLOCK_WAIT"
- c:identifier="GST_PAD_BLOCK_WAIT"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="1275"/>
- <parameters>
- <parameter name="pad">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_CAST"
- c:identifier="GST_PAD_CAST"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="88"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_CHAINFUNC"
- c:identifier="GST_PAD_CHAINFUNC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="896">Get the #GstPadChainFunction from the given @pad.</doc>
- <source-position filename="gst/gstpad.h" line="902"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="898">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_CHAINLISTFUNC"
- c:identifier="GST_PAD_CHAINLISTFUNC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="903">Get the #GstPadChainListFunction from the given @pad.</doc>
- <source-position filename="gst/gstpad.h" line="909"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="905">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_CLASS"
- c:identifier="GST_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="87"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_DIRECTION"
- c:identifier="GST_PAD_DIRECTION"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="856">Get the #GstPadDirection of the given @pad. Accessor macro, use
-gst_pad_get_direction() instead.</doc>
- <source-position filename="gst/gstpad.h" line="863"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="858">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_ELEMENT_PRIVATE"
- c:identifier="GST_PAD_ELEMENT_PRIVATE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="839">Get the private data of @pad, which is usually some pad- or stream-specific
-structure created by the element and set on the pad when creating it.
-No locking is performed in this function.</doc>
- <source-position filename="gst/gstpad.h" line="847"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="841">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_EVENTFULLFUNC"
- c:identifier="GST_PAD_EVENTFULLFUNC"
- version="1.8"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="928">Get the #GstPadEventFullFunction from the given @pad, which
-is the function that handles events on the pad. You can
-use this to set your own event handling function on a pad
-after you create it. If your element derives from a base
-class, use the base class's virtual functions instead.</doc>
- <source-position filename="gst/gstpad.h" line="940"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="930">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_EVENTFUNC"
- c:identifier="GST_PAD_EVENTFUNC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="917">Get the #GstPadEventFunction from the given @pad, which
-is the function that handles events on the pad. You can
-use this to set your own event handling function on a pad
-after you create it. If your element derives from a base
-class, use the base class's virtual functions instead.</doc>
- <source-position filename="gst/gstpad.h" line="927"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="919">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_GETRANGEFUNC"
- c:identifier="GST_PAD_GETRANGEFUNC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="910">Get the #GstPadGetRangeFunction from the given @pad.</doc>
- <source-position filename="gst/gstpad.h" line="916"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="912">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_GET_STREAM_LOCK"
- c:identifier="GST_PAD_GET_STREAM_LOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1231">Get the stream lock of @pad. The stream lock is protecting the
-resources used in the data processing functions of @pad. Accessor
-macro, use GST_PAD_STREAM_LOCK() and GST_PAD_STREAM_UNLOCK() instead
-to take/release the pad's stream lock.</doc>
- <source-position filename="gst/gstpad.h" line="1240"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1233">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_HAS_PENDING_EVENTS"
- c:identifier="GST_PAD_HAS_PENDING_EVENTS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1067">Check if the given @pad has pending events. This is used internally by
-GStreamer.</doc>
- <source-position filename="gst/gstpad.h" line="1074"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1069">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_ACCEPT_INTERSECT"
- c:identifier="GST_PAD_IS_ACCEPT_INTERSECT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1173">Check if the pad's accept intersect flag is set. The default accept-caps
-handler will check if the caps intersect the query-caps result instead of
-checking for a subset. This is interesting for parser elements that can
-accept incompletely specified caps.</doc>
- <source-position filename="gst/gstpad.h" line="1182"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1175">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_ACCEPT_TEMPLATE"
- c:identifier="GST_PAD_IS_ACCEPT_TEMPLATE"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1199">Check if the pad's accept caps operation will use the pad template caps.
-The default accept-caps will do a query caps to get the caps, which might
-be querying downstream causing unnecessary overhead. It is recommended to
-implement a proper accept-caps query handler or to use this flag to prevent
-recursive accept-caps handling.</doc>
- <source-position filename="gst/gstpad.h" line="1211"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1201">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_ACTIVE"
- c:identifier="GST_PAD_IS_ACTIVE"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="1009"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1005">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_BLOCKED"
- c:identifier="GST_PAD_IS_BLOCKED"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1010">Check if the dataflow on a @pad is blocked. Use gst_pad_is_blocked() instead.</doc>
- <source-position filename="gst/gstpad.h" line="1016"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1012">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_BLOCKING"
- c:identifier="GST_PAD_IS_BLOCKING"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1017">Check if the @pad is currently blocking on a buffer or event. Use
-gst_pad_is_blocking() instead.</doc>
- <source-position filename="gst/gstpad.h" line="1024"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1019">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_EOS"
- c:identifier="GST_PAD_IS_EOS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1051">Check if the @pad is in EOS state.</doc>
- <source-position filename="gst/gstpad.h" line="1057"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1053">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_FIXED_CAPS"
- c:identifier="GST_PAD_IS_FIXED_CAPS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1075">Check if the given @pad is using fixed caps, which means that
-once the caps are set on the @pad, the caps query function will
-only return those caps. See gst_pad_use_fixed_caps().</doc>
- <source-position filename="gst/gstpad.h" line="1083"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1077">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_FLUSHING"
- c:identifier="GST_PAD_IS_FLUSHING"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1025">Check if the given @pad is flushing.</doc>
- <source-position filename="gst/gstpad.h" line="1031"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1027">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_LINKED"
- c:identifier="GST_PAD_IS_LINKED"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="1002"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="997">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_PROXY_ALLOCATION"
- c:identifier="GST_PAD_IS_PROXY_ALLOCATION"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1119">Check if the given @pad is set as proxy allocation which means
-that the default query handler will forward allocation queries to the
-internally linked @pads instead of discarding them.</doc>
- <source-position filename="gst/gstpad.h" line="1127"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1121">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_PROXY_CAPS"
- c:identifier="GST_PAD_IS_PROXY_CAPS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1092">Check if the given @pad is set to proxy caps. This means that the default
-event and query handler will forward all events and queries to the
-internally linked @pads instead of discarding them.</doc>
- <source-position filename="gst/gstpad.h" line="1100"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1094">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_PROXY_SCHEDULING"
- c:identifier="GST_PAD_IS_PROXY_SCHEDULING"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1147">Check if the given @pad is set to proxy scheduling queries, which means that
-the default query handler will forward scheduling queries to the internally
-linked @pads instead of discarding them.</doc>
- <source-position filename="gst/gstpad.h" line="1155"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1149">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_SINK"
- c:identifier="GST_PAD_IS_SINK"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="994"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="990">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_IS_SRC"
- c:identifier="GST_PAD_IS_SRC"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="987"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="983">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_ITERINTLINKFUNC"
- c:identifier="GST_PAD_ITERINTLINKFUNC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="952">Get the #GstPadIterIntLinkFunction from the given @pad.</doc>
- <source-position filename="gst/gstpad.h" line="958"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="954">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_LAST_FLOW_RETURN"
- c:identifier="GST_PAD_LAST_FLOW_RETURN"
- version="1.4"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1264">Gets the last flow return on this pad</doc>
- <source-position filename="gst/gstpad.h" line="1272"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1266">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_LINKFUNC"
- c:identifier="GST_PAD_LINKFUNC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="967">Get the #GstPadLinkFunction for the given @pad.</doc>
- <source-position filename="gst/gstpad.h" line="973"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="969">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_LINK_FAILED"
- c:identifier="GST_PAD_LINK_FAILED"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="114">Macro to test if the given #GstPadLinkReturn value indicates a failed
-link step.</doc>
- <source-position filename="gst/gstpad.h" line="121"/>
- <parameters>
- <parameter name="ret">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="116">the #GstPadLinkReturn value</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_LINK_SUCCESSFUL"
- c:identifier="GST_PAD_LINK_SUCCESSFUL"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="123">Macro to test if the given #GstPadLinkReturn value indicates a successful
-link step.</doc>
- <source-position filename="gst/gstpad.h" line="130"/>
- <parameters>
- <parameter name="ret">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="125">the #GstPadLinkReturn value</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_MODE"
- c:identifier="GST_PAD_MODE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="873">Get the #GstPadMode of pad, which will be GST_PAD_MODE_NONE if the pad
-has not been activated yet, and otherwise either GST_PAD_MODE_PUSH or
-GST_PAD_MODE_PULL depending on which mode the pad was activated in.</doc>
- <source-position filename="gst/gstpad.h" line="881"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="875">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_NAME"
- c:identifier="GST_PAD_NAME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="823">Get name of the given pad.
-No locking is performed in this function, use gst_pad_get_name() instead.</doc>
- <source-position filename="gst/gstpad.h" line="830"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="825">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_NEEDS_PARENT"
- c:identifier="GST_PAD_NEEDS_PARENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1084">Check if there is a parent object before calling into the @pad callbacks.
-This is used internally by GStreamer.</doc>
- <source-position filename="gst/gstpad.h" line="1091"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1086">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_NEEDS_RECONFIGURE"
- c:identifier="GST_PAD_NEEDS_RECONFIGURE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1058">Check if the @pad should be reconfigured/renegotiated.
-The flag has to be unset manually after reconfiguration happened.
-Use gst_pad_needs_reconfigure() or gst_pad_check_reconfigure() instead.</doc>
- <source-position filename="gst/gstpad.h" line="1066"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1060">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PAD_TEMPLATE"
- c:identifier="GST_PAD_PAD_TEMPLATE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="848">Get the @pad #GstPadTemplate. It describes the possible media types
-a @pad or an element factory can handle.</doc>
- <source-position filename="gst/gstpad.h" line="855"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="850">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PARENT"
- c:identifier="GST_PAD_PARENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="831">Get the @pad parent.
-No locking is performed in this function, use gst_pad_get_parent() instead.</doc>
- <source-position filename="gst/gstpad.h" line="838"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="833">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PEER"
- c:identifier="GST_PAD_PEER"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="959">Return the pad's peer member. This member is a pointer to the linked @pad.
-No locking is performed in this function, use gst_pad_get_peer() instead.</doc>
- <source-position filename="gst/gstpad.h" line="966"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="961">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PROBE_INFO_BUFFER"
- c:identifier="GST_PAD_PROBE_INFO_BUFFER"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="610"/>
- <parameters>
- <parameter name="d">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PROBE_INFO_BUFFER_LIST"
- c:identifier="GST_PAD_PROBE_INFO_BUFFER_LIST"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="611"/>
- <parameters>
- <parameter name="d">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PROBE_INFO_DATA"
- c:identifier="GST_PAD_PROBE_INFO_DATA"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="607"/>
- <parameters>
- <parameter name="d">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PROBE_INFO_EVENT"
- c:identifier="GST_PAD_PROBE_INFO_EVENT"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="612"/>
- <parameters>
- <parameter name="d">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PROBE_INFO_FLOW_RETURN"
- c:identifier="GST_PAD_PROBE_INFO_FLOW_RETURN"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="608"/>
- <parameters>
- <parameter name="d">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PROBE_INFO_ID"
- c:identifier="GST_PAD_PROBE_INFO_ID"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="606"/>
- <parameters>
- <parameter name="d">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PROBE_INFO_OFFSET"
- c:identifier="GST_PAD_PROBE_INFO_OFFSET"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="615"/>
- <parameters>
- <parameter name="d">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PROBE_INFO_QUERY"
- c:identifier="GST_PAD_PROBE_INFO_QUERY"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="613"/>
- <parameters>
- <parameter name="d">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PROBE_INFO_SIZE"
- c:identifier="GST_PAD_PROBE_INFO_SIZE"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="616"/>
- <parameters>
- <parameter name="d">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_PROBE_INFO_TYPE"
- c:identifier="GST_PAD_PROBE_INFO_TYPE"
- introspectable="0">
- <source-position filename="gst/gstpad.h" line="605"/>
- <parameters>
- <parameter name="d">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_QUERYFUNC"
- c:identifier="GST_PAD_QUERYFUNC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="941">Get the #GstPadQueryFunction from @pad, which is the function
-that handles queries on the pad. You can use this to set your
-own query handling function on a pad after you create it. If your
-element derives from a base class, use the base class's virtual
-functions instead.</doc>
- <source-position filename="gst/gstpad.h" line="951"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="943">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_SET_ACCEPT_INTERSECT"
- c:identifier="GST_PAD_SET_ACCEPT_INTERSECT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1183">Set @pad to by default accept caps by intersecting the result instead of
-checking for a subset. This is interesting for parser elements that can
-accept incompletely specified caps.</doc>
- <source-position filename="gst/gstpad.h" line="1191"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1185">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_SET_ACCEPT_TEMPLATE"
- c:identifier="GST_PAD_SET_ACCEPT_TEMPLATE"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1212">Set @pad to by default use the pad template caps to compare with
-the accept caps instead of using a caps query result.</doc>
- <source-position filename="gst/gstpad.h" line="1221"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1214">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_SET_FLUSHING"
- c:identifier="GST_PAD_SET_FLUSHING"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1032">Set the given @pad to flushing state, which means it will not accept any
-more events, queries or buffers, and return GST_FLOW_FLUSHING if any buffers
-are pushed on it. This usually happens when the pad is shut down or when
-a flushing seek happens. This is used inside GStreamer when flush start/stop
-events pass through pads, or when an element state is changed and pads are
-activated or deactivated.</doc>
- <source-position filename="gst/gstpad.h" line="1043"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1034">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_SET_PROXY_ALLOCATION"
- c:identifier="GST_PAD_SET_PROXY_ALLOCATION"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1128">Set @pad to proxy allocation queries, which means that the default query
-handler will forward allocation queries to the internally linked @pads
-instead of discarding them.
-Set this if the element always outputs data in the exact same format as it
-receives as input. This is just for convenience to avoid implementing some
-standard query handling code in an element.</doc>
- <source-position filename="gst/gstpad.h" line="1139"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1130">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_SET_PROXY_CAPS"
- c:identifier="GST_PAD_SET_PROXY_CAPS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1101">Set @pad to proxy caps, so that all caps-related events and queries are
-proxied down- or upstream to the other side of the element automatically.
-Set this if the element always outputs data in the exact same format as it
-receives as input. This is just for convenience to avoid implementing some
-standard event and query handling code in an element.</doc>
- <source-position filename="gst/gstpad.h" line="1111"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1103">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_SET_PROXY_SCHEDULING"
- c:identifier="GST_PAD_SET_PROXY_SCHEDULING"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1156">Set @pad to proxy scheduling queries, which means that the default query
-handler will forward scheduling queries to the internally linked @pads
-instead of discarding them. You will usually want to handle scheduling
-queries explicitly if your element supports multiple scheduling modes.</doc>
- <source-position filename="gst/gstpad.h" line="1165"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1158">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_STREAM_LOCK"
- c:identifier="GST_PAD_STREAM_LOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1241">Take the pad's stream lock. The stream lock is recursive and will be taken
-when buffers or serialized downstream events are pushed on a pad.</doc>
- <source-position filename="gst/gstpad.h" line="1248"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1243">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_STREAM_TRYLOCK"
- c:identifier="GST_PAD_STREAM_TRYLOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1249">Try to take the pad's stream lock, and return %TRUE if the lock could be
-taken, and otherwise %FALSE.</doc>
- <source-position filename="gst/gstpad.h" line="1256"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1251">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_STREAM_UNLOCK"
- c:identifier="GST_PAD_STREAM_UNLOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1257">Release the pad's stream lock.</doc>
- <source-position filename="gst/gstpad.h" line="1263"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1259">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_TASK"
- c:identifier="GST_PAD_TASK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="864">Get the #GstTask of @pad. Accessor macro used by GStreamer. Use the
-gst_pad_start_task(), gst_pad_stop_task() and gst_pad_pause_task()
-functions instead.</doc>
- <source-position filename="gst/gstpad.h" line="872"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="866">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_TEMPLATE"
- c:identifier="GST_PAD_TEMPLATE"
- introspectable="0">
- <source-position filename="gst/gstpadtemplate.h" line="45"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_TEMPLATE_CAPS"
- c:identifier="GST_PAD_TEMPLATE_CAPS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="89">Get a handle to the padtemplate #GstCaps</doc>
- <source-position filename="gst/gstpadtemplate.h" line="95"/>
- <parameters>
- <parameter name="templ">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="91">the template to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_TEMPLATE_CLASS"
- c:identifier="GST_PAD_TEMPLATE_CLASS"
- introspectable="0">
- <source-position filename="gst/gstpadtemplate.h" line="46"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_TEMPLATE_DIRECTION"
- c:identifier="GST_PAD_TEMPLATE_DIRECTION"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="73">Get the #GstPadDirection of the padtemplate.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="79"/>
- <parameters>
- <parameter name="templ">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="75">the template to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_TEMPLATE_GTYPE"
- c:identifier="GST_PAD_TEMPLATE_GTYPE"
- version="1.14"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="97">Get the #GType of the padtemplate</doc>
- <source-position filename="gst/gstpadtemplate.h" line="105"/>
- <parameters>
- <parameter name="templ">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="99">the template to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_TEMPLATE_IS_FIXED"
- c:identifier="GST_PAD_TEMPLATE_IS_FIXED"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="118">Check if the properties of the padtemplate are fixed</doc>
- <source-position filename="gst/gstpadtemplate.h" line="124"/>
- <parameters>
- <parameter name="templ">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="120">the template to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_TEMPLATE_NAME_TEMPLATE"
- c:identifier="GST_PAD_TEMPLATE_NAME_TEMPLATE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="65">Get the nametemplate of the padtemplate.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="71"/>
- <parameters>
- <parameter name="templ">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="67">the template to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_TEMPLATE_PRESENCE"
- c:identifier="GST_PAD_TEMPLATE_PRESENCE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="81">Get the #GstPadPresence of the padtemplate.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="87"/>
- <parameters>
- <parameter name="templ">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="83">the template to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_UNLINKFUNC"
- c:identifier="GST_PAD_UNLINKFUNC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="974">Get the #GstPadUnlinkFunction from the given @pad.</doc>
- <source-position filename="gst/gstpad.h" line="980"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="976">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_UNSET_ACCEPT_INTERSECT"
- c:identifier="GST_PAD_UNSET_ACCEPT_INTERSECT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1192">Unset accept intersect flag.</doc>
- <source-position filename="gst/gstpad.h" line="1198"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1194">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_UNSET_ACCEPT_TEMPLATE"
- c:identifier="GST_PAD_UNSET_ACCEPT_TEMPLATE"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1222">Unset accept template flag.</doc>
- <source-position filename="gst/gstpad.h" line="1230"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1224">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_UNSET_FLUSHING"
- c:identifier="GST_PAD_UNSET_FLUSHING"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1044">Unset the flushing flag.</doc>
- <source-position filename="gst/gstpad.h" line="1050"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1046">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_UNSET_PROXY_ALLOCATION"
- c:identifier="GST_PAD_UNSET_PROXY_ALLOCATION"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1140">Unset proxy allocation flag.</doc>
- <source-position filename="gst/gstpad.h" line="1146"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1142">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_UNSET_PROXY_CAPS"
- c:identifier="GST_PAD_UNSET_PROXY_CAPS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1112">Unset proxy caps flag.</doc>
- <source-position filename="gst/gstpad.h" line="1118"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1114">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PAD_UNSET_PROXY_SCHEDULING"
- c:identifier="GST_PAD_UNSET_PROXY_SCHEDULING"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1166">Unset proxy scheduling flag.</doc>
- <source-position filename="gst/gstpad.h" line="1172"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1168">a #GstPad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="PARAM_CONDITIONALLY_AVAILABLE"
- value="16384"
- c:type="GST_PARAM_CONDITIONALLY_AVAILABLE"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="74">Use this flag on GObject properties of GstObject to indicate that
-they might not be available depending on environment such as OS, device, etc,
-so such properties will be installed conditionally only if the GstObject is
-able to support it.</doc>
- <source-position filename="gst/gstparamspecs.h" line="84"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PARAM_CONTROLLABLE"
- value="512"
- c:type="GST_PARAM_CONTROLLABLE">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="29">Use this flag on GObject properties to signal they can make sense to be.
-controlled over time. This hint is used by the GstController.</doc>
- <source-position filename="gst/gstparamspecs.h" line="35"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PARAM_DOC_SHOW_DEFAULT"
- value="8192"
- c:type="GST_PARAM_DOC_SHOW_DEFAULT"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="63">Use this flag on GObject properties of GstObject to indicate that
-during `gst-inspect` and friends, the default value should be used
-as default instead of the current value.</doc>
- <source-position filename="gst/gstparamspecs.h" line="72"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PARAM_MUTABLE_PAUSED"
- value="2048"
- c:type="GST_PARAM_MUTABLE_PAUSED">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="45">Use this flag on GObject properties of GstElements to indicate that
-they can be changed when the element is in the PAUSED or lower state.
-This flag implies GST_PARAM_MUTABLE_READY.</doc>
- <source-position filename="gst/gstparamspecs.h" line="52"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PARAM_MUTABLE_PLAYING"
- value="4096"
- c:type="GST_PARAM_MUTABLE_PLAYING">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="54">Use this flag on GObject properties of GstElements to indicate that
-they can be changed when the element is in the PLAYING or lower state.
-This flag implies GST_PARAM_MUTABLE_PAUSED.</doc>
- <source-position filename="gst/gstparamspecs.h" line="61"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PARAM_MUTABLE_READY"
- value="1024"
- c:type="GST_PARAM_MUTABLE_READY">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="37">Use this flag on GObject properties of GstElements to indicate that
-they can be changed when the element is in the READY or lower state.</doc>
- <source-position filename="gst/gstparamspecs.h" line="43"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="PARAM_SPEC_ARRAY_LIST"
- c:identifier="GST_PARAM_SPEC_ARRAY_LIST"
- introspectable="0">
- <source-position filename="gst/gstparamspecs.h" line="118"/>
- <parameters>
- <parameter name="pspec">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PARAM_SPEC_FRACTION"
- c:identifier="GST_PARAM_SPEC_FRACTION"
- introspectable="0">
- <source-position filename="gst/gstparamspecs.h" line="105"/>
- <parameters>
- <parameter name="pspec">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="PARAM_USER_SHIFT"
- value="65536"
- c:type="GST_PARAM_USER_SHIFT">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="86">Bits based on GST_PARAM_USER_SHIFT can be used by 3rd party applications.</doc>
- <source-position filename="gst/gstparamspecs.h" line="91"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="PIPELINE"
- c:identifier="GST_PIPELINE"
- introspectable="0">
- <source-position filename="gst/gstpipeline.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PIPELINE_CAST"
- c:identifier="GST_PIPELINE_CAST"
- introspectable="0">
- <source-position filename="gst/gstpipeline.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PIPELINE_CLASS"
- c:identifier="GST_PIPELINE_CLASS"
- introspectable="0">
- <source-position filename="gst/gstpipeline.h" line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PIPELINE_GET_CLASS"
- c:identifier="GST_PIPELINE_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstpipeline.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PLUGIN" c:identifier="GST_PLUGIN" introspectable="0">
- <source-position filename="gst/gstplugin.h" line="192"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PLUGIN_CAST"
- c:identifier="GST_PLUGIN_CAST"
- introspectable="0">
- <source-position filename="gst/gstplugin.h" line="194"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PLUGIN_CLASS"
- c:identifier="GST_PLUGIN_CLASS"
- introspectable="0">
- <source-position filename="gst/gstplugin.h" line="193"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PLUGIN_DEFINE"
- c:identifier="GST_PLUGIN_DEFINE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="230">This macro needs to be used to define the entry point and meta data of a
-plugin. One would use this macro to export a plugin, so that it can be used
-by other applications.
-
-The macro uses a define named PACKAGE for the #GstPluginDesc,source field.
-When using autoconf, this is usually set automatically via the AC_INIT
-macro, and set in config.h. If you are not using autoconf, you will need to
-define PACKAGE yourself and set it to a short mnemonic string identifying
-your application/package, e.g. 'someapp' or 'my-plugins-foo.
-
-If defined, the GST_PACKAGE_RELEASE_DATETIME will also be used for the
-#GstPluginDesc,release_datetime field.</doc>
- <source-position filename="gst/gstplugin.h" line="255"/>
- <parameters>
- <parameter name="major">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="232">major version number of the gstreamer-core that plugin was compiled for</doc>
- </parameter>
- <parameter name="minor">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="233">minor version number of the gstreamer-core that plugin was compiled for</doc>
- </parameter>
- <parameter name="name">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="234">short, but unique name of the plugin</doc>
- </parameter>
- <parameter name="description">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="235">information about the purpose of the plugin</doc>
- </parameter>
- <parameter name="init">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="236">function pointer to the plugin_init method with the signature of &lt;code&gt;static gboolean plugin_init (GstPlugin * plugin)&lt;/code&gt;.</doc>
- </parameter>
- <parameter name="version">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="237">full version string (e.g. VERSION from config.h)</doc>
- </parameter>
- <parameter name="license">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="238">under which licence the package has been released, e.g. GPL, LGPL.</doc>
- </parameter>
- <parameter name="package">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="239">the package-name (e.g. PACKAGE_NAME from config.h)</doc>
- </parameter>
- <parameter name="origin">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="240">a description from where the package comes from (e.g. the homepage URL)</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PLUGIN_FEATURE"
- c:identifier="GST_PLUGIN_FEATURE"
- introspectable="0">
- <source-position filename="gst/gstpluginfeature.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PLUGIN_FEATURE_CAST"
- c:identifier="GST_PLUGIN_FEATURE_CAST"
- introspectable="0">
- <source-position filename="gst/gstpluginfeature.h" line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PLUGIN_FEATURE_CLASS"
- c:identifier="GST_PLUGIN_FEATURE_CLASS"
- introspectable="0">
- <source-position filename="gst/gstpluginfeature.h" line="36"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PLUGIN_FEATURE_GET_CLASS"
- c:identifier="GST_PLUGIN_FEATURE_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstpluginfeature.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PLUGIN_FEATURE_LIST_DEBUG"
- c:identifier="GST_PLUGIN_FEATURE_LIST_DEBUG"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="136">Debug the plugin feature names in @list.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="144"/>
- <parameters>
- <parameter name="list">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="138">a #GList of
- plugin features</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PLUGIN_GET_CLASS"
- c:identifier="GST_PLUGIN_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstplugin.h" line="191"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PLUGIN_STATIC_DECLARE"
- c:identifier="GST_PLUGIN_STATIC_DECLARE"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="202">This macro can be used to initialize statically linked plugins. It is
-necessary to call this macro before the plugin can be used.
-It has to be used in combination with GST_PLUGIN_STATIC_REGISTER
-and must be placed outside any block to declare the plugin initialization
-function.</doc>
- <source-position filename="gst/gstplugin.h" line="214"/>
- <parameters>
- <parameter name="name">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="204">short, but unique name of the plugin</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PLUGIN_STATIC_REGISTER"
- c:identifier="GST_PLUGIN_STATIC_REGISTER"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="217">This macro can be used to initialize statically linked plugins. It is
-necessary to call this macro before the plugin can be used.
-It has to be used in combination with GST_PLUGIN_STATIC_DECLARE and
-calls the plugin initialization function.</doc>
- <source-position filename="gst/gstplugin.h" line="228"/>
- <parameters>
- <parameter name="name">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="219">short, but unique name of the plugin</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PRESET" c:identifier="GST_PRESET" introspectable="0">
- <source-position filename="gst/gstpreset.h" line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PRESET_GET_INTERFACE"
- c:identifier="GST_PRESET_GET_INTERFACE"
- introspectable="0">
- <source-position filename="gst/gstpreset.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PROMISE"
- c:identifier="GST_PROMISE"
- introspectable="0">
- <source-position filename="gst/gstpromise.h" line="30"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="PROTECTION_SYSTEM_ID_CAPS_FIELD"
- value="protection-system"
- c:type="GST_PROTECTION_SYSTEM_ID_CAPS_FIELD"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstprotection.h"
- line="27">The field name in a GstCaps that is used to signal the UUID of the protection
-system.</doc>
- <source-position filename="gst/gstprotection.h" line="35"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="PROTECTION_UNSPECIFIED_SYSTEM_ID"
- value="unspecified-system-id"
- c:type="GST_PROTECTION_UNSPECIFIED_SYSTEM_ID"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstprotection.h"
- line="37">The protection system value of the unspecified UUID.
-In some cases the system protection ID is not present in the contents or in their
-metadata, as encrypted WebM.
-This define is used to set the value of the "system_id" field in GstProtectionEvent,
-with this value, the application will use an external information to choose which
-protection system to use.
-
-Example: The matroskademux uses this value in the case of encrypted WebM,
-the application will choose the appropriate protection system based on the information
-received through EME API.</doc>
- <source-position filename="gst/gstprotection.h" line="53"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="PROXY_PAD"
- c:identifier="GST_PROXY_PAD"
- introspectable="0">
- <source-position filename="gst/gstghostpad.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PROXY_PAD_CLASS"
- c:identifier="GST_PROXY_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst/gstghostpad.h" line="38"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="PTR_FORMAT"
- value="paA"
- c:type="GST_PTR_FORMAT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="278">printf format type used to debug GStreamer types. You can use this in
-combination with GStreamer's debug logging system as well as the functions
-gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf()
-to pretty-print the following types: #GstCaps, #GstStructure,
-#GstCapsFeatures, #GstTagList, #GstDateTime, #GstBuffer, #GstBufferList,
-#GstMessage, #GstEvent, #GstQuery, #GstContext, #GstPad, #GstObject. All
-#GObject types will be printed as typename plus pointer, and everything
-else will simply be printed as pointer address.
-
-This can only be used on types whose size is &gt;= sizeof(gpointer).</doc>
- <source-position filename="gst/gstinfo.h" line="292"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <class name="Pad"
- c:symbol-prefix="pad"
- c:type="GstPad"
- parent="Object"
- glib:type-name="GstPad"
- glib:get-type="gst_pad_get_type"
- glib:type-struct="PadClass">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="22">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_new_from_template() 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_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_get_static_pad(),
-the pads can be linked with gst_pad_link(). (For quick links,
-you can also use gst_element_link(), which will make the obvious
-link for you if it's straightforward.). Pads can be unlinked again with
-gst_pad_unlink(). gst_pad_get_peer() 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_set_active().
-
-gst_pad_query() and gst_pad_peer_query() can be used to query various
-properties of the pad and the stream.
-
-To send a #GstEvent on a pad, use gst_pad_send_event() and
-gst_pad_push_event(). Some events will be sticky on the pad, meaning that
-after they pass on the pad they can be queried later with
-gst_pad_get_sticky_event() and gst_pad_sticky_events_foreach().
-gst_pad_get_current_caps() and gst_pad_has_current_caps() are convenience
-functions to query the current sticky CAPS event on a pad.
-
-GstElements will use gst_pad_push() and gst_pad_pull_range() 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_add_probe(). gst_pad_is_blocked()
-can be used to check if a block probe is installed on the pad.
-gst_pad_is_blocking() checks if the blocking probe is currently blocking the
-pad. gst_pad_remove_probe() 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_get_offset(). This
-offset will be applied to the running_time of all data passing over the pad.
-gst_pad_set_offset() can be used to change the offset.
-
-Convenience functions exist to start, pause and stop the task on a pad with
-gst_pad_start_task(), gst_pad_pause_task() and gst_pad_stop_task()
-respectively.</doc>
- <source-position filename="gst/gstpad.h" line="817"/>
- <constructor name="new" c:identifier="gst_pad_new">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="825">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.</doc>
- <source-position filename="gst/gstpad.h" line="1285"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="835">a new #GstPad.
-
-MT safe.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="827">the name of the new pad.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="direction" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="828">the #GstPadDirection of the pad.</doc>
- <type name="PadDirection" c:type="GstPadDirection"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_static_template"
- c:identifier="gst_pad_new_from_static_template">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="871">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.</doc>
- <source-position filename="gst/gstpad.h" line="1291"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="881">a new #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="873">the #GstStaticPadTemplate to use</doc>
- <type name="StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="874">the name of the pad</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_template"
- c:identifier="gst_pad_new_from_template">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="846">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.</doc>
- <source-position filename="gst/gstpad.h" line="1288"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="856">a new #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="848">the pad template to use</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </parameter>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="849">the name of the pad</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <function name="link_get_name"
- c:identifier="gst_pad_link_get_name"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="271">Gets a string representing the given pad-link return.</doc>
- <source-position filename="gst/gstpad.h" line="192"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="277">a static string with the name of the pad-link return.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="ret" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="273">a #GstPadLinkReturn to get the name of.</doc>
- <type name="PadLinkReturn" c:type="GstPadLinkReturn"/>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="linked">
- <source-position filename="gst/gstpad.h" line="812"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="peer" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="unlinked">
- <source-position filename="gst/gstpad.h" line="813"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="peer" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="activate_mode" c:identifier="gst_pad_activate_mode">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1287">Activates or deactivates the given pad in @mode via dispatching to the
-pad's activatemodefunc. For use from within pad activation functions only.
-
-If you don't know what this is, you probably don't want to call it.</doc>
- <source-position filename="gst/gstpad.h" line="1327"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1298">%TRUE if the operation was successful.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1289">the #GstPad to activate or deactivate.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1290">the requested activation mode</doc>
- <type name="PadMode" c:type="GstPadMode"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1291">whether or not the pad should be active.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_probe" c:identifier="gst_pad_add_probe">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1398">Be notified of different states of pads. The provided callback is called for
-every state that matches @mask.
-
-Probes are called in groups: First GST_PAD_PROBE_TYPE_BLOCK probes are
-called, then others, then finally GST_PAD_PROBE_TYPE_IDLE. The only
-exception here are GST_PAD_PROBE_TYPE_IDLE probes that are called
-immediately if the pad is already idle while calling gst_pad_add_probe().
-In each of the groups, probes are called in the order in which they were
-added.</doc>
- <source-position filename="gst/gstpad.h" line="1330"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1417">an id or 0 if no probe is pending. The id can be used to remove the
-probe with gst_pad_remove_probe(). When using GST_PAD_PROBE_TYPE_IDLE it can
-happen that the probe can be run immediately and if the probe returns
-GST_PAD_PROBE_REMOVE this functions returns 0.
-
-MT safe.</doc>
- <type name="gulong" c:type="gulong"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1400">the #GstPad to add the probe to</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1401">the probe mask</doc>
- <type name="PadProbeType" c:type="GstPadProbeType"/>
- </parameter>
- <parameter name="callback"
- transfer-ownership="none"
- scope="notified"
- closure="2"
- destroy="3">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1402">#GstPadProbeCallback that will be called with notifications of
- the pad state</doc>
- <type name="PadProbeCallback" c:type="GstPadProbeCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1404">user data passed to the callback</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="destroy_data"
- transfer-ownership="none"
- scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1405">#GDestroyNotify for user_data</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="can_link" c:identifier="gst_pad_can_link">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2441">Checks if the source pad and the sink pad are compatible so they can be
-linked.</doc>
- <source-position filename="gst/gstpad.h" line="1437"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2449">%TRUE if the pads can be linked.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="srcpad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2443">the source #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="sinkpad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2444">the sink #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="chain" c:identifier="gst_pad_chain">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4496">Chain a buffer to @pad.
-
-The function returns #GST_FLOW_FLUSHING if the pad was flushing.
-
-If the buffer type is not acceptable for @pad (as negotiated with a
-preceding GST_EVENT_CAPS event), this function returns
-#GST_FLOW_NOT_NEGOTIATED.
-
-The function proceeds calling the chain function installed on @pad (see
-gst_pad_set_chain_function()) and the return value of that function is
-returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
-chain function.
-
-In all cases, success or failure, the caller loses its reference to @buffer
-after calling this function.</doc>
- <source-position filename="gst/gstpad.h" line="1501"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4518">a #GstFlowReturn from the pad.
-
-MT safe.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4498">a sink #GstPad, returns GST_FLOW_ERROR if not.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4499">the #GstBuffer to send, return GST_FLOW_ERROR
- if not.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="chain_list" c:identifier="gst_pad_chain_list">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4560">Chain a bufferlist to @pad.
-
-The function returns #GST_FLOW_FLUSHING if the pad was flushing.
-
-If @pad was not negotiated properly with a CAPS event, this function
-returns #GST_FLOW_NOT_NEGOTIATED.
-
-The function proceeds calling the chainlist function installed on @pad (see
-gst_pad_set_chain_list_function()) and the return value of that function is
-returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
-chainlist function.
-
-In all cases, success or failure, the caller loses its reference to @list
-after calling this function.
-
-MT safe.</doc>
- <source-position filename="gst/gstpad.h" line="1504"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4583">a #GstFlowReturn from the pad.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4562">a sink #GstPad, returns GST_FLOW_ERROR if not.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="list" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4563">the #GstBufferList to send, return GST_FLOW_ERROR
- if not.</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </method>
- <method name="check_reconfigure"
- c:identifier="gst_pad_check_reconfigure">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1654">Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
-if the flag was set.</doc>
- <source-position filename="gst/gstpad.h" line="1351"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1661">%TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1656">the #GstPad to check</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="create_stream_id" c:identifier="gst_pad_create_stream_id">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4123">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.
-
-This function generates an unique stream-id by getting the upstream
-stream-start event stream ID and appending @stream_id to it. If the
-element has no sinkpad it will generate an upstream stream-id by
-doing an URI query on the element and in the worst case just uses
-a random number. Source elements that don't implement the URI
-handler interface should ideally generate a unique, deterministic
-stream-id manually instead.
-
-Since stream IDs are sorted alphabetically, any numbers in the
-stream ID should be printed with a fixed number of characters,
-preceded by 0's, such as by using the format \%03u instead of \%u.</doc>
- <source-position filename="gst/gstutils.h" line="1117"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4147">A stream-id for @pad. g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4125">A source #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4126">Parent #GstElement of @pad</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="stream_id"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4127">The stream-id</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="create_stream_id_printf"
- c:identifier="gst_pad_create_stream_id_printf"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4085">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.
-
-This function generates an unique stream-id by getting the upstream
-stream-start event stream ID and appending @stream_id to it. If the
-element has no sinkpad it will generate an upstream stream-id by
-doing an URI query on the element and in the worst case just uses
-a random number. Source elements that don't implement the URI
-handler interface should ideally generate a unique, deterministic
-stream-id manually instead.</doc>
- <source-position filename="gst/gstutils.h" line="1120"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4106">A stream-id for @pad. g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4087">A source #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4088">Parent #GstElement of @pad</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="stream_id"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4089">The stream-id</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4090">parameters for the @stream_id format string</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="create_stream_id_printf_valist"
- c:identifier="gst_pad_create_stream_id_printf_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4046">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.
-
-This function generates an unique stream-id by getting the upstream
-stream-start event stream ID and appending @stream_id to it. If the
-element has no sinkpad it will generate an upstream stream-id by
-doing an URI query on the element and in the worst case just uses
-a random number. Source elements that don't implement the URI
-handler interface should ideally generate a unique, deterministic
-stream-id manually instead.</doc>
- <source-position filename="gst/gstutils.h" line="1123"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4067">A stream-id for @pad. g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4048">A source #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4049">Parent #GstElement of @pad</doc>
- <type name="Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="stream_id"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4050">The stream-id</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4051">parameters for the @stream_id format string</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="event_default" c:identifier="gst_pad_event_default">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3128">Invokes the default event handler for the given pad.
-
-The EOS event will pause the task associated with @pad before it is forwarded
-to all internally linked pads,
-
-The event is sent to all pads internally linked to @pad. This function
-takes ownership of @event.</doc>
- <source-position filename="gst/gstpad.h" line="1493"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3142">%TRUE if the event was sent successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3130">a #GstPad to call the default event handler on.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3131">the parent of @pad or %NULL</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="event" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3132">the #GstEvent to handle.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </method>
- <method name="forward" c:identifier="gst_pad_forward">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3029">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.
-
-When @forward returns %TRUE, no further pads will be processed.</doc>
- <source-position filename="gst/gstpad.h" line="1566"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3041">%TRUE if one of the dispatcher functions returned %TRUE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3031">a #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="forward"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3032">a #GstPadForwardFunction</doc>
- <type name="PadForwardFunction" c:type="GstPadForwardFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3033">user data passed to @forward</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_allowed_caps" c:identifier="gst_pad_get_allowed_caps">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2786">Gets the capabilities of the allowed media types that can flow through
-@pad and its peer.
-
-The allowed capabilities is calculated as the intersection of the results of
-calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
-on the resulting caps.</doc>
- <source-position filename="gst/gstpad.h" line="1468"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2797">the allowed #GstCaps of the
- pad link. Unref the caps when you no longer need it. This
- function returns %NULL when @pad has no peer.
-
-MT safe.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2788">a #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_current_caps" c:identifier="gst_pad_get_current_caps">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2712">Gets the capabilities currently configured on @pad with the last
-#GST_EVENT_CAPS event.</doc>
- <source-position filename="gst/gstpad.h" line="1460"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2719">the current caps of the pad with
-incremented ref-count or %NULL when pad has no caps. Unref after usage.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2714">a #GstPad to get the current capabilities of.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_direction" c:identifier="gst_pad_get_direction">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="910">Gets the direction of the pad. The direction of the pad is
-decided at construction time so this function does not take
-the LOCK.</doc>
- <source-position filename="gst/gstpad.h" line="1318"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="918">the #GstPadDirection of the pad.
-
-MT safe.</doc>
- <type name="PadDirection" c:type="GstPadDirection"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="912">a #GstPad to get the direction of.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_element_private"
- c:identifier="gst_pad_get_element_private">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6052">Gets the private data of a pad.
-No locking is performed in this function.</doc>
- <source-position filename="gst/gstpad.h" line="1357"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6059">a #gpointer to the private data.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6054">the #GstPad to get the private data of.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_last_flow_return"
- c:identifier="gst_pad_get_last_flow_return"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6482">Gets the #GstFlowReturn return from the last data passed by this pad.</doc>
- <source-position filename="gst/gstpad.h" line="1496"/>
- <return-value transfer-ownership="none">
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6484">the #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_offset" c:identifier="gst_pad_get_offset">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3903">Get the offset applied to the running time of @pad. @pad has to be a source
-pad.</doc>
- <source-position filename="gst/gstpad.h" line="1473"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3910">the offset.</doc>
- <type name="gint64" c:type="gint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3905">a #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_pad_template" c:identifier="gst_pad_get_pad_template">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2664">Gets the template for @pad.</doc>
- <source-position filename="gst/gstpad.h" line="1360"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2670">the #GstPadTemplate from which
- this pad was instantiated, or %NULL if this pad has no
- template. Unref after usage.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2666">a #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_pad_template_caps"
- c:identifier="gst_pad_get_pad_template_caps">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2739">Gets the capabilities for @pad's template.</doc>
- <source-position filename="gst/gstpad.h" line="1455"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2745">the #GstCaps of this pad template.
-Unref after usage.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2741">a #GstPad to get the template capabilities from.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_parent_element"
- c:identifier="gst_pad_get_parent_element">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2631">Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
-its parent is not an element, return %NULL.</doc>
- <source-position filename="gst/gstutils.h" line="1069"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2638">the parent of the pad. The
-caller has a reference on the parent, so unref when you're finished
-with it.
-
-MT safe.</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2633">a pad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_peer" c:identifier="gst_pad_get_peer">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2759">Gets the peer of @pad. This function refs the peer pad so
-you need to unref it after use.</doc>
- <source-position filename="gst/gstpad.h" line="1452"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2766">the peer #GstPad. Unref after usage.
-
-MT safe.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2761">a #GstPad to get the peer of.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_range" c:identifier="gst_pad_get_range">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4981">When @pad is flushing this function returns #GST_FLOW_FLUSHING
-immediately and @buffer is %NULL.
-
-Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
-description of a getrange function. If @pad has no getrange function
-installed (see gst_pad_set_getrange_function()) this function returns
-#GST_FLOW_NOT_SUPPORTED.
-
-If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
-placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
-must be freed with gst_buffer_unref() after usage.
-
-When @buffer points to a variable that points to a valid #GstBuffer, the
-buffer will be filled with the result data when this function returns
-#GST_FLOW_OK. If the provided buffer is larger than @size, only
-@size bytes will be filled in the result buffer and its size will be updated
-accordingly.
-
-Note that less than @size bytes can be returned in @buffer when, for example,
-an EOS condition is near or when @buffer is not large enough to hold @size
-bytes. The caller should check the result buffer size to get the result size.
-
-When this function returns any other result value than #GST_FLOW_OK, @buffer
-will be unchanged.
-
-This is a lowlevel function. Usually gst_pad_pull_range() is used.</doc>
- <source-position filename="gst/gstpad.h" line="1507"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5016">a #GstFlowReturn from the pad.
-
-MT safe.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4983">a src #GstPad, returns #GST_FLOW_ERROR if not.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4984">The start offset of the buffer</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4985">The length of the buffer</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4986">a pointer to hold the #GstBuffer,
- returns #GST_FLOW_ERROR if %NULL.</doc>
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_single_internal_link"
- c:identifier="gst_pad_get_single_internal_link"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2853">If there is a single internal link of the given pad, this function will
-return it. Otherwise, it will return NULL.</doc>
- <source-position filename="gst/gstpad.h" line="1543"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2860">a #GstPad, or %NULL if @pad has none
-or more than one internal links. Unref returned pad with
-gst_object_unref().</doc>
- <type name="Pad" c:type="GstPad*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2855">the #GstPad to get the internal link of.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_sticky_event" c:identifier="gst_pad_get_sticky_event">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6067">Returns a new reference of the sticky event of type @event_type
-from the event.</doc>
- <source-position filename="gst/gstpad.h" line="1366"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6076">a #GstEvent of type
-@event_type or %NULL when no event of @event_type was on
-@pad. Unref after usage.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6069">the #GstPad to get the event from.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="event_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6070">the #GstEventType that should be retrieved.</doc>
- <type name="EventType" c:type="GstEventType"/>
- </parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6071">the index of the event</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_stream"
- c:identifier="gst_pad_get_stream"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4197">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.
-
-This is a convenience wrapper around gst_pad_get_sticky_event() and
-gst_event_parse_stream().</doc>
- <source-position filename="gst/gstutils.h" line="1129"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4207">the current #GstStream for @pad, or %NULL.
- unref the returned stream when no longer needed.</doc>
- <type name="Stream" c:type="GstStream*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4199">A source #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_id"
- c:identifier="gst_pad_get_stream_id"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4156">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.
-
-This is a convenience wrapper around gst_pad_get_sticky_event() and
-gst_event_parse_stream_start().
-
-The returned stream-id string should be treated as an opaque string, its
-contents should not be interpreted.</doc>
- <source-position filename="gst/gstutils.h" line="1126"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4169">a newly-allocated copy of the stream-id for
- @pad, or %NULL. g_free() the returned string when no longer
- needed.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4158">A source #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_task_state"
- c:identifier="gst_pad_get_task_state"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6309">Get @pad task state. If no task is currently
-set, #GST_TASK_STOPPED is returned.</doc>
- <source-position filename="gst/gstpad.h" line="1524"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6316">The current state of @pad's task.</doc>
- <type name="TaskState" c:type="GstTaskState"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6311">the #GstPad to get task state from</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_current_caps" c:identifier="gst_pad_has_current_caps">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2686">Check if @pad has caps set on it with a #GST_EVENT_CAPS event.</doc>
- <source-position filename="gst/gstpad.h" line="1463"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2692">%TRUE when @pad has caps associated with it.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2688">a #GstPad to check</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_active" c:identifier="gst_pad_is_active">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1343">Query if a pad is active</doc>
- <source-position filename="gst/gstpad.h" line="1324"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1349">%TRUE if the pad is active.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1345">the #GstPad to query</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_blocked" c:identifier="gst_pad_is_blocked">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1578">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_is_blocking()).</doc>
- <source-position filename="gst/gstpad.h" line="1339"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1586">%TRUE if the pad is blocked.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1580">the #GstPad to query</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_blocking" c:identifier="gst_pad_is_blocking">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1604">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.</doc>
- <source-position filename="gst/gstpad.h" line="1342"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1611">%TRUE if the pad is blocking.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1606">the #GstPad to query</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_linked" c:identifier="gst_pad_is_linked">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2213">Checks if a @pad is linked to another pad or not.</doc>
- <source-position filename="gst/gstpad.h" line="1449"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2219">%TRUE if the pad is linked, %FALSE otherwise.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2215">pad to check</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="iterate_internal_links"
- c:identifier="gst_pad_iterate_internal_links">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2985">Gets an iterator for the pads to which the given pad is linked to inside
-of the parent element.
-
-Each #GstPad element yielded by the iterator will have its refcount increased,
-so unref after use.
-
-Free-function: gst_iterator_free</doc>
- <source-position filename="gst/gstpad.h" line="1535"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2997">a new #GstIterator of #GstPad
- or %NULL when the pad does not have an iterator function
- configured. Use gst_iterator_free() after usage.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2987">the GstPad to get the internal links of.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="iterate_internal_links_default"
- c:identifier="gst_pad_iterate_internal_links_default">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2919">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.
-
-The caller must free this iterator after use with gst_iterator_free().</doc>
- <source-position filename="gst/gstpad.h" line="1538"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2931">a #GstIterator of #GstPad, or %NULL if @pad
-has no parent. Unref each returned pad with gst_object_unref().</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2921">the #GstPad to get the internal links of.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2922">the parent of @pad or %NULL</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </method>
- <method name="link" c:identifier="gst_pad_link">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2630">Links the source pad and the sink pad.</doc>
- <source-position filename="gst/gstpad.h" line="1440"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2637">A result code indicating if the connection worked or
- what went wrong.
-
-MT Safe.</doc>
- <type name="PadLinkReturn" c:type="GstPadLinkReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="srcpad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2632">the source #GstPad to link.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="sinkpad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2633">the sink #GstPad to link.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="link_full" c:identifier="gst_pad_link_full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2477">Links the source pad and the sink pad.
-
-This variant of #gst_pad_link provides a more granular control on the
-checks being done when linking. While providing some considerable speedups
-the caller of this method must be aware that wrong usage of those flags
-can cause severe issues. Refer to the documentation of #GstPadLinkCheck
-for more information.
-
-MT Safe.</doc>
- <source-position filename="gst/gstpad.h" line="1443"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2493">A result code indicating if the connection worked or
- what went wrong.</doc>
- <type name="PadLinkReturn" c:type="GstPadLinkReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="srcpad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2479">the source #GstPad to link.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="sinkpad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2480">the sink #GstPad to link.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2481">the checks to validate when linking</doc>
- <type name="PadLinkCheck" c:type="GstPadLinkCheck"/>
- </parameter>
- </parameters>
- </method>
- <method name="link_maybe_ghosting"
- c:identifier="gst_pad_link_maybe_ghosting"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1742">Links @src to @sink, creating any #GstGhostPad's in between as necessary.
-
-This is a convenience function to save having to create and add intermediate
-#GstGhostPad's as required for linking across #GstBin boundaries.
-
-If @src or @sink pads don't have parent elements or do not share a common
-ancestor, the link will fail.</doc>
- <source-position filename="gst/gstutils.h" line="1095"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1755">whether the link succeeded.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1744">a #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1745">a #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="link_maybe_ghosting_full"
- c:identifier="gst_pad_link_maybe_ghosting_full"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1710">Links @src to @sink, creating any #GstGhostPad's in between as necessary.
-
-This is a convenience function to save having to create and add intermediate
-#GstGhostPad's as required for linking across #GstBin boundaries.
-
-If @src or @sink pads don't have parent elements or do not share a common
-ancestor, the link will fail.
-
-Calling gst_pad_link_maybe_ghosting_full() with
-@flags == %GST_PAD_LINK_CHECK_DEFAULT is the recommended way of linking
-pads with safety checks applied.</doc>
- <source-position filename="gst/gstutils.h" line="1098"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1728">whether the link succeeded.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1712">a #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1713">a #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1714">some #GstPadLinkCheck flags</doc>
- <type name="PadLinkCheck" c:type="GstPadLinkCheck"/>
- </parameter>
- </parameters>
- </method>
- <method name="mark_reconfigure" c:identifier="gst_pad_mark_reconfigure">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1681">Mark a pad for needing reconfiguration. The next call to
-gst_pad_check_reconfigure() will return %TRUE after this call.</doc>
- <source-position filename="gst/gstpad.h" line="1345"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1683">the #GstPad to mark</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="needs_reconfigure"
- c:identifier="gst_pad_needs_reconfigure">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1630">Check the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
-if the flag was set.</doc>
- <source-position filename="gst/gstpad.h" line="1348"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1637">%TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag is set on @pad.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1632">the #GstPad to check</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pause_task" c:identifier="gst_pad_pause_task">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6263">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.</doc>
- <source-position filename="gst/gstpad.h" line="1518"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6271">a %TRUE if the task could be paused or %FALSE when the pad
-has no task.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6265">the #GstPad to pause the task of</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="peer_query" c:identifier="gst_pad_peer_query">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4217">Performs gst_pad_query() on the peer of @pad.
-
-The caller is responsible for both the allocation and deallocation of
-the query structure.</doc>
- <source-position filename="gst/gstpad.h" line="1551"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4227">%TRUE if the query could be performed. This function returns %FALSE
-if @pad has no peer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4219">a #GstPad to invoke the peer query on.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4220">the #GstQuery to perform.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peer_query_accept_caps"
- c:identifier="gst_pad_peer_query_accept_caps">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3198">Check if the peer of @pad accepts @caps. If @pad has no peer, this function
-returns %TRUE.</doc>
- <source-position filename="gst/gstutils.h" line="1114"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3206">%TRUE if the peer of @pad can accept the caps or @pad has no peer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3200">a #GstPad to check the peer of</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3201">a #GstCaps to check on the pad</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peer_query_caps" c:identifier="gst_pad_peer_query_caps">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3121">Gets the capabilities of the peer connected to this pad. Similar to
-gst_pad_query_caps().
-
-When called on srcpads @filter contains the caps that
-upstream could produce in the order preferred by upstream. When
-called on sinkpads @filter contains the caps accepted by
-downstream in the preferred order. @filter might be %NULL but
-if it is not %NULL the returned caps will be a subset of @filter.</doc>
- <source-position filename="gst/gstutils.h" line="1111"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3135">the caps of the peer pad with incremented
-ref-count. When there is no peer pad, this function returns @filter or,
-when @filter is %NULL, ANY caps.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3123">a #GstPad to get the capabilities of.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="filter"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3124">a #GstCaps filter, or %NULL.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peer_query_convert"
- c:identifier="gst_pad_peer_query_convert">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3036">Queries the peer pad of a given sink pad to convert @src_val in @src_format
-to @dest_format.</doc>
- <source-position filename="gst/gstutils.h" line="1108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3048">%TRUE if the query could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3038">a #GstPad, on whose peer pad to invoke the convert query on.
- Must be a sink pad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="src_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3040">a #GstFormat to convert from.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="src_val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3041">a value to convert.</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="dest_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3042">the #GstFormat to convert to.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="dest_val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3043">a pointer to the result.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peer_query_duration"
- c:identifier="gst_pad_peer_query_duration">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2967">Queries the peer pad of a given sink pad for the total stream duration.</doc>
- <source-position filename="gst/gstutils.h" line="1105"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2977">%TRUE if the query could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2969">a #GstPad on whose peer pad to invoke the duration query on.
- Must be a sink pad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2971">the #GstFormat requested</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="duration"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2972">a location in which to store the total
- duration, or %NULL.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peer_query_position"
- c:identifier="gst_pad_peer_query_position">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2904">Queries the peer of a given sink pad for the stream position.</doc>
- <source-position filename="gst/gstutils.h" line="1102"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2914">%TRUE if the query could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2906">a #GstPad on whose peer to invoke the position query on.
- Must be a sink pad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2908">the #GstFormat requested</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="cur"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2909">a location in which to store the current
- position, or %NULL.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="proxy_query_accept_caps"
- c:identifier="gst_pad_proxy_query_accept_caps">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2759">Checks if all internally linked pads of @pad accepts the caps in @query and
-returns the intersection of the results.
-
-This function is useful as a default accept caps query function for an element
-that can handle any stream format, but requires caps that are acceptable for
-all opposite pads.</doc>
- <source-position filename="gst/gstutils.h" line="1074"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2771">%TRUE if @query could be executed</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2761">a #GstPad to proxy.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2762">an ACCEPT_CAPS #GstQuery.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </method>
- <method name="proxy_query_caps" c:identifier="gst_pad_proxy_query_caps">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2827">Calls gst_pad_query_caps() for all internally linked pads of @pad and returns
-the intersection of the results.
-
-This function is useful as a default caps query function for an element
-that can handle any stream format, but requires all its pads to have
-the same caps. Two such elements are tee and adder.</doc>
- <source-position filename="gst/gstutils.h" line="1077"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2839">%TRUE if @query could be executed</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2829">a #GstPad to proxy.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2830">a CAPS #GstQuery.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </method>
- <method name="pull_range" c:identifier="gst_pad_pull_range">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5033">Pulls a @buffer from the peer pad or fills up a provided buffer.
-
-This function will first trigger the pad block signal if it was
-installed.
-
-When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
-function returns the result of gst_pad_get_range() on the peer pad.
-See gst_pad_get_range() for a list of return values and for the
-semantics of the arguments of this function.
-
-If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
-placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
-must be freed with gst_buffer_unref() after usage. When this function
-returns any other result value, @buffer will still point to %NULL.
-
-When @buffer points to a variable that points to a valid #GstBuffer, the
-buffer will be filled with the result data when this function returns
-#GST_FLOW_OK. When this function returns any other result value,
-@buffer will be unchanged. If the provided buffer is larger than @size, only
-@size bytes will be filled in the result buffer and its size will be updated
-accordingly.
-
-Note that less than @size bytes can be returned in @buffer when, for example,
-an EOS condition is near or when @buffer is not large enough to hold @size
-bytes. The caller should check the result buffer size to get the result size.</doc>
- <source-position filename="gst/gstpad.h" line="1487"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5067">a #GstFlowReturn from the peer pad.
-
-MT safe.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5035">a sink #GstPad, returns GST_FLOW_ERROR if not.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5036">The start offset of the buffer</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5037">The length of the buffer</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5038">a pointer to hold the #GstBuffer, returns
- GST_FLOW_ERROR if %NULL.</doc>
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </method>
- <method name="push" c:identifier="gst_pad_push">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4742">Pushes a buffer to the peer of @pad.
-
-This function will call installed block probes before triggering any
-installed data probes.
-
-The function proceeds calling gst_pad_chain() on the peer pad and returns
-the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
-be returned.
-
-In all cases, success or failure, the caller loses its reference to @buffer
-after calling this function.</doc>
- <source-position filename="gst/gstpad.h" line="1481"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4760">a #GstFlowReturn from the peer pad.
-
-MT safe.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4744">a source #GstPad, returns #GST_FLOW_ERROR if not.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4745">the #GstBuffer to push returns GST_FLOW_ERROR
- if not.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="push_event" c:identifier="gst_pad_push_event">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5559">Sends the event to the peer of the given pad. This function is
-mainly used by elements to send events to their peer
-elements.
-
-This function takes ownership of the provided event so you should
-gst_event_ref() it if you want to reuse the event after this call.</doc>
- <source-position filename="gst/gstpad.h" line="1490"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5571">%TRUE if the event was handled.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5561">a #GstPad to push the event to.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5562">the #GstEvent to send to the pad.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </method>
- <method name="push_list" c:identifier="gst_pad_push_list">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4780">Pushes a buffer list to the peer of @pad.
-
-This function will call installed block probes before triggering any
-installed data probes.
-
-The function proceeds calling the chain function on the peer pad and returns
-the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
-be returned. If the peer pad does not have any installed chainlist function
-every group buffer of the list will be merged into a normal #GstBuffer and
-chained via gst_pad_chain().
-
-In all cases, success or failure, the caller loses its reference to @list
-after calling this function.</doc>
- <source-position filename="gst/gstpad.h" line="1484"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4800">a #GstFlowReturn from the peer pad.
-
-MT safe.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4782">a source #GstPad, returns #GST_FLOW_ERROR if not.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="list" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4783">the #GstBufferList to push returns GST_FLOW_ERROR
- if not.</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </method>
- <method name="query" c:identifier="gst_pad_query">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4084">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.
-
-Again, the caller is responsible for both the allocation and deallocation of
-the query structure.
-
-Please also note that some queries might need a running pipeline to work.</doc>
- <source-position filename="gst/gstpad.h" line="1548"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4100">%TRUE if the query could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4086">a #GstPad to invoke the default query on.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="4087">the #GstQuery to perform.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </method>
- <method name="query_accept_caps"
- c:identifier="gst_pad_query_accept_caps">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3167">Check if the given pad accepts the caps.</doc>
- <source-position filename="gst/gstutils.h" line="1092"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3174">%TRUE if the pad can accept the caps.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3169">a #GstPad to check</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3170">a #GstCaps to check on the pad</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="query_caps" c:identifier="gst_pad_query_caps">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3070">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_new_caps() - use gst_pad_get_current_caps() 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.
-
-When called on sinkpads @filter contains the caps that
-upstream could produce in the order preferred by upstream. When
-called on srcpads @filter contains the caps accepted by
-downstream in the preferred order. @filter might be %NULL but
-if it is not %NULL the returned caps will be a subset of @filter.
-
-Note that this function does not return writable #GstCaps, use
-gst_caps_make_writable() before modifying the caps.</doc>
- <source-position filename="gst/gstutils.h" line="1089"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3091">the caps of the pad with incremented ref-count.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3072">a #GstPad to get the capabilities of.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="filter"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3073">suggested #GstCaps, or %NULL</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="query_convert" c:identifier="gst_pad_query_convert">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3000">Queries a pad to convert @src_val in @src_format to @dest_format.</doc>
- <source-position filename="gst/gstutils.h" line="1086"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3010">%TRUE if the query could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3002">a #GstPad to invoke the convert query on.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="src_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3003">a #GstFormat to convert from.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="src_val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3004">a value to convert.</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="dest_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3005">the #GstFormat to convert to.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="dest_val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3006">a pointer to the result.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="query_default" c:identifier="gst_pad_query_default">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3456">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.</doc>
- <source-position filename="gst/gstpad.h" line="1558"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3468">%TRUE if the query was performed successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3458">a #GstPad to call the default query handler on.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3459">the parent of @pad or %NULL</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3460">the #GstQuery to handle.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </method>
- <method name="query_duration" c:identifier="gst_pad_query_duration">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2936">Queries a pad for the total stream duration.</doc>
- <source-position filename="gst/gstutils.h" line="1083"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2945">%TRUE if the query could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2938">a #GstPad to invoke the duration query on.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2939">the #GstFormat requested</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="duration"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2940">a location in which to store the total
- duration, or %NULL.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="query_position" c:identifier="gst_pad_query_position">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2874">Queries a pad for the stream position.</doc>
- <source-position filename="gst/gstutils.h" line="1080"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2882">%TRUE if the query could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2876">a #GstPad to invoke the position query on.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2877">the #GstFormat requested</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="cur"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2878">A location in which to store the current position, or %NULL.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_probe" c:identifier="gst_pad_remove_probe">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1541">Remove the probe with @id from @pad.
-
-MT safe.</doc>
- <source-position filename="gst/gstpad.h" line="1336"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1543">the #GstPad with the probe</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1544">the probe id to remove</doc>
- <type name="gulong" c:type="gulong"/>
- </parameter>
- </parameters>
- </method>
- <method name="send_event" c:identifier="gst_pad_send_event">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5966">Sends the event to the pad. This function can be used
-by applications to send events in the pipeline.
-
-If @pad is a source pad, @event should be an upstream event. If @pad is a
-sink pad, @event should be a downstream event. For example, you would not
-send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
-Furthermore, some downstream events have to be serialized with data flow,
-like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
-the event needs to be serialized with data flow, this function will take the
-pad's stream lock while calling its event function.
-
-To find out whether an event type is upstream, downstream, or downstream and
-serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
-#GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
-#GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
-plugin doesn't need to bother itself with this information; the core handles
-all necessary locks and checks.
-
-This function takes ownership of the provided event so you should
-gst_event_ref() it if you want to reuse the event after this call.</doc>
- <source-position filename="gst/gstpad.h" line="1510"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5992">%TRUE if the event was handled.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5968">a #GstPad to send the event to.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5969">the #GstEvent to send to the pad.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_activate_function_full"
- c:identifier="gst_pad_set_activate_function_full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1706">Sets the given activate function for @pad. The activate function will
-dispatch to gst_pad_activate_mode() to perform the actual activation.
-Only makes sense to set on sink pads.
-
-Call this function if your sink pad can start a pull-based task.</doc>
- <source-position filename="gst/gstpad.h" line="1375"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1708">a #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="activate"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1709">the #GstPadActivateFunction to set.</doc>
- <type name="PadActivateFunction" c:type="GstPadActivateFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1710">user_data passed to @notify</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1711">notify called when @activate will not be used anymore.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_activatemode_function_full"
- c:identifier="gst_pad_set_activatemode_function_full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1743">Sets the given activate_mode function for the pad. An activate_mode function
-prepares the element for data passing.</doc>
- <source-position filename="gst/gstpad.h" line="1380"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1745">a #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="activatemode"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1746">the #GstPadActivateModeFunction to set.</doc>
- <type name="PadActivateModeFunction"
- c:type="GstPadActivateModeFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1747">user_data passed to @notify</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1748">notify called when @activatemode will not be used anymore.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_active" c:identifier="gst_pad_set_active">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1064">Activates or deactivates the given pad.
-Normally called from within core state change functions.
-
-If @active, makes sure the pad is active. If it is already active, either in
-push or pull mode, just return. Otherwise dispatches to the pad's activate
-function to perform the actual activation.
-
-If not @active, calls gst_pad_activate_mode() with the pad's current mode
-and a %FALSE argument.</doc>
- <source-position filename="gst/gstpad.h" line="1321"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1079">%TRUE if the operation was successful.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1066">the #GstPad to activate or deactivate.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1067">whether or not the pad should be active.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_chain_function_full"
- c:identifier="gst_pad_set_chain_function_full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1778">Sets the given chain function for the pad. The chain function is called to
-process a #GstBuffer input buffer. see #GstPadChainFunction for more details.</doc>
- <source-position filename="gst/gstpad.h" line="1387"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1780">a sink #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="chain"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1781">the #GstPadChainFunction to set.</doc>
- <type name="PadChainFunction" c:type="GstPadChainFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1782">user_data passed to @notify</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1783">notify called when @chain will not be used anymore.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_chain_list_function_full"
- c:identifier="gst_pad_set_chain_list_function_full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1813">Sets the given chain list function for the pad. The chainlist function is
-called to process a #GstBufferList input buffer list. See
-#GstPadChainListFunction for more details.</doc>
- <source-position filename="gst/gstpad.h" line="1392"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1815">a sink #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="chainlist"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1816">the #GstPadChainListFunction to set.</doc>
- <type name="PadChainListFunction"
- c:type="GstPadChainListFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1817">user_data passed to @notify</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1818">notify called when @chainlist will not be used anymore.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_element_private"
- c:identifier="gst_pad_set_element_private">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6037">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.</doc>
- <source-position filename="gst/gstpad.h" line="1354"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6039">the #GstPad to set the private data of.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="priv"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6040">The private data to attach to the pad.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_event_full_function_full"
- c:identifier="gst_pad_set_event_full_function_full"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1930">Sets the given event handler for the pad.</doc>
- <source-position filename="gst/gstpad.h" line="1407"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1932">a #GstPad of either direction.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="event"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1933">the #GstPadEventFullFunction to set.</doc>
- <type name="PadEventFullFunction"
- c:type="GstPadEventFullFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1934">user_data passed to @notify</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1935">notify called when @event will not be used anymore.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_event_function_full"
- c:identifier="gst_pad_set_event_function_full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1886">Sets the given event handler for the pad.</doc>
- <source-position filename="gst/gstpad.h" line="1402"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1888">a #GstPad of either direction.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="event"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1889">the #GstPadEventFunction to set.</doc>
- <type name="PadEventFunction" c:type="GstPadEventFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1890">user_data passed to @notify</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1891">notify called when @event will not be used anymore.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_getrange_function_full"
- c:identifier="gst_pad_set_getrange_function_full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1850">Sets the given getrange function for the pad. The getrange function is
-called to produce a new #GstBuffer to start the processing pipeline. see
-#GstPadGetRangeFunction for a description of the getrange function.</doc>
- <source-position filename="gst/gstpad.h" line="1397"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1852">a source #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="get"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1853">the #GstPadGetRangeFunction to set.</doc>
- <type name="PadGetRangeFunction" c:type="GstPadGetRangeFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1854">user_data passed to @notify</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1855">notify called when @get will not be used anymore.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_iterate_internal_links_function_full"
- c:identifier="gst_pad_set_iterate_internal_links_function_full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1999">Sets the given internal link iterator function for the pad.</doc>
- <source-position filename="gst/gstpad.h" line="1529"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2001">a #GstPad of either direction.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="iterintlink"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2002">the #GstPadIterIntLinkFunction to set.</doc>
- <type name="PadIterIntLinkFunction"
- c:type="GstPadIterIntLinkFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2003">user_data passed to @notify</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2004">notify called when @iterintlink will not be used anymore.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_link_function_full"
- c:identifier="gst_pad_set_link_function_full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2033">Sets the given link function for the pad. It will be called when
-the pad is linked with another pad.
-
-The return value #GST_PAD_LINK_OK should be used when the connection can be
-made.
-
-The return value #GST_PAD_LINK_REFUSED should be used when the connection
-cannot be made for some reason.
-
-If @link is installed on a source pad, it should call the #GstPadLinkFunction
-of the peer sink pad, if present.</doc>
- <source-position filename="gst/gstpad.h" line="1423"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2035">a #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="link"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2036">the #GstPadLinkFunction to set.</doc>
- <type name="PadLinkFunction" c:type="GstPadLinkFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2037">user_data passed to @notify</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2038">notify called when @link will not be used anymore.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_offset" c:identifier="gst_pad_set_offset">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3933">Set the offset that will be applied to the running time of @pad.</doc>
- <source-position filename="gst/gstpad.h" line="1476"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3935">a #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="3936">the offset</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_query_function_full"
- c:identifier="gst_pad_set_query_function_full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1966">Set the given query function for the pad.</doc>
- <source-position filename="gst/gstpad.h" line="1554"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1968">a #GstPad of either direction.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="query"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1969">the #GstPadQueryFunction to set.</doc>
- <type name="PadQueryFunction" c:type="GstPadQueryFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1970">user_data passed to @notify</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1971">notify called when @query will not be used anymore.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_unlink_function_full"
- c:identifier="gst_pad_set_unlink_function_full">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2076">Sets the given unlink function for the pad. It will be called
-when the pad is unlinked.
-
-Note that the pad's lock is already held when the unlink
-function is called, so most pad functions cannot be called
-from within the callback.</doc>
- <source-position filename="gst/gstpad.h" line="1428"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2078">a #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="unlink"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2079">the #GstPadUnlinkFunction to set.</doc>
- <type name="PadUnlinkFunction" c:type="GstPadUnlinkFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2080">user_data passed to @notify</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2081">notify called when @unlink will not be used anymore.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="start_task" c:identifier="gst_pad_start_task">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6202">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.</doc>
- <source-position filename="gst/gstpad.h" line="1515"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6214">a %TRUE if the task could be started.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6204">the #GstPad to start the task of</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6205">the task function to call</doc>
- <type name="TaskFunction" c:type="GstTaskFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6206">user data passed to the task function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6207">called when @user_data is no longer referenced</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="sticky_events_foreach"
- c:identifier="gst_pad_sticky_events_foreach">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6121">Iterates all sticky events on @pad and calls @foreach_func for every
-event. If @foreach_func returns %FALSE the iteration is immediately stopped.</doc>
- <source-position filename="gst/gstpad.h" line="1370"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6123">the #GstPad that should be used for iteration.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="foreach_func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6124">the #GstPadStickyEventsForeachFunction that
- should be called for every event.</doc>
- <type name="PadStickyEventsForeachFunction"
- c:type="GstPadStickyEventsForeachFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6126">the optional user data.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="stop_task" c:identifier="gst_pad_stop_task">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6345">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.
-
-This function will deadlock if called from the GstTaskFunction of
-the task. Use gst_task_pause() instead.
-
-Regardless of whether the pad has a task, the stream lock is acquired and
-released so as to ensure that streaming through this pad has finished.</doc>
- <source-position filename="gst/gstpad.h" line="1521"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6359">a %TRUE if the task could be stopped or %FALSE on error.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6347">the #GstPad to stop the task of</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="store_sticky_event"
- c:identifier="gst_pad_store_sticky_event"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5336">Store the sticky @event on @pad</doc>
- <source-position filename="gst/gstpad.h" line="1363"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5343">#GST_FLOW_OK on success, #GST_FLOW_FLUSHING when the pad
-was flushing or #GST_FLOW_EOS when the pad was EOS.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5338">a #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="5339">a #GstEvent</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </method>
- <method name="unlink" c:identifier="gst_pad_unlink">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2106">Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
-signal on both pads.</doc>
- <source-position filename="gst/gstpad.h" line="1446"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2114">%TRUE if the pads were unlinked. This function returns %FALSE if
-the pads were not linked together.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="srcpad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2108">the source #GstPad to unlink.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- <parameter name="sinkpad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2109">the sink #GstPad to unlink.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="use_fixed_caps" c:identifier="gst_pad_use_fixed_caps">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2613">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.
-
-The negotiated caps are the caps of the last CAPS event that passed on the
-pad. Use this function on a pad that, once it negotiated to a CAPS, cannot
-be renegotiated to something else.</doc>
- <source-position filename="gst/gstutils.h" line="1066"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="2615">the pad to use</doc>
- <type name="Pad" c:type="GstPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <property name="caps" transfer-ownership="none">
- <type name="Caps"/>
- </property>
- <property name="direction"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="PadDirection"/>
- </property>
- <property name="offset"
- version="1.6"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="376">The offset that will be applied to the running time of the pad.</doc>
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="template" writable="1" transfer-ownership="none">
- <type name="PadTemplate"/>
- </property>
- <field name="object">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="element_private">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="723">private data owned by the parent element</doc>
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="padtemplate">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="724">padtemplate for this pad</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </field>
- <field name="direction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="725">the direction of the pad, cannot change after creating
- the pad.</doc>
- <type name="PadDirection" c:type="GstPadDirection"/>
- </field>
- <field name="stream_rec_lock" readable="0" private="1">
- <type name="GLib.RecMutex" c:type="GRecMutex"/>
- </field>
- <field name="task" readable="0" private="1">
- <type name="Task" c:type="GstTask*"/>
- </field>
- <field name="block_cond" readable="0" private="1">
- <type name="GLib.Cond" c:type="GCond"/>
- </field>
- <field name="probes" readable="0" private="1">
- <type name="GLib.HookList" c:type="GHookList"/>
- </field>
- <field name="mode" readable="0" private="1">
- <type name="PadMode" c:type="GstPadMode"/>
- </field>
- <field name="activatefunc" readable="0" private="1">
- <type name="PadActivateFunction" c:type="GstPadActivateFunction"/>
- </field>
- <field name="activatedata" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="activatenotify" readable="0" private="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="activatemodefunc" readable="0" private="1">
- <type name="PadActivateModeFunction"
- c:type="GstPadActivateModeFunction"/>
- </field>
- <field name="activatemodedata" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="activatemodenotify" readable="0" private="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="peer" readable="0" private="1">
- <type name="Pad" c:type="GstPad*"/>
- </field>
- <field name="linkfunc" readable="0" private="1">
- <type name="PadLinkFunction" c:type="GstPadLinkFunction"/>
- </field>
- <field name="linkdata" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="linknotify" readable="0" private="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="unlinkfunc" readable="0" private="1">
- <type name="PadUnlinkFunction" c:type="GstPadUnlinkFunction"/>
- </field>
- <field name="unlinkdata" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="unlinknotify" readable="0" private="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="chainfunc" readable="0" private="1">
- <type name="PadChainFunction" c:type="GstPadChainFunction"/>
- </field>
- <field name="chaindata" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="chainnotify" readable="0" private="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="chainlistfunc" readable="0" private="1">
- <type name="PadChainListFunction" c:type="GstPadChainListFunction"/>
- </field>
- <field name="chainlistdata" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="chainlistnotify" readable="0" private="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="getrangefunc" readable="0" private="1">
- <type name="PadGetRangeFunction" c:type="GstPadGetRangeFunction"/>
- </field>
- <field name="getrangedata" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="getrangenotify" readable="0" private="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="eventfunc" readable="0" private="1">
- <type name="PadEventFunction" c:type="GstPadEventFunction"/>
- </field>
- <field name="eventdata" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="eventnotify" readable="0" private="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="offset" readable="0" private="1">
- <type name="gint64" c:type="gint64"/>
- </field>
- <field name="queryfunc" readable="0" private="1">
- <type name="PadQueryFunction" c:type="GstPadQueryFunction"/>
- </field>
- <field name="querydata" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="querynotify" readable="0" private="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="iterintlinkfunc" readable="0" private="1">
- <type name="PadIterIntLinkFunction"
- c:type="GstPadIterIntLinkFunction"/>
- </field>
- <field name="iterintlinkdata" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="iterintlinknotify" readable="0" private="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="num_probes" readable="0" private="1">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="num_blocked" readable="0" private="1">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="PadPrivate" c:type="GstPadPrivate*"/>
- </field>
- <union name="ABI" c:type="ABI">
- <source-position filename="gst/gstpad.h" line="805"/>
- <field name="_gst_reserved" writable="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <record name="abi" c:type="abi">
- <source-position filename="gst/gstpad.h" line="804"/>
- <field name="last_flowret" writable="1">
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </field>
- <field name="eventfullfunc" writable="1">
- <type name="PadEventFullFunction"
- c:type="GstPadEventFullFunction"/>
- </field>
- </record>
- </union>
- <glib:signal name="linked" when="last">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="337">Signals that a pad has been linked to the peer pad.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="peer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="340">the peer pad that has been connected</doc>
- <type name="Pad"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="unlinked" when="last">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="348">Signals that a pad has been unlinked from the peer pad.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="peer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="351">the peer pad that has been disconnected</doc>
- <type name="Pad"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <callback name="PadActivateFunction" c:type="GstPadActivateFunction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="235">This function is called when the pad is activated during the element
-READY to PAUSED state change. By default this function will call the
-activate function that puts the pad in push mode but elements can
-override this function to activate the pad in pull mode if they wish.</doc>
- <source-position filename="gst/gstpad.h" line="247"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="245">%TRUE if the pad could be activated.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="237">a #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="238">the parent of @pad</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="PadActivateModeFunction"
- c:type="GstPadActivateModeFunction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="248">The prototype of the push and pull activate functions.</doc>
- <source-position filename="gst/gstpad.h" line="259"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="257">%TRUE if the pad could be activated or deactivated.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="250">a #GstPad</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="251">the parent of @pad</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="252">the requested activation mode of @pad</doc>
- <type name="PadMode" c:type="GstPadMode"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="253">activate or deactivate the pad.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="PadChainFunction" c:type="GstPadChainFunction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="264">A function that will be called on sinkpads when chaining buffers.
-The function typically processes the data contained in the buffer and
-either consumes the data or passes it on to the internally linked pad(s).
-
-The implementer of this function receives a refcount to @buffer and should
-gst_buffer_unref() when the buffer is no longer needed.
-
-When a chain function detects an error in the data stream, it must post an
-error on the bus and return an appropriate #GstFlowReturn value.</doc>
- <source-position filename="gst/gstpad.h" line="284"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="282">#GST_FLOW_OK for success</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="266">the sink #GstPad that performed the chain.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="267">the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
- flag is set, @parent is guaranteed to be not-%NULL and remain valid
- during the execution of this function.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="270">the #GstBuffer that is chained, not %NULL.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="PadChainListFunction" c:type="GstPadChainListFunction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="287">A function that will be called on sinkpads when chaining buffer lists.
-The function typically processes the data contained in the buffer list and
-either consumes the data or passes it on to the internally linked pad(s).
-
-The implementer of this function receives a refcount to @list and
-should gst_buffer_list_unref() when the list is no longer needed.
-
-When a chainlist function detects an error in the data stream, it must
-post an error on the bus and return an appropriate #GstFlowReturn value.</doc>
- <source-position filename="gst/gstpad.h" line="307"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="305">#GST_FLOW_OK for success</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="289">the sink #GstPad that performed the chain.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="290">the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
- flag is set, @parent is guaranteed to be not-%NULL and remain valid
- during the execution of this function.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="list" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="293">the #GstBufferList that is chained, not %NULL.</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="PadClass"
- c:type="GstPadClass"
- glib:is-gtype-struct-for="Pad">
- <source-position filename="gst/gstpad.h" line="817"/>
- <field name="parent_class">
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="linked">
- <callback name="linked">
- <source-position filename="gst/gstpad.h" line="812"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="peer" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="unlinked">
- <callback name="unlinked">
- <source-position filename="gst/gstpad.h" line="813"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="peer" transfer-ownership="none">
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <enumeration name="PadDirection"
- glib:type-name="GstPadDirection"
- glib:get-type="gst_pad_direction_get_type"
- c:type="GstPadDirection">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="34">The direction of a pad.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_PAD_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="36">direction is unknown.</doc>
- </member>
- <member name="src" value="1" c:identifier="GST_PAD_SRC" glib:nick="src">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="37">the pad is a source pad.</doc>
- </member>
- <member name="sink"
- value="2"
- c:identifier="GST_PAD_SINK"
- glib:nick="sink">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="38">the pad is a sink pad.</doc>
- </member>
- </enumeration>
- <callback name="PadEventFullFunction"
- c:type="GstPadEventFullFunction"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="376">Function signature to handle an event for the pad.
-
-This variant is for specific elements that will take into account the
-last downstream flow return (from a pad push), in which case they can
-return it.</doc>
- <source-position filename="gst/gstpad.h" line="395"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="390">%GST_FLOW_OK if the event was handled properly, or any other
-#GstFlowReturn dependent on downstream state.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="378">the #GstPad to handle the event.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="379">the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
- flag is set, @parent is guaranteed to be not-%NULL and remain valid
- during the execution of this function.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="event" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="382">the #GstEvent to handle.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="PadEventFunction" c:type="GstPadEventFunction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="361">Function signature to handle an event for the pad.</doc>
- <source-position filename="gst/gstpad.h" line="373"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="371">%TRUE if the pad could handle the event.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="363">the #GstPad to handle the event.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="364">the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
- flag is set, @parent is guaranteed to be not-%NULL and remain valid
- during the execution of this function.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="event" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="367">the #GstEvent to handle.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- <bitfield name="PadFlags"
- glib:type-name="GstPadFlags"
- glib:get-type="gst_pad_flags_get_type"
- c:type="GstPadFlags">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="667">Pad state flags</doc>
- <member name="blocked"
- value="16"
- c:identifier="GST_PAD_FLAG_BLOCKED"
- glib:nick="blocked">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="669">is dataflow on a pad blocked</doc>
- </member>
- <member name="flushing"
- value="32"
- c:identifier="GST_PAD_FLAG_FLUSHING"
- glib:nick="flushing">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="670">is pad flushing</doc>
- </member>
- <member name="eos"
- value="64"
- c:identifier="GST_PAD_FLAG_EOS"
- glib:nick="eos">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="671">is pad in EOS state</doc>
- </member>
- <member name="blocking"
- value="128"
- c:identifier="GST_PAD_FLAG_BLOCKING"
- glib:nick="blocking">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="672">is pad currently blocking on a buffer or event</doc>
- </member>
- <member name="need_parent"
- value="256"
- c:identifier="GST_PAD_FLAG_NEED_PARENT"
- glib:nick="need-parent">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="673">ensure that there is a parent object before calling
- into the pad callbacks.</doc>
- </member>
- <member name="need_reconfigure"
- value="512"
- c:identifier="GST_PAD_FLAG_NEED_RECONFIGURE"
- glib:nick="need-reconfigure">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="675">the pad should be reconfigured/renegotiated.
- The flag has to be unset manually after
- reconfiguration happened.</doc>
- </member>
- <member name="pending_events"
- value="1024"
- c:identifier="GST_PAD_FLAG_PENDING_EVENTS"
- glib:nick="pending-events">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="678">the pad has pending events</doc>
- </member>
- <member name="fixed_caps"
- value="2048"
- c:identifier="GST_PAD_FLAG_FIXED_CAPS"
- glib:nick="fixed-caps">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="679">the pad is using fixed caps. This means that
- once the caps are set on the pad, the default caps query function
- will only return those caps.</doc>
- </member>
- <member name="proxy_caps"
- value="4096"
- c:identifier="GST_PAD_FLAG_PROXY_CAPS"
- glib:nick="proxy-caps">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="682">the default event and query handler will forward
- all events and queries to the internally linked pads
- instead of discarding them.</doc>
- </member>
- <member name="proxy_allocation"
- value="8192"
- c:identifier="GST_PAD_FLAG_PROXY_ALLOCATION"
- glib:nick="proxy-allocation">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="685">the default query handler will forward
- allocation queries to the internally linked pads
- instead of discarding them.</doc>
- </member>
- <member name="proxy_scheduling"
- value="16384"
- c:identifier="GST_PAD_FLAG_PROXY_SCHEDULING"
- glib:nick="proxy-scheduling">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="688">the default query handler will forward
- scheduling queries to the internally linked pads
- instead of discarding them.</doc>
- </member>
- <member name="accept_intersect"
- value="32768"
- c:identifier="GST_PAD_FLAG_ACCEPT_INTERSECT"
- glib:nick="accept-intersect">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="691">the default accept-caps handler will check
- it the caps intersect the query-caps result instead
- of checking for a subset. This is interesting for
- parsers that can accept incompletely specified caps.</doc>
- </member>
- <member name="accept_template"
- value="65536"
- c:identifier="GST_PAD_FLAG_ACCEPT_TEMPLATE"
- glib:nick="accept-template">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="695">the default accept-caps handler will use
- the template pad caps instead of query caps to
- compare with the accept caps. Use this in combination
- with %GST_PAD_FLAG_ACCEPT_INTERSECT. (Since: 1.6)</doc>
- </member>
- <member name="last"
- value="1048576"
- c:identifier="GST_PAD_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="699">offset to define more flags</doc>
- </member>
- </bitfield>
- <callback name="PadForwardFunction" c:type="GstPadForwardFunction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="463">A forward function is called for all internally linked pads, see
-gst_pad_forward().</doc>
- <source-position filename="gst/gstpad.h" line="473"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="471">%TRUE if the dispatching procedure has to be stopped.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="465">the #GstPad that is forwarded.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="466">the gpointer to optional user data.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="PadGetRangeFunction" c:type="GstPadGetRangeFunction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="310">This function will be called on source pads when a peer element
-request a buffer at the specified @offset and @length. If this function
-returns #GST_FLOW_OK, the result buffer will be stored in @buffer. The
-contents of @buffer is invalid for any other return value.
-
-This function is installed on a source pad with
-gst_pad_set_getrange_function() and can only be called on source pads after
-they are successfully activated with gst_pad_activate_mode() with the
-#GST_PAD_MODE_PULL.
-
-@offset and @length are always given in byte units. @offset must normally be a value
-between 0 and the length in bytes of the data available on @pad. The
-length (duration in bytes) can be retrieved with a #GST_QUERY_DURATION or with a
-#GST_QUERY_SEEKING.
-
-Any @offset larger or equal than the length will make the function return
-#GST_FLOW_EOS, which corresponds to EOS. In this case @buffer does not
-contain a valid buffer.
-
-The buffer size of @buffer will only be smaller than @length when @offset is
-near the end of the stream. In all other cases, the size of @buffer must be
-exactly the requested size.
-
-It is allowed to call this function with a 0 @length and valid @offset, in
-which case @buffer will contain a 0-sized buffer and the function returns
-#GST_FLOW_OK.
-
-When this function is called with a -1 @offset, the sequentially next buffer
-of length @length in the stream is returned.
-
-When this function is called with a -1 @length, a buffer with a default
-optimal length is returned in @buffer. The length might depend on the value
-of @offset.</doc>
- <source-position filename="gst/gstpad.h" line="357"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="354">#GST_FLOW_OK for success and a valid buffer in @buffer. Any other
-return value leaves @buffer undefined.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="312">the src #GstPad to perform the getrange on.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="313">the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
- flag is set, @parent is guaranteed to be not-%NULL and remain valid
- during the execution of this function.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="316">the offset of the range</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="317">the length of the range</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="318">a memory location to hold the result buffer, cannot be %NULL.</doc>
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="PadIterIntLinkFunction" c:type="GstPadIterIntLinkFunction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="400">The signature of the internal pad link iterator function.</doc>
- <source-position filename="gst/gstpad.h" line="414"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="409">a new #GstIterator that will iterate over all pads that are
-linked to the given pad on the inside of the parent element.
-
-the caller must call gst_iterator_free() after usage.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="402">The #GstPad to query.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="403">the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
- flag is set, @parent is guaranteed to be not-%NULL and remain valid
- during the execution of this function.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </callback>
- <bitfield name="PadLinkCheck"
- glib:type-name="GstPadLinkCheck"
- glib:get-type="gst_pad_link_check_get_type"
- c:type="GstPadLinkCheck">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="194">The amount of checking to be done when linking pads. @GST_PAD_LINK_CHECK_CAPS
-and @GST_PAD_LINK_CHECK_TEMPLATE_CAPS are mutually exclusive. If both are
-specified, expensive but safe @GST_PAD_LINK_CHECK_CAPS are performed.
-
-&gt; Only disable some of the checks if you are 100% certain you know the link
-&gt; will not fail because of hierarchy/caps compatibility failures. If uncertain,
-&gt; use the default checks (%GST_PAD_LINK_CHECK_DEFAULT) or the regular methods
-&gt; for linking the pads.</doc>
- <member name="nothing"
- value="0"
- c:identifier="GST_PAD_LINK_CHECK_NOTHING"
- glib:nick="nothing">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="196">Don't check hierarchy or caps compatibility.</doc>
- </member>
- <member name="hierarchy"
- value="1"
- c:identifier="GST_PAD_LINK_CHECK_HIERARCHY"
- glib:nick="hierarchy">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="197">Check the pads have same parents/grandparents.
- Could be omitted if it is already known that the two elements that own the
- pads are in the same bin.</doc>
- </member>
- <member name="template_caps"
- value="2"
- c:identifier="GST_PAD_LINK_CHECK_TEMPLATE_CAPS"
- glib:nick="template-caps">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="200">Check if the pads are compatible by using
- their template caps. This is much faster than @GST_PAD_LINK_CHECK_CAPS, but
- would be unsafe e.g. if one pad has %GST_CAPS_ANY.</doc>
- </member>
- <member name="caps"
- value="4"
- c:identifier="GST_PAD_LINK_CHECK_CAPS"
- glib:nick="caps">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="203">Check if the pads are compatible by comparing the
- caps returned by gst_pad_query_caps().</doc>
- </member>
- <member name="no_reconfigure"
- value="8"
- c:identifier="GST_PAD_LINK_CHECK_NO_RECONFIGURE"
- glib:nick="no-reconfigure">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="205">Disables pushing a reconfigure event when pads are
- linked.</doc>
- </member>
- <member name="default"
- value="5"
- c:identifier="GST_PAD_LINK_CHECK_DEFAULT"
- glib:nick="default">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="207">The default checks done when linking
- pads (i.e. the ones used by gst_pad_link()).</doc>
- </member>
- </bitfield>
- <callback name="PadLinkFunction" c:type="GstPadLinkFunction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="434">Function signature to handle a new link on the pad.</doc>
- <source-position filename="gst/gstpad.h" line="446"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="444">the result of the link with the specified peer.</doc>
- <type name="PadLinkReturn" c:type="GstPadLinkReturn"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="436">the #GstPad that is linked.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="437">the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
- flag is set, @parent is guaranteed to be not-%NULL and remain valid
- during the execution of this function.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="peer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="440">the peer #GstPad of the link</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </callback>
- <enumeration name="PadLinkReturn"
- glib:type-name="GstPadLinkReturn"
- glib:get-type="gst_pad_link_return_get_type"
- c:type="GstPadLinkReturn">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="92">Result values from gst_pad_link and friends.</doc>
- <member name="ok"
- value="0"
- c:identifier="GST_PAD_LINK_OK"
- glib:nick="ok">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="94">link succeeded</doc>
- </member>
- <member name="wrong_hierarchy"
- value="-1"
- c:identifier="GST_PAD_LINK_WRONG_HIERARCHY"
- glib:nick="wrong-hierarchy">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="95">pads have no common grandparent</doc>
- </member>
- <member name="was_linked"
- value="-2"
- c:identifier="GST_PAD_LINK_WAS_LINKED"
- glib:nick="was-linked">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="96">pad was already linked</doc>
- </member>
- <member name="wrong_direction"
- value="-3"
- c:identifier="GST_PAD_LINK_WRONG_DIRECTION"
- glib:nick="wrong-direction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="97">pads have wrong direction</doc>
- </member>
- <member name="noformat"
- value="-4"
- c:identifier="GST_PAD_LINK_NOFORMAT"
- glib:nick="noformat">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="98">pads do not have common format</doc>
- </member>
- <member name="nosched"
- value="-5"
- c:identifier="GST_PAD_LINK_NOSCHED"
- glib:nick="nosched">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="99">pads cannot cooperate in scheduling</doc>
- </member>
- <member name="refused"
- value="-6"
- c:identifier="GST_PAD_LINK_REFUSED"
- glib:nick="refused">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="100">refused for some reason</doc>
- </member>
- </enumeration>
- <enumeration name="PadMode"
- glib:type-name="GstPadMode"
- glib:get-type="gst_pad_mode_get_type"
- c:type="GstPadMode">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="48">The status of a GstPad. After activating a pad, which usually happens when the
-parent element goes from READY to PAUSED, the GstPadMode defines if the
-pad operates in push or pull mode.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_PAD_MODE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="50">Pad will not handle dataflow</doc>
- </member>
- <member name="push"
- value="1"
- c:identifier="GST_PAD_MODE_PUSH"
- glib:nick="push">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="51">Pad handles dataflow in downstream push mode</doc>
- </member>
- <member name="pull"
- value="2"
- c:identifier="GST_PAD_MODE_PULL"
- glib:nick="pull">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="52">Pad handles dataflow in upstream pull mode</doc>
- </member>
- <function name="get_name" c:identifier="gst_pad_mode_get_name">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="944">Return the name of a pad mode, for use in debug messages mostly.</doc>
- <source-position filename="gst/gstpad.h" line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="950">short mnemonic for pad mode @mode</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="946">the pad mode</doc>
- <type name="PadMode" c:type="GstPadMode"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <enumeration name="PadPresence"
- glib:type-name="GstPadPresence"
- glib:get-type="gst_pad_presence_get_type"
- c:type="GstPadPresence">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="50">Indicates when this pad will become available.</doc>
- <member name="always"
- value="0"
- c:identifier="GST_PAD_ALWAYS"
- glib:nick="always">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="52">the pad is always available</doc>
- </member>
- <member name="sometimes"
- value="1"
- c:identifier="GST_PAD_SOMETIMES"
- glib:nick="sometimes">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="53">the pad will become available depending on the media stream</doc>
- </member>
- <member name="request"
- value="2"
- c:identifier="GST_PAD_REQUEST"
- glib:nick="request">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="54">the pad is only available on request with
- gst_element_request_pad().</doc>
- </member>
- </enumeration>
- <record name="PadPrivate" c:type="GstPadPrivate" disguised="1">
- <source-position filename="gst/gstpad.h" line="30"/>
- </record>
- <callback name="PadProbeCallback" c:type="GstPadProbeCallback">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="630">Callback used by gst_pad_add_probe(). Gets called to notify about the current
-blocking type.
-
-The callback is allowed to modify the data pointer in @info.</doc>
- <source-position filename="gst/gstpad.h" line="643"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="641">a #GstPadProbeReturn</doc>
- <type name="PadProbeReturn" c:type="GstPadProbeReturn"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="632">the #GstPad that is blocked</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="633">#GstPadProbeInfo</doc>
- <type name="PadProbeInfo" c:type="GstPadProbeInfo*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="634">the gpointer to optional user data.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="PadProbeInfo" c:type="GstPadProbeInfo">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="575">Info passed in the #GstPadProbeCallback.</doc>
- <source-position filename="gst/gstpad.h" line="603"/>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="577">the current probe type</doc>
- <type name="PadProbeType" c:type="GstPadProbeType"/>
- </field>
- <field name="id" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="578">the id of the probe</doc>
- <type name="gulong" c:type="gulong"/>
- </field>
- <field name="data" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="579">type specific data, check the @type field to know the
- datatype. This field can be %NULL.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="offset" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="581">offset of pull probe, this field is valid when @type contains
- #GST_PAD_PROBE_TYPE_PULL</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="583">size of pull probe, this field is valid when @type contains
- #GST_PAD_PROBE_TYPE_PULL</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <union name="ABI" c:type="ABI">
- <source-position filename="gst/gstpad.h" line="602"/>
- <field name="_gst_reserved" writable="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <record name="abi" c:type="abi">
- <source-position filename="gst/gstpad.h" line="601"/>
- <field name="flow_ret" writable="1">
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </field>
- </record>
- </union>
- <method name="get_buffer" c:identifier="gst_pad_probe_info_get_buffer">
- <source-position filename="gst/gstpad.h" line="625"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6456">The #GstBuffer from the probe</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6454">a #GstPadProbeInfo</doc>
- <type name="PadProbeInfo" c:type="GstPadProbeInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_buffer_list"
- c:identifier="gst_pad_probe_info_get_buffer_list">
- <source-position filename="gst/gstpad.h" line="628"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6471">The #GstBufferList from the probe</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6469">a #GstPadProbeInfo</doc>
- <type name="PadProbeInfo" c:type="GstPadProbeInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_event" c:identifier="gst_pad_probe_info_get_event">
- <source-position filename="gst/gstpad.h" line="619"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6423">The #GstEvent from the probe</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6421">a #GstPadProbeInfo</doc>
- <type name="PadProbeInfo" c:type="GstPadProbeInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_query" c:identifier="gst_pad_probe_info_get_query">
- <source-position filename="gst/gstpad.h" line="622"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6440">The #GstQuery from the probe</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="6438">a #GstPadProbeInfo</doc>
- <type name="PadProbeInfo" c:type="GstPadProbeInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <enumeration name="PadProbeReturn"
- glib:type-name="GstPadProbeReturn"
- glib:get-type="gst_pad_probe_return_get_type"
- c:type="GstPadProbeReturn">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="539">Different return values for the #GstPadProbeCallback.</doc>
- <member name="drop"
- value="0"
- c:identifier="GST_PAD_PROBE_DROP"
- glib:nick="drop">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="546">drop data in data probes. For push mode this means that
- the data item is not sent downstream. For pull mode, it means that
- the data item is not passed upstream. In both cases, no other probes
- are called for this item and %GST_FLOW_OK or %TRUE is returned to the
- caller.</doc>
- </member>
- <member name="ok"
- value="1"
- c:identifier="GST_PAD_PROBE_OK"
- glib:nick="ok">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="541">normal probe return value. This leaves the probe in
- place, and defers decisions about dropping or passing data to other
- probes, if any. If there are no other probes, the default behaviour
- for the probe type applies ('block' for blocking probes,
- and 'pass' for non-blocking probes).</doc>
- </member>
- <member name="remove"
- value="2"
- c:identifier="GST_PAD_PROBE_REMOVE"
- glib:nick="remove">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="551">remove this probe.</doc>
- </member>
- <member name="pass"
- value="3"
- c:identifier="GST_PAD_PROBE_PASS"
- glib:nick="pass">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="552">pass the data item in the block probe and block on the
- next item.</doc>
- </member>
- <member name="handled"
- value="4"
- c:identifier="GST_PAD_PROBE_HANDLED"
- glib:nick="handled">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="554">Data has been handled in the probe and will not be
- forwarded further. For events and buffers this is the same behaviour as
- %GST_PAD_PROBE_DROP (except that in this case you need to unref the buffer
- or event yourself). For queries it will also return %TRUE to the caller.
- The probe can also modify the #GstFlowReturn value by using the
- #GST_PAD_PROBE_INFO_FLOW_RETURN() accessor.
- Note that the resulting query must contain valid entries.
- Since: 1.6</doc>
- </member>
- </enumeration>
- <bitfield name="PadProbeType"
- glib:type-name="GstPadProbeType"
- glib:get-type="gst_pad_probe_type_get_type"
- c:type="GstPadProbeType">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="475">The different probing types that can occur. When either one of
-@GST_PAD_PROBE_TYPE_IDLE or @GST_PAD_PROBE_TYPE_BLOCK is used, the probe will be a
-blocking probe.</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_PAD_PROBE_TYPE_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="477">invalid probe type</doc>
- </member>
- <member name="idle"
- value="1"
- c:identifier="GST_PAD_PROBE_TYPE_IDLE"
- glib:nick="idle">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="478">probe idle pads and block while the callback is called</doc>
- </member>
- <member name="block"
- value="2"
- c:identifier="GST_PAD_PROBE_TYPE_BLOCK"
- glib:nick="block">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="479">probe and block pads</doc>
- </member>
- <member name="buffer"
- value="16"
- c:identifier="GST_PAD_PROBE_TYPE_BUFFER"
- glib:nick="buffer">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="480">probe buffers</doc>
- </member>
- <member name="buffer_list"
- value="32"
- c:identifier="GST_PAD_PROBE_TYPE_BUFFER_LIST"
- glib:nick="buffer-list">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="481">probe buffer lists</doc>
- </member>
- <member name="event_downstream"
- value="64"
- c:identifier="GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM"
- glib:nick="event-downstream">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="482">probe downstream events</doc>
- </member>
- <member name="event_upstream"
- value="128"
- c:identifier="GST_PAD_PROBE_TYPE_EVENT_UPSTREAM"
- glib:nick="event-upstream">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="483">probe upstream events</doc>
- </member>
- <member name="event_flush"
- value="256"
- c:identifier="GST_PAD_PROBE_TYPE_EVENT_FLUSH"
- glib:nick="event-flush">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="484">probe flush events. This probe has to be
- explicitly enabled and is not included in the
- @@GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM or
- @@GST_PAD_PROBE_TYPE_EVENT_UPSTREAM probe types.</doc>
- </member>
- <member name="query_downstream"
- value="512"
- c:identifier="GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM"
- glib:nick="query-downstream">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="488">probe downstream queries</doc>
- </member>
- <member name="query_upstream"
- value="1024"
- c:identifier="GST_PAD_PROBE_TYPE_QUERY_UPSTREAM"
- glib:nick="query-upstream">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="489">probe upstream queries</doc>
- </member>
- <member name="push"
- value="4096"
- c:identifier="GST_PAD_PROBE_TYPE_PUSH"
- glib:nick="push">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="490">probe push</doc>
- </member>
- <member name="pull"
- value="8192"
- c:identifier="GST_PAD_PROBE_TYPE_PULL"
- glib:nick="pull">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="491">probe pull</doc>
- </member>
- <member name="blocking"
- value="3"
- c:identifier="GST_PAD_PROBE_TYPE_BLOCKING"
- glib:nick="blocking">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="492">probe and block at the next opportunity, at data flow or when idle</doc>
- </member>
- <member name="data_downstream"
- value="112"
- c:identifier="GST_PAD_PROBE_TYPE_DATA_DOWNSTREAM"
- glib:nick="data-downstream">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="493">probe downstream data (buffers, buffer lists, and events)</doc>
- </member>
- <member name="data_upstream"
- value="128"
- c:identifier="GST_PAD_PROBE_TYPE_DATA_UPSTREAM"
- glib:nick="data-upstream">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="494">probe upstream data (events)</doc>
- </member>
- <member name="data_both"
- value="240"
- c:identifier="GST_PAD_PROBE_TYPE_DATA_BOTH"
- glib:nick="data-both">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="495">probe upstream and downstream data (buffers, buffer lists, and events)</doc>
- </member>
- <member name="block_downstream"
- value="114"
- c:identifier="GST_PAD_PROBE_TYPE_BLOCK_DOWNSTREAM"
- glib:nick="block-downstream">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="496">probe and block downstream data (buffers, buffer lists, and events)</doc>
- </member>
- <member name="block_upstream"
- value="130"
- c:identifier="GST_PAD_PROBE_TYPE_BLOCK_UPSTREAM"
- glib:nick="block-upstream">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="497">probe and block upstream data (events)</doc>
- </member>
- <member name="event_both"
- value="192"
- c:identifier="GST_PAD_PROBE_TYPE_EVENT_BOTH"
- glib:nick="event-both">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="498">probe upstream and downstream events</doc>
- </member>
- <member name="query_both"
- value="1536"
- c:identifier="GST_PAD_PROBE_TYPE_QUERY_BOTH"
- glib:nick="query-both">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="499">probe upstream and downstream queries</doc>
- </member>
- <member name="all_both"
- value="1776"
- c:identifier="GST_PAD_PROBE_TYPE_ALL_BOTH"
- glib:nick="all-both">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="500">probe upstream events and queries and downstream buffers, buffer lists, events and queries</doc>
- </member>
- <member name="scheduling"
- value="12288"
- c:identifier="GST_PAD_PROBE_TYPE_SCHEDULING"
- glib:nick="scheduling">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="501">probe push and pull</doc>
- </member>
- </bitfield>
- <callback name="PadQueryFunction" c:type="GstPadQueryFunction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="417">The signature of the query function.</doc>
- <source-position filename="gst/gstpad.h" line="429"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="427">%TRUE if the query could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="419">the #GstPad to query.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="420">the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
- flag is set, @parent is guaranteed to be not-%NULL and remain valid
- during the execution of this function.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="423">the #GstQuery object to execute</doc>
- <type name="Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="PadStickyEventsForeachFunction"
- c:type="GstPadStickyEventsForeachFunction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="646">Callback used by gst_pad_sticky_events_foreach().
-
-When this function returns %TRUE, the next event will be
-returned. When %FALSE is returned, gst_pad_sticky_events_foreach() will return.
-
-When @event is set to %NULL, the item will be removed from the list of sticky events.
-@event can be replaced by assigning a new reference to it.
-This function is responsible for unreffing the old event when
-removing or modifying.</doc>
- <source-position filename="gst/gstpad.h" line="664"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="662">%TRUE if the iteration should continue</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="648">the #GstPad.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="event"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="649">a sticky #GstEvent.</doc>
- <type name="Event" c:type="GstEvent**"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="650">the #gpointer to optional user data.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <class name="PadTemplate"
- c:symbol-prefix="pad_template"
- c:type="GstPadTemplate"
- parent="Object"
- glib:type-name="GstPadTemplate"
- glib:get-type="gst_pad_template_get_type"
- glib:type-struct="PadTemplateClass">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="23">Padtemplates describe the possible media types a pad or an elementfactory can
-handle. This allows for both inspection of handled types before loading the
-element plugin as well as identifying pads on elements that are not yet
-created (request or sometimes pads).
-
-Pad and PadTemplates have #GstCaps attached to it to describe the media type
-they are capable of dealing with. gst_pad_template_get_caps() or
-GST_PAD_TEMPLATE_CAPS() are used to get the caps of a padtemplate. It's not
-possible to modify the caps of a padtemplate after creation.
-
-PadTemplates have a #GstPadPresence property which identifies the lifetime
-of the pad and that can be retrieved with GST_PAD_TEMPLATE_PRESENCE(). Also
-the direction of the pad can be retrieved from the #GstPadTemplate with
-GST_PAD_TEMPLATE_DIRECTION().
-
-The GST_PAD_TEMPLATE_NAME_TEMPLATE () is important for GST_PAD_REQUEST pads
-because it has to be used as the name in the gst_element_get_request_pad()
-call to instantiate a pad from this template.
-
-Padtemplates can be created with gst_pad_template_new() or with
-gst_static_pad_template_get (), which creates a #GstPadTemplate from a
-#GstStaticPadTemplate that can be filled with the
-convenient GST_STATIC_PAD_TEMPLATE() macro.
-
-A padtemplate can be used to create a pad (see gst_pad_new_from_template()
-or gst_pad_new_from_static_template ()) or to add to an element class
-(see gst_element_class_add_static_pad_template ()).
-
-The following code example shows the code to create a pad from a padtemplate.
-|[&lt;!-- language="C" --&gt;
- GstStaticPadTemplate my_template =
- GST_STATIC_PAD_TEMPLATE (
- "sink", // the name of the pad
- GST_PAD_SINK, // the direction of the pad
- GST_PAD_ALWAYS, // when this pad will be present
- GST_STATIC_CAPS ( // the capabilities of the padtemplate
- "audio/x-raw, "
- "channels = (int) [ 1, 6 ]"
- )
- );
- void
- my_method (void)
- {
- GstPad *pad;
- pad = gst_pad_new_from_static_template (&amp;amp;my_template, "sink");
- ...
- }
-]|
-
-The following example shows you how to add the padtemplate to an
-element class, this is usually done in the class_init of the class:
-|[&lt;!-- language="C" --&gt;
- static void
- my_element_class_init (GstMyElementClass *klass)
- {
- GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
-
- gst_element_class_add_static_pad_template (gstelement_class, &amp;amp;my_template);
- }
-]|</doc>
- <source-position filename="gst/gstpadtemplate.h" line="157"/>
- <constructor name="new" c:identifier="gst_pad_template_new">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="366">Creates a new pad template with a name according to the given template
-and with the given arguments.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="211"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="376">a new #GstPadTemplate.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </return-value>
- <parameters>
- <parameter name="name_template" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="368">the name template.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="direction" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="369">the #GstPadDirection of the template.</doc>
- <type name="PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="presence" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="370">the #GstPadPresence of the pad.</doc>
- <type name="PadPresence" c:type="GstPadPresence"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="371">a #GstCaps set for the template.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_static_pad_template_with_gtype"
- c:identifier="gst_pad_template_new_from_static_pad_template_with_gtype"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="329">Converts a #GstStaticPadTemplate into a #GstPadTemplate with a type.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="222"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="336">a new #GstPadTemplate.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </return-value>
- <parameters>
- <parameter name="pad_template" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="331">the static pad template</doc>
- <type name="StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
- </parameter>
- <parameter name="pad_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="332">The #GType of the pad to create</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_with_gtype"
- c:identifier="gst_pad_template_new_with_gtype"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="402">Creates a new pad template with a name according to the given template
-and with the given arguments.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="215"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="413">a new #GstPadTemplate.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </return-value>
- <parameters>
- <parameter name="name_template" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="404">the name template.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="direction" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="405">the #GstPadDirection of the template.</doc>
- <type name="PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="presence" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="406">the #GstPadPresence of the pad.</doc>
- <type name="PadPresence" c:type="GstPadPresence"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="407">a #GstCaps set for the template.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="pad_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="408">The #GType of the pad to create</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </constructor>
- <virtual-method name="pad_created" invoker="pad_created">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="529">Emit the pad-created signal for this template when created by this pad.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="153"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="531">a #GstPadTemplate that has been created</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="532">the #GstPad that created it</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="get_caps" c:identifier="gst_pad_template_get_caps">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="463">Gets the capabilities of the pad template.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="230"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="469">the #GstCaps of the pad template.
-Unref after usage.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="465">a #GstPadTemplate to get capabilities of.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_documentation_caps"
- c:identifier="gst_pad_template_get_documentation_caps"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="507">See gst_pad_template_set_documentation_caps().</doc>
- <source-position filename="gst/gstpadtemplate.h" line="236"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="513">The caps to document. For convenience, this will return
- gst_pad_template_get_caps() when no documentation caps were set.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="509">the pad template to get documented capabilities on</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pad_created" c:identifier="gst_pad_template_pad_created">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="529">Emit the pad-created signal for this template when created by this pad.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="239"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="531">a #GstPadTemplate that has been created</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="532">the #GstPad that created it</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_documentation_caps"
- c:identifier="gst_pad_template_set_documentation_caps"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="483">Certain elements will dynamically construct the caps of their
-pad templates. In order not to let environment-specific information
-into the documentation, element authors should use this method to
-expose "stable" caps to the reader.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="233"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="485">the pad template to set documented capabilities on</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="486">the documented capabilities</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <property name="caps"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="188">The capabilities of the pad described by the pad template.</doc>
- <type name="Caps"/>
- </property>
- <property name="direction"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="166">The direction of the pad described by the pad template.</doc>
- <type name="PadDirection"/>
- </property>
- <property name="gtype"
- version="1.14"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="199">The type of the pad described by the pad template.</doc>
- <type name="GType" c:type="GType"/>
- </property>
- <property name="name-template"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="156">The name template of the pad template.</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="presence"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="177">When the pad described by the pad template will become available.</doc>
- <type name="PadPresence"/>
- </property>
- <field name="object">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="name_template">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="direction">
- <type name="PadDirection" c:type="GstPadDirection"/>
- </field>
- <field name="presence">
- <type name="PadPresence" c:type="GstPadPresence"/>
- </field>
- <field name="caps">
- <type name="Caps" c:type="GstCaps*"/>
- </field>
- <union name="ABI" c:type="ABI">
- <source-position filename="gst/gstpadtemplate.h" line="146"/>
- <field name="_gst_reserved" writable="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <record name="abi" c:type="abi">
- <source-position filename="gst/gstpadtemplate.h" line="145"/>
- <field name="gtype" writable="1">
- <type name="GType" c:type="GType"/>
- </field>
- <field name="documentation_caps" writable="1">
- <type name="Caps" c:type="GstCaps*"/>
- </field>
- </record>
- </union>
- <glib:signal name="pad-created" when="last">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="139">This signal is fired when an element creates a pad from this template.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="142">the pad that was created.</doc>
- <type name="Pad"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="PadTemplateClass"
- c:type="GstPadTemplateClass"
- glib:is-gtype-struct-for="PadTemplate">
- <source-position filename="gst/gstpadtemplate.h" line="157"/>
- <field name="parent_class">
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="pad_created">
- <callback name="pad_created">
- <source-position filename="gst/gstpadtemplate.h" line="153"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="531">a #GstPadTemplate that has been created</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="532">the #GstPad that created it</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <bitfield name="PadTemplateFlags"
- glib:type-name="GstPadTemplateFlags"
- glib:get-type="gst_pad_template_flags_get_type"
- c:type="GstPadTemplateFlags">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="107">Flags for the padtemplate</doc>
- <member name="last"
- value="256"
- c:identifier="GST_PAD_TEMPLATE_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="109">first flag that can be used by subclasses.</doc>
- </member>
- </bitfield>
- <callback name="PadUnlinkFunction" c:type="GstPadUnlinkFunction">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="447">Function signature to handle a unlinking the pad prom its peer.
-
-The pad's lock is already held when the unlink function is called, so most
-pad functions cannot be called from within the callback.</doc>
- <source-position filename="gst/gstpad.h" line="459"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="449">the #GstPad that is linked.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="450">the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
- flag is set, @parent is guaranteed to be not-%NULL and remain valid
- during the execution of this function.</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </callback>
- <class name="ParamArray"
- c:symbol-prefix="param_spec_array"
- version="1.12"
- parent="GObject.ParamSpec"
- glib:type-name="GstParamArray"
- glib:get-type="gst_param_spec_array_get_type"
- glib:fundamental="1">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="107">A fundamental type that describes a #GParamSpec for arrays of
-values</doc>
- </class>
- <class name="ParamFraction"
- c:symbol-prefix="param_spec_fraction"
- parent="GObject.ParamSpec"
- glib:type-name="GstParamFraction"
- glib:get-type="gst_param_spec_fraction_get_type"
- glib:fundamental="1">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="96">A fundamental type that describes a #GParamSpec for fractional
-properties</doc>
- </class>
- <record name="ParamSpecArray" c:type="GstParamSpecArray">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="156">A GParamSpec derived structure for arrays of values.</doc>
- <source-position filename="gst/gstparamspecs.h" line="167"/>
- <field name="parent_instance" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="158">super class</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec"/>
- </field>
- <field name="element_spec" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="159">the #GParamSpec of the type of values in the array</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </field>
- </record>
- <record name="ParamSpecFraction" c:type="GstParamSpecFraction">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="135">A GParamSpec derived structure that contains the meta data for fractional
-properties.</doc>
- <source-position filename="gst/gstparamspecs.h" line="154"/>
- <field name="parent_instance" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="137">super class</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec"/>
- </field>
- <field name="min_num" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="138">minimal numerator</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="min_den" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="139">minimal denominator</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="max_num" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="140">maximal numerator</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="max_den" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="141">maximal denominator</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="def_num" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="142">default numerator</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="def_den" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.h"
- line="143">default denominator</doc>
- <type name="gint" c:type="gint"/>
- </field>
- </record>
- <record name="ParentBufferMeta" c:type="GstParentBufferMeta" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="705">The #GstParentBufferMeta is a #GstMeta which can be attached to a #GstBuffer
-to hold a reference to another buffer that is only released when the child
-#GstBuffer is released.
-
-Typically, #GstParentBufferMeta is used when the child buffer is directly
-using the #GstMemory of the parent buffer, and wants to prevent the parent
-buffer from being returned to a buffer pool until the #GstMemory is available
-for re-use.</doc>
- <source-position filename="gst/gstbuffer.h" line="727"/>
- <field name="parent" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="707">the parent #GstMeta structure</doc>
- <type name="Meta" c:type="GstMeta"/>
- </field>
- <field name="buffer" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="708">the #GstBuffer on which a reference is being held.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </field>
- <function name="get_info"
- c:identifier="gst_parent_buffer_meta_get_info"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2675">Get the global #GstMetaInfo describing the #GstParentBufferMeta meta.</doc>
- <source-position filename="gst/gstbuffer.h" line="747"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2680">The #GstMetaInfo</doc>
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <record name="ParseContext"
- c:type="GstParseContext"
- glib:type-name="GstParseContext"
- glib:get-type="gst_parse_context_get_type"
- c:symbol-prefix="parse_context">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="90">Opaque structure.</doc>
- <source-position filename="gst/gstparse.h" line="95"/>
- <constructor name="new" c:identifier="gst_parse_context_new">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="70">Allocates a parse context for use with gst_parse_launch_full() or
-gst_parse_launchv_full().
-
-Free-function: gst_parse_context_free</doc>
- <source-position filename="gst/gstparse.h" line="103"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="78">a newly-allocated parse context. Free
- with gst_parse_context_free() when no longer needed.</doc>
- <type name="ParseContext" c:type="GstParseContext*"/>
- </return-value>
- </constructor>
- <method name="copy"
- c:identifier="gst_parse_context_copy"
- version="1.12.1">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="96">Copies the @context.</doc>
- <source-position filename="gst/gstparse.h" line="112"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="102">A copied #GstParseContext</doc>
- <type name="ParseContext" c:type="GstParseContext*"/>
- </return-value>
- <parameters>
- <instance-parameter name="context" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="98">a #GstParseContext</doc>
- <type name="ParseContext" c:type="const GstParseContext*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_parse_context_free">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="126">Frees a parse context previously allocated with gst_parse_context_new().</doc>
- <source-position filename="gst/gstparse.h" line="109"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="context" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="128">a #GstParseContext</doc>
- <type name="ParseContext" c:type="GstParseContext*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_missing_elements"
- c:identifier="gst_parse_context_get_missing_elements">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="144">Retrieve missing elements from a previous run of gst_parse_launch_full()
-or gst_parse_launchv_full(). Will only return results if an error code
-of %GST_PARSE_ERROR_NO_SUCH_ELEMENT was returned.</doc>
- <source-position filename="gst/gstparse.h" line="106"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="152">a
- %NULL-terminated array of element factory name strings of missing
- elements. Free with g_strfreev() when no longer needed.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="context" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="146">a #GstParseContext</doc>
- <type name="ParseContext" c:type="GstParseContext*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <enumeration name="ParseError"
- glib:type-name="GstParseError"
- glib:get-type="gst_parse_error_get_type"
- c:type="GstParseError"
- glib:error-domain="gst_parse_error">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="41">The different parsing errors that can occur.</doc>
- <member name="syntax"
- value="0"
- c:identifier="GST_PARSE_ERROR_SYNTAX"
- glib:nick="syntax">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="43">A syntax error occurred.</doc>
- </member>
- <member name="no_such_element"
- value="1"
- c:identifier="GST_PARSE_ERROR_NO_SUCH_ELEMENT"
- glib:nick="no-such-element">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="44">The description contained an unknown element</doc>
- </member>
- <member name="no_such_property"
- value="2"
- c:identifier="GST_PARSE_ERROR_NO_SUCH_PROPERTY"
- glib:nick="no-such-property">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="45">An element did not have a specified property</doc>
- </member>
- <member name="link"
- value="3"
- c:identifier="GST_PARSE_ERROR_LINK"
- glib:nick="link">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="46">There was an error linking two pads.</doc>
- </member>
- <member name="could_not_set_property"
- value="4"
- c:identifier="GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY"
- glib:nick="could-not-set-property">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="47">There was an error setting a property</doc>
- </member>
- <member name="empty_bin"
- value="5"
- c:identifier="GST_PARSE_ERROR_EMPTY_BIN"
- glib:nick="empty-bin">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="48">An empty bin was specified.</doc>
- </member>
- <member name="empty"
- value="6"
- c:identifier="GST_PARSE_ERROR_EMPTY"
- glib:nick="empty">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="49">An empty description was specified</doc>
- </member>
- <member name="delayed_link"
- value="7"
- c:identifier="GST_PARSE_ERROR_DELAYED_LINK"
- glib:nick="delayed-link">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="50">A delayed link did not get resolved.</doc>
- </member>
- <function name="quark" c:identifier="gst_parse_error_quark">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="52">Get the error quark used by the parsing subsystem.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="57">the quark of the parse errors.</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- </enumeration>
- <bitfield name="ParseFlags"
- glib:type-name="GstParseFlags"
- glib:get-type="gst_parse_flags_get_type"
- c:type="GstParseFlags">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="66">Parsing options.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_PARSE_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="68">Do not use any special parsing options.</doc>
- </member>
- <member name="fatal_errors"
- value="1"
- c:identifier="GST_PARSE_FLAG_FATAL_ERRORS"
- glib:nick="fatal-errors">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="69">Always return %NULL when an error occurs
- (default behaviour is to return partially constructed bins or elements
- in some cases)</doc>
- </member>
- <member name="no_single_element_bins"
- value="2"
- c:identifier="GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS"
- glib:nick="no-single-element-bins">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="72">If a bin only has a single element,
- just return the element.</doc>
- </member>
- <member name="place_in_bin"
- value="4"
- c:identifier="GST_PARSE_FLAG_PLACE_IN_BIN"
- glib:nick="place-in-bin">
- <doc xml:space="preserve"
- filename="gst/gstparse.h"
- line="74">If more than one toplevel element is described
- by the pipeline description string, put them in a #GstBin instead of a
- #GstPipeline. (Since: 1.10)</doc>
- </member>
- </bitfield>
- <class name="Pipeline"
- c:symbol-prefix="pipeline"
- c:type="GstPipeline"
- parent="Bin"
- glib:type-name="GstPipeline"
- glib:get-type="gst_pipeline_get_type"
- glib:type-struct="PipelineClass">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="23">A #GstPipeline is a special #GstBin used as the toplevel container for
-the filter graph. The #GstPipeline will manage the selection and
-distribution of a global #GstClock as well as provide a #GstBus to the
-application.
-
-gst_pipeline_new() is used to create a pipeline. when you are done with
-the pipeline, use gst_object_unref() to free its resources including all
-added #GstElement objects (if not otherwise referenced).
-
-Elements are added and removed from the pipeline using the #GstBin
-methods like gst_bin_add() and gst_bin_remove() (see #GstBin).
-
-Before changing the state of the #GstPipeline (see #GstElement) a #GstBus
-can be retrieved with gst_pipeline_get_bus(). This bus can then be
-used to receive #GstMessage from the elements in the pipeline.
-
-By default, a #GstPipeline will automatically flush the pending #GstBus
-messages when going to the NULL state to ensure that no circular
-references exist when no messages are read from the #GstBus. This
-behaviour can be changed with gst_pipeline_set_auto_flush_bus().
-
-When the #GstPipeline performs the PAUSED to PLAYING state change it will
-select a clock for the elements. The clock selection algorithm will by
-default select a clock provided by an element that is most upstream
-(closest to the source). For live pipelines (ones that return
-#GST_STATE_CHANGE_NO_PREROLL from the gst_element_set_state() call) this
-will select the clock provided by the live source. For normal pipelines
-this will select a clock provided by the sinks (most likely the audio
-sink). If no element provides a clock, a default #GstSystemClock is used.
-
-The clock selection can be controlled with the gst_pipeline_use_clock()
-method, which will enforce a given clock on the pipeline. With
-gst_pipeline_auto_clock() the default clock selection algorithm can be
-restored.
-
-A #GstPipeline maintains a running time for the elements. The running
-time is defined as the difference between the current clock time and
-the base time. When the pipeline goes to READY or a flushing seek is
-performed on it, the running time is reset to 0. When the pipeline is
-set from PLAYING to PAUSED, the current clock time is sampled and used to
-configure the base time for the elements when the pipeline is set
-to PLAYING again. The effect is that the running time (as the difference
-between the clock time and the base time) will count how much time was spent
-in the PLAYING state. This default behaviour can be changed with the
-gst_element_set_start_time() method.</doc>
- <source-position filename="gst/gstpipeline.h" line="89"/>
- <implements name="ChildProxy"/>
- <constructor name="new" c:identifier="gst_pipeline_new">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="331">Create a new pipeline with the given name.</doc>
- <source-position filename="gst/gstpipeline.h" line="95"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="337">newly created GstPipeline
-
-MT safe.</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="333">name of new pipeline</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="auto_clock" c:identifier="gst_pipeline_auto_clock">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="887">Let @pipeline select a clock automatically. This is the default
-behaviour.
-
-Use this function if you previous forced a fixed clock with
-gst_pipeline_use_clock() and want to restore the default
-pipeline clock selection algorithm.
-
-MT safe.</doc>
- <source-position filename="gst/gstpipeline.h" line="113"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="889">a #GstPipeline</doc>
- <type name="Pipeline" c:type="GstPipeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_auto_flush_bus"
- c:identifier="gst_pipeline_get_auto_flush_bus">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="1000">Check if @pipeline will automatically flush messages when going to
-the NULL state.</doc>
- <source-position filename="gst/gstpipeline.h" line="131"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="1007">whether the pipeline will automatically flush its bus when
-going from READY to NULL state or not.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="1002">a #GstPipeline</doc>
- <type name="Pipeline" c:type="GstPipeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_bus" c:identifier="gst_pipeline_get_bus">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="737">Gets the #GstBus of @pipeline. The bus allows applications to receive
-#GstMessage packets.</doc>
- <source-position filename="gst/gstpipeline.h" line="98"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="744">a #GstBus, unref after usage.
-
-MT safe.</doc>
- <type name="Bus" c:type="GstBus*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="739">a #GstPipeline</doc>
- <type name="Pipeline" c:type="GstPipeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_clock"
- c:identifier="gst_pipeline_get_clock"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="790">Gets the current clock used by @pipeline. Users of object
-oriented languages should use gst_pipeline_get_pipeline_clock()
-to avoid confusion with gst_element_get_clock() which has a different behavior.
-
-Unlike gst_element_get_clock(), this function will always return a
-clock, even if the pipeline is not in the PLAYING state.</doc>
- <source-position filename="gst/gstpipeline.h" line="107"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="801">a #GstClock, unref after usage.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="792">a #GstPipeline</doc>
- <type name="Pipeline" c:type="GstPipeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_delay" c:identifier="gst_pipeline_get_delay">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="945">Get the configured delay (see gst_pipeline_set_delay()).</doc>
- <source-position filename="gst/gstpipeline.h" line="119"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="951">The configured delay.
-
-MT safe.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="947">a #GstPipeline</doc>
- <type name="Pipeline" c:type="GstPipeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_latency"
- c:identifier="gst_pipeline_get_latency"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="1057">Gets the latency that should be configured on the pipeline. See
-gst_pipeline_set_latency().</doc>
- <source-position filename="gst/gstpipeline.h" line="125"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="1064">Latency to configure on the pipeline or GST_CLOCK_TIME_NONE</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="1059">a #GstPipeline</doc>
- <type name="Pipeline" c:type="GstPipeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_pipeline_clock"
- c:identifier="gst_pipeline_get_pipeline_clock"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="809">Gets the current clock used by @pipeline.
-
-Unlike gst_element_get_clock(), this function will always return a
-clock, even if the pipeline is not in the PLAYING state.</doc>
- <source-position filename="gst/gstpipeline.h" line="110"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="818">a #GstClock, unref after usage.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="811">a #GstPipeline</doc>
- <type name="Pipeline" c:type="GstPipeline*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_auto_flush_bus"
- c:identifier="gst_pipeline_set_auto_flush_bus">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="969">Usually, when a pipeline goes from READY to NULL state, it automatically
-flushes all pending messages on the bus, which is done for refcounting
-purposes, to break circular references.
-
-This means that applications that update state using (async) bus messages
-(e.g. do certain things when a pipeline goes from PAUSED to READY) might
-not get to see messages when the pipeline is shut down, because they might
-be flushed before they can be dispatched in the main thread. This behaviour
-can be disabled using this function.
-
-It is important that all messages on the bus are handled when the
-automatic flushing is disabled else memory leaks will be introduced.
-
-MT safe.</doc>
- <source-position filename="gst/gstpipeline.h" line="128"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="971">a #GstPipeline</doc>
- <type name="Pipeline" c:type="GstPipeline*"/>
- </instance-parameter>
- <parameter name="auto_flush" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="972">whether or not to automatically flush the bus when
-the pipeline goes from READY to NULL state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_clock"
- c:identifier="gst_pipeline_set_clock"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="863">Set the clock for @pipeline. The clock will be distributed
-to all the elements managed by the pipeline.</doc>
- <source-position filename="gst/gstpipeline.h" line="104"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="871">%TRUE if the clock could be set on the pipeline. %FALSE if
- some element did not accept the clock.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="865">a #GstPipeline</doc>
- <type name="Pipeline" c:type="GstPipeline*"/>
- </instance-parameter>
- <parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="866">the clock to set</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_delay" c:identifier="gst_pipeline_set_delay">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="918">Set the expected delay needed for all elements to perform the
-PAUSED to PLAYING state change. @delay will be added to the
-base time of the elements so that they wait an additional @delay
-amount of time before starting to process buffers and cannot be
-#GST_CLOCK_TIME_NONE.
-
-This option is used for tuning purposes and should normally not be
-used.
-
-MT safe.</doc>
- <source-position filename="gst/gstpipeline.h" line="116"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="920">a #GstPipeline</doc>
- <type name="Pipeline" c:type="GstPipeline*"/>
- </instance-parameter>
- <parameter name="delay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="921">the delay</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_latency"
- c:identifier="gst_pipeline_set_latency"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="1026">Sets the latency that should be configured on the pipeline. Setting
-GST_CLOCK_TIME_NONE will restore the default behaviour of using the minimum
-latency from the LATENCY query. Setting this is usually not required and
-the pipeline will figure out an appropriate latency automatically.
-
-Setting a too low latency, especially lower than the minimum latency from
-the LATENCY query, will most likely cause the pipeline to fail.</doc>
- <source-position filename="gst/gstpipeline.h" line="122"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="1028">a #GstPipeline</doc>
- <type name="Pipeline" c:type="GstPipeline*"/>
- </instance-parameter>
- <parameter name="latency" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="1029">latency to configure</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="use_clock" c:identifier="gst_pipeline_use_clock">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="831">Force @pipeline to use the given @clock. The pipeline will
-always use the given clock even if new clock providers are added
-to this pipeline.
-
-If @clock is %NULL all clocking will be disabled which will make
-the pipeline run as fast as possible.
-
-MT safe.</doc>
- <source-position filename="gst/gstpipeline.h" line="101"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pipeline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="833">a #GstPipeline</doc>
- <type name="Pipeline" c:type="GstPipeline*"/>
- </instance-parameter>
- <parameter name="clock"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="834">the clock to use</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- </parameters>
- </method>
- <property name="auto-flush-bus" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="179">Whether or not to automatically flush all messages on the
-pipeline's bus when going from READY to NULL state. Please see
-gst_pipeline_set_auto_flush_bus() for more information on this option.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="delay" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="166">The expected delay needed for elements to spin up to the
-PLAYING state expressed in nanoseconds.
-see gst_pipeline_set_delay() for more information on this option.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="latency"
- version="1.6"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.c"
- line="192">Latency to configure on the pipeline. See gst_pipeline_set_latency().</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <field name="bin">
- <type name="Bin" c:type="GstBin"/>
- </field>
- <field name="fixed_clock">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.h"
- line="58">The fixed clock of the pipeline, used when
- GST_PIPELINE_FLAG_FIXED_CLOCK is set.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </field>
- <field name="stream_time">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.h"
- line="60">The stream time of the pipeline. A better name for this
- property would be the running_time, the total time spent in the
- PLAYING state without being flushed. (deprecated, use the start_time
- on GstElement).</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="delay">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.h"
- line="64">Extra delay added to base_time to compensate for computing delays
- when setting elements to PLAYING.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="PipelinePrivate" c:type="GstPipelinePrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="PipelineClass"
- c:type="GstPipelineClass"
- glib:is-gtype-struct-for="Pipeline">
- <source-position filename="gst/gstpipeline.h" line="89"/>
- <field name="parent_class">
- <type name="BinClass" c:type="GstBinClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <bitfield name="PipelineFlags"
- glib:type-name="GstPipelineFlags"
- glib:get-type="gst_pipeline_flags_get_type"
- c:type="GstPipelineFlags">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.h"
- line="43">Pipeline flags</doc>
- <member name="fixed_clock"
- value="524288"
- c:identifier="GST_PIPELINE_FLAG_FIXED_CLOCK"
- glib:nick="fixed-clock">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.h"
- line="45">this pipeline works with a fixed clock</doc>
- </member>
- <member name="last"
- value="8388608"
- c:identifier="GST_PIPELINE_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst/gstpipeline.h"
- line="46">offset to define more flags</doc>
- </member>
- </bitfield>
- <record name="PipelinePrivate" c:type="GstPipelinePrivate" disguised="1">
- <source-position filename="gst/gstpipeline.h" line="41"/>
- </record>
- <class name="Plugin"
- c:symbol-prefix="plugin"
- c:type="GstPlugin"
- parent="Object"
- glib:type-name="GstPlugin"
- glib:get-type="gst_plugin_get_type"
- glib:type-struct="PluginClass">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="23">GStreamer is extensible, so #GstElement instances can be loaded at runtime.
-A plugin system can provide one or more of the basic GStreamer
-#GstPluginFeature subclasses.
-
-A plugin should export a symbol `gst_plugin_desc` that is a
-struct of type #GstPluginDesc.
-the plugin loader will check the version of the core library the plugin was
-linked against and will create a new #GstPlugin. It will then call the
-#GstPluginInitFunc function that was provided in the
-`gst_plugin_desc`.
-
-Once you have a handle to a #GstPlugin (e.g. from the #GstRegistry), you
-can add any object that subclasses #GstPluginFeature.
-
-Usually plugins are always automatically loaded so you don't need to call
-gst_plugin_load() explicitly to bring it into memory. There are options to
-statically link plugins to an app or even use GStreamer without a plugin
-repository in which case gst_plugin_load() can be needed to bring the plugin
-into memory.</doc>
- <source-position filename="gst/gstplugin.h" line="41"/>
- <function name="list_free" c:identifier="gst_plugin_list_free">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1396">Unrefs each member of @list, then frees the list.</doc>
- <source-position filename="gst/gstplugin.h" line="396"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="list" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1398">list of #GstPlugin</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Plugin"/>
- </type>
- </parameter>
- </parameters>
- </function>
- <function name="load_by_name" c:identifier="gst_plugin_load_by_name">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1320">Load the named plugin. Refs the plugin.</doc>
- <source-position filename="gst/gstplugin.h" line="381"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1326">a reference to a loaded plugin, or
-%NULL on error.</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1322">name of plugin to load</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="load_file"
- c:identifier="gst_plugin_load_file"
- throws="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="676">Loads the given plugin and refs it. Caller needs to unref after use.</doc>
- <source-position filename="gst/gstplugin.h" line="375"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="683">a reference to the existing loaded GstPlugin, a
-reference to the newly-loaded GstPlugin, or %NULL if an error occurred.</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </return-value>
- <parameters>
- <parameter name="filename" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="678">the plugin filename to load</doc>
- <type name="filename" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="register_static"
- c:identifier="gst_plugin_register_static">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="179">Registers a static plugin, ie. a plugin which is private to an application
-or library and contained within the application or library (as opposed to
-being shipped as a separate module file).
-
-You must make sure that GStreamer has been initialised (with gst_init() or
-via gst_init_get_option_group()) before calling this function.</doc>
- <source-position filename="gst/gstplugin.h" line="316"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="204">%TRUE if the plugin was registered correctly, otherwise %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="major_version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="181">the major version number of the GStreamer core that the
- plugin was compiled for, you can just use GST_VERSION_MAJOR here</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="minor_version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="183">the minor version number of the GStreamer core that the
- plugin was compiled for, you can just use GST_VERSION_MINOR here</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="185">a unique name of the plugin (ideally prefixed with an application- or
- library-specific namespace prefix in order to avoid name conflicts in
- case a similar plugin with the same name ever gets added to GStreamer)</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="188">description of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="init_func" transfer-ownership="none" scope="call">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="189">pointer to the init function of this plugin.</doc>
- <type name="PluginInitFunc" c:type="GstPluginInitFunc"/>
- </parameter>
- <parameter name="version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="190">version string of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="license" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="191">effective license of plugin. Must be one of the approved licenses
- (see #GstPluginDesc above) or the plugin will not be registered.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="193">source module plugin belongs to</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="package" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="194">shipped package plugin belongs to</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="origin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="195">URL to provider of plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="register_static_full"
- c:identifier="gst_plugin_register_static_full">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="240">Registers a static plugin, ie. a plugin which is private to an application
-or library and contained within the application or library (as opposed to
-being shipped as a separate module file) with a #GstPluginInitFullFunc
-which allows user data to be passed to the callback function (useful
-for bindings).
-
-You must make sure that GStreamer has been initialised (with gst_init() or
-via gst_init_get_option_group()) before calling this function.</doc>
- <source-position filename="gst/gstplugin.h" line="327"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="269">%TRUE if the plugin was registered correctly, otherwise %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="major_version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="242">the major version number of the GStreamer core that the
- plugin was compiled for, you can just use GST_VERSION_MAJOR here</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="minor_version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="244">the minor version number of the GStreamer core that the
- plugin was compiled for, you can just use GST_VERSION_MINOR here</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="246">a unique name of the plugin (ideally prefixed with an application- or
- library-specific namespace prefix in order to avoid name conflicts in
- case a similar plugin with the same name ever gets added to GStreamer)</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="249">description of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="init_full_func"
- transfer-ownership="none"
- scope="call"
- closure="10">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="250">pointer to the init function with user data
- of this plugin.</doc>
- <type name="PluginInitFullFunc" c:type="GstPluginInitFullFunc"/>
- </parameter>
- <parameter name="version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="252">version string of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="license" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="253">effective license of plugin. Must be one of the approved licenses
- (see #GstPluginDesc above) or the plugin will not be registered.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="255">source module plugin belongs to</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="package" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="256">shipped package plugin belongs to</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="origin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="257">URL to provider of plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="258">gpointer to user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </function>
- <method name="add_dependency" c:identifier="gst_plugin_add_dependency">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1828">Make GStreamer aware of external dependencies which affect the feature
-set of this plugin (ie. the elements or typefinders associated with it).
-
-GStreamer will re-inspect plugins with external dependencies whenever any
-of the external dependencies change. This is useful for plugins which wrap
-other plugin systems, e.g. a plugin which wraps a plugin-based visualisation
-library and makes visualisations available as GStreamer elements, or a
-codec loader which exposes elements and/or caps dependent on what external
-codec libraries are currently installed.</doc>
- <source-position filename="gst/gstplugin.h" line="384"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1830">a #GstPlugin</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- <parameter name="env_vars"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1831">%NULL-terminated array of environment variables affecting the
- feature set of the plugin (e.g. an environment variable containing
- paths where to look for additional modules/plugins of a library),
- or %NULL. Environment variable names may be followed by a path component
- which will be added to the content of the environment variable, e.g.
- "HOME/.mystuff/plugins".</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- <parameter name="paths"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1837">%NULL-terminated array of directories/paths where dependent files
- may be, or %NULL.</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- <parameter name="names"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1839">%NULL-terminated array of file names (or file name suffixes,
- depending on @flags) to be used in combination with the paths from
- @paths and/or the paths extracted from the environment variables in
- @env_vars, or %NULL.</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1843">optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE</doc>
- <type name="PluginDependencyFlags"
- c:type="GstPluginDependencyFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_dependency_simple"
- c:identifier="gst_plugin_add_dependency_simple">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1899">Make GStreamer aware of external dependencies which affect the feature
-set of this plugin (ie. the elements or typefinders associated with it).
-
-GStreamer will re-inspect plugins with external dependencies whenever any
-of the external dependencies change. This is useful for plugins which wrap
-other plugin systems, e.g. a plugin which wraps a plugin-based visualisation
-library and makes visualisations available as GStreamer elements, or a
-codec loader which exposes elements and/or caps dependent on what external
-codec libraries are currently installed.
-
-Convenience wrapper function for gst_plugin_add_dependency() which
-takes simple strings as arguments instead of string arrays, with multiple
-arguments separated by predefined delimiters (see above).</doc>
- <source-position filename="gst/gstplugin.h" line="390"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1901">the #GstPlugin</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- <parameter name="env_vars"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1902">one or more environment variables (separated by ':', ';' or ','),
- or %NULL. Environment variable names may be followed by a path component
- which will be added to the content of the environment variable, e.g.
- "HOME/.mystuff/plugins:MYSTUFF_PLUGINS_PATH"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="paths"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1906">one ore more directory paths (separated by ':' or ';' or ','),
- or %NULL. Example: "/usr/lib/mystuff/plugins"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="names"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1908">one or more file names or file name suffixes (separated by commas),
- or %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1910">optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE</doc>
- <type name="PluginDependencyFlags"
- c:type="GstPluginDependencyFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_cache_data" c:identifier="gst_plugin_get_cache_data">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1118">Gets the plugin specific data cache. If it is %NULL there is no cached data
-stored. This is the case when the registry is getting rebuilt.</doc>
- <source-position filename="gst/gstplugin.h" line="366"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1125">The cached data as a
-#GstStructure or %NULL.</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1120">a plugin</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_description" c:identifier="gst_plugin_get_description">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="966">Get the long descriptive name of the plugin</doc>
- <source-position filename="gst/gstplugin.h" line="342"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="972">the long name of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="968">plugin to get long name of</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_filename" c:identifier="gst_plugin_get_filename">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="982">get the filename of the plugin</doc>
- <source-position filename="gst/gstplugin.h" line="345"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="988">the filename of the plugin</doc>
- <type name="filename" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="984">plugin to get the filename of</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_license" c:identifier="gst_plugin_get_license">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1014">get the license of the plugin</doc>
- <source-position filename="gst/gstplugin.h" line="351"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1020">the license of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1016">plugin to get the license of</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_name" c:identifier="gst_plugin_get_name">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="950">Get the short name of the plugin</doc>
- <source-position filename="gst/gstplugin.h" line="339"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="956">the name of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="952">plugin to get the name of</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_origin" c:identifier="gst_plugin_get_origin">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1062">get the URL where the plugin comes from</doc>
- <source-position filename="gst/gstplugin.h" line="360"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1068">the origin of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1064">plugin to get the origin of</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_package" c:identifier="gst_plugin_get_package">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1046">get the package the plugin belongs to.</doc>
- <source-position filename="gst/gstplugin.h" line="357"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1052">the package of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1048">plugin to get the package of</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_release_date_string"
- c:identifier="gst_plugin_get_release_date_string">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1078">Get the release date (and possibly time) in form of a string, if available.
-
-For normal GStreamer plugin releases this will usually just be a date in
-the form of "YYYY-MM-DD", while pre-releases and builds from git may contain
-a time component after the date as well, in which case the string will be
-formatted like "YYYY-MM-DDTHH:MMZ" (e.g. "2012-04-30T09:30Z").
-
-There may be plugins that do not have a valid release date set on them.</doc>
- <source-position filename="gst/gstplugin.h" line="363"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1091">the date string of the plugin, or %NULL if not
-available.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1080">plugin to get the release date of</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_source" c:identifier="gst_plugin_get_source">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1030">get the source module the plugin belongs to.</doc>
- <source-position filename="gst/gstplugin.h" line="354"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1036">the source of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1032">plugin to get the source of</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_version" c:identifier="gst_plugin_get_version">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="998">get the version of the plugin</doc>
- <source-position filename="gst/gstplugin.h" line="348"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1004">the version of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1000">plugin to get the version of</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_loaded" c:identifier="gst_plugin_is_loaded">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1102">queries if the plugin is loaded into memory</doc>
- <source-position filename="gst/gstplugin.h" line="372"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1108">%TRUE is loaded, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1104">plugin to query</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="load" c:identifier="gst_plugin_load">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1355">Loads @plugin. Note that the *return value* is the loaded plugin; @plugin is
-untouched. The normal use pattern of this function goes like this:
-
-|[
-GstPlugin *loaded_plugin;
-loaded_plugin = gst_plugin_load (plugin);
-// presumably, we're no longer interested in the potentially-unloaded plugin
-gst_object_unref (plugin);
-plugin = loaded_plugin;
-]|</doc>
- <source-position filename="gst/gstplugin.h" line="378"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1370">a reference to a loaded plugin, or
-%NULL on error.</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1357">plugin to load</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_cache_data" c:identifier="gst_plugin_set_cache_data">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1136">Adds plugin specific data to cache. Passes the ownership of the structure to
-the @plugin.
-
-The cache is flushed every time the registry is rebuilt.</doc>
- <source-position filename="gst/gstplugin.h" line="369"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1138">a plugin</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </instance-parameter>
- <parameter name="cache_data" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstplugin.c"
- line="1139">a structure containing the data to cache</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- </class>
- <bitfield name="PluginAPIFlags"
- version="1.18"
- glib:type-name="GstPluginAPIFlags"
- glib:get-type="gst_plugin_api_flags_get_type"
- c:type="GstPluginAPIFlags">
- <member name="members"
- value="1"
- c:identifier="GST_PLUGIN_API_FLAG_IGNORE_ENUM_MEMBERS"
- glib:nick="members">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="1176">Ignore enum members when generating
- the plugins cache. This is useful if the members of the enum are generated
- dynamically, in order not to expose incorrect documentation to the end user.</doc>
- </member>
- </bitfield>
- <record name="PluginClass"
- c:type="GstPluginClass"
- disguised="1"
- glib:is-gtype-struct-for="Plugin">
- <source-position filename="gst/gstplugin.h" line="41"/>
- </record>
- <bitfield name="PluginDependencyFlags"
- glib:type-name="GstPluginDependencyFlags"
- glib:get-type="gst_plugin_dependency_flags_get_type"
- c:type="GstPluginDependencyFlags">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="89">Flags used in connection with gst_plugin_add_dependency().</doc>
- <member name="none"
- value="0"
- c:identifier="GST_PLUGIN_DEPENDENCY_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="91">no special flags</doc>
- </member>
- <member name="recurse"
- value="1"
- c:identifier="GST_PLUGIN_DEPENDENCY_FLAG_RECURSE"
- glib:nick="recurse">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="92">recurse into subdirectories</doc>
- </member>
- <member name="paths_are_default_only"
- value="2"
- c:identifier="GST_PLUGIN_DEPENDENCY_FLAG_PATHS_ARE_DEFAULT_ONLY"
- glib:nick="paths-are-default-only">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="93">use paths
- argument only if none of the environment variables is set</doc>
- </member>
- <member name="file_name_is_suffix"
- value="4"
- c:identifier="GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX"
- glib:nick="file-name-is-suffix">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="95">interpret
- filename argument as filter suffix and check all matching files in
- the directory</doc>
- </member>
- <member name="file_name_is_prefix"
- value="8"
- c:identifier="GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_PREFIX"
- glib:nick="file-name-is-prefix">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="98">interpret
- filename argument as filter prefix and check all matching files in
- the directory. Since: 1.8.</doc>
- </member>
- <member name="paths_are_relative_to_exe"
- value="16"
- c:identifier="GST_PLUGIN_DEPENDENCY_FLAG_PATHS_ARE_RELATIVE_TO_EXE"
- glib:nick="paths-are-relative-to-exe">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="101">interpret
- non-absolute paths as relative to the main executable directory. Since
- 1.14.</doc>
- </member>
- </bitfield>
- <record name="PluginDesc" c:type="GstPluginDesc">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="146">A plugin should export a variable of this type called plugin_desc. The plugin
-loader will use the data provided there to initialize the plugin.
-
-The @licence parameter must be one of: LGPL, GPL, QPL, GPL/QPL, MPL,
-BSD, MIT/X11, Proprietary, unknown.</doc>
- <source-position filename="gst/gstplugin.h" line="185"/>
- <field name="major_version" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="148">the major version number of core that plugin was compiled for</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="minor_version" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="149">the minor version number of core that plugin was compiled for</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="name" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="150">a unique name of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="description" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="151">description of plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="plugin_init" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="152">pointer to the init function of this plugin.</doc>
- <type name="PluginInitFunc" c:type="GstPluginInitFunc"/>
- </field>
- <field name="version" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="153">version of the plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="license" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="154">effective license of plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="source" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="155">source module plugin belongs to</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="package" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="156">shipped package plugin belongs to</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="origin" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="157">URL to provider of plugin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="release_datetime" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="158">date time string in ISO 8601
- format (or rather, a subset thereof), or %NULL. Allowed are the
- following formats: "YYYY-MM-DD" and "YYY-MM-DDTHH:MMZ" (with
- 'T' a separator and 'Z' indicating UTC/Zulu time). This field
- should be set via the GST_PACKAGE_RELEASE_DATETIME
- preprocessor macro.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <enumeration name="PluginError"
- glib:type-name="GstPluginError"
- glib:get-type="gst_plugin_error_get_type"
- c:type="GstPluginError"
- glib:error-domain="gst_plugin_error">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="61">The plugin loading errors</doc>
- <member name="module"
- value="0"
- c:identifier="GST_PLUGIN_ERROR_MODULE"
- glib:nick="module">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="63">The plugin could not be loaded</doc>
- </member>
- <member name="dependencies"
- value="1"
- c:identifier="GST_PLUGIN_ERROR_DEPENDENCIES"
- glib:nick="dependencies">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="64">The plugin has unresolved dependencies</doc>
- </member>
- <member name="name_mismatch"
- value="2"
- c:identifier="GST_PLUGIN_ERROR_NAME_MISMATCH"
- glib:nick="name-mismatch">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="65">The plugin has already be loaded from a different file</doc>
- </member>
- <function name="quark" c:identifier="gst_plugin_error_quark">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="44">Get the error quark.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="49">The error quark used in GError messages</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- </enumeration>
- <class name="PluginFeature"
- c:symbol-prefix="plugin_feature"
- c:type="GstPluginFeature"
- parent="Object"
- abstract="1"
- glib:type-name="GstPluginFeature"
- glib:get-type="gst_plugin_feature_get_type"
- glib:type-struct="PluginFeatureClass">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="23">This is a base class for anything that can be added to a #GstPlugin.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="47"/>
- <function name="list_copy" c:identifier="gst_plugin_feature_list_copy">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="248">Copies the list of features. Caller should call @gst_plugin_feature_list_free
-when done with the list.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="131"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="256">a copy of @list,
- with each feature's reference count incremented.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="PluginFeature"/>
- </type>
- </return-value>
- <parameters>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="250">list
- of #GstPluginFeature</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="PluginFeature"/>
- </type>
- </parameter>
- </parameters>
- </function>
- <function name="list_debug" c:identifier="gst_plugin_feature_list_debug">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="285">Debug the plugin feature names in @list.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="134"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="287">a #GList of
- plugin features</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="PluginFeature"/>
- </type>
- </parameter>
- </parameters>
- </function>
- <function name="list_free" c:identifier="gst_plugin_feature_list_free">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="228">Unrefs each member of @list, then frees the list.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="128"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="list" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="230">list
- of #GstPluginFeature</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="PluginFeature"/>
- </type>
- </parameter>
- </parameters>
- </function>
- <function name="rank_compare_func"
- c:identifier="gst_plugin_feature_rank_compare_func">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="378">Compares the two given #GstPluginFeature instances. This function can be
-used as a #GCompareFunc when sorting by rank and then by name.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="155"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="386">negative value if the rank of p1 &gt; the rank of p2 or the ranks are
-equal but the name of p1 comes before the name of p2; zero if the rank
-and names are equal; positive value if the rank of p1 &lt; the rank of p2 or the
-ranks are equal but the name of p2 comes before the name of p1</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="p1"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="380">a #GstPluginFeature</doc>
- <type name="gpointer" c:type="gconstpointer"/>
- </parameter>
- <parameter name="p2"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="381">a #GstPluginFeature</doc>
- <type name="gpointer" c:type="gconstpointer"/>
- </parameter>
- </parameters>
- </function>
- <method name="check_version"
- c:identifier="gst_plugin_feature_check_version">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="304">Checks whether the given plugin feature is at least
- the required version</doc>
- <source-position filename="gst/gstpluginfeature.h" line="150"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="314">%TRUE if the plugin feature has at least
- the required version, otherwise %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="306">a feature</doc>
- <type name="PluginFeature" c:type="GstPluginFeature*"/>
- </instance-parameter>
- <parameter name="min_major" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="307">minimum required major version</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="min_minor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="308">minimum required minor version</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="min_micro" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="309">minimum required micro version</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_plugin" c:identifier="gst_plugin_feature_get_plugin">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="184">Get the plugin that provides this feature.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="122"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="190">the plugin that provides this
- feature, or %NULL. Unref with gst_object_unref() when no
- longer needed.</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </return-value>
- <parameters>
- <instance-parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="186">a feature</doc>
- <type name="PluginFeature" c:type="GstPluginFeature*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_plugin_name"
- c:identifier="gst_plugin_feature_get_plugin_name"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="205">Get the name of the plugin that provides this feature.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="125"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="211">the name of the plugin that provides this
- feature, or %NULL if the feature is not associated with a
- plugin.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="207">a feature</doc>
- <type name="PluginFeature" c:type="GstPluginFeature*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_rank" c:identifier="gst_plugin_feature_get_rank">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="168">Gets the rank of a plugin feature.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="119"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="174">The rank of the feature</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="170">a feature</doc>
- <type name="PluginFeature" c:type="GstPluginFeature*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="load" c:identifier="gst_plugin_feature_load">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="77">Loads the plugin containing @feature if it's not already loaded. @feature is
-unaffected; use the return value instead.
-
-Normally this function is used like this:
-|[&lt;!-- language="C" --&gt;
-GstPluginFeature *loaded_feature;
-
-loaded_feature = gst_plugin_feature_load (feature);
-// presumably, we're no longer interested in the potentially-unloaded feature
-gst_object_unref (feature);
-feature = loaded_feature;
-]|</doc>
- <source-position filename="gst/gstpluginfeature.h" line="113"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="94">a reference to the loaded
-feature, or %NULL on error</doc>
- <type name="PluginFeature" c:type="GstPluginFeature*"/>
- </return-value>
- <parameters>
- <instance-parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="79">the plugin feature to check</doc>
- <type name="PluginFeature" c:type="GstPluginFeature*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_rank" c:identifier="gst_plugin_feature_set_rank">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="151">Specifies a rank for a plugin feature, so that autoplugging uses
-the most appropriate feature.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="116"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="153">feature to rank</doc>
- <type name="PluginFeature" c:type="GstPluginFeature*"/>
- </instance-parameter>
- <parameter name="rank" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.c"
- line="154">rank value - higher number means more priority rank</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- </class>
- <record name="PluginFeatureClass"
- c:type="GstPluginFeatureClass"
- disguised="1"
- glib:is-gtype-struct-for="PluginFeature">
- <source-position filename="gst/gstpluginfeature.h" line="47"/>
- </record>
- <callback name="PluginFeatureFilter" c:type="GstPluginFeatureFilter">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="92">A function that can be used with e.g. gst_registry_feature_filter()
-to get a list of pluginfeature that match certain criteria.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="103"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="101">%TRUE for a positive match, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="94">the pluginfeature to check</doc>
- <type name="PluginFeature" c:type="GstPluginFeature*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="95">the user_data that has been passed on e.g.
- gst_registry_feature_filter()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="PluginFilter" c:type="GstPluginFilter">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="299">A function that can be used with e.g. gst_registry_plugin_filter()
-to get a list of plugins that match certain criteria.</doc>
- <source-position filename="gst/gstplugin.h" line="309"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="307">%TRUE for a positive match, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="301">the plugin to check</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="302">the user_data that has been passed on e.g. gst_registry_plugin_filter()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <bitfield name="PluginFlags"
- glib:type-name="GstPluginFlags"
- glib:get-type="gst_plugin_flags_get_type"
- c:type="GstPluginFlags">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="76">The plugin loading state</doc>
- <member name="cached"
- value="16"
- c:identifier="GST_PLUGIN_FLAG_CACHED"
- glib:nick="cached">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="78">Temporarily loaded plugins</doc>
- </member>
- <member name="blacklisted"
- value="32"
- c:identifier="GST_PLUGIN_FLAG_BLACKLISTED"
- glib:nick="blacklisted">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="79">The plugin won't be scanned (again)</doc>
- </member>
- </bitfield>
- <callback name="PluginInitFullFunc" c:type="GstPluginInitFullFunc">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="130">A plugin should provide a pointer to a function of either #GstPluginInitFunc
-or this type in the plugin_desc struct.
-The function will be called by the loader at startup. One would then
-register each #GstPluginFeature. This version allows
-user data to be passed to init function (useful for bindings).</doc>
- <source-position filename="gst/gstplugin.h" line="144"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="141">%TRUE if plugin initialised successfully</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="132">The plugin object</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="133">extra data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="PluginInitFunc" c:type="GstPluginInitFunc">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="116">A plugin should provide a pointer to a function of this type in the
-plugin_desc struct.
-This function will be called by the loader at startup. One would then
-register each #GstPluginFeature.</doc>
- <source-position filename="gst/gstplugin.h" line="128"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="125">%TRUE if plugin initialised successfully</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="118">The plugin object</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="Poll" c:type="GstPoll" disguised="1">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="24">A #GstPoll keeps track of file descriptors much like fd_set (used with
-select ()) or a struct pollfd array (used with poll ()). Once created with
-gst_poll_new(), the set can be used to wait for file descriptors to be
-readable and/or writable. It is possible to make this wait be controlled
-by specifying %TRUE for the @controllable flag when creating the set (or
-later calling gst_poll_set_controllable()).
-
-New file descriptors are added to the set using gst_poll_add_fd(), and
-removed using gst_poll_remove_fd(). Controlling which file descriptors
-should be waited for to become readable and/or writable are done using
-gst_poll_fd_ctl_read(), gst_poll_fd_ctl_write() and gst_poll_fd_ctl_pri().
-
-Use gst_poll_wait() to wait for the file descriptors to actually become
-readable and/or writable, or to timeout if no file descriptor is available
-in time. The wait can be controlled by calling gst_poll_restart() and
-gst_poll_set_flushing().
-
-Once the file descriptor set has been waited for, one can use
-gst_poll_fd_has_closed() to see if the file descriptor has been closed,
-gst_poll_fd_has_error() to see if it has generated an error,
-gst_poll_fd_can_read() to see if it is possible to read from the file
-descriptor, and gst_poll_fd_can_write() to see if it is possible to
-write to it.</doc>
- <source-position filename="gst/gstpoll.h" line="39"/>
- <method name="add_fd" c:identifier="gst_poll_add_fd">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="885">Add a file descriptor to the file descriptor set.</doc>
- <source-position filename="gst/gstpoll.h" line="80"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="892">%TRUE if the file descriptor was successfully added to the set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="887">a file descriptor set.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- <parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="888">a file descriptor.</doc>
- <type name="PollFD" c:type="GstPollFD*"/>
- </parameter>
- </parameters>
- </method>
- <method name="fd_can_read" c:identifier="gst_poll_fd_can_read">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1271">Check if @fd in @set has data to be read.</doc>
- <source-position filename="gst/gstpoll.h" line="104"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1278">%TRUE if the descriptor has data to be read.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1273">a file descriptor set.</doc>
- <type name="Poll" c:type="const GstPoll*"/>
- </instance-parameter>
- <parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1274">a file descriptor.</doc>
- <type name="PollFD" c:type="GstPollFD*"/>
- </parameter>
- </parameters>
- </method>
- <method name="fd_can_write" c:identifier="gst_poll_fd_can_write">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1298">Check if @fd in @set can be used for writing.</doc>
- <source-position filename="gst/gstpoll.h" line="107"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1305">%TRUE if the descriptor can be used for writing.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1300">a file descriptor set.</doc>
- <type name="Poll" c:type="const GstPoll*"/>
- </instance-parameter>
- <parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1301">a file descriptor.</doc>
- <type name="PollFD" c:type="GstPollFD*"/>
- </parameter>
- </parameters>
- </method>
- <method name="fd_ctl_pri"
- c:identifier="gst_poll_fd_ctl_pri"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1067">Control whether the descriptor @fd in @set will be monitored for
-exceptional conditions (POLLPRI).
-
-Not implemented on Windows (will just return %FALSE there).</doc>
- <source-position filename="gst/gstpoll.h" line="92"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1078">%TRUE if the descriptor was successfully updated.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1069">a file descriptor set.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- <parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1070">a file descriptor.</doc>
- <type name="PollFD" c:type="GstPollFD*"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1071">a new status.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="fd_ctl_read" c:identifier="gst_poll_fd_ctl_read">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1038">Control whether the descriptor @fd in @set will be monitored for
-readability.</doc>
- <source-position filename="gst/gstpoll.h" line="89"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1047">%TRUE if the descriptor was successfully updated.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1040">a file descriptor set.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- <parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1041">a file descriptor.</doc>
- <type name="PollFD" c:type="GstPollFD*"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1042">a new status.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="fd_ctl_write" c:identifier="gst_poll_fd_ctl_write">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="959">Control whether the descriptor @fd in @set will be monitored for
-writability.</doc>
- <source-position filename="gst/gstpoll.h" line="86"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="968">%TRUE if the descriptor was successfully updated.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="961">a file descriptor set.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- <parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="962">a file descriptor.</doc>
- <type name="PollFD" c:type="GstPollFD*"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="963">a new status.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="fd_has_closed" c:identifier="gst_poll_fd_has_closed">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1158">Check if @fd in @set has closed the connection.</doc>
- <source-position filename="gst/gstpoll.h" line="98"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1165">%TRUE if the connection was closed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1160">a file descriptor set.</doc>
- <type name="Poll" c:type="const GstPoll*"/>
- </instance-parameter>
- <parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1161">a file descriptor.</doc>
- <type name="PollFD" c:type="GstPollFD*"/>
- </parameter>
- </parameters>
- </method>
- <method name="fd_has_error" c:identifier="gst_poll_fd_has_error">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1200">Check if @fd in @set has an error.</doc>
- <source-position filename="gst/gstpoll.h" line="101"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1207">%TRUE if the descriptor has an error.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1202">a file descriptor set.</doc>
- <type name="Poll" c:type="const GstPoll*"/>
- </instance-parameter>
- <parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1203">a file descriptor.</doc>
- <type name="PollFD" c:type="GstPollFD*"/>
- </parameter>
- </parameters>
- </method>
- <method name="fd_has_pri"
- c:identifier="gst_poll_fd_has_pri"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1340">Check if @fd in @set has an exceptional condition (POLLPRI).
-
-Not implemented on Windows (will just return %FALSE there).</doc>
- <source-position filename="gst/gstpoll.h" line="110"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1349">%TRUE if the descriptor has an exceptional condition.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1342">a file descriptor set.</doc>
- <type name="Poll" c:type="const GstPoll*"/>
- </instance-parameter>
- <parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1343">a file descriptor.</doc>
- <type name="PollFD" c:type="GstPollFD*"/>
- </parameter>
- </parameters>
- </method>
- <method name="fd_ignored" c:identifier="gst_poll_fd_ignored">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1120">Mark @fd as ignored so that the next call to gst_poll_wait() will yield
-the same result for @fd as last time. This function must be called if no
-operation (read/write/recv/send/etc.) will be performed on @fd before
-the next call to gst_poll_wait().
-
-The reason why this is needed is because the underlying implementation
-might not allow querying the fd more than once between calls to one of
-the re-enabling operations.</doc>
- <source-position filename="gst/gstpoll.h" line="95"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1122">a file descriptor set.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- <parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1123">a file descriptor.</doc>
- <type name="PollFD" c:type="GstPollFD*"/>
- </parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_poll_free">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="761">Free a file descriptor set.</doc>
- <source-position filename="gst/gstpoll.h" line="71"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="763">a file descriptor set.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_read_gpollfd" c:identifier="gst_poll_get_read_gpollfd">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="800">Get a GPollFD for the reading part of the control socket. This is useful when
-integrating with a GSource and GMainLoop.</doc>
- <source-position filename="gst/gstpoll.h" line="74"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="802">a #GstPoll</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- <parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="803">a #GPollFD</doc>
- <type name="GLib.PollFD" c:type="GPollFD*"/>
- </parameter>
- </parameters>
- </method>
- <method name="read_control" c:identifier="gst_poll_read_control">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1764">Read a byte from the control socket of the controllable @set.
-
-This function only works for timer #GstPoll objects created with
-gst_poll_new_timer().</doc>
- <source-position filename="gst/gstpoll.h" line="128"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1773">%TRUE on success. %FALSE when when there was no byte to read or
-reading the byte failed. If there was no byte to read, and only then, errno
-will contain EWOULDBLOCK or EAGAIN. For all other values of errno this always signals a
-critical error.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1766">a #GstPoll.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_fd" c:identifier="gst_poll_remove_fd">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="912">Remove a file descriptor from the file descriptor set.</doc>
- <source-position filename="gst/gstpoll.h" line="83"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="919">%TRUE if the file descriptor was successfully removed from the set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="914">a file descriptor set.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- <parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="915">a file descriptor.</doc>
- <type name="PollFD" c:type="GstPollFD*"/>
- </parameter>
- </parameters>
- </method>
- <method name="restart" c:identifier="gst_poll_restart">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1674">Restart any gst_poll_wait() that is in progress. This function is typically
-used after adding or removing descriptors to @set.
-
-If @set is not controllable, then this call will have no effect.
-
-This function only works for non-timer #GstPoll objects created with
-gst_poll_new().</doc>
- <source-position filename="gst/gstpoll.h" line="119"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1676">a #GstPoll.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_controllable" c:identifier="gst_poll_set_controllable">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1647">When @controllable is %TRUE, this function ensures that future calls to
-gst_poll_wait() will be affected by gst_poll_restart() and
-gst_poll_set_flushing().
-
-This function only works for non-timer #GstPoll objects created with
-gst_poll_new().</doc>
- <source-position filename="gst/gstpoll.h" line="116"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1659">%TRUE if the controllability of @set could be updated.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1649">a #GstPoll.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- <parameter name="controllable" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1650">new controllable state.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_flushing" c:identifier="gst_poll_set_flushing">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1699">When @flushing is %TRUE, this function ensures that current and future calls
-to gst_poll_wait() will return -1, with errno set to EBUSY.
-
-Unsetting the flushing state will restore normal operation of @set.
-
-This function only works for non-timer #GstPoll objects created with
-gst_poll_new().</doc>
- <source-position filename="gst/gstpoll.h" line="122"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1701">a #GstPoll.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- <parameter name="flushing" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1702">new flushing state.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="wait" c:identifier="gst_poll_wait">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1384">Wait for activity on the file descriptors in @set. This function waits up to
-the specified @timeout. A timeout of #GST_CLOCK_TIME_NONE waits forever.
-
-For #GstPoll objects created with gst_poll_new(), this function can only be
-called from a single thread at a time. If called from multiple threads,
--1 will be returned with errno set to EPERM.
-
-This is not true for timer #GstPoll objects created with
-gst_poll_new_timer(), where it is allowed to have multiple threads waiting
-simultaneously.</doc>
- <source-position filename="gst/gstpoll.h" line="113"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1400">The number of #GstPollFD in @set that have activity or 0 when no
-activity was detected after @timeout. If an error occurs, -1 is returned
-and errno is set.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1386">a #GstPoll.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1387">a timeout in nanoseconds.</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="write_control" c:identifier="gst_poll_write_control">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1731">Write a byte to the control socket of the controllable @set.
-This function is mostly useful for timer #GstPoll objects created with
-gst_poll_new_timer().
-
-It will make any current and future gst_poll_wait() function return with
-1, meaning the control socket is set. After an equal amount of calls to
-gst_poll_read_control() have been performed, calls to gst_poll_wait() will
-block again until their timeout expired.
-
-This function only works for timer #GstPoll objects created with
-gst_poll_new_timer().</doc>
- <source-position filename="gst/gstpoll.h" line="125"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1747">%TRUE on success. %FALSE when when the byte could not be written.
-errno contains the detailed error code but will never be EAGAIN, EINTR or
-EWOULDBLOCK. %FALSE always signals a critical error.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="set" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="1733">a #GstPoll.</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="new" c:identifier="gst_poll_new" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="662">Create a new file descriptor set. If @controllable, it
-is possible to restart or flush a call to gst_poll_wait() with
-gst_poll_restart() and gst_poll_set_flushing() respectively.
-
-Free-function: gst_poll_free</doc>
- <source-position filename="gst/gstpoll.h" line="65"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="672">a new #GstPoll, or %NULL in
- case of an error. Free with gst_poll_free().</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </return-value>
- <parameters>
- <parameter name="controllable" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="664">whether it should be possible to control a wait.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_timer"
- c:identifier="gst_poll_new_timer"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="731">Create a new poll object that can be used for scheduling cancellable
-timeouts.
-
-A timeout is performed with gst_poll_wait(). Multiple timeouts can be
-performed from different threads.
-
-Free-function: gst_poll_free</doc>
- <source-position filename="gst/gstpoll.h" line="68"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="742">a new #GstPoll, or %NULL in
- case of an error. Free with gst_poll_free().</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </return-value>
- </function>
- </record>
- <record name="PollFD" c:type="GstPollFD">
- <doc xml:space="preserve"
- filename="gst/gstpoll.h"
- line="41">A file descriptor object.</doc>
- <source-position filename="gst/gstpoll.h" line="52"/>
- <field name="fd" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstpoll.h"
- line="43">a file descriptor</doc>
- <type name="gint" c:type="int"/>
- </field>
- <field name="idx" readable="0" private="1">
- <type name="gint" c:type="gint"/>
- </field>
- <method name="init" c:identifier="gst_poll_fd_init">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="827">Initializes @fd. Alternatively you can initialize it with
-#GST_POLL_FD_INIT.</doc>
- <source-position filename="gst/gstpoll.h" line="77"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="fd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="829">a #GstPollFD</doc>
- <type name="PollFD" c:type="GstPollFD*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <interface name="Preset"
- c:symbol-prefix="preset"
- c:type="GstPreset"
- glib:type-name="GstPreset"
- glib:get-type="gst_preset_get_type"
- glib:type-struct="PresetInterface">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="21">This interface offers methods to query and manipulate parameter preset sets.
-A preset is a bunch of property settings, together with meta data and a name.
-The name of a preset serves as key for subsequent method calls to manipulate
-single presets.
-All instances of one type will share the list of presets. The list is created
-on demand, if presets are not used, the list is not created.
-
-The interface comes with a default implementation that serves most plugins.
-Wrapper plugins will override most methods to implement support for the
-native preset format of those wrapped plugins.
-One method that is useful to be overridden is gst_preset_get_property_names().
-With that one can control which properties are saved and in which order.
-When implementing support for read-only presets, one should set the vmethods
-for gst_preset_save_preset() and gst_preset_delete_preset() to %NULL.
-Applications can use gst_preset_is_editable() to check for that.
-
-The default implementation supports presets located in a system directory,
-application specific directory and in the users home directory. When getting
-a list of presets individual presets are read and overlaid in 1) system,
-2) application and 3) user order. Whenever an earlier entry is newer, the
-later entries will be updated. Since 1.8 you can also provide extra paths
-where to find presets through the GST_PRESET_PATH environment variable.
-Presets found in those paths will be considered as "app presets".</doc>
- <source-position filename="gst/gstpreset.h" line="78"/>
- <function name="get_app_dir" c:identifier="gst_preset_get_app_dir">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1234">Gets the directory for application specific presets if set by the
-application.</doc>
- <source-position filename="gst/gstpreset.h" line="111"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1240">the directory or %NULL, don't free or modify
-the string</doc>
- <type name="filename" c:type="const gchar*"/>
- </return-value>
- </function>
- <function name="set_app_dir" c:identifier="gst_preset_set_app_dir">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1212">Sets an extra directory as an absolute path that should be considered when
-looking for presets. Any presets in the application dir will shadow the
-system presets.</doc>
- <source-position filename="gst/gstpreset.h" line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1220">%TRUE for success, %FALSE if the dir already has been set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="app_dir" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1214">the application specific preset dir</doc>
- <type name="filename" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="delete_preset" invoker="delete_preset">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1145">Delete the given preset.</doc>
- <source-position filename="gst/gstpreset.h" line="70"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1152">%TRUE for success, %FALSE if e.g. there is no preset with that @name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1147">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1148">preset name to remove</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_meta" invoker="get_meta">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1187">Gets the @value for an existing meta data @tag. Meta data @tag names can be
-something like e.g. "comment". Returned values need to be released when done.</doc>
- <source-position filename="gst/gstpreset.h" line="74"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1197">%TRUE for success, %FALSE if e.g. there is no preset with that @name
-or no value for the given @tag</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1189">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1190">preset name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1191">meta data item name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1192">value</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_preset_names" invoker="get_preset_names">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1051">Get a copy of preset names as a %NULL terminated string array.</doc>
- <source-position filename="gst/gstpreset.h" line="62"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1057">
- list with names, use g_strfreev() after usage.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1053">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_property_names" invoker="get_property_names">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1068">Get a the names of the GObject properties that can be used for presets.</doc>
- <source-position filename="gst/gstpreset.h" line="64"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1074">an
- array of property names which should be freed with g_strfreev() after use.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1070">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="load_preset" invoker="load_preset">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1085">Load the given preset.</doc>
- <source-position filename="gst/gstpreset.h" line="66"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1092">%TRUE for success, %FALSE if e.g. there is no preset with that @name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1087">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1088">preset name to load</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="rename_preset" invoker="rename_preset">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1122">Renames a preset. If there is already a preset by the @new_name it will be
-overwritten.</doc>
- <source-position filename="gst/gstpreset.h" line="68"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1131">%TRUE for success, %FALSE if e.g. there is no preset with @old_name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1124">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- <parameter name="old_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1125">current preset name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="new_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1126">new preset name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="save_preset" invoker="save_preset">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1103">Save the current object settings as a preset under the given name. If there
-is already a preset by this @name it will be overwritten.</doc>
- <source-position filename="gst/gstpreset.h" line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1111">%TRUE for success, %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1105">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1106">preset name to save</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_meta" invoker="set_meta">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1163">Sets a new @value for an existing meta data item or adds a new item. Meta
-data @tag names can be something like e.g. "comment". Supplying %NULL for the
-@value will unset an existing value.</doc>
- <source-position filename="gst/gstpreset.h" line="72"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1174">%TRUE for success, %FALSE if e.g. there is no preset with that @name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1165">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1166">preset name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1167">meta data item name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1168">new value</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="delete_preset" c:identifier="gst_preset_delete_preset">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1145">Delete the given preset.</doc>
- <source-position filename="gst/gstpreset.h" line="99"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1152">%TRUE for success, %FALSE if e.g. there is no preset with that @name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1147">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1148">preset name to remove</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_meta" c:identifier="gst_preset_get_meta">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1187">Gets the @value for an existing meta data @tag. Meta data @tag names can be
-something like e.g. "comment". Returned values need to be released when done.</doc>
- <source-position filename="gst/gstpreset.h" line="105"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1197">%TRUE for success, %FALSE if e.g. there is no preset with that @name
-or no value for the given @tag</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1189">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1190">preset name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1191">meta data item name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1192">value</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_preset_names"
- c:identifier="gst_preset_get_preset_names">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1051">Get a copy of preset names as a %NULL terminated string array.</doc>
- <source-position filename="gst/gstpreset.h" line="84"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1057">
- list with names, use g_strfreev() after usage.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1053">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_property_names"
- c:identifier="gst_preset_get_property_names">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1068">Get a the names of the GObject properties that can be used for presets.</doc>
- <source-position filename="gst/gstpreset.h" line="87"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1074">an
- array of property names which should be freed with g_strfreev() after use.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1070">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_editable"
- c:identifier="gst_preset_is_editable"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1249">Check if one can add new presets, change existing ones and remove presets.</doc>
- <source-position filename="gst/gstpreset.h" line="114"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1255">%TRUE if presets are editable or %FALSE if they are static</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1251">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="load_preset" c:identifier="gst_preset_load_preset">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1085">Load the given preset.</doc>
- <source-position filename="gst/gstpreset.h" line="90"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1092">%TRUE for success, %FALSE if e.g. there is no preset with that @name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1087">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1088">preset name to load</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="rename_preset" c:identifier="gst_preset_rename_preset">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1122">Renames a preset. If there is already a preset by the @new_name it will be
-overwritten.</doc>
- <source-position filename="gst/gstpreset.h" line="96"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1131">%TRUE for success, %FALSE if e.g. there is no preset with @old_name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1124">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- <parameter name="old_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1125">current preset name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="new_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1126">new preset name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="save_preset" c:identifier="gst_preset_save_preset">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1103">Save the current object settings as a preset under the given name. If there
-is already a preset by this @name it will be overwritten.</doc>
- <source-position filename="gst/gstpreset.h" line="93"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1111">%TRUE for success, %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1105">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1106">preset name to save</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_meta" c:identifier="gst_preset_set_meta">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1163">Sets a new @value for an existing meta data item or adds a new item. Meta
-data @tag names can be something like e.g. "comment". Supplying %NULL for the
-@value will unset an existing value.</doc>
- <source-position filename="gst/gstpreset.h" line="102"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1174">%TRUE for success, %FALSE if e.g. there is no preset with that @name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1165">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1166">preset name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1167">meta data item name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1168">new value</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- </interface>
- <record name="PresetInterface"
- c:type="GstPresetInterface"
- glib:is-gtype-struct-for="Preset">
- <doc xml:space="preserve"
- filename="gst/gstpreset.h"
- line="43">#GstPreset interface.</doc>
- <source-position filename="gst/gstpreset.h" line="78"/>
- <field name="parent">
- <doc xml:space="preserve"
- filename="gst/gstpreset.h"
- line="45">parent interface type.</doc>
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- <field name="get_preset_names">
- <callback name="get_preset_names">
- <source-position filename="gst/gstpreset.h" line="62"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1057">
- list with names, use g_strfreev() after usage.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1053">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_property_names">
- <callback name="get_property_names">
- <source-position filename="gst/gstpreset.h" line="64"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1074">an
- array of property names which should be freed with g_strfreev() after use.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1070">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="load_preset">
- <callback name="load_preset">
- <source-position filename="gst/gstpreset.h" line="66"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1092">%TRUE for success, %FALSE if e.g. there is no preset with that @name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1087">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1088">preset name to load</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="save_preset">
- <callback name="save_preset">
- <source-position filename="gst/gstpreset.h" line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1111">%TRUE for success, %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1105">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1106">preset name to save</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="rename_preset">
- <callback name="rename_preset">
- <source-position filename="gst/gstpreset.h" line="68"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1131">%TRUE for success, %FALSE if e.g. there is no preset with @old_name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1124">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </parameter>
- <parameter name="old_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1125">current preset name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="new_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1126">new preset name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="delete_preset">
- <callback name="delete_preset">
- <source-position filename="gst/gstpreset.h" line="70"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1152">%TRUE for success, %FALSE if e.g. there is no preset with that @name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1147">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1148">preset name to remove</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_meta">
- <callback name="set_meta">
- <source-position filename="gst/gstpreset.h" line="72"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1174">%TRUE for success, %FALSE if e.g. there is no preset with that @name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1165">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1166">preset name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1167">meta data item name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1168">new value</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_meta">
- <callback name="get_meta">
- <source-position filename="gst/gstpreset.h" line="74"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1197">%TRUE for success, %FALSE if e.g. there is no preset with that @name
-or no value for the given @tag</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="preset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1189">a #GObject that implements #GstPreset</doc>
- <type name="Preset" c:type="GstPreset*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1190">preset name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1191">meta data item name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1192">value</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <enumeration name="ProgressType"
- glib:type-name="GstProgressType"
- glib:get-type="gst_progress_type_get_type"
- c:type="GstProgressType">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="307">The type of a %GST_MESSAGE_PROGRESS. The progress messages inform the
-application of the status of asynchronous tasks.</doc>
- <member name="start"
- value="0"
- c:identifier="GST_PROGRESS_TYPE_START"
- glib:nick="start">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="309">A new task started.</doc>
- </member>
- <member name="continue"
- value="1"
- c:identifier="GST_PROGRESS_TYPE_CONTINUE"
- glib:nick="continue">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="310">A task completed and a new one continues.</doc>
- </member>
- <member name="complete"
- value="2"
- c:identifier="GST_PROGRESS_TYPE_COMPLETE"
- glib:nick="complete">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="311">A task completed.</doc>
- </member>
- <member name="canceled"
- value="3"
- c:identifier="GST_PROGRESS_TYPE_CANCELED"
- glib:nick="canceled">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="312">A task was canceled.</doc>
- </member>
- <member name="error"
- value="4"
- c:identifier="GST_PROGRESS_TYPE_ERROR"
- glib:nick="error">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="313">A task caused an error. An error message is also
- posted on the bus.</doc>
- </member>
- </enumeration>
- <record name="Promise"
- c:type="GstPromise"
- version="1.14"
- glib:type-name="GstPromise"
- glib:get-type="gst_promise_get_type"
- c:symbol-prefix="promise">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="31">The #GstPromise object implements the container for values that may
-be available later. i.e. a Future or a Promise in
-&lt;https://en.wikipedia.org/wiki/Futures_and_promises&gt;.
-As with all Future/Promise-like functionality, there is the concept of the
-producer of the value and the consumer of the value.
-
-A #GstPromise is created with gst_promise_new() by the consumer and passed
-to the producer to avoid thread safety issues with the change callback.
-A #GstPromise can be replied to with a value (or an error) by the producer
-with gst_promise_reply(). The exact value returned is defined by the API
-contract of the producer and %NULL may be a valid reply.
-gst_promise_interrupt() is for the consumer to
-indicate to the producer that the value is not needed anymore and producing
-that value can stop. The @GST_PROMISE_RESULT_EXPIRED state set by a call
-to gst_promise_expire() indicates to the consumer that a value will never
-be produced and is intended to be called by a third party that implements
-some notion of message handling such as #GstBus.
-A callback can also be installed at #GstPromise creation for
-result changes with gst_promise_new_with_change_func().
-The change callback can be used to chain #GstPromises's together as in the
-following example.
-|[&lt;!-- language="C" --&gt;
-const GstStructure *reply;
-GstPromise *p;
-if (gst_promise_wait (promise) != GST_PROMISE_RESULT_REPLIED)
- return; // interrupted or expired value
-reply = gst_promise_get_reply (promise);
-if (error in reply)
- return; // propagate error
-p = gst_promise_new_with_change_func (another_promise_change_func, user_data, notify);
-pass p to promise-using API
-]|
-
-Each #GstPromise starts out with a #GstPromiseResult of
-%GST_PROMISE_RESULT_PENDING and only ever transitions once
-into one of the other #GstPromiseResult's.
-
-In order to support multi-threaded code, gst_promise_reply(),
-gst_promise_interrupt() and gst_promise_expire() may all be from
-different threads with some restrictions and the final result of the promise
-is whichever call is made first. There are two restrictions on ordering:
-
-1. That gst_promise_reply() and gst_promise_interrupt() cannot be called
-after gst_promise_expire()
-2. That gst_promise_reply() and gst_promise_interrupt()
-cannot be called twice.
-
-The change function set with gst_promise_new_with_change_func() is
-called directly from either the gst_promise_reply(),
-gst_promise_interrupt() or gst_promise_expire() and can be called
-from an arbitrary thread. #GstPromise using APIs can restrict this to
-a single thread or a subset of threads but that is entirely up to the API
-that uses #GstPromise.</doc>
- <source-position filename="gst/gstpromise.h" line="74"/>
- <field name="parent" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstpromise.h"
- line="67">parent #GstMiniObject</doc>
- <type name="MiniObject" c:type="GstMiniObject"/>
- </field>
- <constructor name="new" c:identifier="gst_promise_new" version="1.14">
- <source-position filename="gst/gstpromise.h" line="77"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="368">a new #GstPromise</doc>
- <type name="Promise" c:type="GstPromise*"/>
- </return-value>
- </constructor>
- <constructor name="new_with_change_func"
- c:identifier="gst_promise_new_with_change_func"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="383">@func will be called exactly once when transitioning out of
-%GST_PROMISE_RESULT_PENDING into any of the other #GstPromiseResult
-states.</doc>
- <source-position filename="gst/gstpromise.h" line="79"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="393">a new #GstPromise</doc>
- <type name="Promise" c:type="GstPromise*"/>
- </return-value>
- <parameters>
- <parameter name="func"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="385">a #GstPromiseChangeFunc to call</doc>
- <type name="PromiseChangeFunc" c:type="GstPromiseChangeFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="386">argument to call @func with</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="387">notification function that @user_data is no longer needed</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="expire" c:identifier="gst_promise_expire" version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="285">Expire a @promise. This will wake up any waiters with
-%GST_PROMISE_RESULT_EXPIRED. Called by a message loop when the parent
-message is handled and/or destroyed (possibly unanswered).</doc>
- <source-position filename="gst/gstpromise.h" line="91"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="promise" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="287">a #GstPromise</doc>
- <type name="Promise" c:type="GstPromise*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_reply"
- c:identifier="gst_promise_get_reply"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="216">Retrieve the reply set on @promise. @promise must be in
-%GST_PROMISE_RESULT_REPLIED and the returned structure is owned by @promise</doc>
- <source-position filename="gst/gstpromise.h" line="94"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="223">The reply set on @promise</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="promise" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="218">a #GstPromise</doc>
- <type name="Promise" c:type="GstPromise*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="interrupt"
- c:identifier="gst_promise_interrupt"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="244">Interrupt waiting for a @promise. This will wake up any waiters with
-%GST_PROMISE_RESULT_INTERRUPTED. Called when the consumer does not want
-the value produced anymore.</doc>
- <source-position filename="gst/gstpromise.h" line="89"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="promise" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="246">a #GstPromise</doc>
- <type name="Promise" c:type="GstPromise*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reply" c:identifier="gst_promise_reply" version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="149">Set a reply on @promise. This will wake up any waiters with
-%GST_PROMISE_RESULT_REPLIED. Called by the producer of the value to
-indicate success (or failure).
-
-If @promise has already been interrupted by the consumer, then this reply
-is not visible to the consumer.</doc>
- <source-position filename="gst/gstpromise.h" line="86"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="promise"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="151">a #GstPromise</doc>
- <type name="Promise" c:type="GstPromise*"/>
- </instance-parameter>
- <parameter name="s"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="152">a #GstStructure with the the reply contents</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="wait" c:identifier="gst_promise_wait" version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="115">Wait for @promise to move out of the %GST_PROMISE_RESULT_PENDING state.
-If @promise is not in %GST_PROMISE_RESULT_PENDING then it will return
-immediately with the current result.</doc>
- <source-position filename="gst/gstpromise.h" line="84"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="123">the result of the promise</doc>
- <type name="PromiseResult" c:type="GstPromiseResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="promise" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpromise.c"
- line="117">a #GstPromise</doc>
- <type name="Promise" c:type="GstPromise*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <callback name="PromiseChangeFunc"
- c:type="GstPromiseChangeFunc"
- version="1.14">
- <source-position filename="gst/gstpromise.h" line="63"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="promise" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpromise.h"
- line="58">a #GstPromise</doc>
- <type name="Promise" c:type="GstPromise*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gstpromise.h"
- line="59">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <enumeration name="PromiseResult"
- version="1.14"
- glib:type-name="GstPromiseResult"
- glib:get-type="gst_promise_result_get_type"
- c:type="GstPromiseResult">
- <doc xml:space="preserve"
- filename="gst/gstpromise.h"
- line="34">The result of a #GstPromise</doc>
- <member name="pending"
- value="0"
- c:identifier="GST_PROMISE_RESULT_PENDING"
- glib:nick="pending">
- <doc xml:space="preserve"
- filename="gst/gstpromise.h"
- line="36">Initial state. Waiting for transition to any
- other state.</doc>
- </member>
- <member name="interrupted"
- value="1"
- c:identifier="GST_PROMISE_RESULT_INTERRUPTED"
- glib:nick="interrupted">
- <doc xml:space="preserve"
- filename="gst/gstpromise.h"
- line="38">Interrupted by the consumer as it doesn't
- want the value anymore.</doc>
- </member>
- <member name="replied"
- value="2"
- c:identifier="GST_PROMISE_RESULT_REPLIED"
- glib:nick="replied">
- <doc xml:space="preserve"
- filename="gst/gstpromise.h"
- line="40">A producer marked a reply</doc>
- </member>
- <member name="expired"
- value="3"
- c:identifier="GST_PROMISE_RESULT_EXPIRED"
- glib:nick="expired">
- <doc xml:space="preserve"
- filename="gst/gstpromise.h"
- line="41">The promise expired (the carrying object
- lost all refs) and the promise will never be fulfilled.</doc>
- </member>
- </enumeration>
- <record name="ProtectionMeta" c:type="GstProtectionMeta" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstprotection.h"
- line="56">Metadata type that holds information about a sample from a protection-protected
-track, including the information needed to decrypt it (if it is encrypted).</doc>
- <source-position filename="gst/gstprotection.h" line="71"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstprotection.h"
- line="58">the parent #GstMeta.</doc>
- <type name="Meta" c:type="GstMeta"/>
- </field>
- <field name="info" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstprotection.h"
- line="59">the cryptographic information needed to decrypt the sample.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </field>
- <function name="get_info" c:identifier="gst_protection_meta_get_info">
- <source-position filename="gst/gstprotection.h" line="87"/>
- <return-value transfer-ownership="none">
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <class name="ProxyPad"
- c:symbol-prefix="proxy_pad"
- c:type="GstProxyPad"
- parent="Pad"
- glib:type-name="GstProxyPad"
- glib:get-type="gst_proxy_pad_get_type"
- glib:type-struct="ProxyPadClass">
- <source-position filename="gst/gstghostpad.h" line="58"/>
- <function name="chain_default"
- c:identifier="gst_proxy_pad_chain_default">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="105">Invoke the default chain function of the proxy pad.</doc>
- <source-position filename="gst/gstghostpad.h" line="71"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="114">a #GstFlowReturn from the pad.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="107">a sink #GstPad, returns GST_FLOW_ERROR if not.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="108">the parent of @pad or %NULL</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="109">the #GstBuffer to send, return GST_FLOW_ERROR
- if not.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="chain_list_default"
- c:identifier="gst_proxy_pad_chain_list_default">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="133">Invoke the default chain list function of the proxy pad.</doc>
- <source-position filename="gst/gstghostpad.h" line="74"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="142">a #GstFlowReturn from the pad.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="135">a sink #GstPad, returns GST_FLOW_ERROR if not.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="136">the parent of @pad or %NULL</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="list" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="137">the #GstBufferList to send, return GST_FLOW_ERROR
- if not.</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </function>
- <function name="getrange_default"
- c:identifier="gst_proxy_pad_getrange_default">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="161">Invoke the default getrange function of the proxy pad.</doc>
- <source-position filename="gst/gstghostpad.h" line="77"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="172">a #GstFlowReturn from the pad.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="163">a src #GstPad, returns #GST_FLOW_ERROR if not.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="164">the parent of @pad</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="165">The start offset of the buffer</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="166">The length of the buffer</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="167">a pointer to hold the #GstBuffer,
- returns #GST_FLOW_ERROR if %NULL.</doc>
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </function>
- <function name="iterate_internal_links_default"
- c:identifier="gst_proxy_pad_iterate_internal_links_default">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="76">Invoke the default iterate internal links function of the proxy pad.</doc>
- <source-position filename="gst/gstghostpad.h" line="68"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="83">a #GstIterator of #GstPad, or %NULL if @pad
-has no parent. Unref each returned pad with gst_object_unref().</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="78">the #GstPad to get the internal links of.</doc>
- <type name="Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="79">the parent of @pad or %NULL</doc>
- <type name="Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </function>
- <method name="get_internal" c:identifier="gst_proxy_pad_get_internal">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="203">Get the internal pad of @pad. Unref target pad after usage.
-
-The internal pad of a #GstGhostPad is the internally used
-pad of opposite direction, which is used to link to the target.</doc>
- <source-position filename="gst/gstghostpad.h" line="64"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="212">the target #GstProxyPad, can
-be %NULL. Unref target pad after usage.</doc>
- <type name="ProxyPad" c:type="GstProxyPad*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstghostpad.c"
- line="205">the #GstProxyPad</doc>
- <type name="ProxyPad" c:type="GstProxyPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <field name="pad">
- <type name="Pad" c:type="GstPad"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="ProxyPadPrivate" c:type="GstProxyPadPrivate*"/>
- </field>
- </class>
- <record name="ProxyPadClass"
- c:type="GstProxyPadClass"
- glib:is-gtype-struct-for="ProxyPad">
- <source-position filename="gst/gstghostpad.h" line="58"/>
- <field name="parent_class">
- <type name="PadClass" c:type="GstPadClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="1">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="ProxyPadPrivate" c:type="GstProxyPadPrivate" disguised="1">
- <source-position filename="gst/gstghostpad.h" line="41"/>
- </record>
- <enumeration name="QOSType"
- glib:type-name="GstQOSType"
- glib:get-type="gst_qos_type_get_type"
- c:type="GstQOSType">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="386">The different types of QoS events that can be given to the
-gst_event_new_qos() method.</doc>
- <member name="overflow"
- value="0"
- c:identifier="GST_QOS_TYPE_OVERFLOW"
- glib:nick="overflow">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="388">The QoS event type that is produced when upstream
- elements are producing data too quickly and the element can't keep up
- processing the data. Upstream should reduce their production rate. This
- type is also used when buffers arrive early or in time.</doc>
- </member>
- <member name="underflow"
- value="1"
- c:identifier="GST_QOS_TYPE_UNDERFLOW"
- glib:nick="underflow">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="392">The QoS event type that is produced when upstream
- elements are producing data too slowly and need to speed up their
- production rate.</doc>
- </member>
- <member name="throttle"
- value="2"
- c:identifier="GST_QOS_TYPE_THROTTLE"
- glib:nick="throttle">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="395">The QoS event type that is produced when the
- application enabled throttling to limit the data rate.</doc>
- </member>
- </enumeration>
- <function-macro name="QUERY" c:identifier="GST_QUERY" introspectable="0">
- <source-position filename="gst/gstquery.h" line="136"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="QUERY_CAST"
- c:identifier="GST_QUERY_CAST"
- introspectable="0">
- <source-position filename="gst/gstquery.h" line="135"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="QUERY_IS_DOWNSTREAM"
- c:identifier="GST_QUERY_IS_DOWNSTREAM"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="162">Check if an query can travel downstream.</doc>
- <source-position filename="gst/gstquery.h" line="167"/>
- <parameters>
- <parameter name="ev">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="164">the query to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="QUERY_IS_SERIALIZED"
- c:identifier="GST_QUERY_IS_SERIALIZED"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="169">Check if an query is serialized with the data stream.</doc>
- <source-position filename="gst/gstquery.h" line="174"/>
- <parameters>
- <parameter name="ev">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="171">the query to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="QUERY_IS_UPSTREAM"
- c:identifier="GST_QUERY_IS_UPSTREAM"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="155">Check if an query can travel upstream.</doc>
- <source-position filename="gst/gstquery.h" line="160"/>
- <parameters>
- <parameter name="ev">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="157">the query to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="QUERY_MAKE_TYPE"
- c:identifier="GST_QUERY_MAKE_TYPE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="66">when making custom query types, use this macro with the num and
-the given flags</doc>
- <source-position filename="gst/gstquery.h" line="73"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="68">the query number to create</doc>
- </parameter>
- <parameter name="flags">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="69">the query flags</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="QUERY_NUM_SHIFT" value="8" c:type="GST_QUERY_NUM_SHIFT">
- <source-position filename="gst/gstquery.h" line="63"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="QUERY_TYPE"
- c:identifier="GST_QUERY_TYPE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="139">Get the #GstQueryType of the query.</doc>
- <source-position filename="gst/gstquery.h" line="144"/>
- <parameters>
- <parameter name="query">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="141">the query to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="QUERY_TYPE_BOTH" value="3" c:type="GST_QUERY_TYPE_BOTH">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="56">The same thing as #GST_QUERY_TYPE_UPSTREAM | #GST_QUERY_TYPE_DOWNSTREAM.</doc>
- <source-position filename="gst/gstquery.h" line="61"/>
- <type name="QueryTypeFlags" c:type="GstQueryTypeFlags"/>
- </constant>
- <function-macro name="QUERY_TYPE_NAME"
- c:identifier="GST_QUERY_TYPE_NAME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="147">Get a constant string representation of the #GstQueryType of the query.</doc>
- <source-position filename="gst/gstquery.h" line="152"/>
- <parameters>
- <parameter name="query">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="149">the query to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <record name="Query"
- c:type="GstQuery"
- glib:type-name="GstQuery"
- glib:get-type="gst_query_get_type"
- c:symbol-prefix="query">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="24">Queries can be performed on pads (gst_pad_query()) and elements
-(gst_element_query()). Please note that some queries might need a running
-pipeline to work.
-
-Queries can be created using the gst_query_new_*() functions.
-Query values can be set using gst_query_set_*(), and parsed using
-gst_query_parse_*() helpers.
-
-The following example shows how to query the duration of a pipeline:
-|[&lt;!-- language="C" --&gt;
- GstQuery *query;
- gboolean res;
- query = gst_query_new_duration (GST_FORMAT_TIME);
- res = gst_element_query (pipeline, query);
- if (res) {
- gint64 duration;
- gst_query_parse_duration (query, NULL, &amp;amp;duration);
- g_print ("duration = %"GST_TIME_FORMAT, GST_TIME_ARGS (duration));
- } else {
- g_print ("duration query failed...");
- }
- gst_query_unref (query);
-]|</doc>
- <source-position filename="gst/gstquery.h" line="191"/>
- <field name="mini_object" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="180">The parent #GstMiniObject type</doc>
- <type name="MiniObject" c:type="GstMiniObject"/>
- </field>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="181">the #GstQueryType</doc>
- <type name="QueryType" c:type="GstQueryType"/>
- </field>
- <constructor name="new_accept_caps"
- c:identifier="gst_query_new_accept_caps">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2326">Constructs a new query object for querying if @caps are accepted.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="650"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2334">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2328">a fixed #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_allocation"
- c:identifier="gst_query_new_allocation">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1533">Constructs a new query object for querying the allocation properties.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="534"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1542">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1535">the negotiated caps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="need_pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1536">return a pool</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_bitrate"
- c:identifier="gst_query_new_bitrate"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2659">Constructs a new query object for querying the bitrate.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="697"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2666">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- </constructor>
- <constructor name="new_buffering" c:identifier="gst_query_new_buffering">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1031">Constructs a new query object for querying the buffering status of
-a stream.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="468"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1040">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1033">the default #GstFormat for the new query</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_caps" c:identifier="gst_query_new_caps">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2412">Constructs a new query object for querying the caps.
-
-The CAPS query should return the allowable caps for a pad in the context
-of the element's state, its link to other elements, and the devices or files
-it has opened. These caps must be a subset of the pad template caps. In the
-NULL state with no links, the CAPS query should ideally return the same caps
-as the pad template. In rare circumstances, an object property can affect
-the caps returned by the CAPS query, but this is discouraged.
-
-For most filters, the caps returned by CAPS query is directly affected by the
-allowed caps on other pads. For demuxers and decoders, the caps returned by
-the srcpad's getcaps function is directly related to the stream data. Again,
-the CAPS query should return the most specific caps it reasonably can, since this
-helps with autoplugging.
-
-The @filter is used to restrict the result caps, only the caps matching
-@filter should be returned from the CAPS query. Specifying a filter might
-greatly reduce the amount of processing an element needs to do.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="664"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2437">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <parameter name="filter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2414">a filter</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_context"
- c:identifier="gst_query_new_context"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2549">Constructs a new query object for querying the pipeline-local context.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="683"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2557">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <parameter name="context_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2551">Context type to query</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_convert" c:identifier="gst_query_new_convert">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="460">Constructs a new convert query object. Use gst_query_unref()
-when done with it. A convert query is used to ask for a conversion between
-one format and another.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="410"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="472">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <parameter name="src_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="462">the source #GstFormat for the new query</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="463">the value to convert</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="dest_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="464">the target #GstFormat</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_custom" c:identifier="gst_query_new_custom">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="660">Constructs a new custom query object. Use gst_query_unref()
-when done with it.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="363"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="670">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="662">the query type</doc>
- <type name="QueryType" c:type="GstQueryType"/>
- </parameter>
- <parameter name="structure"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="663">a structure for the query</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_drain" c:identifier="gst_query_new_drain">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2528">Constructs a new query object for querying the drain state.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="678"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2535">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- </constructor>
- <constructor name="new_duration" c:identifier="gst_query_new_duration">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="300">Constructs a new stream duration query object to query in the given format.
-Use gst_query_unref() when done with it. A duration query will give the
-total length of the stream.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="386"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="310">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="302">the #GstFormat for this duration query</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_formats" c:identifier="gst_query_new_formats">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="872">Constructs a new query object for querying formats of
-the stream.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="451"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="880">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- </constructor>
- <constructor name="new_latency" c:identifier="gst_query_new_latency">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="377">Constructs a new latency query object.
-Use gst_query_unref() when done with it. A latency query is usually performed
-by sinks to compensate for additional latency introduced by elements in the
-pipeline.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="397"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="387">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- </constructor>
- <constructor name="new_position" c:identifier="gst_query_new_position">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="221">Constructs a new query stream position query object. Use gst_query_unref()
-when done with it. A position query is used to query the current position
-of playback in the streams, in some format.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="375"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="231">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="223">the default #GstFormat for the new query</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_scheduling"
- c:identifier="gst_query_new_scheduling">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2112">Constructs a new query object for querying the scheduling properties.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="621"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2119">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- </constructor>
- <constructor name="new_seeking" c:identifier="gst_query_new_seeking">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="755">Constructs a new query object for querying seeking properties of
-the stream.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="435"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="764">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="757">the default #GstFormat for the new query</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_segment" c:identifier="gst_query_new_segment">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="557">Constructs a new segment query object. Use gst_query_unref()
-when done with it. A segment query is used to discover information about the
-currently configured segment for playback.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="422"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="567">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="559">the #GstFormat for the new query</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_uri" c:identifier="gst_query_new_uri">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1363">Constructs a new query URI query object. Use gst_query_unref()
-when done with it. An URI query is used to query the current URI
-that is used by the source or sink.
-
-Free-function: gst_query_unref()</doc>
- <source-position filename="gst/gstquery.h" line="511"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1372">a new #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- </constructor>
- <method name="add_allocation_meta"
- c:identifier="gst_query_add_allocation_meta">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1781">Add @api with @params as one of the supported metadata API to @query.</doc>
- <source-position filename="gst/gstquery.h" line="589"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1783">a GST_QUERY_ALLOCATION type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="api" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1784">the metadata API</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1785">API specific parameters</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_allocation_param"
- c:identifier="gst_query_add_allocation_param">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1950">Add @allocator and its @params as a supported memory allocator.</doc>
- <source-position filename="gst/gstquery.h" line="567"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1952">a GST_QUERY_ALLOCATION type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="allocator"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1953">the memory allocator</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1954">a #GstAllocationParams</doc>
- <type name="AllocationParams" c:type="const GstAllocationParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_allocation_pool"
- c:identifier="gst_query_add_allocation_pool">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1604">Set the pool parameters in @query.</doc>
- <source-position filename="gst/gstquery.h" line="542"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1606">A valid #GstQuery of type GST_QUERY_ALLOCATION.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="pool"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1607">the #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1608">the buffer size</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="min_buffers" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1609">the min buffers</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="max_buffers" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1610">the max buffers</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_buffering_range"
- c:identifier="gst_query_add_buffering_range">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1255">Set the buffering-ranges array field in @query. The current last
-start position of the array should be inferior to @start.</doc>
- <source-position filename="gst/gstquery.h" line="497"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1264">a #gboolean indicating if the range was added or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1257">a GST_QUERY_BUFFERING type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1258">start position of the range</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="stop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1259">stop position of the range</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_scheduling_mode"
- c:identifier="gst_query_add_scheduling_mode">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2190">Add @mode as one of the supported scheduling modes to @query.</doc>
- <source-position filename="gst/gstquery.h" line="632"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2192">a GST_QUERY_SCHEDULING type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2193">a #GstPadMode</doc>
- <type name="PadMode" c:type="GstPadMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_query_copy" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="280">Copies the given query using the copy function of the parent #GstStructure.
-
-Free-function: gst_query_unref</doc>
- <source-position filename="gst/gstquery.h" line="290"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="288">a new copy of @q.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </return-value>
- <parameters>
- <instance-parameter name="q" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="282">a #GstQuery to copy.</doc>
- <type name="Query" c:type="const GstQuery*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="find_allocation_meta"
- c:identifier="gst_query_find_allocation_meta">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1898">Check if @query has metadata @api set. When this function returns %TRUE,
-@index will contain the index where the requested API and the parameters
-can be found.</doc>
- <source-position filename="gst/gstquery.h" line="602"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1908">%TRUE when @api is in the list of metadata.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1900">a GST_QUERY_ALLOCATION type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="api" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1901">the metadata API</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="index"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1902">the index</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_n_allocation_metas"
- c:identifier="gst_query_get_n_allocation_metas">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1812">Retrieve the number of values currently stored in the
-meta API array of the query's structure.</doc>
- <source-position filename="gst/gstquery.h" line="592"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1819">the metadata API array size as a #guint.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1814">a GST_QUERY_ALLOCATION type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_n_allocation_params"
- c:identifier="gst_query_get_n_allocation_params">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1984">Retrieve the number of values currently stored in the
-allocator params array of the query's structure.
-
-If no memory allocator is specified, the downstream element can handle
-the default memory allocator. The first memory allocator in the query
-should be generic and allow mapping to system memory, all following
-allocators should be ordered by preference with the preferred one first.</doc>
- <source-position filename="gst/gstquery.h" line="571"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1996">the allocator array size as a #guint.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1986">a GST_QUERY_ALLOCATION type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_n_allocation_pools"
- c:identifier="gst_query_get_n_allocation_pools">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1638">Retrieve the number of values currently stored in the
-pool array of the query's structure.</doc>
- <source-position filename="gst/gstquery.h" line="547"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1645">the pool array size as a #guint.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1640">a GST_QUERY_ALLOCATION type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_n_buffering_ranges"
- c:identifier="gst_query_get_n_buffering_ranges">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1299">Retrieve the number of values currently stored in the
-buffered-ranges array of the query's structure.</doc>
- <source-position filename="gst/gstquery.h" line="501"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1306">the range array size as a #guint.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1301">a GST_QUERY_BUFFERING type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_n_scheduling_modes"
- c:identifier="gst_query_get_n_scheduling_modes">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2213">Retrieve the number of values currently stored in the
-scheduling mode array of the query's structure.</doc>
- <source-position filename="gst/gstquery.h" line="635"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2220">the scheduling mode array size as a #guint.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2215">a GST_QUERY_SCHEDULING type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_structure" c:identifier="gst_query_get_structure">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="706">Get the structure of a query.</doc>
- <source-position filename="gst/gstquery.h" line="367"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="712">the #GstStructure of the query. The
- structure is still owned by the query and will therefore be freed when the
- query is unreffed.</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="708">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_scheduling_mode"
- c:identifier="gst_query_has_scheduling_mode">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2264">Check if @query has scheduling mode set.
-
-&gt; When checking if upstream supports pull mode, it is usually not
-&gt; enough to just check for GST_PAD_MODE_PULL with this function, you
-&gt; also want to check whether the scheduling flags returned by
-&gt; gst_query_parse_scheduling() have the seeking flag set (meaning
-&gt; random access is supported, not only sequential pulls).</doc>
- <source-position filename="gst/gstquery.h" line="641"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2277">%TRUE when @mode is in the list of scheduling modes.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2266">a GST_QUERY_SCHEDULING type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2267">the scheduling mode</doc>
- <type name="PadMode" c:type="GstPadMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="has_scheduling_mode_with_flags"
- c:identifier="gst_query_has_scheduling_mode_with_flags">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2300">Check if @query has scheduling mode set and @flags is set in
-query scheduling flags.</doc>
- <source-position filename="gst/gstquery.h" line="644"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2309">%TRUE when @mode is in the list of scheduling modes
- and @flags are compatible with query flags.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2302">a GST_QUERY_SCHEDULING type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2303">the scheduling mode</doc>
- <type name="PadMode" c:type="GstPadMode"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2304">#GstSchedulingFlags</doc>
- <type name="SchedulingFlags" c:type="GstSchedulingFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_accept_caps"
- c:identifier="gst_query_parse_accept_caps">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2352">Get the caps from @query. The caps remains valid as long as @query remains
-valid.</doc>
- <source-position filename="gst/gstquery.h" line="653"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2354">The query to parse</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="caps"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2355">A pointer to the caps</doc>
- <type name="Caps" c:type="GstCaps**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_accept_caps_result"
- c:identifier="gst_query_parse_accept_caps_result">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2393">Parse the result from @query and store in @result.</doc>
- <source-position filename="gst/gstquery.h" line="659"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2395">a GST_QUERY_ACCEPT_CAPS type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="result"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2396">location for the result</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_allocation"
- c:identifier="gst_query_parse_allocation">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1559">Parse an allocation query, writing the requested caps in @caps and
-whether a pool is needed in @need_pool, if the respective parameters
-are non-%NULL.
-
-Pool details can be retrieved using gst_query_get_n_allocation_pools() and
-gst_query_parse_nth_allocation_pool().</doc>
- <source-position filename="gst/gstquery.h" line="537"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1561">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="caps"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1562">The #GstCaps</doc>
- <type name="Caps" c:type="GstCaps**"/>
- </parameter>
- <parameter name="need_pool"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1563">Whether a #GstBufferPool is needed</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_bitrate"
- c:identifier="gst_query_parse_bitrate"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2706">Get the results of a bitrate query. See also gst_query_set_bitrate().</doc>
- <source-position filename="gst/gstquery.h" line="703"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2708">a GST_QUERY_BITRATE type #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="nominal_bitrate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2709">The resulting bitrate in bits per second</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_buffering_percent"
- c:identifier="gst_query_parse_buffering_percent">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1091">Get the percentage of buffered data. This is a value between 0 and 100.
-The @busy indicator is %TRUE when the buffering is in progress.</doc>
- <source-position filename="gst/gstquery.h" line="474"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1093">A valid #GstQuery of type GST_QUERY_BUFFERING.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="busy"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1094">if buffering is busy, or %NULL</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="percent"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1095">a buffering percent, or %NULL</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_buffering_range"
- c:identifier="gst_query_parse_buffering_range">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1209">Parse an available query, writing the format into @format, and
-other results into the passed parameters, if the respective parameters
-are non-%NULL</doc>
- <source-position filename="gst/gstquery.h" line="492"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1211">a GST_QUERY_BUFFERING type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1212">the format to set for the @segment_start
- and @segment_end values, or %NULL</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="start"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1214">the start to set, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- <parameter name="stop"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1215">the stop to set, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- <parameter name="estimated_total"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1216">estimated total amount of download
- time remaining in milliseconds, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_buffering_stats"
- c:identifier="gst_query_parse_buffering_stats">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1144">Extracts the buffering stats values from @query.</doc>
- <source-position filename="gst/gstquery.h" line="482"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1146">A valid #GstQuery of type GST_QUERY_BUFFERING.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="mode"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1147">a buffering mode, or %NULL</doc>
- <type name="BufferingMode" c:type="GstBufferingMode*"/>
- </parameter>
- <parameter name="avg_in"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1148">the average input rate, or %NULL</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="avg_out"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1149">the average output rat, or %NULL</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="buffering_left"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1150">amount of buffering time left in
- milliseconds, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_caps" c:identifier="gst_query_parse_caps">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2453">Get the filter from the caps @query. The caps remains valid as long as
-@query remains valid.</doc>
- <source-position filename="gst/gstquery.h" line="667"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2455">The query to parse</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="filter"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2456">A pointer to the caps filter</doc>
- <type name="Caps" c:type="GstCaps**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_caps_result"
- c:identifier="gst_query_parse_caps_result">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2493">Get the caps result from @query. The caps remains valid as long as
-@query remains valid.</doc>
- <source-position filename="gst/gstquery.h" line="673"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2495">The query to parse</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="caps"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2496">A pointer to the caps</doc>
- <type name="Caps" c:type="GstCaps**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_context"
- c:identifier="gst_query_parse_context"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2603">Get the context from the context @query. The context remains valid as long as
-@query remains valid.</doc>
- <source-position filename="gst/gstquery.h" line="692"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2605">The query to parse</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="context"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2606">A pointer to store the #GstContext</doc>
- <type name="Context" c:type="GstContext**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_context_type"
- c:identifier="gst_query_parse_context_type"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2630">Parse a context type from an existing GST_QUERY_CONTEXT query.</doc>
- <source-position filename="gst/gstquery.h" line="686"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2637">a #gboolean indicating if the parsing succeeded.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2632">a GST_QUERY_CONTEXT type query</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="context_type"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2633">the context type, or %NULL</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_convert" c:identifier="gst_query_parse_convert">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="518">Parse a convert query answer. Any of @src_format, @src_value, @dest_format,
-and @dest_value may be %NULL, in which case that value is omitted.</doc>
- <source-position filename="gst/gstquery.h" line="417"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="520">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="src_format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="521">the storage for the #GstFormat of the
- source value, or %NULL</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="src_value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="523">the storage for the source value, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- <parameter name="dest_format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="524">the storage for the #GstFormat of the
- destination value, or %NULL</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="dest_value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="526">the storage for the destination value,
- or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_duration" c:identifier="gst_query_parse_duration">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="349">Parse a duration query answer. Write the format of the duration into @format,
-and the value into @duration, if the respective variables are non-%NULL.</doc>
- <source-position filename="gst/gstquery.h" line="392"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="351">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="352">the storage for the #GstFormat of the duration
- value, or %NULL.</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="duration"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="354">the storage for the total duration, or %NULL.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_latency" c:identifier="gst_query_parse_latency">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="430">Parse a latency query answer.</doc>
- <source-position filename="gst/gstquery.h" line="404"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="432">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="live"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="433">storage for live or %NULL</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="min_latency"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="434">the storage for the min latency or %NULL</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="max_latency"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="435">the storage for the max latency or %NULL</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_n_formats" c:identifier="gst_query_parse_n_formats">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="971">Parse the number of formats in the formats @query.</doc>
- <source-position filename="gst/gstquery.h" line="460"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="973">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="n_formats"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="974">the number of formats in this query.</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_nth_allocation_meta"
- c:identifier="gst_query_parse_nth_allocation_meta">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1837">Parse an available query and get the metadata API
-at @index of the metadata API array.</doc>
- <source-position filename="gst/gstquery.h" line="595"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1846">a #GType of the metadata API at @index.</doc>
- <type name="GType" c:type="GType"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1839">a GST_QUERY_ALLOCATION type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1840">position in the metadata API array to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="params"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1841">API specific parameters</doc>
- <type name="Structure" c:type="const GstStructure**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_nth_allocation_param"
- c:identifier="gst_query_parse_nth_allocation_param">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2013">Parse an available query and get the allocator and its params
-at @index of the allocator array.</doc>
- <source-position filename="gst/gstquery.h" line="574"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2015">a GST_QUERY_ALLOCATION type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2016">position in the allocator array to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="allocator"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2017">variable to hold the result</doc>
- <type name="Allocator" c:type="GstAllocator**"/>
- </parameter>
- <parameter name="params"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2018">parameters for the allocator</doc>
- <type name="AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_nth_allocation_pool"
- c:identifier="gst_query_parse_nth_allocation_pool">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1662">Get the pool parameters in @query.
-
-Unref @pool with gst_object_unref() when it's not needed any more.</doc>
- <source-position filename="gst/gstquery.h" line="550"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1664">A valid #GstQuery of type GST_QUERY_ALLOCATION.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1665">index to parse</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pool"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1666">the #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool**"/>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1667">the buffer size</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="min_buffers"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1668">the min buffers</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="max_buffers"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1669">the max buffers</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_nth_buffering_range"
- c:identifier="gst_query_parse_nth_buffering_range">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1324">Parse an available query and get the start and stop values stored
-at the @index of the buffered ranges array.</doc>
- <source-position filename="gst/gstquery.h" line="504"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1334">a #gboolean indicating if the parsing succeeded.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1326">a GST_QUERY_BUFFERING type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1327">position in the buffered-ranges array to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="start"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1328">the start position to set, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- <parameter name="stop"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1329">the stop position to set, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_nth_format"
- c:identifier="gst_query_parse_nth_format">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="997">Parse the format query and retrieve the @nth format from it into
-@format. If the list contains less elements than @nth, @format will be
-set to GST_FORMAT_UNDEFINED.</doc>
- <source-position filename="gst/gstquery.h" line="463"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="999">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1000">the nth format to retrieve.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1001">a pointer to store the nth format</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_nth_scheduling_mode"
- c:identifier="gst_query_parse_nth_scheduling_mode">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2237">Parse an available query and get the scheduling mode
-at @index of the scheduling modes array.</doc>
- <source-position filename="gst/gstquery.h" line="638"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2245">a #GstPadMode of the scheduling mode at @index.</doc>
- <type name="PadMode" c:type="GstPadMode"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2239">a GST_QUERY_SCHEDULING type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2240">position in the scheduling modes array to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_position" c:identifier="gst_query_parse_position">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="272">Parse a position query, writing the format into @format, and the position
-into @cur, if the respective parameters are non-%NULL.</doc>
- <source-position filename="gst/gstquery.h" line="381"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="274">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="275">the storage for the #GstFormat of the
- position values (may be %NULL)</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="cur"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="277">the storage for the current position (may be %NULL)</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_scheduling"
- c:identifier="gst_query_parse_scheduling">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2164">Set the scheduling properties.</doc>
- <source-position filename="gst/gstquery.h" line="628"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2166">A valid #GstQuery of type GST_QUERY_SCHEDULING.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="flags"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2167">#GstSchedulingFlags</doc>
- <type name="SchedulingFlags" c:type="GstSchedulingFlags*"/>
- </parameter>
- <parameter name="minsize"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2168">the suggested minimum size of pull requests</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="maxsize"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2169">the suggested maximum size of pull requests:</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="align"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2170">the suggested alignment of pull requests</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_seeking" c:identifier="gst_query_parse_seeking">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="810">Parse a seeking query, writing the format into @format, and
-other results into the passed parameters, if the respective parameters
-are non-%NULL</doc>
- <source-position filename="gst/gstquery.h" line="444"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="812">a GST_QUERY_SEEKING type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="813">the format to set for the @segment_start
- and @segment_end values, or %NULL</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="seekable"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="815">the seekable flag to set, or %NULL</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="segment_start"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="816">the segment_start to set, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- <parameter name="segment_end"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="817">the segment_end to set, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_segment" c:identifier="gst_query_parse_segment">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="622">Parse a segment query answer. Any of @rate, @format, @start_value, and
-@stop_value may be %NULL, which will cause this value to be omitted.
-
-See gst_query_set_segment() for an explanation of the function arguments.</doc>
- <source-position filename="gst/gstquery.h" line="429"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="624">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="rate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="625">the storage for the rate of the segment, or %NULL</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="format"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="626">the storage for the #GstFormat of the values,
- or %NULL</doc>
- <type name="Format" c:type="GstFormat*"/>
- </parameter>
- <parameter name="start_value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="628">the storage for the start value, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- <parameter name="stop_value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="629">the storage for the stop value, or %NULL</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_uri" c:identifier="gst_query_parse_uri">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1408">Parse an URI query, writing the URI into @uri as a newly
-allocated string, if the respective parameters are non-%NULL.
-Free the string with g_free() after usage.</doc>
- <source-position filename="gst/gstquery.h" line="514"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1410">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="uri"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1411">the storage for the current URI
- (may be %NULL)</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_uri_redirection"
- c:identifier="gst_query_parse_uri_redirection"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1454">Parse an URI query, writing the URI into @uri as a newly
-allocated string, if the respective parameters are non-%NULL.
-Free the string with g_free() after usage.</doc>
- <source-position filename="gst/gstquery.h" line="520"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1456">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="uri"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1457">the storage for the redirect URI
- (may be %NULL)</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_uri_redirection_permanent"
- c:identifier="gst_query_parse_uri_redirection_permanent"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1504">Parse an URI query, and set @permanent to %TRUE if there is a redirection
-and it should be considered permanent. If a redirection is permanent,
-applications should update their internal storage of the URI, otherwise
-they should make all future requests to the original URI.</doc>
- <source-position filename="gst/gstquery.h" line="526"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1506">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="permanent"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1507">if the URI redirection is permanent
- (may be %NULL)</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_nth_allocation_meta"
- c:identifier="gst_query_remove_nth_allocation_meta">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1873">Remove the metadata API at @index of the metadata API array.</doc>
- <source-position filename="gst/gstquery.h" line="599"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1875">a GST_QUERY_ALLOCATION type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1876">position in the metadata API array to remove</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_nth_allocation_param"
- c:identifier="gst_query_remove_nth_allocation_param"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2085">Remove the allocation param at @index of the allocation param array.</doc>
- <source-position filename="gst/gstquery.h" line="584"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2087">a GST_QUERY_ALLOCATION type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2088">position in the allocation param array to remove</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_nth_allocation_pool"
- c:identifier="gst_query_remove_nth_allocation_pool"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1741">Remove the allocation pool at @index of the allocation pool array.</doc>
- <source-position filename="gst/gstquery.h" line="562"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1743">a GST_QUERY_ALLOCATION type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1744">position in the allocation pool array to remove</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_accept_caps_result"
- c:identifier="gst_query_set_accept_caps_result">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2373">Set @result as the result for the @query.</doc>
- <source-position filename="gst/gstquery.h" line="656"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2375">a GST_QUERY_ACCEPT_CAPS type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="result" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2376">the result to set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_bitrate"
- c:identifier="gst_query_set_bitrate"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2682">Set the results of a bitrate query. The nominal bitrate is the average
-bitrate expected over the length of the stream as advertised in file
-headers (or similar).</doc>
- <source-position filename="gst/gstquery.h" line="700"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2684">a GST_QUERY_BITRATE type #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="nominal_bitrate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2685">the nominal bitrate in bits per second</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_buffering_percent"
- c:identifier="gst_query_set_buffering_percent">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1067">Set the percentage of buffered data. This is a value between 0 and 100.
-The @busy indicator is %TRUE when the buffering is in progress.</doc>
- <source-position filename="gst/gstquery.h" line="471"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1069">A valid #GstQuery of type GST_QUERY_BUFFERING.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="busy" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1070">if buffering is busy</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="percent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1071">a buffering percent</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_buffering_range"
- c:identifier="gst_query_set_buffering_range">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1181">Set the available query result fields in @query.</doc>
- <source-position filename="gst/gstquery.h" line="487"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1183">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1184">the format to set for the @start and @stop values</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1185">the start to set</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="stop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1186">the stop to set</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="estimated_total" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1187">estimated total amount of download time remaining in
- milliseconds</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_buffering_stats"
- c:identifier="gst_query_set_buffering_stats">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1117">Configures the buffering stats values in @query.</doc>
- <source-position filename="gst/gstquery.h" line="477"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1119">A valid #GstQuery of type GST_QUERY_BUFFERING.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1120">a buffering mode</doc>
- <type name="BufferingMode" c:type="GstBufferingMode"/>
- </parameter>
- <parameter name="avg_in" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1121">the average input rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="avg_out" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1122">the average output rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="buffering_left" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1123">amount of buffering time left in milliseconds</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_caps_result" c:identifier="gst_query_set_caps_result">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2474">Set the @caps result in @query.</doc>
- <source-position filename="gst/gstquery.h" line="670"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2476">The query to use</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2477">A pointer to the caps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_context"
- c:identifier="gst_query_set_context"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2576">Answer a context query by setting the requested context.</doc>
- <source-position filename="gst/gstquery.h" line="689"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2578">a #GstQuery with query type GST_QUERY_CONTEXT</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="context" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2579">the requested #GstContext</doc>
- <type name="Context" c:type="GstContext*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_convert" c:identifier="gst_query_set_convert">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="492">Answer a convert query by setting the requested values.</doc>
- <source-position filename="gst/gstquery.h" line="413"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="494">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="src_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="495">the source #GstFormat</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="src_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="496">the source value</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="dest_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="497">the destination #GstFormat</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="dest_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="498">the destination value</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_duration" c:identifier="gst_query_set_duration">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="327">Answer a duration query by setting the requested value in the given format.</doc>
- <source-position filename="gst/gstquery.h" line="389"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="329">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="330">the #GstFormat for the duration</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="331">the duration of the stream</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_formats"
- c:identifier="gst_query_set_formats"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="905">Set the formats query result fields in @query. The number of formats passed
-must be equal to @n_formats.</doc>
- <source-position filename="gst/gstquery.h" line="454"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="907">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="n_formats" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="908">the number of formats to set.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="909">A number of @GstFormats equal to @n_formats.</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="set_formatsv" c:identifier="gst_query_set_formatsv">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="940">Set the formats query result fields in @query. The number of formats passed
-in the @formats array must be equal to @n_formats.</doc>
- <source-position filename="gst/gstquery.h" line="457"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="942">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="n_formats" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="943">the number of formats to set.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="formats" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="944">an array containing @n_formats
- @GstFormat values.</doc>
- <array length="0" zero-terminated="0" c:type="const GstFormat*">
- <type name="Format" c:type="GstFormat"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="set_latency" c:identifier="gst_query_set_latency">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="405">Answer a latency query by setting the requested values in the given format.</doc>
- <source-position filename="gst/gstquery.h" line="400"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="407">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="live" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="408">if there is a live element upstream</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="min_latency" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="409">the minimal latency of the upstream elements</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="max_latency" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="410">the maximal latency of the upstream elements</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_nth_allocation_param"
- c:identifier="gst_query_set_nth_allocation_param">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2047">Parse an available query and get the allocator and its params
-at @index of the allocator array.</doc>
- <source-position filename="gst/gstquery.h" line="579"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2049">a GST_QUERY_ALLOCATION type query #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2050">position in the allocator array to set</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="allocator"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2051">new allocator to set</doc>
- <type name="Allocator" c:type="GstAllocator*"/>
- </parameter>
- <parameter name="params"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2052">parameters for the allocator</doc>
- <type name="AllocationParams" c:type="const GstAllocationParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_nth_allocation_pool"
- c:identifier="gst_query_set_nth_allocation_pool">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1704">Set the pool parameters in @query.</doc>
- <source-position filename="gst/gstquery.h" line="556"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1707">A valid #GstQuery of type GST_QUERY_ALLOCATION.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1706">index to modify</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pool"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1708">the #GstBufferPool</doc>
- <type name="BufferPool" c:type="GstBufferPool*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1709">the buffer size</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="min_buffers" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1710">the min buffers</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="max_buffers" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1711">the max buffers</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_position" c:identifier="gst_query_set_position">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="248">Answer a position query by setting the requested value in the given format.</doc>
- <source-position filename="gst/gstquery.h" line="378"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="250">a #GstQuery with query type GST_QUERY_POSITION</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="251">the requested #GstFormat</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="cur" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="252">the position to set</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_scheduling" c:identifier="gst_query_set_scheduling">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2137">Set the scheduling properties.</doc>
- <source-position filename="gst/gstquery.h" line="624"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2139">A valid #GstQuery of type GST_QUERY_SCHEDULING.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2140">#GstSchedulingFlags</doc>
- <type name="SchedulingFlags" c:type="GstSchedulingFlags"/>
- </parameter>
- <parameter name="minsize" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2141">the suggested minimum size of pull requests</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="maxsize" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2142">the suggested maximum size of pull requests</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="2143">the suggested alignment of pull requests</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_seeking" c:identifier="gst_query_set_seeking">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="783">Set the seeking query result fields in @query.</doc>
- <source-position filename="gst/gstquery.h" line="438"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="785">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="786">the format to set for the @segment_start and @segment_end values</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="seekable" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="787">the seekable flag to set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="segment_start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="788">the segment_start to set</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="segment_end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="789">the segment_end to set</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_segment" c:identifier="gst_query_set_segment">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="586">Answer a segment query by setting the requested values. The normal
-playback segment of a pipeline is 0 to duration at the default rate of
-1.0. If a seek was performed on the pipeline to play a different
-segment, this query will return the range specified in the last seek.
-
-@start_value and @stop_value will respectively contain the configured
-playback range start and stop values expressed in @format.
-The values are always between 0 and the duration of the media and
-@start_value &lt;= @stop_value. @rate will contain the playback rate. For
-negative rates, playback will actually happen from @stop_value to
-@start_value.</doc>
- <source-position filename="gst/gstquery.h" line="425"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="588">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="589">the rate of the segment</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="590">the #GstFormat of the segment values (@start_value and @stop_value)</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="start_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="591">the start value</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="stop_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="592">the stop value</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_uri" c:identifier="gst_query_set_uri">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1388">Answer a URI query by setting the requested URI.</doc>
- <source-position filename="gst/gstquery.h" line="517"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1390">a #GstQuery with query type GST_QUERY_URI</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1391">the URI to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_uri_redirection"
- c:identifier="gst_query_set_uri_redirection"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1431">Answer a URI query by setting the requested URI redirection.</doc>
- <source-position filename="gst/gstquery.h" line="523"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1433">a #GstQuery with query type GST_QUERY_URI</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1434">the URI to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_uri_redirection_permanent"
- c:identifier="gst_query_set_uri_redirection_permanent"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1481">Answer a URI query by setting the requested URI redirection
-to permanent or not.</doc>
- <source-position filename="gst/gstquery.h" line="529"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1483">a #GstQuery with query type %GST_QUERY_URI</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- <parameter name="permanent" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="1484">whether the redirect is permanent or not</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_query_unref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="246">Decreases the refcount of the query. If the refcount reaches 0, the query
-will be freed.</doc>
- <source-position filename="gst/gstquery.h" line="253"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="q" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="248">a #GstQuery to decrease the refcount of.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="writable_structure"
- c:identifier="gst_query_writable_structure">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="724">Get the structure of a query. This method should be called with a writable
-@query so that the returned structure is guaranteed to be writable.</doc>
- <source-position filename="gst/gstquery.h" line="370"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="731">the #GstStructure of the query. The structure is
- still owned by the query and will therefore be freed when the query
- is unreffed.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="726">a #GstQuery</doc>
- <type name="Query" c:type="GstQuery*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="replace"
- c:identifier="gst_query_replace"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="313">Modifies a pointer to a #GstQuery to point to a different #GstQuery. The
-modification is done atomically (so this is useful for ensuring thread safety
-in some cases), and the reference counts are updated appropriately (the old
-query is unreffed, the new one is reffed).
-
-Either @new_query or the #GstQuery pointed to by @old_query may be %NULL.</doc>
- <source-position filename="gst/gstquery.h" line="329"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="327">%TRUE if @new_query was different from @old_query</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="old_query"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="315">pointer to a pointer to a
- #GstQuery to be replaced.</doc>
- <type name="Query" c:type="GstQuery**"/>
- </parameter>
- <parameter name="new_query"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="317">pointer to a #GstQuery that will
- replace the query pointed to by @old_query.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <enumeration name="QueryType"
- glib:type-name="GstQueryType"
- glib:get-type="gst_query_type_get_type"
- c:type="GstQueryType">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="80">Standard predefined Query types</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_QUERY_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="82">unknown query type</doc>
- </member>
- <member name="position"
- value="2563"
- c:identifier="GST_QUERY_POSITION"
- glib:nick="position">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="83">current position in stream</doc>
- </member>
- <member name="duration"
- value="5123"
- c:identifier="GST_QUERY_DURATION"
- glib:nick="duration">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="84">total duration of the stream</doc>
- </member>
- <member name="latency"
- value="7683"
- c:identifier="GST_QUERY_LATENCY"
- glib:nick="latency">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="85">latency of stream</doc>
- </member>
- <member name="jitter"
- value="10243"
- c:identifier="GST_QUERY_JITTER"
- glib:nick="jitter">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="86">current jitter of stream</doc>
- </member>
- <member name="rate"
- value="12803"
- c:identifier="GST_QUERY_RATE"
- glib:nick="rate">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="87">current rate of the stream</doc>
- </member>
- <member name="seeking"
- value="15363"
- c:identifier="GST_QUERY_SEEKING"
- glib:nick="seeking">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="88">seeking capabilities</doc>
- </member>
- <member name="segment"
- value="17923"
- c:identifier="GST_QUERY_SEGMENT"
- glib:nick="segment">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="89">segment start/stop positions</doc>
- </member>
- <member name="convert"
- value="20483"
- c:identifier="GST_QUERY_CONVERT"
- glib:nick="convert">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="90">convert values between formats</doc>
- </member>
- <member name="formats"
- value="23043"
- c:identifier="GST_QUERY_FORMATS"
- glib:nick="formats">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="91">query supported formats for convert</doc>
- </member>
- <member name="buffering"
- value="28163"
- c:identifier="GST_QUERY_BUFFERING"
- glib:nick="buffering">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="92">query available media for efficient seeking.</doc>
- </member>
- <member name="custom"
- value="30723"
- c:identifier="GST_QUERY_CUSTOM"
- glib:nick="custom">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="93">a custom application or element defined query.</doc>
- </member>
- <member name="uri"
- value="33283"
- c:identifier="GST_QUERY_URI"
- glib:nick="uri">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="94">query the URI of the source or sink.</doc>
- </member>
- <member name="allocation"
- value="35846"
- c:identifier="GST_QUERY_ALLOCATION"
- glib:nick="allocation">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="95">the buffer allocation properties</doc>
- </member>
- <member name="scheduling"
- value="38401"
- c:identifier="GST_QUERY_SCHEDULING"
- glib:nick="scheduling">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="96">the scheduling properties</doc>
- </member>
- <member name="accept_caps"
- value="40963"
- c:identifier="GST_QUERY_ACCEPT_CAPS"
- glib:nick="accept-caps">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="97">the accept caps query</doc>
- </member>
- <member name="caps"
- value="43523"
- c:identifier="GST_QUERY_CAPS"
- glib:nick="caps">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="98">the caps query</doc>
- </member>
- <member name="drain"
- value="46086"
- c:identifier="GST_QUERY_DRAIN"
- glib:nick="drain">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="99">wait till all serialized data is consumed downstream</doc>
- </member>
- <member name="context"
- value="48643"
- c:identifier="GST_QUERY_CONTEXT"
- glib:nick="context">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="100">query the pipeline-local context from
- downstream or upstream (since 1.2)</doc>
- </member>
- <member name="bitrate"
- value="51202"
- c:identifier="GST_QUERY_BITRATE"
- glib:nick="bitrate">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="102">the bitrate query (since 1.16)</doc>
- </member>
- <function name="get_flags" c:identifier="gst_query_type_get_flags">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="169">Gets the #GstQueryTypeFlags associated with @type.</doc>
- <source-position filename="gst/gstquery.h" line="225"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="175">a #GstQueryTypeFlags.</doc>
- <type name="QueryTypeFlags" c:type="GstQueryTypeFlags"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="171">a #GstQueryType</doc>
- <type name="QueryType" c:type="GstQueryType"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_name" c:identifier="gst_query_type_get_name">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="129">Get a printable name for the given query type. Do not modify or free.</doc>
- <source-position filename="gst/gstquery.h" line="218"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="135">a reference to the static name of the query.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="131">the query type</doc>
- <type name="QueryType" c:type="GstQueryType"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_quark" c:identifier="gst_query_type_to_quark">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="149">Get the unique quark for the given query type.</doc>
- <source-position filename="gst/gstquery.h" line="221"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="155">the quark associated with the query type</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="151">the query type</doc>
- <type name="QueryType" c:type="GstQueryType"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <bitfield name="QueryTypeFlags"
- glib:type-name="GstQueryTypeFlags"
- glib:get-type="gst_query_type_flags_get_type"
- c:type="GstQueryTypeFlags">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="39">#GstQueryTypeFlags indicate the aspects of the different #GstQueryType
-values. You can get the type flags of a #GstQueryType with the
-gst_query_type_get_flags() function.</doc>
- <member name="upstream"
- value="1"
- c:identifier="GST_QUERY_TYPE_UPSTREAM"
- glib:nick="upstream">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="41">Set if the query can travel upstream.</doc>
- </member>
- <member name="downstream"
- value="2"
- c:identifier="GST_QUERY_TYPE_DOWNSTREAM"
- glib:nick="downstream">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="42">Set if the query can travel downstream.</doc>
- </member>
- <member name="serialized"
- value="4"
- c:identifier="GST_QUERY_TYPE_SERIALIZED"
- glib:nick="serialized">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="43">Set if the query should be serialized with data
- flow.</doc>
- </member>
- </bitfield>
- <function-macro name="READ_UINT16_BE"
- c:identifier="GST_READ_UINT16_BE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="340">Read a 16 bit unsigned integer value in big endian format from the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="354"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="342">memory location</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="READ_UINT16_LE"
- c:identifier="GST_READ_UINT16_LE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="346">Read a 16 bit unsigned integer value in little endian format from the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="355"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="348">memory location</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="READ_UINT24_BE"
- c:identifier="GST_READ_UINT24_BE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="310">Read a 24 bit unsigned integer value in big endian format from the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="320"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="312">memory location</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="READ_UINT24_LE"
- c:identifier="GST_READ_UINT24_LE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="325">Read a 24 bit unsigned integer value in little endian format from the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="335"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="327">memory location</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="READ_UINT32_BE"
- c:identifier="GST_READ_UINT32_BE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="268">Read a 32 bit unsigned integer value in big endian format from the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="283"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="270">memory location</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="READ_UINT32_LE"
- c:identifier="GST_READ_UINT32_LE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="275">Read a 32 bit unsigned integer value in little endian format from the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="284"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="277">memory location</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="READ_UINT64_BE"
- c:identifier="GST_READ_UINT64_BE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="218">Read a 64 bit unsigned integer value in big endian format from the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="233"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="220">memory location</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="READ_UINT64_LE"
- c:identifier="GST_READ_UINT64_LE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="225">Read a 64 bit unsigned integer value in little endian format from the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="234"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="227">memory location</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="READ_UINT8"
- c:identifier="GST_READ_UINT8"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="377">Read an 8 bit unsigned integer value from the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="383"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="379">memory location</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="REGISTRY"
- c:identifier="GST_REGISTRY"
- introspectable="0">
- <source-position filename="gst/gstregistry.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="REGISTRY_CLASS"
- c:identifier="GST_REGISTRY_CLASS"
- introspectable="0">
- <source-position filename="gst/gstregistry.h" line="36"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="REGISTRY_GET_CLASS"
- c:identifier="GST_REGISTRY_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstregistry.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_DOWN_128"
- c:identifier="GST_ROUND_DOWN_128"
- version="1.4"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="957">Rounds an integer value down to the next multiple of 128.</doc>
- <source-position filename="gst/gstutils.h" line="964"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="959">integer value to round down</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_DOWN_16"
- c:identifier="GST_ROUND_DOWN_16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="936">Rounds an integer value down to the next multiple of 16.</doc>
- <source-position filename="gst/gstutils.h" line="942"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="938">integer value to round down</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_DOWN_2"
- c:identifier="GST_ROUND_DOWN_2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="915">Rounds an integer value down to the next multiple of 2.</doc>
- <source-position filename="gst/gstutils.h" line="921"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="917">integer value to round down</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_DOWN_32"
- c:identifier="GST_ROUND_DOWN_32"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="943">Rounds an integer value down to the next multiple of 32.</doc>
- <source-position filename="gst/gstutils.h" line="949"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="945">integer value to round down</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_DOWN_4"
- c:identifier="GST_ROUND_DOWN_4"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="922">Rounds an integer value down to the next multiple of 4.</doc>
- <source-position filename="gst/gstutils.h" line="928"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="924">integer value to round down</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_DOWN_64"
- c:identifier="GST_ROUND_DOWN_64"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="950">Rounds an integer value down to the next multiple of 64.</doc>
- <source-position filename="gst/gstutils.h" line="956"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="952">integer value to round down</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_DOWN_8"
- c:identifier="GST_ROUND_DOWN_8"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="929">Rounds an integer value down to the next multiple of 8.</doc>
- <source-position filename="gst/gstutils.h" line="935"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="931">integer value to round down</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_DOWN_N"
- c:identifier="GST_ROUND_DOWN_N"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="965">Rounds an integer value down to the next multiple of @align. @align MUST be a
-power of two.</doc>
- <source-position filename="gst/gstutils.h" line="973"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="967">integrer value to round down</doc>
- </parameter>
- <parameter name="align">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="968">a power of two to round down to</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_UP_128"
- c:identifier="GST_ROUND_UP_128"
- version="1.4"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="896">Rounds an integer value up to the next multiple of 128.</doc>
- <source-position filename="gst/gstutils.h" line="903"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="898">integer value to round up</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_UP_16"
- c:identifier="GST_ROUND_UP_16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="875">Rounds an integer value up to the next multiple of 16.</doc>
- <source-position filename="gst/gstutils.h" line="881"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="877">integer value to round up</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_UP_2"
- c:identifier="GST_ROUND_UP_2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="854">Rounds an integer value up to the next multiple of 2.</doc>
- <source-position filename="gst/gstutils.h" line="860"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="856">integer value to round up</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_UP_32"
- c:identifier="GST_ROUND_UP_32"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="882">Rounds an integer value up to the next multiple of 32.</doc>
- <source-position filename="gst/gstutils.h" line="888"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="884">integer value to round up</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_UP_4"
- c:identifier="GST_ROUND_UP_4"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="861">Rounds an integer value up to the next multiple of 4.</doc>
- <source-position filename="gst/gstutils.h" line="867"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="863">integer value to round up</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_UP_64"
- c:identifier="GST_ROUND_UP_64"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="889">Rounds an integer value up to the next multiple of 64.</doc>
- <source-position filename="gst/gstutils.h" line="895"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="891">integer value to round up</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_UP_8"
- c:identifier="GST_ROUND_UP_8"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="868">Rounds an integer value up to the next multiple of 8.</doc>
- <source-position filename="gst/gstutils.h" line="874"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="870">integer value to round up</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ROUND_UP_N"
- c:identifier="GST_ROUND_UP_N"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="904">Rounds an integer value up to the next multiple of @align. @align MUST be a
-power of two.</doc>
- <source-position filename="gst/gstutils.h" line="912"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="906">integrer value to round up</doc>
- </parameter>
- <parameter name="align">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="907">a power of two to round up to</doc>
- </parameter>
- </parameters>
- </function-macro>
- <enumeration name="Rank"
- glib:type-name="GstRank"
- glib:get-type="gst_rank_get_type"
- c:type="GstRank">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="49">Element priority ranks. Defines the order in which the autoplugger (or
-similar rank-picking mechanisms, such as e.g. gst_element_make_from_uri())
-will choose this element over an alternative one with the same function.
-
-These constants serve as a rough guidance for defining the rank of a
-#GstPluginFeature. Any value is valid, including values bigger than
-@GST_RANK_PRIMARY.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_RANK_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="51">will be chosen last or not at all</doc>
- </member>
- <member name="marginal"
- value="64"
- c:identifier="GST_RANK_MARGINAL"
- glib:nick="marginal">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="52">unlikely to be chosen</doc>
- </member>
- <member name="secondary"
- value="128"
- c:identifier="GST_RANK_SECONDARY"
- glib:nick="secondary">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="53">likely to be chosen</doc>
- </member>
- <member name="primary"
- value="256"
- c:identifier="GST_RANK_PRIMARY"
- glib:nick="primary">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="54">will be chosen first</doc>
- </member>
- </enumeration>
- <record name="ReferenceTimestampMeta"
- c:type="GstReferenceTimestampMeta"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="758">#GstReferenceTimestampMeta can be used to attach alternative timestamps and
-possibly durations to a #GstBuffer. These are generally not according to
-the pipeline clock and could be e.g. the NTP timestamp when the media was
-captured.
-
-The reference is stored as a #GstCaps in @reference. Examples of valid
-references would be "timestamp/x-drivername-stream" for timestamps that are locally
-generated by some driver named "drivername" when generating the stream,
-e.g. based on a frame counter, or "timestamp/x-ntp, host=pool.ntp.org,
-port=123" for timestamps based on a specific NTP server.</doc>
- <source-position filename="gst/gstbuffer.h" line="785"/>
- <field name="parent" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="760">the parent #GstMeta structure</doc>
- <type name="Meta" c:type="GstMeta"/>
- </field>
- <field name="reference" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="761">identifier for the timestamp reference.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </field>
- <field name="timestamp" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="762">timestamp</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="duration" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="763">duration, or %GST_CLOCK_TIME_NONE</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </field>
- <function name="get_info"
- c:identifier="gst_reference_timestamp_meta_get_info"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2847">Get the global #GstMetaInfo describing the #GstReferenceTimestampMeta meta.</doc>
- <source-position filename="gst/gstbuffer.h" line="792"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2852">The #GstMetaInfo</doc>
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <class name="Registry"
- c:symbol-prefix="registry"
- c:type="GstRegistry"
- parent="Object"
- glib:type-name="GstRegistry"
- glib:get-type="gst_registry_get_type"
- glib:type-struct="RegistryClass">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="24">One registry holds the metadata of a set of plugins.
-
-&lt;emphasis role="bold"&gt;Design:&lt;/emphasis&gt;
-
-The #GstRegistry object is a list of plugins and some functions for dealing
-with them. Each #GstPlugin is matched 1-1 with a file on disk, and may or may
-not be loaded at a given time.
-
-The primary source, at all times, of plugin information is each plugin file
-itself. Thus, if an application wants information about a particular plugin,
-or wants to search for a feature that satisfies given criteria, the primary
-means of doing so is to load every plugin and look at the resulting
-information that is gathered in the default registry. Clearly, this is a time
-consuming process, so we cache information in the registry file. The format
-and location of the cache file is internal to gstreamer.
-
-On startup, plugins are searched for in the plugin search path. The following
-locations are checked in this order:
-
-* location from --gst-plugin-path commandline option.
-* the GST_PLUGIN_PATH environment variable.
-* the GST_PLUGIN_SYSTEM_PATH environment variable.
-* default locations (if GST_PLUGIN_SYSTEM_PATH is not set).
- Those default locations are:
- `$XDG_DATA_HOME/gstreamer-$GST_API_VERSION/plugins/`
- and `$prefix/libs/gstreamer-$GST_API_VERSION/`.
- [$XDG_DATA_HOME](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html) defaults to
- `$HOME/.local/share`.
-
-The registry cache file is loaded from
-`$XDG_CACHE_HOME/gstreamer-$GST_API_VERSION/registry-$ARCH.bin`
-(where $XDG_CACHE_HOME defaults to `$HOME/.cache`) or the file listed in the `GST_REGISTRY`
-env var. One reason to change the registry location is for testing.
-
-For each plugin that is found in the plugin search path, there could be 3
-possibilities for cached information:
-
- * the cache may not contain information about a given file.
- * the cache may have stale information.
- * the cache may have current information.
-
-In the first two cases, the plugin is loaded and the cache updated. In
-addition to these cases, the cache may have entries for plugins that are not
-relevant to the current process. These are marked as not available to the
-current process. If the cache is updated for whatever reason, it is marked
-dirty.
-
-A dirty cache is written out at the end of initialization. Each entry is
-checked to make sure the information is minimally valid. If not, the entry is
-simply dropped.
-
-## Implementation notes:
-
-The "cache" and "registry" are different concepts and can represent
-different sets of plugins. For various reasons, at init time, the cache is
-stored in the default registry, and plugins not relevant to the current
-process are marked with the %GST_PLUGIN_FLAG_CACHED bit. These plugins are
-removed at the end of initialization.</doc>
- <source-position filename="gst/gstregistry.h" line="58"/>
- <function name="fork_is_enabled"
- c:identifier="gst_registry_fork_is_enabled">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1796">By default GStreamer will perform scanning and rebuilding of the
-registry file using a helper child process.
-
-Applications might want to disable this behaviour with the
-gst_registry_fork_set_enabled() function, in which case new plugins
-are scanned (and loaded) into the application process.</doc>
- <source-position filename="gst/gst.h" line="128"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1806">%TRUE if GStreamer will use the child helper process when
-rebuilding the registry.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="fork_set_enabled"
- c:identifier="gst_registry_fork_set_enabled">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1815">Applications might want to disable/enable spawning of a child helper process
-when rebuilding the registry. See gst_registry_fork_is_enabled() for more
-information.</doc>
- <source-position filename="gst/gst.h" line="131"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1817">whether rebuilding the registry can use a temporary child helper process.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="get" c:identifier="gst_registry_get">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="322">Retrieves the singleton plugin registry. The caller does not own a
-reference on the registry, as it is alive as long as GStreamer is
-initialized.</doc>
- <source-position filename="gst/gstregistry.h" line="64"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="329">the #GstRegistry.</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </return-value>
- </function>
- <method name="add_feature" c:identifier="gst_registry_add_feature">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="552">Add the feature to the registry. The feature-added signal will be emitted.
-
-@feature's reference count will be incremented, and any floating
-reference will be removed (see gst_object_ref_sink())</doc>
- <source-position filename="gst/gstregistry.h" line="81"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="562">%TRUE on success.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="554">the registry to add the plugin to</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="555">the feature to add</doc>
- <type name="PluginFeature" c:type="GstPluginFeature*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_plugin" c:identifier="gst_registry_add_plugin">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="418">Add the plugin to the registry. The plugin-added signal will be emitted.
-
-@plugin's reference count will be incremented, and any floating
-reference will be removed (see gst_object_ref_sink())</doc>
- <source-position filename="gst/gstregistry.h" line="75"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="428">%TRUE on success.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="420">the registry to add the plugin to</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="421">the plugin to add</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </parameter>
- </parameters>
- </method>
- <method name="check_feature_version"
- c:identifier="gst_registry_check_feature_version">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1480">Checks whether a plugin feature by the given name exists in
-@registry and whether its version is at least the
-version required.</doc>
- <source-position filename="gst/gstregistry.h" line="121"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1492">%TRUE if the feature could be found and the version is
-the same as the required version or newer, and %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1482">a #GstRegistry</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="feature_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1483">the name of the feature (e.g. "oggdemux")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="min_major" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1484">the minimum major version number</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="min_minor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1485">the minimum minor version number</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="min_micro" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1486">the minimum micro version number</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="feature_filter" c:identifier="gst_registry_feature_filter">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="819">Runs a filter against all features of the plugins in the registry
-and returns a GList with the results.
-If the first flag is set, only the first match is
-returned (as a list with a single object).</doc>
- <source-position filename="gst/gstregistry.h" line="95"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="831">a #GList of
- #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
-
-MT safe.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="PluginFeature"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="821">registry to query</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="filter"
- transfer-ownership="none"
- scope="call"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="822">the filter to use</doc>
- <type name="PluginFeatureFilter" c:type="GstPluginFeatureFilter"/>
- </parameter>
- <parameter name="first" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="823">only return first match</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="824">user data passed to the filter function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="find_feature" c:identifier="gst_registry_find_feature">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="909">Find the pluginfeature with the given name and type in the registry.</doc>
- <source-position filename="gst/gstregistry.h" line="112"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="917">the pluginfeature with the
- given name and type or %NULL if the plugin was not
- found. gst_object_unref() after usage.
-
-MT safe.</doc>
- <type name="PluginFeature" c:type="GstPluginFeature*"/>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="911">the registry to search</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="912">the pluginfeature name to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="913">the pluginfeature type to find</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="find_plugin" c:identifier="gst_registry_find_plugin">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="874">Find the plugin with the given name in the registry.
-The plugin will be reffed; caller is responsible for unreffing.</doc>
- <source-position filename="gst/gstregistry.h" line="109"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="882">the plugin with the given name
- or %NULL if the plugin was not found. gst_object_unref() after
- usage.
-
-MT safe.</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="876">the registry to search</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="877">the plugin name to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_feature_list"
- c:identifier="gst_registry_get_feature_list">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="942">Retrieves a #GList of #GstPluginFeature of @type.</doc>
- <source-position filename="gst/gstregistry.h" line="100"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="949">a #GList of
- #GstPluginFeature of @type. Use gst_plugin_feature_list_free() after use
-
-MT safe.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="PluginFeature"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="944">a #GstRegistry</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="945">a #GType.</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_feature_list_by_plugin"
- c:identifier="gst_registry_get_feature_list_by_plugin">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1424">Retrieves a #GList of features of the plugin with name @name.</doc>
- <source-position filename="gst/gstregistry.h" line="103"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1431">a #GList of
- #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="PluginFeature"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1426">a #GstRegistry.</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1427">a plugin name.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_feature_list_cookie"
- c:identifier="gst_registry_get_feature_list_cookie">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1888">Returns the registry's feature list cookie. This changes
-every time a feature is added or removed from the registry.</doc>
- <source-position filename="gst/gstregistry.h" line="106"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1895">the feature list cookie.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1890">the registry</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_plugin_list"
- c:identifier="gst_registry_get_plugin_list">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="978">Get a copy of all plugins registered in the given registry. The refcount
-of each element in the list in incremented.</doc>
- <source-position filename="gst/gstregistry.h" line="87"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="985">a #GList of #GstPlugin.
- Use gst_plugin_list_free() after usage.
-
-MT safe.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Plugin"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="980">the registry to search</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="lookup" c:identifier="gst_registry_lookup">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1063">Look up a plugin in the given registry with the given filename.
-If found, plugin is reffed.</doc>
- <source-position filename="gst/gstregistry.h" line="115"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1071">the #GstPlugin if found, or
- %NULL if not. gst_object_unref() after usage.</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1065">the registry to look up in</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="filename" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1066">the name of the file to look up</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- </parameters>
- </method>
- <method name="lookup_feature" c:identifier="gst_registry_lookup_feature">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1014">Find a #GstPluginFeature with @name in @registry.</doc>
- <source-position filename="gst/gstregistry.h" line="118"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1021">a #GstPluginFeature with its refcount incremented,
- use gst_object_unref() after usage.
-
-MT safe.</doc>
- <type name="PluginFeature" c:type="GstPluginFeature*"/>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1016">a #GstRegistry</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1017">a #GstPluginFeature name</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- </parameters>
- </method>
- <method name="plugin_filter" c:identifier="gst_registry_plugin_filter">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="641">Runs a filter against all plugins in the registry and returns a #GList with
-the results. If the first flag is set, only the first match is
-returned (as a list with a single object).
-Every plugin is reffed; use gst_plugin_list_free() after use, which
-will unref again.</doc>
- <source-position filename="gst/gstregistry.h" line="90"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="654">a #GList of #GstPlugin.
- Use gst_plugin_list_free() after usage.
-
-MT safe.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Plugin"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="643">registry to query</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="filter"
- transfer-ownership="none"
- scope="call"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="644">the filter to use</doc>
- <type name="PluginFilter" c:type="GstPluginFilter"/>
- </parameter>
- <parameter name="first" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="645">only return first match</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="646">user data passed to the filter function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_feature" c:identifier="gst_registry_remove_feature">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="614">Remove the feature from the registry.
-
-MT safe.</doc>
- <source-position filename="gst/gstregistry.h" line="84"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="616">the registry to remove the feature from</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="617">the feature to remove</doc>
- <type name="PluginFeature" c:type="GstPluginFeature*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_plugin" c:identifier="gst_registry_remove_plugin">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="524">Remove the plugin from the registry.
-
-MT safe.</doc>
- <source-position filename="gst/gstregistry.h" line="78"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="526">the registry to remove the plugin from</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="527">the plugin to remove</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </parameter>
- </parameters>
- </method>
- <method name="scan_path" c:identifier="gst_registry_scan_path">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1388">Scan the given path for plugins to add to the registry. The syntax of the
-path is specific to the registry.</doc>
- <source-position filename="gst/gstregistry.h" line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1396">%TRUE if registry changed</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="registry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1390">the registry to add found plugins to</doc>
- <type name="Registry" c:type="GstRegistry*"/>
- </instance-parameter>
- <parameter name="path" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1391">the path to scan</doc>
- <type name="filename" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <field name="object">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="RegistryPrivate" c:type="GstRegistryPrivate*"/>
- </field>
- <glib:signal name="feature-added" when="last">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="233">Signals that a feature has been added to the registry (possibly
-replacing a previously-added one by the same name)</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="feature" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="236">the feature that has been added</doc>
- <type name="PluginFeature"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="plugin-added" when="last">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="221">Signals that a plugin has been added to the registry (possibly
-replacing a previously-added one by the same name)</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="224">the plugin that has been added</doc>
- <type name="Plugin"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="RegistryClass"
- c:type="GstRegistryClass"
- glib:is-gtype-struct-for="Registry">
- <source-position filename="gst/gstregistry.h" line="58"/>
- <field name="parent_class">
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- </record>
- <record name="RegistryPrivate" c:type="GstRegistryPrivate" disguised="1">
- <source-position filename="gst/gstregistry.h" line="42"/>
- </record>
- <enumeration name="ResourceError"
- glib:type-name="GstResourceError"
- glib:get-type="gst_resource_error_get_type"
- c:type="GstResourceError"
- glib:error-domain="gst-resource-error-quark">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="108">Resource errors are for any resource used by an element:
-memory, files, network connections, process space, ...
-They're typically used by source and sink elements.</doc>
- <member name="failed"
- value="1"
- c:identifier="GST_RESOURCE_ERROR_FAILED"
- glib:nick="failed">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="110">a general error which doesn't fit in any other
-category. Make sure you add a custom message to the error call.</doc>
- </member>
- <member name="too_lazy"
- value="2"
- c:identifier="GST_RESOURCE_ERROR_TOO_LAZY"
- glib:nick="too-lazy">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="112">do not use this except as a placeholder for
-deciding where to go while developing code.</doc>
- </member>
- <member name="not_found"
- value="3"
- c:identifier="GST_RESOURCE_ERROR_NOT_FOUND"
- glib:nick="not-found">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="114">used when the resource could not be found.</doc>
- </member>
- <member name="busy"
- value="4"
- c:identifier="GST_RESOURCE_ERROR_BUSY"
- glib:nick="busy">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="115">used when resource is busy.</doc>
- </member>
- <member name="open_read"
- value="5"
- c:identifier="GST_RESOURCE_ERROR_OPEN_READ"
- glib:nick="open-read">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="116">used when resource fails to open for reading.</doc>
- </member>
- <member name="open_write"
- value="6"
- c:identifier="GST_RESOURCE_ERROR_OPEN_WRITE"
- glib:nick="open-write">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="117">used when resource fails to open for writing.</doc>
- </member>
- <member name="open_read_write"
- value="7"
- c:identifier="GST_RESOURCE_ERROR_OPEN_READ_WRITE"
- glib:nick="open-read-write">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="118">used when resource cannot be opened for
-both reading and writing, or either (but unspecified which).</doc>
- </member>
- <member name="close"
- value="8"
- c:identifier="GST_RESOURCE_ERROR_CLOSE"
- glib:nick="close">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="120">used when the resource can't be closed.</doc>
- </member>
- <member name="read"
- value="9"
- c:identifier="GST_RESOURCE_ERROR_READ"
- glib:nick="read">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="121">used when the resource can't be read from.</doc>
- </member>
- <member name="write"
- value="10"
- c:identifier="GST_RESOURCE_ERROR_WRITE"
- glib:nick="write">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="122">used when the resource can't be written to.</doc>
- </member>
- <member name="seek"
- value="11"
- c:identifier="GST_RESOURCE_ERROR_SEEK"
- glib:nick="seek">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="123">used when a seek on the resource fails.</doc>
- </member>
- <member name="sync"
- value="12"
- c:identifier="GST_RESOURCE_ERROR_SYNC"
- glib:nick="sync">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="124">used when a synchronize on the resource fails.</doc>
- </member>
- <member name="settings"
- value="13"
- c:identifier="GST_RESOURCE_ERROR_SETTINGS"
- glib:nick="settings">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="125">used when settings can't be manipulated on.</doc>
- </member>
- <member name="no_space_left"
- value="14"
- c:identifier="GST_RESOURCE_ERROR_NO_SPACE_LEFT"
- glib:nick="no-space-left">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="126">used when the resource has no space left.</doc>
- </member>
- <member name="not_authorized"
- value="15"
- c:identifier="GST_RESOURCE_ERROR_NOT_AUTHORIZED"
- glib:nick="not-authorized">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="127">used when the resource can't be opened
- due to missing authorization.
- (Since: 1.2.4)</doc>
- </member>
- <member name="num_errors"
- value="16"
- c:identifier="GST_RESOURCE_ERROR_NUM_ERRORS"
- glib:nick="num-errors">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="130">the number of resource error types.</doc>
- </member>
- <function name="quark" c:identifier="gst_resource_error_quark">
- <attribute name="doc.skip" value="true"/>
- <return-value transfer-ownership="none">
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- </enumeration>
- <function-macro name="SAMPLE" c:identifier="GST_SAMPLE" introspectable="0">
- <source-position filename="gst/gstsample.h" line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="SAMPLE_CAST"
- c:identifier="GST_SAMPLE_CAST"
- introspectable="0">
- <source-position filename="gst/gstsample.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="SECOND" value="1000000000" c:type="GST_SECOND">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="98">Constant that defines one GStreamer second.</doc>
- <source-position filename="gst/gstclock.h" line="103"/>
- <type name="ClockTimeDiff" c:type="GstClockTimeDiff"/>
- </constant>
- <constant name="SEGMENT_FORMAT"
- value="paB"
- c:type="GST_SEGMENT_FORMAT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="294">printf format type used to debug GStreamer segments. You can use this in
-combination with GStreamer's debug logging system as well as the functions
-gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf()
-to pretty-print #GstSegment structures.
-This can only be used on pointers to GstSegment structures.</doc>
- <source-position filename="gst/gstinfo.h" line="303"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="SEGMENT_INSTANT_FLAGS"
- value="912"
- c:type="GST_SEGMENT_INSTANT_FLAGS">
- <source-position filename="gst/gstsegment.h" line="197"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="SEQNUM_INVALID"
- value="0"
- c:type="GST_SEQNUM_INVALID"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="102">A value which is guaranteed to never be returned by
-gst_util_seqnum_next().
-
-Can be used as a default value in variables used to store seqnum.</doc>
- <source-position filename="gst/gstutils.h" line="112"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="SHARED_TASK_POOL"
- c:identifier="GST_SHARED_TASK_POOL"
- introspectable="0">
- <source-position filename="gst/gsttaskpool.h" line="127"/>
- <parameters>
- <parameter name="pool">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="SHARED_TASK_POOL_CLASS"
- c:identifier="GST_SHARED_TASK_POOL_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttaskpool.h" line="129"/>
- <parameters>
- <parameter name="pclass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="SHARED_TASK_POOL_GET_CLASS"
- c:identifier="GST_SHARED_TASK_POOL_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttaskpool.h" line="131"/>
- <parameters>
- <parameter name="pool">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE" c:identifier="GST_STATE" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="103">This macro returns the current #GstState of the element.</doc>
- <source-position filename="gst/gstelement.h" line="109"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="105">a #GstElement to return state for.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_BROADCAST"
- c:identifier="GST_STATE_BROADCAST"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="586"/>
- <parameters>
- <parameter name="elem">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_GET_COND"
- c:identifier="GST_STATE_GET_COND"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="570">Get the conditional used to signal the completion of a state change.</doc>
- <source-position filename="gst/gstelement.h" line="576"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="572">a #GstElement</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_GET_LOCK"
- c:identifier="GST_STATE_GET_LOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="561">Get a reference to the state lock of @elem.
-This lock is used by the core. It is taken while getting or setting
-the state, during state changes, and while finalizing.</doc>
- <source-position filename="gst/gstelement.h" line="569"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="563">a #GstElement</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_GET_NEXT"
- c:identifier="GST_STATE_GET_NEXT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="144">Given a current state @cur and a target state @pending, calculate the next (intermediate)
-#GstState.</doc>
- <source-position filename="gst/gstelement.h" line="152"/>
- <parameters>
- <parameter name="cur">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="146">A starting #GstState</doc>
- </parameter>
- <parameter name="pending">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="147">A target #GstState</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_LOCK"
- c:identifier="GST_STATE_LOCK"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="578"/>
- <parameters>
- <parameter name="elem">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_NEXT"
- c:identifier="GST_STATE_NEXT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="111">This macro returns the next #GstState of the element.</doc>
- <source-position filename="gst/gstelement.h" line="117"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="113">a #GstElement to return the next state for.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_PENDING"
- c:identifier="GST_STATE_PENDING"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="119">This macro returns the currently pending #GstState of the element.</doc>
- <source-position filename="gst/gstelement.h" line="125"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="121">a #GstElement to return the pending state for.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_RETURN"
- c:identifier="GST_STATE_RETURN"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="135">This macro returns the last #GstStateChangeReturn value.</doc>
- <source-position filename="gst/gstelement.h" line="141"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="137">a #GstElement to return the last state result for.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_SIGNAL"
- c:identifier="GST_STATE_SIGNAL"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="585"/>
- <parameters>
- <parameter name="elem">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_TARGET"
- c:identifier="GST_STATE_TARGET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="127">This macro returns the target #GstState of the element.</doc>
- <source-position filename="gst/gstelement.h" line="133"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="129">a #GstElement to return the target state for.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_TRANSITION"
- c:identifier="GST_STATE_TRANSITION"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="153">Given a current state @cur and a next state @next, calculate the associated
-#GstStateChange transition.</doc>
- <source-position filename="gst/gstelement.h" line="161"/>
- <parameters>
- <parameter name="cur">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="155">A current state</doc>
- </parameter>
- <parameter name="next">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="156">A next state</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_TRANSITION_CURRENT"
- c:identifier="GST_STATE_TRANSITION_CURRENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="162">Given a state transition @trans, extract the current #GstState.</doc>
- <source-position filename="gst/gstelement.h" line="168"/>
- <parameters>
- <parameter name="trans">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="164">A #GstStateChange</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_TRANSITION_NEXT"
- c:identifier="GST_STATE_TRANSITION_NEXT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="169">Given a state transition @trans, extract the next #GstState.</doc>
- <source-position filename="gst/gstelement.h" line="175"/>
- <parameters>
- <parameter name="trans">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="171">A #GstStateChange</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_TRYLOCK"
- c:identifier="GST_STATE_TRYLOCK"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="579"/>
- <parameters>
- <parameter name="elem">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_UNLOCK"
- c:identifier="GST_STATE_UNLOCK"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="580"/>
- <parameters>
- <parameter name="elem">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_WAIT"
- c:identifier="GST_STATE_WAIT"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="581"/>
- <parameters>
- <parameter name="elem">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATE_WAIT_UNTIL"
- c:identifier="GST_STATE_WAIT_UNTIL"
- introspectable="0">
- <source-position filename="gst/gstelement.h" line="583"/>
- <parameters>
- <parameter name="elem">
- </parameter>
- <parameter name="end_time">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATIC_CAPS"
- c:identifier="GST_STATIC_CAPS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="122">Creates a new #GstCaps static caps from an input string.
-This can be used in pad templates.</doc>
- <source-position filename="gst/gstcaps.h" line="129"/>
- <parameters>
- <parameter name="string">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="124">the string describing the caps</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STATIC_PAD_TEMPLATE"
- c:identifier="GST_STATIC_PAD_TEMPLATE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="175">Convenience macro to fill the values of a #GstStaticPadTemplate
-structure.
-Example:
-|[&lt;!-- language="C" --&gt;
-static GstStaticPadTemplate my_src_template = * GST_STATIC_PAD_TEMPLATE("src", GST_PAD_SRC, GST_PAD_ALWAYS,
-,
- GST_STATIC_CAPS_ANY);
-]|</doc>
- <source-position filename="gst/gstpadtemplate.h" line="191"/>
- <parameters>
- <parameter name="padname">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="177">the name template of the pad</doc>
- </parameter>
- <parameter name="dir">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="178">the GstPadDirection of the pad</doc>
- </parameter>
- <parameter name="pres">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="179">the GstPadPresence of the pad</doc>
- </parameter>
- <parameter name="caps">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="180">the GstStaticCaps of the pad</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="STIMEP_FORMAT"
- value="paS"
- c:type="GST_STIMEP_FORMAT"
- version="1.18"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="318">printf format type used to debug GStreamer signed time value pointers. You
-can use this in combination with GStreamer's debug logging system as well as
-the functions gst_info_vasprintf(), gst_info_strdup_vprintf() and
-gst_info_strdup_printf() to pretty-print signed time (pointers to
-#GstClockTimeDiff or #gint64).</doc>
- <source-position filename="gst/gstinfo.h" line="329"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="STIME_ARGS"
- c:identifier="GST_STIME_ARGS"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="259">Format @t for the #GST_STIME_FORMAT format string. Note: @t will be
-evaluated more than once.</doc>
- <source-position filename="gst/gstclock.h" line="268"/>
- <parameters>
- <parameter name="t">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="261">a #GstClockTimeDiff or #gint64</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="STIME_FORMAT"
- value="c%"
- c:type="GST_STIME_FORMAT"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="244">A string that can be used in printf-like format strings to display a signed
-#GstClockTimeDiff or #gint64 value in h:m:s format. Use GST_TIME_ARGS() to
-construct the matching arguments.
-
-Example:
-|[
-printf("%" GST_STIME_FORMAT "\n", GST_STIME_ARGS(ts));
-]|</doc>
- <source-position filename="gst/gstclock.h" line="258"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="STREAM" c:identifier="GST_STREAM" introspectable="0">
- <source-position filename="gst/gststreams.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STREAM_CAST"
- c:identifier="GST_STREAM_CAST"
- introspectable="0">
- <source-position filename="gst/gststreams.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STREAM_CLASS"
- c:identifier="GST_STREAM_CLASS"
- introspectable="0">
- <source-position filename="gst/gststreams.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STREAM_COLLECTION"
- c:identifier="GST_STREAM_COLLECTION"
- introspectable="0">
- <source-position filename="gst/gststreamcollection.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STREAM_COLLECTION_CAST"
- c:identifier="GST_STREAM_COLLECTION_CAST"
- introspectable="0">
- <source-position filename="gst/gststreamcollection.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STREAM_COLLECTION_CLASS"
- c:identifier="GST_STREAM_COLLECTION_CLASS"
- introspectable="0">
- <source-position filename="gst/gststreamcollection.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STREAM_COLLECTION_GET_CLASS"
- c:identifier="GST_STREAM_COLLECTION_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gststreamcollection.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STREAM_GET_CLASS"
- c:identifier="GST_STREAM_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gststreams.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STRUCTURE"
- c:identifier="GST_STRUCTURE"
- introspectable="0">
- <source-position filename="gst/gststructure.h" line="38"/>
- <parameters>
- <parameter name="object">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STRUCTURE_CAST"
- c:identifier="GST_STRUCTURE_CAST"
- introspectable="0">
- <source-position filename="gst/gststructure.h" line="37"/>
- <parameters>
- <parameter name="object">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STR_FOURCC"
- c:identifier="GST_STR_FOURCC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="48">Transform an input string into a #guint32 fourcc value with host
-endianness.
-Caller is responsible for ensuring the input string consists of at least
-four characters.
-
-|[
-guint32 fourcc = GST_STR_FOURCC ("MJPG");
-]|</doc>
- <source-position filename="gst/gstvalue.h" line="62"/>
- <parameters>
- <parameter name="f">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="50">a string with at least four characters</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="STR_NULL"
- c:identifier="GST_STR_NULL"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="230">Macro to use when a string must not be %NULL, but may be %NULL. If the string
-is %NULL, "(NULL)" is printed instead.
-In GStreamer printf string arguments may not be %NULL, because on some
-platforms (ie Solaris) the libc crashes in that case. This includes debugging
-strings.</doc>
- <source-position filename="gst/gstinfo.h" line="240"/>
- <parameters>
- <parameter name="str">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="232">The string to check.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="SYSTEM_CLOCK"
- c:identifier="GST_SYSTEM_CLOCK"
- introspectable="0">
- <source-position filename="gst/gstsystemclock.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="SYSTEM_CLOCK_CAST"
- c:identifier="GST_SYSTEM_CLOCK_CAST"
- introspectable="0">
- <source-position filename="gst/gstsystemclock.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="SYSTEM_CLOCK_CLASS"
- c:identifier="GST_SYSTEM_CLOCK_CLASS"
- introspectable="0">
- <source-position filename="gst/gstsystemclock.h" line="36"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="SYSTEM_CLOCK_GET_CLASS"
- c:identifier="GST_SYSTEM_CLOCK_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gstsystemclock.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <record name="Sample"
- c:type="GstSample"
- glib:type-name="GstSample"
- glib:get-type="gst_sample_get_type"
- c:symbol-prefix="sample">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="22">A #GstSample is a small object containing data, a type, timing and
-extra arbitrary information.</doc>
- <source-position filename="gst/gstsample.h" line="48"/>
- <constructor name="new" c:identifier="gst_sample_new">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="111">Create a new #GstSample with the provided details.
-
-Free-function: gst_sample_unref</doc>
- <source-position filename="gst/gstsample.h" line="56"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="122">the new #GstSample. gst_sample_unref()
- after usage.</doc>
- <type name="Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <parameter name="buffer"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="113">a #GstBuffer, or %NULL</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="114">a #GstCaps, or %NULL</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="segment"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="115">a #GstSegment, or %NULL</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </parameter>
- <parameter name="info"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="116">a #GstStructure, or %NULL</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="copy"
- c:identifier="gst_sample_copy"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="161">Create a copy of the given sample. This will also make a newly allocated
-copy of the data the source sample contains.</doc>
- <source-position filename="gst/gstsample.h" line="172"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="168">a new copy of @buf.</doc>
- <type name="Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="163">a #GstSample.</doc>
- <type name="Sample" c:type="const GstSample*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_buffer" c:identifier="gst_sample_get_buffer">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="175">Get the buffer associated with @sample</doc>
- <source-position filename="gst/gstsample.h" line="61"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="181">the buffer of @sample or %NULL
- when there is no buffer. The buffer remains valid as long as
- @sample is valid. If you need to hold on to it for longer than
- that, take a ref to the buffer with gst_buffer_ref().</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="177">a #GstSample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_buffer_list"
- c:identifier="gst_sample_get_buffer_list"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="247">Get the buffer list associated with @sample</doc>
- <source-position filename="gst/gstsample.h" line="73"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="253">the buffer list of @sample or %NULL
- when there is no buffer list. The buffer list remains valid as long as
- @sample is valid. If you need to hold on to it for longer than
- that, take a ref to the buffer list with gst_mini_object_ref ().</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="249">a #GstSample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_caps" c:identifier="gst_sample_get_caps">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="194">Get the caps associated with @sample</doc>
- <source-position filename="gst/gstsample.h" line="64"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="200">the caps of @sample or %NULL
- when there is no caps. The caps remain valid as long as @sample is
- valid. If you need to hold on to the caps for longer than that,
- take a ref to the caps with gst_caps_ref().</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="196">a #GstSample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_info" c:identifier="gst_sample_get_info">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="230">Get extra information associated with @sample.</doc>
- <source-position filename="gst/gstsample.h" line="70"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="236">the extra info of @sample.
- The info remains valid as long as @sample is valid.</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="232">a #GstSample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_segment" c:identifier="gst_sample_get_segment">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="213">Get the segment associated with @sample</doc>
- <source-position filename="gst/gstsample.h" line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="219">the segment of @sample.
- The segment remains valid as long as @sample is valid.</doc>
- <type name="Segment" c:type="GstSegment*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="215">a #GstSample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_sample_ref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="91">Increases the refcount of the given sample by one.</doc>
- <source-position filename="gst/gstsample.h" line="99"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="97">@sample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="93">a #GstSample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_buffer"
- c:identifier="gst_sample_set_buffer"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="304">Set the buffer associated with @sample. @sample must be writable.</doc>
- <source-position filename="gst/gstsample.h" line="79"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="306">A #GstSample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="307">A #GstBuffer</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_buffer_list"
- c:identifier="gst_sample_set_buffer_list"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="268">Set the buffer list associated with @sample. @sample must be writable.</doc>
- <source-position filename="gst/gstsample.h" line="76"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="270">a #GstSample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </instance-parameter>
- <parameter name="buffer_list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="271">a #GstBufferList</doc>
- <type name="BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_caps"
- c:identifier="gst_sample_set_caps"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="341">Set the caps associated with @sample. @sample must be writable.</doc>
- <source-position filename="gst/gstsample.h" line="82"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="343">A #GstSample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="344">A #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_info"
- c:identifier="gst_sample_set_info"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="400">Set the info structure associated with @sample. @sample must be writable,
-and @info must not have a parent set already.</doc>
- <source-position filename="gst/gstsample.h" line="88"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="402">A #GstSample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="403">A #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_segment"
- c:identifier="gst_sample_set_segment"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="378">Set the segment associated with @sample. @sample must be writable.</doc>
- <source-position filename="gst/gstsample.h" line="85"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="380">A #GstSample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </instance-parameter>
- <parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsample.c"
- line="381">A #GstSegment</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_sample_unref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="107">Decreases the refcount of the sample. If the refcount reaches 0, the
-sample will be freed.</doc>
- <source-position filename="gst/gstsample.h" line="114"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sample" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="109">a #GstSample</doc>
- <type name="Sample" c:type="GstSample*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <bitfield name="SchedulingFlags"
- glib:type-name="GstSchedulingFlags"
- glib:get-type="gst_scheduling_flags_get_type"
- c:type="GstSchedulingFlags">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="606">The different scheduling flags.</doc>
- <member name="seekable"
- value="1"
- c:identifier="GST_SCHEDULING_FLAG_SEEKABLE"
- glib:nick="seekable">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="608">if seeking is possible</doc>
- </member>
- <member name="sequential"
- value="2"
- c:identifier="GST_SCHEDULING_FLAG_SEQUENTIAL"
- glib:nick="sequential">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="609">if sequential access is recommended</doc>
- </member>
- <member name="bandwidth_limited"
- value="4"
- c:identifier="GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED"
- glib:nick="bandwidth-limited">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="610">if bandwidth is limited and buffering possible (since 1.2)</doc>
- </member>
- </bitfield>
- <enumeration name="SearchMode"
- glib:type-name="GstSearchMode"
- glib:get-type="gst_search_mode_get_type"
- c:type="GstSearchMode">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="1160">The different search modes.</doc>
- <member name="exact"
- value="0"
- c:identifier="GST_SEARCH_MODE_EXACT"
- glib:nick="exact">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="1162">Only search for exact matches.</doc>
- </member>
- <member name="before"
- value="1"
- c:identifier="GST_SEARCH_MODE_BEFORE"
- glib:nick="before">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="1163">Search for an exact match or the element just before.</doc>
- </member>
- <member name="after"
- value="2"
- c:identifier="GST_SEARCH_MODE_AFTER"
- glib:nick="after">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="1164">Search for an exact match or the element just after.</doc>
- </member>
- </enumeration>
- <bitfield name="SeekFlags"
- glib:type-name="GstSeekFlags"
- glib:get-type="gst_seek_flags_get_type"
- c:type="GstSeekFlags">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="50">Flags to be used with gst_element_seek() or gst_event_new_seek(). All flags
-can be used together.
-
-A non flushing seek might take some time to perform as the currently
-playing data in the pipeline will not be cleared.
-
-An accurate seek might be slower for formats that don't have any indexes
-or timestamp markers in the stream. Specifying this flag might require a
-complete scan of the file in those cases.
-
-When performing a segment seek: after the playback of the segment completes,
-no EOS will be emitted by the element that performed the seek, but a
-%GST_MESSAGE_SEGMENT_DONE message will be posted on the bus by the element.
-When this message is posted, it is possible to send a new seek event to
-continue playback. With this seek method it is possible to perform seamless
-looping or simple linear editing.
-
-When only changing the playback rate and not the direction, the
-%GST_SEEK_FLAG_INSTANT_RATE_CHANGE flag can be used for a non-flushing seek
-to signal that the rate change should be applied immediately. This requires
-special support in the seek handlers (e.g. demuxers) and any elements
-synchronizing to the clock, and in general can't work in all cases (for example
-UDP streaming where the delivery rate is controlled by a remote server). The
-instant-rate-change mode supports changing the trickmode-related GST_SEEK_ flags,
-but can't be used in conjunction with other seek flags that affect the new
-playback position - as the playback position will not be changing.
-
-When doing fast forward (rate &gt; 1.0) or fast reverse (rate &lt; -1.0) trickmode
-playback, the %GST_SEEK_FLAG_TRICKMODE flag can be used to instruct decoders
-and demuxers to adjust the playback rate by skipping frames. This can improve
-performance and decrease CPU usage because not all frames need to be decoded.
-
-Beyond that, the %GST_SEEK_FLAG_TRICKMODE_KEY_UNITS flag can be used to
-request that decoders skip all frames except key units, and
-%GST_SEEK_FLAG_TRICKMODE_NO_AUDIO flags can be used to request that audio
-decoders do no decoding at all, and simple output silence.
-
-The %GST_SEEK_FLAG_SNAP_BEFORE flag can be used to snap to the previous
-relevant location, and the %GST_SEEK_FLAG_SNAP_AFTER flag can be used to
-select the next relevant location. If %GST_SEEK_FLAG_KEY_UNIT is specified,
-the relevant location is a keyframe. If both flags are specified, the nearest
-of these locations will be selected. If none are specified, the implementation is
-free to select whichever it wants.
-
-The before and after here are in running time, so when playing backwards,
-the next location refers to the one that will played in next, and not the
-one that is located after in the actual source stream.
-
-Also see part-seeking.txt in the GStreamer design documentation for more
-details on the meaning of these flags and the behaviour expected of
-elements that handle them.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_SEEK_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="52">no flag</doc>
- </member>
- <member name="flush"
- value="1"
- c:identifier="GST_SEEK_FLAG_FLUSH"
- glib:nick="flush">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="53">flush pipeline</doc>
- </member>
- <member name="accurate"
- value="2"
- c:identifier="GST_SEEK_FLAG_ACCURATE"
- glib:nick="accurate">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="54">accurate position is requested, this might
- be considerably slower for some formats.</doc>
- </member>
- <member name="key_unit"
- value="4"
- c:identifier="GST_SEEK_FLAG_KEY_UNIT"
- glib:nick="key-unit">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="56">seek to the nearest keyframe. This might be
- faster but less accurate.</doc>
- </member>
- <member name="segment"
- value="8"
- c:identifier="GST_SEEK_FLAG_SEGMENT"
- glib:nick="segment">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="58">perform a segment seek.</doc>
- </member>
- <member name="trickmode"
- value="16"
- c:identifier="GST_SEEK_FLAG_TRICKMODE"
- glib:nick="trickmode">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="59">when doing fast forward or fast reverse playback, allow
- elements to skip frames instead of generating all
- frames. (Since: 1.6)</doc>
- </member>
- <member name="skip"
- value="16"
- c:identifier="GST_SEEK_FLAG_SKIP"
- glib:nick="skip">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="88">Deprecated backward compatibility flag, replaced
- by %GST_SEEK_FLAG_TRICKMODE</doc>
- </member>
- <member name="snap_before"
- value="32"
- c:identifier="GST_SEEK_FLAG_SNAP_BEFORE"
- glib:nick="snap-before">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="62">go to a location before the requested position,
- if %GST_SEEK_FLAG_KEY_UNIT this means the keyframe at or before
- the requested position the one at or before the seek target.</doc>
- </member>
- <member name="snap_after"
- value="64"
- c:identifier="GST_SEEK_FLAG_SNAP_AFTER"
- glib:nick="snap-after">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="65">go to a location after the requested position,
- if %GST_SEEK_FLAG_KEY_UNIT this means the keyframe at of after the
- requested position.</doc>
- </member>
- <member name="snap_nearest"
- value="96"
- c:identifier="GST_SEEK_FLAG_SNAP_NEAREST"
- glib:nick="snap-nearest">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="68">go to a position near the requested position,
- if %GST_SEEK_FLAG_KEY_UNIT this means the keyframe closest
- to the requested position, if both keyframes are at an equal
- distance, behaves like %GST_SEEK_FLAG_SNAP_BEFORE.</doc>
- </member>
- <member name="trickmode_key_units"
- value="128"
- c:identifier="GST_SEEK_FLAG_TRICKMODE_KEY_UNITS"
- glib:nick="trickmode-key-units">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="72">when doing fast forward or fast reverse
- playback, request that elements only decode keyframes
- and skip all other content, for formats that have
- keyframes. (Since: 1.6)</doc>
- </member>
- <member name="trickmode_no_audio"
- value="256"
- c:identifier="GST_SEEK_FLAG_TRICKMODE_NO_AUDIO"
- glib:nick="trickmode-no-audio">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="81">when doing fast forward or fast reverse
- playback, request that audio decoder elements skip
- decoding and output only gap events or silence. (Since: 1.6)</doc>
- </member>
- <member name="trickmode_forward_predicted"
- value="512"
- c:identifier="GST_SEEK_FLAG_TRICKMODE_FORWARD_PREDICTED"
- glib:nick="trickmode-forward-predicted">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="76">When doing fast forward or fast reverse
- playback, request that elements only decode keyframes and
- forward predicted frames and skip all other content (for example
- B-Frames), for formats that have keyframes and forward predicted
- frames. (Since: 1.18)</doc>
- </member>
- <member name="instant_rate_change"
- value="1024"
- c:identifier="GST_SEEK_FLAG_INSTANT_RATE_CHANGE"
- glib:nick="instant-rate-change">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="84">Signals that a rate change should be
- applied immediately. Only valid if start/stop position
- are GST_CLOCK_TIME_NONE, the playback direction does not change
- and the seek is not flushing. (Since: 1.18)</doc>
- </member>
- </bitfield>
- <enumeration name="SeekType"
- glib:type-name="GstSeekType"
- glib:get-type="gst_seek_type_get_type"
- c:type="GstSeekType">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="34">The different types of seek events. When constructing a seek event with
-gst_event_new_seek() or when doing gst_segment_do_seek ().</doc>
- <member name="none"
- value="0"
- c:identifier="GST_SEEK_TYPE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="36">no change in position is required</doc>
- </member>
- <member name="set"
- value="1"
- c:identifier="GST_SEEK_TYPE_SET"
- glib:nick="set">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="37">absolute position is requested</doc>
- </member>
- <member name="end"
- value="2"
- c:identifier="GST_SEEK_TYPE_END"
- glib:nick="end">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="38">relative position to duration is requested</doc>
- </member>
- </enumeration>
- <record name="Segment"
- c:type="GstSegment"
- glib:type-name="GstSegment"
- glib:get-type="gst_segment_get_type"
- c:symbol-prefix="segment">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="29">This helper structure holds the relevant values for tracking the region of
-interest in a media file, called a segment.
-
-The structure can be used for two purposes:
-
- * performing seeks (handling seek events)
- * tracking playback regions (handling newsegment events)
-
-The segment is usually configured by the application with a seek event which
-is propagated upstream and eventually handled by an element that performs the seek.
-
-The configured segment is then propagated back downstream with a newsegment event.
-This information is then used to clip media to the segment boundaries.
-
-A segment structure is initialized with gst_segment_init(), which takes a #GstFormat
-that will be used as the format of the segment values. The segment will be configured
-with a start value of 0 and a stop/duration of -1, which is undefined. The default
-rate and applied_rate is 1.0.
-
-The public duration field contains the duration of the segment. When using
-the segment for seeking, the start and time members should normally be left
-to their default 0 value. The stop position is left to -1 unless explicitly
-configured to a different value after a seek event.
-
-The current position in the segment should be set by changing the position
-member in the structure.
-
-For elements that perform seeks, the current segment should be updated with the
-gst_segment_do_seek() and the values from the seek event. This method will update
-all the segment fields. The position field will contain the new playback position.
-If the start_type was different from GST_SEEK_TYPE_NONE, playback continues from
-the position position, possibly with updated flags or rate.
-
-For elements that want to use #GstSegment to track the playback region,
-update the segment fields with the information from the newsegment event.
-The gst_segment_clip() method can be used to check and clip
-the media data to the segment boundaries.
-
-For elements that want to synchronize to the pipeline clock, gst_segment_to_running_time()
-can be used to convert a timestamp to a value that can be used to synchronize
-to the clock. This function takes into account the base as well as
-any rate or applied_rate conversions.
-
-For elements that need to perform operations on media data in stream_time,
-gst_segment_to_stream_time() can be used to convert a timestamp and the segment
-info to stream time (which is always between 0 and the duration of the stream).</doc>
- <source-position filename="gst/gstsegment.h" line="282"/>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="202">flags for this segment</doc>
- <type name="SegmentFlags" c:type="GstSegmentFlags"/>
- </field>
- <field name="rate" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="203">the playback rate of the segment is set in response to a seek
- event and, without any seek, the value should be `1.0`. This
- value is used by elements that synchronize buffer [running
- times](additional/design/synchronisation.md#running-time) on
- the clock (usually the sink elements), leading to consuming
- buffers faster (for a value `&gt; 1.0`) or slower (for `0.0 &lt;
- value &lt; 1.0`) than normal playback speed. The rate also
- defines the playback direction, meaning that when the value is
- lower than `0.0`, the playback happens in reverse, and the
- [stream-time](additional/design/synchronisation.md#stream-time)
- is going backward. The `rate` value should never be `0.0`.</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="applied_rate" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="214">The applied rate is the rate that has been applied to the stream.
- The effective/resulting playback rate of a stream is
- `rate * applied_rate`.
- The applied rate can be set by source elements when a server is
- sending the stream with an already modified playback speed
- rate. Filter elements that modify the stream in a way that
- modifies the playback speed should also modify the applied
- rate. For example the #videorate element when its
- #videorate:rate property is set will set the applied rate of
- the segment it pushed downstream. Also #scaletempo applies the
- input segment rate to the stream and outputs a segment with
- rate=1.0 and applied_rate=&lt;inputsegment.rate&gt;.</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="format" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="226">the unit used for all of the segment's values.</doc>
- <type name="Format" c:type="GstFormat"/>
- </field>
- <field name="base" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="227">the running time (plus elapsed time, see offset) of the
- segment [start](GstSegment.start) ([stop](GstSegment.stop) if
- rate &lt; 0.0).</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="offset" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="230">the offset expresses the elapsed time (in buffer timestamps)
- before a seek with its start (stop if rate &lt; 0.0) seek type
- set to #GST_SEEK_TYPE_NONE, the value is set to the position
- of the segment at the time of the seek.</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="start" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="234">the start time of the segment (in buffer timestamps)
- [(PTS)](GstBuffer.pts), that is the timestamp of the first
- buffer to output inside the segment (last one during
- reverse playback). For example decoders will
- [clip](gst_segment_clip) out the buffers before the start
- time.</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="stop" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="240">the stop time of the segment (in buffer timestamps)
- [(PTS)](GstBuffer.pts), that is the timestamp of the last
- buffer to output inside the segment (first one during
- reverse playback). For example decoders will
- [clip](gst_segment_clip) out buffers after the stop time.</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="time" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="245">the stream time of the segment [start](GstSegment.start)
- ([stop](GstSegment.stop) if rate &lt; 0.0).</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="position" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="247">the buffer timestamp position in the segment is supposed to be
- updated by elements such as sources, demuxers or parsers to
- track progress by setting it to the last pushed buffer' end time
- ([timestamp](GstBuffer.pts) + #GstBuffer.duration) for that
- specific segment. The position is used when reconfiguring the
- segment with #gst_segment_do_seek when the seek is only
- updating the segment (see [offset](GstSegment.offset)).</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="duration" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="254">the duration of the segment is the maximum absolute difference
- between #GstSegment.start and #GstSegment.stop if stop is not
- set, otherwise it should be the difference between those
- two values. This should be set by elements that know the
- overall stream duration (like demuxers) and will be used when
- seeking with #GST_SEEK_TYPE_END.</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <constructor name="new" c:identifier="gst_segment_new">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="127">Allocate a new #GstSegment structure and initialize it using
-gst_segment_init().
-
-Free-function: gst_segment_free</doc>
- <source-position filename="gst/gstsegment.h" line="288"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="135">a new #GstSegment, free with gst_segment_free().</doc>
- <type name="Segment" c:type="GstSegment*"/>
- </return-value>
- </constructor>
- <method name="clip" c:identifier="gst_segment_clip">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="868">Clip the given @start and @stop values to the segment boundaries given
-in @segment. @start and @stop are compared and clipped to @segment
-start and stop values.
-
-If the function returns %FALSE, @start and @stop are known to fall
-outside of @segment and @clip_start and @clip_stop are not updated.
-
-When the function returns %TRUE, @clip_start and @clip_stop will be
-updated. If @clip_start or @clip_stop are different from @start or @stop
-respectively, the region fell partially in the segment.
-
-Note that when @stop is -1, @clip_stop will be set to the end of the
-segment. Depending on the use case, this may or may not be what you want.</doc>
- <source-position filename="gst/gstsegment.h" line="337"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="891">%TRUE if the given @start and @stop times fall partially or
- completely in @segment, %FALSE if the values are completely outside
- of the segment.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="870">a #GstSegment structure.</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="871">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="872">the start position in the segment</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="stop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="873">the stop position in the segment</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="clip_start"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="874">the clipped start position in the segment</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="clip_stop"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="875">the clipped stop position in the segment</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_segment_copy">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="90">Create a copy of given @segment.
-
-Free-function: gst_segment_free</doc>
- <source-position filename="gst/gstsegment.h" line="291"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="98">a new #GstSegment, free with gst_segment_free().</doc>
- <type name="Segment" c:type="GstSegment*"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="92">a #GstSegment</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="copy_into" c:identifier="gst_segment_copy_into">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="111">Copy the contents of @src into @dest.</doc>
- <source-position filename="gst/gstsegment.h" line="294"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="113">a #GstSegment</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="114">a #GstSegment</doc>
- <type name="Segment" c:type="GstSegment*"/>
- </parameter>
- </parameters>
- </method>
- <method name="do_seek" c:identifier="gst_segment_do_seek">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="189">Update the segment structure with the field values of a seek event (see
-gst_event_new_seek()).
-
-After calling this method, the segment field position and time will
-contain the requested new position in the segment. The new requested
-position in the segment depends on @rate and @start_type and @stop_type.
-
-For positive @rate, the new position in the segment is the new @segment
-start field when it was updated with a @start_type different from
-#GST_SEEK_TYPE_NONE. If no update was performed on @segment start position
-(#GST_SEEK_TYPE_NONE), @start is ignored and @segment position is
-unmodified.
-
-For negative @rate, the new position in the segment is the new @segment
-stop field when it was updated with a @stop_type different from
-#GST_SEEK_TYPE_NONE. If no stop was previously configured in the segment, the
-duration of the segment will be used to update the stop position.
-If no update was performed on @segment stop position (#GST_SEEK_TYPE_NONE),
-@stop is ignored and @segment position is unmodified.
-
-The applied rate of the segment will be set to 1.0 by default.
-If the caller can apply a rate change, it should update @segment
-rate and applied_rate after calling this function.
-
-@update will be set to %TRUE if a seek should be performed to the segment
-position field. This field can be %FALSE if, for example, only the @rate
-has been changed but not the playback position.</doc>
- <source-position filename="gst/gstsegment.h" line="340"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="229">%TRUE if the seek could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="191">a #GstSegment structure.</doc>
- <type name="Segment" c:type="GstSegment*"/>
- </instance-parameter>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="192">the rate of the segment.</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="193">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="194">the segment flags for the segment</doc>
- <type name="SeekFlags" c:type="GstSeekFlags"/>
- </parameter>
- <parameter name="start_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="195">the seek method</doc>
- <type name="SeekType" c:type="GstSeekType"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="196">the seek start value</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="stop_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="197">the seek method</doc>
- <type name="SeekType" c:type="GstSeekType"/>
- </parameter>
- <parameter name="stop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="198">the seek stop value</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="update"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="199">boolean holding whether position was updated.</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_segment_free">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="148">Free the allocated segment @segment.</doc>
- <source-position filename="gst/gstsegment.h" line="297"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="150">a #GstSegment</doc>
- <type name="Segment" c:type="GstSegment*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_segment_init">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="160">The start/position fields are set to 0 and the stop/duration
-fields are set to -1 (unknown). The default rate of 1.0 and no
-flags are set.
-
-Initialize @segment to its default values.</doc>
- <source-position filename="gst/gstsegment.h" line="300"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="162">a #GstSegment structure.</doc>
- <type name="Segment" c:type="GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="163">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_equal"
- c:identifier="gst_segment_is_equal"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1216">Checks for two segments being equal. Equality here is defined
-as perfect equality, including floating point values.</doc>
- <source-position filename="gst/gstsegment.h" line="345"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1226">%TRUE if the segments are equal, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="s0" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1218">a #GstSegment structure.</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- <parameter name="s1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1219">a #GstSegment structure.</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </parameter>
- </parameters>
- </method>
- <method name="offset_running_time"
- c:identifier="gst_segment_offset_running_time"
- version="1.2.3">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1167">Adjust the values in @segment so that @offset is applied to all
-future running-time calculations.</doc>
- <source-position filename="gst/gstsegment.h" line="334"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1178">%TRUE if the segment could be updated successfully. If %FALSE is
-returned, @offset is not in @segment.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1169">a #GstSegment structure.</doc>
- <type name="Segment" c:type="GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1170">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1171">the offset to apply in the segment</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="position_from_running_time"
- c:identifier="gst_segment_position_from_running_time"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="937">Convert @running_time into a position in the segment so that
-gst_segment_to_running_time() with that position returns @running_time.</doc>
- <source-position filename="gst/gstsegment.h" line="328"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="946">the position in the segment for @running_time. This function returns
--1 when @running_time is -1 or when it is not inside @segment.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="939">a #GstSegment structure.</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="940">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="running_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="941">the running_time in the segment</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="position_from_running_time_full"
- c:identifier="gst_segment_position_from_running_time_full"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="985">Translate @running_time to the segment position using the currently configured
-segment. Compared to gst_segment_position_from_running_time() this function can
-return negative segment position.
-
-This function is typically used by elements that need to synchronize buffers
-against the clock or each other.
-
-@running_time can be any value and the result of this function for values
-outside of the segment is extrapolated.
-
-When 1 is returned, @running_time resulted in a positive position returned
-in @position.
-
-When this function returns -1, the returned @position was &lt; 0, and the value
-in the position variable should be negated to get the real negative segment
-position.</doc>
- <source-position filename="gst/gstsegment.h" line="325"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1009">a 1 or -1 on success, 0 on failure.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="987">a #GstSegment structure.</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="988">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="running_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="989">the running-time</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="position"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="990">the resulting position in the segment</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="position_from_stream_time"
- c:identifier="gst_segment_position_from_stream_time"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="659">Convert @stream_time into a position in the segment so that
-gst_segment_to_stream_time() with that position returns @stream_time.</doc>
- <source-position filename="gst/gstsegment.h" line="312"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="668">the position in the segment for @stream_time. This function returns
--1 when @stream_time is -1 or when it is not inside @segment.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="661">a #GstSegment structure.</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="662">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="stream_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="663">the stream_time in the segment</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="position_from_stream_time_full"
- c:identifier="gst_segment_position_from_stream_time_full"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="548">Translate @stream_time to the segment position using the currently configured
-segment. Compared to gst_segment_position_from_stream_time() this function can
-return negative segment position.
-
-This function is typically used by elements that need to synchronize buffers
-against the clock or each other.
-
-@stream_time can be any value and the result of this function for values outside
-of the segment is extrapolated.
-
-When 1 is returned, @stream_time resulted in a positive position returned
-in @position.
-
-When this function returns -1, the returned @position should be negated
-to get the real negative segment position.</doc>
- <source-position filename="gst/gstsegment.h" line="309"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="571">a 1 or -1 on success, 0 on failure.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="550">a #GstSegment structure.</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="551">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="stream_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="552">the stream-time</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="position"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="553">the resulting position in the segment</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_running_time"
- c:identifier="gst_segment_set_running_time">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1121">Adjust the start/stop and base values of @segment such that the next valid
-buffer will be one with @running_time.</doc>
- <source-position filename="gst/gstsegment.h" line="331"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1130">%TRUE if the segment could be updated successfully. If %FALSE is
-returned, @running_time is -1 or not in @segment.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1123">a #GstSegment structure.</doc>
- <type name="Segment" c:type="GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1124">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="running_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1125">the running_time in the segment</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_position"
- c:identifier="gst_segment_to_position"
- deprecated="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1098">Convert @running_time into a position in the segment so that
-gst_segment_to_running_time() with that position returns @running_time.</doc>
- <doc-deprecated xml:space="preserve">Use gst_segment_position_from_running_time() instead.</doc-deprecated>
- <source-position filename="gst/gstsegment.h" line="322"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1107">the position in the segment for @running_time. This function returns
--1 when @running_time is -1 or when it is not inside @segment.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1100">a #GstSegment structure.</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1101">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="running_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="1102">the running_time in the segment</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_running_time"
- c:identifier="gst_segment_to_running_time">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="820">Translate @position to the total running time using the currently configured
-segment. Position is a value between @segment start and stop time.
-
-This function is typically used by elements that need to synchronize to the
-global clock in a pipeline. The running time is a constantly increasing value
-starting from 0. When gst_segment_init() is called, this value will reset to
-0.
-
-This function returns -1 if the position is outside of @segment start and stop.</doc>
- <source-position filename="gst/gstsegment.h" line="315"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="836">the position as the total running time or -1 when an invalid position
-was given.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="822">a #GstSegment structure.</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="823">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="824">the position in the segment</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_running_time_full"
- c:identifier="gst_segment_to_running_time_full"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="707">Translate @position to the total running time using the currently configured
-segment. Compared to gst_segment_to_running_time() this function can return
-negative running-time.
-
-This function is typically used by elements that need to synchronize buffers
-against the clock or each other.
-
-@position can be any value and the result of this function for values outside
-of the segment is extrapolated.
-
-When 1 is returned, @position resulted in a positive running-time returned
-in @running_time.
-
-When this function returns -1, the returned @running_time should be negated
-to get the real negative running time.</doc>
- <source-position filename="gst/gstsegment.h" line="318"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="730">a 1 or -1 on success, 0 on failure.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="709">a #GstSegment structure.</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="710">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="711">the position in the segment</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="running_time"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="712">result running-time</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_stream_time"
- c:identifier="gst_segment_to_stream_time"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="498">Translate @position to stream time using the currently configured
-segment. The @position value must be between @segment start and
-stop value.
-
-This function is typically used by elements that need to operate on
-the stream time of the buffers it receives, such as effect plugins.
-In those use cases, @position is typically the buffer timestamp or
-clock time that one wants to convert to the stream time.
-The stream time is always between 0 and the total duration of the
-media stream.</doc>
- <source-position filename="gst/gstsegment.h" line="306"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="515">the position in stream_time or -1 when an invalid position
-was given.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="500">a #GstSegment structure.</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="501">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="502">the position in the segment</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_stream_time_full"
- c:identifier="gst_segment_to_stream_time_full"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="390">Translate @position to the total stream time using the currently configured
-segment. Compared to gst_segment_to_stream_time() this function can return
-negative stream-time.
-
-This function is typically used by elements that need to synchronize buffers
-against the clock or each other.
-
-@position can be any value and the result of this function for values outside
-of the segment is extrapolated.
-
-When 1 is returned, @position resulted in a positive stream-time returned
-in @stream_time.
-
-When this function returns -1, the returned @stream_time should be negated
-to get the real negative stream time.</doc>
- <source-position filename="gst/gstsegment.h" line="303"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="413">a 1 or -1 on success, 0 on failure.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="392">a #GstSegment structure.</doc>
- <type name="Segment" c:type="const GstSegment*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="393">the format of the segment.</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="394">the position in the segment</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="stream_time"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstsegment.c"
- line="395">result stream-time</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <bitfield name="SegmentFlags"
- glib:type-name="GstSegmentFlags"
- glib:get-type="gst_segment_flags_get_type"
- c:type="GstSegmentFlags">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="163">Flags for the GstSegment structure. Currently mapped to the corresponding
-values of the seek flags.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_SEGMENT_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="165">no flags</doc>
- </member>
- <member name="reset"
- value="1"
- c:identifier="GST_SEGMENT_FLAG_RESET"
- glib:nick="reset">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="166">reset the pipeline running_time to the segment
- running_time</doc>
- </member>
- <member name="trickmode"
- value="16"
- c:identifier="GST_SEGMENT_FLAG_TRICKMODE"
- glib:nick="trickmode">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="168">perform skip playback (Since: 1.6)</doc>
- </member>
- <member name="skip"
- value="16"
- c:identifier="GST_SEGMENT_FLAG_SKIP"
- glib:nick="skip">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="176">Deprecated backward compatibility flag, replaced
- by @GST_SEGMENT_FLAG_TRICKMODE</doc>
- </member>
- <member name="segment"
- value="8"
- c:identifier="GST_SEGMENT_FLAG_SEGMENT"
- glib:nick="segment">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="169">send SEGMENT_DONE instead of EOS</doc>
- </member>
- <member name="trickmode_key_units"
- value="128"
- c:identifier="GST_SEGMENT_FLAG_TRICKMODE_KEY_UNITS"
- glib:nick="trickmode-key-units">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="170">Decode only keyframes, where
- possible (Since: 1.6)</doc>
- </member>
- <member name="trickmode_forward_predicted"
- value="512"
- c:identifier="GST_SEGMENT_FLAG_TRICKMODE_FORWARD_PREDICTED"
- glib:nick="trickmode-forward-predicted">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="172">Decode only keyframes or forward
- predicted frames, where possible (Since: 1.18)</doc>
- </member>
- <member name="trickmode_no_audio"
- value="256"
- c:identifier="GST_SEGMENT_FLAG_TRICKMODE_NO_AUDIO"
- glib:nick="trickmode-no-audio">
- <doc xml:space="preserve"
- filename="gst/gstsegment.h"
- line="174">Do not decode any audio, where
- possible (Since: 1.6)</doc>
- </member>
- </bitfield>
- <class name="SharedTaskPool"
- c:symbol-prefix="shared_task_pool"
- c:type="GstSharedTaskPool"
- version="1.20"
- parent="TaskPool"
- glib:type-name="GstSharedTaskPool"
- glib:get-type="gst_shared_task_pool_get_type"
- glib:type-struct="SharedTaskPoolClass">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.h"
- line="133">The #GstSharedTaskPool object.</doc>
- <source-position filename="gst/gsttaskpool.h" line="161"/>
- <constructor name="new"
- c:identifier="gst_shared_task_pool_new"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="525">Create a new shared task pool. The shared task pool will queue tasks on
-a maximum number of threads, 1 by default.
-
-Do not use a #GstSharedTaskPool to manage potentially inter-dependent tasks such
-as pad tasks, as having one task waiting on another to return before returning
-would cause obvious deadlocks if they happen to share the same thread.</doc>
- <source-position filename="gst/gsttaskpool.h" line="173"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="535">a new #GstSharedTaskPool. gst_object_unref() after usage.</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </return-value>
- </constructor>
- <method name="get_max_threads"
- c:identifier="gst_shared_task_pool_get_max_threads"
- version="1.20">
- <source-position filename="gst/gsttaskpool.h" line="170"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="508">the maximum number of threads @pool is configured to spawn</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="506">a #GstSharedTaskPool</doc>
- <type name="SharedTaskPool" c:type="GstSharedTaskPool*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_max_threads"
- c:identifier="gst_shared_task_pool_set_max_threads"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="474">Update the maximal number of threads the @pool may spawn. When
-the maximal number of threads is reduced, existing threads are not
-immediately shut down, see g_thread_pool_set_max_threads().
-
-Setting @max_threads to 0 effectively freezes the pool.</doc>
- <source-position filename="gst/gsttaskpool.h" line="167"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="476">a #GstSharedTaskPool</doc>
- <type name="SharedTaskPool" c:type="GstSharedTaskPool*"/>
- </instance-parameter>
- <parameter name="max_threads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="477">Maximum number of threads to spawn.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <field name="parent">
- <type name="TaskPool" c:type="GstTaskPool"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="SharedTaskPoolPrivate" c:type="GstSharedTaskPoolPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="SharedTaskPoolClass"
- c:type="GstSharedTaskPoolClass"
- glib:is-gtype-struct-for="SharedTaskPool"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.h"
- line="149">The #GstSharedTaskPoolClass object.</doc>
- <source-position filename="gst/gsttaskpool.h" line="161"/>
- <field name="parent_class">
- <type name="TaskPoolClass" c:type="GstTaskPoolClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="SharedTaskPoolPrivate"
- c:type="GstSharedTaskPoolPrivate"
- disguised="1">
- <source-position filename="gst/gsttaskpool.h" line="124"/>
- </record>
- <bitfield name="StackTraceFlags"
- version="1.12"
- glib:type-name="GstStackTraceFlags"
- glib:get-type="gst_stack_trace_flags_get_type"
- c:type="GstStackTraceFlags">
- <member name="none"
- value="0"
- c:identifier="GST_STACK_TRACE_SHOW_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="180">Try to retrieve the minimum information
- available, which may be none on some platforms
- (Since: 1.18)</doc>
- </member>
- <member name="full"
- value="1"
- c:identifier="GST_STACK_TRACE_SHOW_FULL"
- glib:nick="full">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="183">Try to retrieve as much information as possible,
- including source information when getting the
- stack trace</doc>
- </member>
- </bitfield>
- <enumeration name="State"
- glib:type-name="GstState"
- glib:get-type="gst_state_get_type"
- c:type="GstState">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="36">The possible states an element can be in. States can be changed using
-gst_element_set_state() and checked using gst_element_get_state().</doc>
- <member name="void_pending"
- value="0"
- c:identifier="GST_STATE_VOID_PENDING"
- glib:nick="void-pending">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="38">no pending state.</doc>
- </member>
- <member name="null"
- value="1"
- c:identifier="GST_STATE_NULL"
- glib:nick="null">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="39">the NULL state or initial state of an element.</doc>
- </member>
- <member name="ready"
- value="2"
- c:identifier="GST_STATE_READY"
- glib:nick="ready">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="40">the element is ready to go to PAUSED.</doc>
- </member>
- <member name="paused"
- value="3"
- c:identifier="GST_STATE_PAUSED"
- glib:nick="paused">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="41">the element is PAUSED, it is ready to accept and
- process data. Sink elements however only accept one
- buffer and then block.</doc>
- </member>
- <member name="playing"
- value="4"
- c:identifier="GST_STATE_PLAYING"
- glib:nick="playing">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="44">the element is PLAYING, the #GstClock is running and
- the data is flowing.</doc>
- </member>
- </enumeration>
- <enumeration name="StateChange"
- glib:type-name="GstStateChange"
- glib:get-type="gst_state_change_get_type"
- c:type="GstStateChange">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="177">These are the different state changes an element goes through.
-%GST_STATE_NULL &amp;rArr; %GST_STATE_PLAYING is called an upwards state change
-and %GST_STATE_PLAYING &amp;rArr; %GST_STATE_NULL a downwards state change.</doc>
- <member name="null_to_ready"
- value="10"
- c:identifier="GST_STATE_CHANGE_NULL_TO_READY"
- glib:nick="null-to-ready">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="179">state change from NULL to READY.
- * The element must check if the resources it needs are available. Device
- sinks and -sources typically try to probe the device to constrain their
- caps.
- * The element opens the device (in case feature need to be probed).</doc>
- </member>
- <member name="ready_to_paused"
- value="19"
- c:identifier="GST_STATE_CHANGE_READY_TO_PAUSED"
- glib:nick="ready-to-paused">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="184">state change from READY to PAUSED.
- * The element pads are activated in order to receive data in PAUSED.
- Streaming threads are started.
- * Some elements might need to return %GST_STATE_CHANGE_ASYNC and complete
- the state change when they have enough information. It is a requirement
- for sinks to return %GST_STATE_CHANGE_ASYNC and complete the state change
- when they receive the first buffer or %GST_EVENT_EOS (preroll).
- Sinks also block the dataflow when in PAUSED.
- * A pipeline resets the running_time to 0.
- * Live sources return %GST_STATE_CHANGE_NO_PREROLL and don't generate data.</doc>
- </member>
- <member name="paused_to_playing"
- value="28"
- c:identifier="GST_STATE_CHANGE_PAUSED_TO_PLAYING"
- glib:nick="paused-to-playing">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="194">state change from PAUSED to PLAYING.
- * Most elements ignore this state change.
- * The pipeline selects a #GstClock and distributes this to all the children
- before setting them to PLAYING. This means that it is only allowed to
- synchronize on the #GstClock in the PLAYING state.
- * The pipeline uses the #GstClock and the running_time to calculate the
- base_time. The base_time is distributed to all children when performing
- the state change.
- * Sink elements stop blocking on the preroll buffer or event and start
- rendering the data.
- * Sinks can post %GST_MESSAGE_EOS in the PLAYING state. It is not allowed
- to post %GST_MESSAGE_EOS when not in the PLAYING state.
- * While streaming in PAUSED or PLAYING elements can create and remove
- sometimes pads.
- * Live sources start generating data and return %GST_STATE_CHANGE_SUCCESS.</doc>
- </member>
- <member name="playing_to_paused"
- value="35"
- c:identifier="GST_STATE_CHANGE_PLAYING_TO_PAUSED"
- glib:nick="playing-to-paused">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="209">state change from PLAYING to PAUSED.
- * Most elements ignore this state change.
- * The pipeline calculates the running_time based on the last selected
- #GstClock and the base_time. It stores this information to continue
- playback when going back to the PLAYING state.
- * Sinks unblock any #GstClock wait calls.
- * When a sink does not have a pending buffer to play, it returns
- #GST_STATE_CHANGE_ASYNC from this state change and completes the state
- change when it receives a new buffer or an %GST_EVENT_EOS.
- * Any queued %GST_MESSAGE_EOS items are removed since they will be reposted
- when going back to the PLAYING state. The EOS messages are queued in
- #GstBin containers.
- * Live sources stop generating data and return %GST_STATE_CHANGE_NO_PREROLL.</doc>
- </member>
- <member name="paused_to_ready"
- value="26"
- c:identifier="GST_STATE_CHANGE_PAUSED_TO_READY"
- glib:nick="paused-to-ready">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="222">state change from PAUSED to READY.
- * Sinks unblock any waits in the preroll.
- * Elements unblock any waits on devices
- * Chain or get_range functions return %GST_FLOW_FLUSHING.
- * The element pads are deactivated so that streaming becomes impossible and
- all streaming threads are stopped.
- * The sink forgets all negotiated formats
- * Elements remove all sometimes pads</doc>
- </member>
- <member name="ready_to_null"
- value="17"
- c:identifier="GST_STATE_CHANGE_READY_TO_NULL"
- glib:nick="ready-to-null">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="230">state change from READY to NULL.
- * Elements close devices
- * Elements reset any internal state.</doc>
- </member>
- <member name="null_to_null"
- value="9"
- c:identifier="GST_STATE_CHANGE_NULL_TO_NULL"
- glib:nick="null-to-null">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="233">state change from NULL to NULL. (Since: 1.14)</doc>
- </member>
- <member name="ready_to_ready"
- value="18"
- c:identifier="GST_STATE_CHANGE_READY_TO_READY"
- glib:nick="ready-to-ready">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="234">state change from READY to READY,
-This might happen when going to PAUSED asynchronously failed, in that case
-elements should make sure they are in a proper, coherent READY state. (Since: 1.14)</doc>
- </member>
- <member name="paused_to_paused"
- value="27"
- c:identifier="GST_STATE_CHANGE_PAUSED_TO_PAUSED"
- glib:nick="paused-to-paused">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="237">state change from PAUSED to PAUSED.
-This might happen when elements were in PLAYING state and 'lost state',
-they should make sure to go back to real 'PAUSED' state (prerolling for example). (Since: 1.14)</doc>
- </member>
- <member name="playing_to_playing"
- value="36"
- c:identifier="GST_STATE_CHANGE_PLAYING_TO_PLAYING"
- glib:nick="playing-to-playing">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="240">state change from PLAYING to PLAYING. (Since: 1.14)</doc>
- </member>
- <function name="get_name"
- c:identifier="gst_state_change_get_name"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1331">Gets a string representing the given state transition.</doc>
- <source-position filename="gst/gstutils.h" line="999"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1337">a string with the name of the state
- result.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="transition" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1333">a #GstStateChange to get the name of.</doc>
- <type name="StateChange" c:type="GstStateChange"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <enumeration name="StateChangeReturn"
- glib:type-name="GstStateChangeReturn"
- glib:get-type="gst_state_change_return_get_type"
- c:type="GstStateChangeReturn">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="66">The possible return values from a state change function such as
-gst_element_set_state(). Only @GST_STATE_CHANGE_FAILURE is a real failure.</doc>
- <member name="failure"
- value="0"
- c:identifier="GST_STATE_CHANGE_FAILURE"
- glib:nick="failure">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="68">the state change failed</doc>
- </member>
- <member name="success"
- value="1"
- c:identifier="GST_STATE_CHANGE_SUCCESS"
- glib:nick="success">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="69">the state change succeeded</doc>
- </member>
- <member name="async"
- value="2"
- c:identifier="GST_STATE_CHANGE_ASYNC"
- glib:nick="async">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="70">the state change will happen asynchronously</doc>
- </member>
- <member name="no_preroll"
- value="3"
- c:identifier="GST_STATE_CHANGE_NO_PREROLL"
- glib:nick="no-preroll">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="71">the state change succeeded but the element
- cannot produce data in %GST_STATE_PAUSED.
- This typically happens with live sources.</doc>
- </member>
- </enumeration>
- <record name="StaticCaps" c:type="GstStaticCaps">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="336">Datastructure to initialize #GstCaps from a string description usually
-used in conjunction with GST_STATIC_CAPS() and gst_static_caps_get() to
-instantiate a #GstCaps.</doc>
- <source-position filename="gst/gstcaps.h" line="352"/>
- <field name="caps" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="338">the cached #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </field>
- <field name="string" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="339">a string describing a caps</doc>
- <type name="utf8" c:type="const char*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="cleanup" c:identifier="gst_static_caps_cleanup">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="461">Clean up the cached caps contained in @static_caps.</doc>
- <source-position filename="gst/gstcaps.h" line="438"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="static_caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="463">the #GstStaticCaps to clean</doc>
- <type name="StaticCaps" c:type="GstStaticCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get" c:identifier="gst_static_caps_get">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="396">Converts a #GstStaticCaps to a #GstCaps.</doc>
- <source-position filename="gst/gstcaps.h" line="435"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="402">a pointer to the #GstCaps. Unref
- after usage. Since the core holds an additional ref to the
- returned caps, use gst_caps_make_writable() on the returned caps
- to modify it.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="static_caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="398">the #GstStaticCaps to convert</doc>
- <type name="StaticCaps" c:type="GstStaticCaps*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <record name="StaticPadTemplate" c:type="GstStaticPadTemplate">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="159">Structure describing the #GstStaticPadTemplate.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="173"/>
- <field name="name_template" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="161">the name of the template</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="direction" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="162">the direction of the template</doc>
- <type name="PadDirection" c:type="GstPadDirection"/>
- </field>
- <field name="presence" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="163">the presence of the template</doc>
- <type name="PadPresence" c:type="GstPadPresence"/>
- </field>
- <field name="static_caps" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.h"
- line="164">the caps of the template.</doc>
- <type name="StaticCaps" c:type="GstStaticCaps"/>
- </field>
- <method name="get" c:identifier="gst_static_pad_template_get">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="298">Converts a #GstStaticPadTemplate into a #GstPadTemplate.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="219"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="304">a new #GstPadTemplate.</doc>
- <type name="PadTemplate" c:type="GstPadTemplate*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad_template" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="300">the static pad template</doc>
- <type name="StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_caps" c:identifier="gst_static_pad_template_get_caps">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="444">Gets the capabilities of the static pad template.</doc>
- <source-position filename="gst/gstpadtemplate.h" line="227"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="450">the #GstCaps of the static pad template.
-Unref after usage. Since the core holds an additional
-ref to the returned caps, use gst_caps_make_writable()
-on the returned caps to modify it.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="templ" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpadtemplate.c"
- line="446">a #GstStaticPadTemplate to get capabilities of.</doc>
- <type name="StaticPadTemplate" c:type="GstStaticPadTemplate*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <class name="Stream"
- c:symbol-prefix="stream"
- c:type="GstStream"
- version="1.10"
- parent="Object"
- glib:type-name="GstStream"
- glib:get-type="gst_stream_get_type"
- glib:type-struct="StreamClass">
- <doc xml:space="preserve"
- filename="gst/gststreams.h"
- line="70">A high-level object representing a single stream. It might be backed, or
-not, by an actual flow of data in a pipeline (#GstPad).
-
-A #GstStream does not care about data changes (such as decoding, encoding,
-parsing,...) as long as the underlying data flow corresponds to the same
-high-level flow (ex: a certain audio track).
-
-A #GstStream contains all the information pertinent to a stream, such as
-stream-id, tags, caps, type, ...
-
-Elements can subclass a #GstStream for internal usage (to contain information
-pertinent to streams of data).</doc>
- <source-position filename="gst/gststreams.h" line="113"/>
- <constructor name="new" c:identifier="gst_stream_new" version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="198">Create a new #GstStream for the given @stream_id, @caps, @type
-and @flags</doc>
- <source-position filename="gst/gststreams.h" line="121"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="209">The new #GstStream</doc>
- <type name="Stream" c:type="GstStream*"/>
- </return-value>
- <parameters>
- <parameter name="stream_id"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="200">the id for the new stream. If %NULL,
-a new one will be automatically generated</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="202">the #GstCaps of the stream</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="203">the #GstStreamType of the stream</doc>
- <type name="StreamType" c:type="GstStreamType"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="204">the #GstStreamFlags of the stream</doc>
- <type name="StreamFlags" c:type="GstStreamFlags"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="get_caps"
- c:identifier="gst_stream_get_caps"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="445">Retrieve the caps for @stream, if any</doc>
- <source-position filename="gst/gststreams.h" line="150"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="451">The #GstCaps for @stream</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="447">a #GstStream</doc>
- <type name="Stream" c:type="GstStream*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_flags"
- c:identifier="gst_stream_get_stream_flags"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="292">Retrieve the current stream flags for @stream</doc>
- <source-position filename="gst/gststreams.h" line="132"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="298">The #GstStreamFlags for @stream</doc>
- <type name="StreamFlags" c:type="GstStreamFlags"/>
- </return-value>
- <parameters>
- <instance-parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="294">a #GstStream</doc>
- <type name="Stream" c:type="GstStream*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_id"
- c:identifier="gst_stream_get_stream_id"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="251">Returns the stream ID of @stream.</doc>
- <source-position filename="gst/gststreams.h" line="126"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="257">the stream ID of @stream. Only valid
-during the lifetime of @stream.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="253">a #GstStream</doc>
- <type name="Stream" c:type="GstStream*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_type"
- c:identifier="gst_stream_get_stream_type"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="338">Retrieve the stream type for @stream</doc>
- <source-position filename="gst/gststreams.h" line="138"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="344">The #GstStreamType for @stream</doc>
- <type name="StreamType" c:type="GstStreamType"/>
- </return-value>
- <parameters>
- <instance-parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="340">a #GstStream</doc>
- <type name="Stream" c:type="GstStream*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tags"
- c:identifier="gst_stream_get_tags"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="391">Retrieve the tags for @stream, if any</doc>
- <source-position filename="gst/gststreams.h" line="144"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="397">The #GstTagList for @stream</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="393">a #GstStream</doc>
- <type name="Stream" c:type="GstStream*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_caps"
- c:identifier="gst_stream_set_caps"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="416">Set the caps for the #GstStream</doc>
- <source-position filename="gst/gststreams.h" line="147"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="418">a #GstStream</doc>
- <type name="Stream" c:type="GstStream*"/>
- </instance-parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="419">a #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_stream_flags"
- c:identifier="gst_stream_set_stream_flags"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="270">Set the @flags for the @stream.</doc>
- <source-position filename="gst/gststreams.h" line="129"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="272">a #GstStream</doc>
- <type name="Stream" c:type="GstStream*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="273">the flags to set on @stream</doc>
- <type name="StreamFlags" c:type="GstStreamFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_stream_type"
- c:identifier="gst_stream_set_stream_type"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="316">Set the stream type of @stream</doc>
- <source-position filename="gst/gststreams.h" line="135"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="318">a #GstStream</doc>
- <type name="Stream" c:type="GstStream*"/>
- </instance-parameter>
- <parameter name="stream_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="319">the type to set on @stream</doc>
- <type name="StreamType" c:type="GstStreamType"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_tags"
- c:identifier="gst_stream_set_tags"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="362">Set the tags for the #GstStream</doc>
- <source-position filename="gst/gststreams.h" line="141"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="364">a #GstStream</doc>
- <type name="Stream" c:type="GstStream*"/>
- </instance-parameter>
- <parameter name="tags"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="365">a #GstTagList</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </parameter>
- </parameters>
- </method>
- <property name="caps" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="153">The #GstCaps of the #GstStream.</doc>
- <type name="Caps"/>
- </property>
- <property name="stream-flags"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="StreamFlags"/>
- </property>
- <property name="stream-id"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="117">The unique identifier of the #GstStream. Can only be set at construction
-time.</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="stream-type"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="141">The #GstStreamType of the #GstStream. Can only be set at construction time.</doc>
- <type name="StreamType"/>
- </property>
- <property name="tags" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="164">The #GstTagList of the #GstStream.</doc>
- <type name="TagList"/>
- </property>
- <field name="object" readable="0" private="1">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="stream_id">
- <doc xml:space="preserve"
- filename="gst/gststreams.h"
- line="72">The Stream Identifier for this #GstStream</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="StreamPrivate" c:type="GstStreamPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="StreamClass"
- c:type="GstStreamClass"
- glib:is-gtype-struct-for="Stream">
- <doc xml:space="preserve"
- filename="gst/gststreams.h"
- line="102">GstStream class structure</doc>
- <source-position filename="gst/gststreams.h" line="113"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst/gststreams.h"
- line="104">the parent class structure</doc>
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="StreamCollection"
- c:symbol-prefix="stream_collection"
- c:type="GstStreamCollection"
- version="1.10"
- parent="Object"
- glib:type-name="GstStreamCollection"
- glib:get-type="gst_stream_collection_get_type"
- glib:type-struct="StreamCollectionClass">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.h"
- line="47">A collection of #GstStream that are available.
-
-A #GstStreamCollection will be provided by elements that can make those
-streams available. Applications can use the collection to show the user
-what streams are available by using %gst_stream_collection_get_stream()
-
-Once posted, a #GstStreamCollection is immutable. Updates are made by sending
-a new #GstStreamCollection message, which may or may not share some of
-the #GstStream objects from the collection it replaces. The receiver can check
-the sender of a stream collection message to know which collection is
-obsoleted.
-
-Several elements in a pipeline can provide #GstStreamCollection.
-
-Applications can activate streams from a collection by using the
-#GST_EVENT_SELECT_STREAMS event on a pipeline, bin or element.</doc>
- <source-position filename="gst/gststreamcollection.h" line="94"/>
- <constructor name="new"
- c:identifier="gst_stream_collection_new"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="161">Create a new #GstStreamCollection.</doc>
- <source-position filename="gst/gststreamcollection.h" line="100"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="167">The new #GstStreamCollection.</doc>
- <type name="StreamCollection" c:type="GstStreamCollection*"/>
- </return-value>
- <parameters>
- <parameter name="upstream_id"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="163">The stream id of the parent stream</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <virtual-method name="stream_notify">
- <source-position filename="gst/gststreamcollection.h" line="90"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="collection" transfer-ownership="none">
- <type name="StreamCollection" c:type="GstStreamCollection*"/>
- </instance-parameter>
- <parameter name="stream" transfer-ownership="none">
- <type name="Stream" c:type="GstStream*"/>
- </parameter>
- <parameter name="pspec" transfer-ownership="none">
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add_stream"
- c:identifier="gst_stream_collection_add_stream"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="269">Add the given @stream to the @collection.</doc>
- <source-position filename="gst/gststreamcollection.h" line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="276">%TRUE if the @stream was properly added, else %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="collection" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="271">a #GstStreamCollection</doc>
- <type name="StreamCollection" c:type="GstStreamCollection*"/>
- </instance-parameter>
- <parameter name="stream" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="272">the #GstStream to add</doc>
- <type name="Stream" c:type="GstStream*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_size"
- c:identifier="gst_stream_collection_get_size"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="296">Get the number of streams this collection contains</doc>
- <source-position filename="gst/gststreamcollection.h" line="106"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="302">The number of streams that @collection contains</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="collection" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="298">a #GstStreamCollection</doc>
- <type name="StreamCollection" c:type="GstStreamCollection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream"
- c:identifier="gst_stream_collection_get_stream"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="314">Retrieve the #GstStream with index @index from the collection.
-
-The caller should not modify the returned #GstStream</doc>
- <source-position filename="gst/gststreamcollection.h" line="109"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="323">A #GstStream</doc>
- <type name="Stream" c:type="GstStream*"/>
- </return-value>
- <parameters>
- <instance-parameter name="collection" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="316">a #GstStreamCollection</doc>
- <type name="StreamCollection" c:type="GstStreamCollection*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="317">Index of the stream to retrieve</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_upstream_id"
- c:identifier="gst_stream_collection_get_upstream_id"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="201">Returns the upstream id of the @collection.</doc>
- <source-position filename="gst/gststreamcollection.h" line="103"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="207">The upstream id</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="collection" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.c"
- line="203">a #GstStreamCollection</doc>
- <type name="StreamCollection" c:type="GstStreamCollection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <property name="upstream-id"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <field name="object" readable="0" private="1">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="upstream_id" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="StreamCollectionPrivate"
- c:type="GstStreamCollectionPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="stream-notify"
- when="first"
- no-recurse="1"
- detailed="1"
- no-hooks="1">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="Stream"/>
- </parameter>
- <parameter name="p0" transfer-ownership="none">
- <type name="GObject.ParamSpec"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="StreamCollectionClass"
- c:type="GstStreamCollectionClass"
- glib:is-gtype-struct-for="StreamCollection">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.h"
- line="79">GstStreamCollection class structure</doc>
- <source-position filename="gst/gststreamcollection.h" line="94"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst/gststreamcollection.h"
- line="81">the parent class structure</doc>
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="stream_notify">
- <callback name="stream_notify">
- <source-position filename="gst/gststreamcollection.h" line="90"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="collection" transfer-ownership="none">
- <type name="StreamCollection" c:type="GstStreamCollection*"/>
- </parameter>
- <parameter name="stream" transfer-ownership="none">
- <type name="Stream" c:type="GstStream*"/>
- </parameter>
- <parameter name="pspec" transfer-ownership="none">
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="StreamCollectionPrivate"
- c:type="GstStreamCollectionPrivate"
- disguised="1">
- <source-position filename="gst/gststreamcollection.h" line="42"/>
- </record>
- <enumeration name="StreamError"
- glib:type-name="GstStreamError"
- glib:get-type="gst_stream_error_get_type"
- c:type="GstStreamError"
- glib:error-domain="gst-stream-error-quark">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="156">Stream errors are for anything related to the stream being processed:
-format errors, media type errors, ...
-They're typically used by decoders, demuxers, converters, ...</doc>
- <member name="failed"
- value="1"
- c:identifier="GST_STREAM_ERROR_FAILED"
- glib:nick="failed">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="158">a general error which doesn't fit in any other
-category. Make sure you add a custom message to the error call.</doc>
- </member>
- <member name="too_lazy"
- value="2"
- c:identifier="GST_STREAM_ERROR_TOO_LAZY"
- glib:nick="too-lazy">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="160">do not use this except as a placeholder for
-deciding where to go while developing code.</doc>
- </member>
- <member name="not_implemented"
- value="3"
- c:identifier="GST_STREAM_ERROR_NOT_IMPLEMENTED"
- glib:nick="not-implemented">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="162">use this when you do not want to implement
-this functionality yet.</doc>
- </member>
- <member name="type_not_found"
- value="4"
- c:identifier="GST_STREAM_ERROR_TYPE_NOT_FOUND"
- glib:nick="type-not-found">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="164">used when the element doesn't know the
-stream's type.</doc>
- </member>
- <member name="wrong_type"
- value="5"
- c:identifier="GST_STREAM_ERROR_WRONG_TYPE"
- glib:nick="wrong-type">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="166">used when the element doesn't handle this type
-of stream.</doc>
- </member>
- <member name="codec_not_found"
- value="6"
- c:identifier="GST_STREAM_ERROR_CODEC_NOT_FOUND"
- glib:nick="codec-not-found">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="168">used when there's no codec to handle the
-stream's type.</doc>
- </member>
- <member name="decode"
- value="7"
- c:identifier="GST_STREAM_ERROR_DECODE"
- glib:nick="decode">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="170">used when decoding fails.</doc>
- </member>
- <member name="encode"
- value="8"
- c:identifier="GST_STREAM_ERROR_ENCODE"
- glib:nick="encode">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="171">used when encoding fails.</doc>
- </member>
- <member name="demux"
- value="9"
- c:identifier="GST_STREAM_ERROR_DEMUX"
- glib:nick="demux">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="172">used when demuxing fails.</doc>
- </member>
- <member name="mux"
- value="10"
- c:identifier="GST_STREAM_ERROR_MUX"
- glib:nick="mux">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="173">used when muxing fails.</doc>
- </member>
- <member name="format"
- value="11"
- c:identifier="GST_STREAM_ERROR_FORMAT"
- glib:nick="format">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="174">used when the stream is of the wrong format
-(for example, wrong caps).</doc>
- </member>
- <member name="decrypt"
- value="12"
- c:identifier="GST_STREAM_ERROR_DECRYPT"
- glib:nick="decrypt">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="176">used when the stream is encrypted and can't be
-decrypted because this is not supported by the element.</doc>
- </member>
- <member name="decrypt_nokey"
- value="13"
- c:identifier="GST_STREAM_ERROR_DECRYPT_NOKEY"
- glib:nick="decrypt-nokey">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="178">used when the stream is encrypted and
-can't be decrypted because no suitable key is available.</doc>
- </member>
- <member name="num_errors"
- value="14"
- c:identifier="GST_STREAM_ERROR_NUM_ERRORS"
- glib:nick="num-errors">
- <doc xml:space="preserve"
- filename="gst/gsterror.h"
- line="180">the number of stream error types.</doc>
- </member>
- <function name="quark" c:identifier="gst_stream_error_quark">
- <attribute name="doc.skip" value="true"/>
- <return-value transfer-ownership="none">
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- </enumeration>
- <bitfield name="StreamFlags"
- version="1.2"
- glib:type-name="GstStreamFlags"
- glib:get-type="gst_stream_flags_get_type"
- c:type="GstStreamFlags">
- <member name="none"
- value="0"
- c:identifier="GST_STREAM_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="197">This stream has no special attributes</doc>
- </member>
- <member name="sparse"
- value="1"
- c:identifier="GST_STREAM_FLAG_SPARSE"
- glib:nick="sparse">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="198">This stream is a sparse stream (e.g. a subtitle
- stream), data may flow only in irregular intervals with large gaps in
- between.</doc>
- </member>
- <member name="select"
- value="2"
- c:identifier="GST_STREAM_FLAG_SELECT"
- glib:nick="select">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="201">This stream should be selected by default. This
- flag may be used by demuxers to signal that a stream should be selected
- by default in a playback scenario.</doc>
- </member>
- <member name="unselect"
- value="4"
- c:identifier="GST_STREAM_FLAG_UNSELECT"
- glib:nick="unselect">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="204">This stream should not be selected by default.
- This flag may be used by demuxers to signal that a stream should not
- be selected by default in a playback scenario, but only if explicitly
- selected by the user (e.g. an audio track for the hard of hearing or
- a director's commentary track).</doc>
- </member>
- </bitfield>
- <record name="StreamPrivate" c:type="GstStreamPrivate" disguised="1">
- <source-position filename="gst/gststreams.h" line="68"/>
- </record>
- <enumeration name="StreamStatusType"
- glib:type-name="GstStreamStatusType"
- glib:get-type="gst_stream_status_type_get_type"
- c:type="GstStreamStatusType">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="283">The type of a %GST_MESSAGE_STREAM_STATUS. The stream status messages inform the
-application of new streaming threads and their status.</doc>
- <member name="create"
- value="0"
- c:identifier="GST_STREAM_STATUS_TYPE_CREATE"
- glib:nick="create">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="285">A new thread need to be created.</doc>
- </member>
- <member name="enter"
- value="1"
- c:identifier="GST_STREAM_STATUS_TYPE_ENTER"
- glib:nick="enter">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="286">a thread entered its loop function</doc>
- </member>
- <member name="leave"
- value="2"
- c:identifier="GST_STREAM_STATUS_TYPE_LEAVE"
- glib:nick="leave">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="287">a thread left its loop function</doc>
- </member>
- <member name="destroy"
- value="3"
- c:identifier="GST_STREAM_STATUS_TYPE_DESTROY"
- glib:nick="destroy">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="288">a thread is destroyed</doc>
- </member>
- <member name="start"
- value="8"
- c:identifier="GST_STREAM_STATUS_TYPE_START"
- glib:nick="start">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="289">a thread is started</doc>
- </member>
- <member name="pause"
- value="9"
- c:identifier="GST_STREAM_STATUS_TYPE_PAUSE"
- glib:nick="pause">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="290">a thread is paused</doc>
- </member>
- <member name="stop"
- value="10"
- c:identifier="GST_STREAM_STATUS_TYPE_STOP"
- glib:nick="stop">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="291">a thread is stopped</doc>
- </member>
- </enumeration>
- <bitfield name="StreamType"
- version="1.10"
- glib:type-name="GstStreamType"
- glib:get-type="gst_stream_type_get_type"
- c:type="GstStreamType">
- <doc xml:space="preserve"
- filename="gst/gststreams.h"
- line="40">#GstStreamType describes a high level classification set for
-flows of data in #GstStream objects.
-
-Note that this is a flag, and therefore users should not assume it
-will be a single value. Do not use the equality operator for checking
-whether a stream is of a certain type.</doc>
- <member name="unknown"
- value="1"
- c:identifier="GST_STREAM_TYPE_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst/gststreams.h"
- line="42">The stream is of unknown (unclassified) type.</doc>
- </member>
- <member name="audio"
- value="2"
- c:identifier="GST_STREAM_TYPE_AUDIO"
- glib:nick="audio">
- <doc xml:space="preserve"
- filename="gst/gststreams.h"
- line="43">The stream is of audio data</doc>
- </member>
- <member name="video"
- value="4"
- c:identifier="GST_STREAM_TYPE_VIDEO"
- glib:nick="video">
- <doc xml:space="preserve"
- filename="gst/gststreams.h"
- line="44">The stream carries video data</doc>
- </member>
- <member name="container"
- value="8"
- c:identifier="GST_STREAM_TYPE_CONTAINER"
- glib:nick="container">
- <doc xml:space="preserve"
- filename="gst/gststreams.h"
- line="45">The stream is a muxed container type</doc>
- </member>
- <member name="text"
- value="16"
- c:identifier="GST_STREAM_TYPE_TEXT"
- glib:nick="text">
- <doc xml:space="preserve"
- filename="gst/gststreams.h"
- line="46">The stream contains subtitle / subpicture data.</doc>
- </member>
- <function name="get_name"
- c:identifier="gst_stream_type_get_name"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="540">Get a descriptive string for a given #GstStreamType</doc>
- <source-position filename="gst/gststreams.h" line="153"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="546">A string describing the stream type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="stype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="542">a #GstStreamType</doc>
- <type name="StreamType" c:type="GstStreamType"/>
- </parameter>
- </parameters>
- </function>
- </bitfield>
- <record name="Structure"
- c:type="GstStructure"
- glib:type-name="GstStructure"
- glib:get-type="gst_structure_get_type"
- c:symbol-prefix="structure">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="22">A #GstStructure is a collection of key/value pairs. The keys are expressed as
-GQuarks and the values can be of any GType.
-
-In addition to the key/value pairs, a #GstStructure also has a name. The name
-starts with a letter and can be filled by letters, numbers and any of
-"/-_.:".
-
-#GstStructure is used by various GStreamer subsystems to store information in
-a flexible and extensible way. A #GstStructure does not have a refcount
-because it usually is part of a higher level object such as #GstCaps,
-#GstMessage, #GstEvent, #GstQuery. It provides a means to enforce mutability
-using the refcount of the parent with the gst_structure_set_parent_refcount()
-method.
-
-A #GstStructure can be created with gst_structure_new_empty() or
-gst_structure_new(), which both take a name and an optional set of key/value
-pairs along with the types of the values.
-
-Field values can be changed with gst_structure_set_value() or
-gst_structure_set().
-
-Field values can be retrieved with gst_structure_get_value() or the more
-convenient gst_structure_get_*() functions.
-
-Fields can be removed with gst_structure_remove_field() or
-gst_structure_remove_fields().
-
-Strings in structures must be ASCII or UTF-8 encoded. Other encodings are not
-allowed. Strings may be %NULL however.
-
-## The serialization format
-
-GstStructure serialization format serialize the GstStructure name,
-keys/GType/values in a comma separated list with the structure name as first
-field without value followed by separated key/value pairs in the form
-`key=value`, for example:
-
-```
-a-structure, key=value
-````
-
-The values type will be inferred if not explicitly specified with the
-`(GTypeName)value` syntax, for example the following struct will have one
-field called 'is-string' which has the string 'true' as a value:
-
-```
-a-struct, field-is-string=(string)true, field-is-boolean=true
-```
-
-*Note*: without specifying `(string), `field-is-string` type would have been
-inferred as boolean.
-
-*Note*: we specified `(string)` as a type even if `gchararray` is the actual
-GType name as for convenience some well known types have been aliased or
-abbreviated.
-
-To avoid specifying the type, you can give some hints to the "type system".
-For example to specify a value as a double, you should add a decimal (ie. `1`
-is an `int` while `1.0` is a `double`).
-
-*Note*: when a structure is serialized with #gst_structure_to_string, all
-values are explicitly typed.
-
-Some types have special delimiters:
-
-- [GstValueArray](GST_TYPE_ARRAY) are inside curly brackets (`{` and `}`).
- For example `a-structure, array={1, 2, 3}`
-- Ranges are inside brackets (`[` and `]`). For example `a-structure,
- range=[1, 6, 2]` 1 being the min value, 6 the maximum and 2 the step. To
- specify a #GST_TYPE_INT64_RANGE you need to explicitly specify it like:
- `a-structure, a-int64-range=(gint64) [1, 5]`
-- [GstValueList](GST_TYPE_LIST) are inside "less and greater than" (`&lt;` and
- `&gt;`). For example `a-structure, list=&lt;1, 2, 3&gt;
-
-Structures are delimited either by a null character `\0` or a semicolumn `;`
-the latter allowing to store multiple structures in the same string (see
-#GstCaps).
-
-Quotes are used as "default" delimiters and can be used around any types that
-don't use other delimiters (for example `a-struct, i=(int)"1"`). They are use
-to allow adding spaces or special characters (such as delimiters,
-semicolumns, etc..) inside strings and you can use backslashes `\` to escape
-characters inside them, for example:
-
-```
-a-struct, special="\"{[(;)]}\" can be used inside quotes"
-```
-
-They also allow for nested structure, such as:
-
-```
-a-struct, nested=(GstStructure)"nested-struct, nested=true"
-```
-
-&gt; *Note*: Be aware that the current #GstCaps / #GstStructure serialization
-&gt; into string has limited support for nested #GstCaps / #GstStructure fields.
-&gt; It can only support one level of nesting. Using more levels will lead to
-&gt; unexpected behavior when using serialization features, such as
-&gt; gst_caps_to_string() or gst_value_serialize() and their counterparts.</doc>
- <source-position filename="gst/gststructure.h" line="101"/>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="92">the GType of a structure</doc>
- <type name="GType" c:type="GType"/>
- </field>
- <field name="name" readable="0" private="1">
- <type name="GLib.Quark" c:type="GQuark"/>
- </field>
- <constructor name="from_string" c:identifier="gst_structure_from_string">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2312">Creates a #GstStructure from a string representation.
-If end is not %NULL, a pointer to the place inside the given string
-where parsing ended will be returned.
-
-Free-function: gst_structure_free</doc>
- <source-position filename="gst/gststructure.h" line="335"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2323">a new #GstStructure or %NULL
- when the string could not be parsed. Free with
- gst_structure_free() after use.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <parameter name="string" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2314">a string representation of a #GstStructure.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="end"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1"
- skip="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2315">pointer to store the end of the string in.</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new"
- c:identifier="gst_structure_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="366">Creates a new #GstStructure with the given name. Parses the
-list of variable arguments and sets fields to the values listed.
-Variable arguments should be passed as field name, field type,
-and value. Last variable argument should be %NULL.
-
-Free-function: gst_structure_free</doc>
- <source-position filename="gst/gststructure.h" line="113"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="379">a new #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="368">name of new structure</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="firstfield" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="369">name of first field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="370">additional arguments</doc>
- <varargs/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_empty" c:identifier="gst_structure_new_empty">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="346">Creates a new, empty #GstStructure with the given @name.
-
-See gst_structure_set_name() for constraints on the @name parameter.
-
-Free-function: gst_structure_free</doc>
- <source-position filename="gst/gststructure.h" line="107"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="356">a new, empty #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="348">name of new structure</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_string"
- c:identifier="gst_structure_new_from_string"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2287">Creates a #GstStructure from a string representation.
-If end is not %NULL, a pointer to the place inside the given string
-where parsing ended will be returned.
-
-The current implementation of serialization will lead to unexpected results
-when there are nested #GstCaps / #GstStructure deeper than one level.
-
-Free-function: gst_structure_free</doc>
- <source-position filename="gst/gststructure.h" line="125"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2300">a new #GstStructure or %NULL
- when the string could not be parsed. Free with
- gst_structure_free() after use.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <parameter name="string" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2289">a string representation of a #GstStructure</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_id"
- c:identifier="gst_structure_new_id"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="945">Creates a new #GstStructure with the given name as a GQuark, followed by
-fieldname quark, GType, argument(s) "triplets" in the same format as
-gst_structure_id_set(). Basically a convenience wrapper around
-gst_structure_new_id_empty() and gst_structure_id_set().
-
-The last variable argument must be %NULL (or 0).
-
-Free-function: gst_structure_free</doc>
- <source-position filename="gst/gststructure.h" line="121"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="960">a new #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <parameter name="name_quark" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="947">name of new structure</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="field_quark" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="948">the GQuark for the name of the field to set</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="949">variable arguments</doc>
- <varargs/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_id_empty"
- c:identifier="gst_structure_new_id_empty">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="292">Creates a new, empty #GstStructure with the given name as a GQuark.
-
-Free-function: gst_structure_free</doc>
- <source-position filename="gst/gststructure.h" line="110"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="300">a new, empty #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <parameter name="quark" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="294">name of new structure</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_valist"
- c:identifier="gst_structure_new_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="394">Creates a new #GstStructure with the given @name. Structure fields
-are set according to the varargs in a manner similar to
-gst_structure_new().
-
-See gst_structure_set_name() for constraints on the @name parameter.
-
-Free-function: gst_structure_free</doc>
- <source-position filename="gst/gststructure.h" line="117"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="408">a new #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="396">name of new structure</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="firstfield" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="397">name of first field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="varargs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="398">variable argument list</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="can_intersect" c:identifier="gst_structure_can_intersect">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3154">Tries intersecting @struct1 and @struct2 and reports whether the result
-would not be empty.</doc>
- <source-position filename="gst/gststructure.h" line="371"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3162">%TRUE if intersection would not be empty</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="struct1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3156">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="struct2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3157">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_structure_copy">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="477">Duplicates a #GstStructure and all its fields and values.
-
-Free-function: gst_structure_free</doc>
- <source-position filename="gst/gststructure.h" line="128"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="485">a new #GstStructure.</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="479">a #GstStructure to duplicate</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="filter_and_map_in_place"
- c:identifier="gst_structure_filter_and_map_in_place"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1406">Calls the provided function once for each field in the #GstStructure. In
-contrast to gst_structure_foreach(), the function may modify the fields.
-In contrast to gst_structure_map_in_place(), the field is removed from
-the structure if %FALSE is returned from the function.
-The structure must be mutable.</doc>
- <source-position filename="gst/gststructure.h" line="243"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1408">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1409">a function to call for each field</doc>
- <type name="StructureFilterMapFunc"
- c:type="GstStructureFilterMapFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1410">private data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="fixate" c:identifier="gst_structure_fixate">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3243">Fixate all values in @structure using gst_value_fixate().
-@structure will be modified in-place and should be writable.</doc>
- <source-position filename="gst/gststructure.h" line="362"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3245">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="fixate_field" c:identifier="gst_structure_fixate_field">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2740">Fixates a #GstStructure by changing the given field with its fixated value.</doc>
- <source-position filename="gst/gststructure.h" line="359"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2747">%TRUE if the structure field could be fixated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2742">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="field_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2743">a field in @structure</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- </parameters>
- </method>
- <method name="fixate_field_boolean"
- c:identifier="gst_structure_fixate_field_boolean">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2528">Fixates a #GstStructure by changing the given @field_name field to the given
-@target boolean if that field is not fixed yet.</doc>
- <source-position filename="gst/gststructure.h" line="346"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2537">%TRUE if the structure could be fixated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2530">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="field_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2531">a field in @structure</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2532">the target value of the fixation</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="fixate_field_nearest_double"
- c:identifier="gst_structure_fixate_field_nearest_double">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2463">Fixates a #GstStructure by changing the given field to the nearest
-double to @target that is a subset of the existing field.</doc>
- <source-position filename="gst/gststructure.h" line="342"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2472">%TRUE if the structure could be fixated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2465">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="field_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2466">a field in @structure</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2467">the target value of the fixation</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- </parameters>
- </method>
- <method name="fixate_field_nearest_fraction"
- c:identifier="gst_structure_fixate_field_nearest_fraction">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2634">Fixates a #GstStructure by changing the given field to the nearest
-fraction to @target_numerator/@target_denominator that is a subset
-of the existing field.</doc>
- <source-position filename="gst/gststructure.h" line="354"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2645">%TRUE if the structure could be fixated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2636">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="field_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2637">a field in @structure</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="target_numerator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2638">The numerator of the target value of the fixation</doc>
- <type name="gint" c:type="const gint"/>
- </parameter>
- <parameter name="target_denominator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2639">The denominator of the target value of the fixation</doc>
- <type name="gint" c:type="const gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="fixate_field_nearest_int"
- c:identifier="gst_structure_fixate_field_nearest_int">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2393">Fixates a #GstStructure by changing the given field to the nearest
-integer to @target that is a subset of the existing field.</doc>
- <source-position filename="gst/gststructure.h" line="338"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2402">%TRUE if the structure could be fixated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2395">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="field_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2396">a field in @structure</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2397">the target value of the fixation</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </method>
- <method name="fixate_field_string"
- c:identifier="gst_structure_fixate_field_string">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2581">Fixates a #GstStructure by changing the given @field_name field to the given
-@target string if that field is not fixed yet.</doc>
- <source-position filename="gst/gststructure.h" line="350"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2590">%TRUE if the structure could be fixated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2583">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="field_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2584">a field in @structure</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2585">the target value of the fixation</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="foreach" c:identifier="gst_structure_foreach">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1332">Calls the provided function once for each field in the #GstStructure. The
-function must not modify the fields. Also see gst_structure_map_in_place()
-and gst_structure_filter_and_map_in_place().</doc>
- <source-position filename="gst/gststructure.h" line="235"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1342">%TRUE if the supplied function returns %TRUE For each of the fields,
-%FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1334">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1335">a function to call for each field</doc>
- <type name="StructureForeachFunc"
- c:type="GstStructureForeachFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1336">private data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_structure_free">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="514">Frees a #GstStructure and all its fields and values. The structure must not
-have a parent when this function is called.</doc>
- <source-position filename="gst/gststructure.h" line="134"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="516">the #GstStructure to free</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get" c:identifier="gst_structure_get" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2924">Parses the variable arguments and reads fields from @structure accordingly.
-Variable arguments should be in the form field name, field type
-(as a GType), pointer(s) to a variable(s) to hold the return value(s).
-The last variable argument should be %NULL.
-
-For refcounted (mini)objects you will receive a new reference which
-you must release with a suitable _unref\() when no longer needed. For
-strings and boxed types you will receive a copy which you will need to
-release with either g_free() or the suitable function for the boxed type.</doc>
- <source-position filename="gst/gststructure.h" line="200"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2940">%FALSE if there was a problem reading any of the fields (e.g.
- because the field requested did not exist, or was of a type other
- than the type specified), otherwise %TRUE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2926">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="first_fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2927">the name of the first field to read</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2928">variable arguments</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="get_array"
- c:identifier="gst_structure_get_array"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3285">This is useful in language bindings where unknown #GValue types are not
-supported. This function will convert the %GST_TYPE_ARRAY into a newly
-allocated #GValueArray and return it through @array. Be aware that this is
-slower then getting the #GValue directly.</doc>
- <source-position filename="gst/gststructure.h" line="324"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3296">%TRUE if the value could be set correctly. If there was no field
-with @fieldname or the existing field did not contain a %GST_TYPE_ARRAY,
-this function returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3287">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3288">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="array"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3289">a pointer to a #GValueArray</doc>
- <type name="GObject.ValueArray" c:type="GValueArray**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_boolean" c:identifier="gst_structure_get_boolean">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1541">Sets the boolean pointed to by @value corresponding to the value of the
-given field. Caller is responsible for making sure the field exists
-and has the correct type.</doc>
- <source-position filename="gst/gststructure.h" line="270"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1551">%TRUE if the value could be set correctly. If there was no field
-with @fieldname or the existing field did not contain a boolean, this
-function returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1543">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1544">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1545">a pointer to a #gboolean to set</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_clock_time"
- c:identifier="gst_structure_get_clock_time">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1796">Sets the clock time pointed to by @value corresponding to the clock time
-of the given field. Caller is responsible for making sure the field exists
-and has the correct type.</doc>
- <source-position filename="gst/gststructure.h" line="302"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1806">%TRUE if the value could be set correctly. If there was no field
-with @fieldname or the existing field did not contain a #GstClockTime, this
-function returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1798">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1799">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1800">a pointer to a #GstClockTime to set</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_date" c:identifier="gst_structure_get_date">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1714">Sets the date pointed to by @value corresponding to the date of the
-given field. Caller is responsible for making sure the field exists
-and has the correct type.
-
-On success @value will point to a newly-allocated copy of the date which
-should be freed with g_date_free() when no longer needed (note: this is
-inconsistent with e.g. gst_structure_get_string() which doesn't return a
-copy of the string).</doc>
- <source-position filename="gst/gststructure.h" line="294"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1729">%TRUE if the value could be set correctly. If there was no field
-with @fieldname or the existing field did not contain a data, this function
-returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1716">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1717">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1718">a pointer to a #GDate to set</doc>
- <type name="GLib.Date" c:type="GDate**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_date_time" c:identifier="gst_structure_get_date_time">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1754">Sets the datetime pointed to by @value corresponding to the datetime of the
-given field. Caller is responsible for making sure the field exists
-and has the correct type.
-
-On success @value will point to a reference of the datetime which
-should be unreffed with gst_date_time_unref() when no longer needed
-(note: this is inconsistent with e.g. gst_structure_get_string()
-which doesn't return a copy of the string).</doc>
- <source-position filename="gst/gststructure.h" line="298"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1769">%TRUE if the value could be set correctly. If there was no field
-with @fieldname or the existing field did not contain a data, this function
-returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1756">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1757">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1758">a pointer to a #GstDateTime to set</doc>
- <type name="DateTime" c:type="GstDateTime**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_double" c:identifier="gst_structure_get_double">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1817">Sets the double pointed to by @value corresponding to the value of the
-given field. Caller is responsible for making sure the field exists
-and has the correct type.</doc>
- <source-position filename="gst/gststructure.h" line="290"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1827">%TRUE if the value could be set correctly. If there was no field
-with @fieldname or the existing field did not contain a double, this
-function returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1819">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1820">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1821">a pointer to a gdouble to set</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_enum" c:identifier="gst_structure_get_enum">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1883">Sets the int pointed to by @value corresponding to the value of the
-given field. Caller is responsible for making sure the field exists,
-has the correct type and that the enumtype is correct.</doc>
- <source-position filename="gst/gststructure.h" line="309"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1894">%TRUE if the value could be set correctly. If there was no field
-with @fieldname or the existing field did not contain an enum of the given
-type, this function returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1885">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1886">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="enumtype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1887">the enum type of a field</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1888">a pointer to an int to set</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_field_type"
- c:identifier="gst_structure_get_field_type">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1267">Finds the field with the given name, and returns the type of the
-value it contains. If the field is not found, G_TYPE_INVALID is
-returned.</doc>
- <source-position filename="gst/gststructure.h" line="232"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1276">the #GValue of the field</doc>
- <type name="GType" c:type="GType"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1269">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1270">the name of the field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_flagset"
- c:identifier="gst_structure_get_flagset"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1958">Read the GstFlagSet flags and mask out of the structure into the
-provided pointers.</doc>
- <source-position filename="gst/gststructure.h" line="319"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1968">%TRUE if the values could be set correctly. If there was no field
-with @fieldname or the existing field did not contain a GstFlagSet, this
-function returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1960">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1961">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value_flags"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1962">a pointer to a guint for the flags field</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="value_mask"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1963">a pointer to a guint for the mask field</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_fraction" c:identifier="gst_structure_get_fraction">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1921">Sets the integers pointed to by @value_numerator and @value_denominator
-corresponding to the value of the given field. Caller is responsible
-for making sure the field exists and has the correct type.</doc>
- <source-position filename="gst/gststructure.h" line="314"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1932">%TRUE if the values could be set correctly. If there was no field
-with @fieldname or the existing field did not contain a GstFraction, this
-function returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1923">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1924">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value_numerator"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1925">a pointer to an int to set</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="value_denominator"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1926">a pointer to an int to set</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int" c:identifier="gst_structure_get_int">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1574">Sets the int pointed to by @value corresponding to the value of the
-given field. Caller is responsible for making sure the field exists
-and has the correct type.</doc>
- <source-position filename="gst/gststructure.h" line="274"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1584">%TRUE if the value could be set correctly. If there was no field
-with @fieldname or the existing field did not contain an int, this function
-returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1576">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1577">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1578">a pointer to an int to set</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int64"
- c:identifier="gst_structure_get_int64"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1642">Sets the #gint64 pointed to by @value corresponding to the value of the
-given field. Caller is responsible for making sure the field exists
-and has the correct type.</doc>
- <source-position filename="gst/gststructure.h" line="282"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1652">%TRUE if the value could be set correctly. If there was no field
-with @fieldname or the existing field did not contain a #gint64, this function
-returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1644">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1645">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1646">a pointer to a #gint64 to set</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_list"
- c:identifier="gst_structure_get_list"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3310">This is useful in language bindings where unknown #GValue types are not
-supported. This function will convert the %GST_TYPE_LIST into a newly
-allocated GValueArray and return it through @array. Be aware that this is
-slower then getting the #GValue directly.</doc>
- <source-position filename="gst/gststructure.h" line="328"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3321">%TRUE if the value could be set correctly. If there was no field
-with @fieldname or the existing field did not contain a %GST_TYPE_LIST, this
-function returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3312">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3313">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="array"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3314">a pointer to a #GValueArray</doc>
- <type name="GObject.ValueArray" c:type="GValueArray**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_name" c:identifier="gst_structure_get_name">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="614">Get the name of @structure as a string.</doc>
- <source-position filename="gst/gststructure.h" line="144"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="620">the name of the structure.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="616">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_name_id" c:identifier="gst_structure_get_name_id">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="655">Get the name of @structure as a GQuark.</doc>
- <source-position filename="gst/gststructure.h" line="147"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="661">the quark representing the name of the structure.</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="657">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_string" c:identifier="gst_structure_get_string">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1851">Finds the field corresponding to @fieldname, and returns the string
-contained in the field's value. Caller is responsible for making
-sure the field exists and has the correct type.
-
-The string should not be modified, and remains valid until the next
-call to a gst_structure_*() function with the given structure.</doc>
- <source-position filename="gst/gststructure.h" line="306"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1863">a pointer to the string or %NULL when the
-field did not exist or did not contain a string.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1853">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1854">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint" c:identifier="gst_structure_get_uint">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1608">Sets the uint pointed to by @value corresponding to the value of the
-given field. Caller is responsible for making sure the field exists
-and has the correct type.</doc>
- <source-position filename="gst/gststructure.h" line="278"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1618">%TRUE if the value could be set correctly. If there was no field
-with @fieldname or the existing field did not contain a uint, this function
-returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1610">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1611">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1612">a pointer to a uint to set</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint64"
- c:identifier="gst_structure_get_uint64"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1678">Sets the #guint64 pointed to by @value corresponding to the value of the
-given field. Caller is responsible for making sure the field exists
-and has the correct type.</doc>
- <source-position filename="gst/gststructure.h" line="286"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1688">%TRUE if the value could be set correctly. If there was no field
-with @fieldname or the existing field did not contain a #guint64, this function
-returns %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1680">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1681">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1682">a pointer to a #guint64 to set</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_valist"
- c:identifier="gst_structure_get_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2789">Parses the variable arguments and reads fields from @structure accordingly.
-valist-variant of gst_structure_get(). Look at the documentation of
-gst_structure_get() for more details.</doc>
- <source-position filename="gst/gststructure.h" line="196"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2799">%TRUE, or %FALSE if there was a problem reading any of the fields</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2791">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="first_fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2792">the name of the first field to read</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2793">variable arguments</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_value" c:identifier="gst_structure_get_value">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1109">Get the value of the field with name @fieldname.</doc>
- <source-position filename="gst/gststructure.h" line="215"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1116">the #GValue corresponding to the field with the given
-name.</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1111">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1112">the name of the field to get</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="has_field" c:identifier="gst_structure_has_field">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1472">Check if @structure contains a field named @fieldname.</doc>
- <source-position filename="gst/gststructure.h" line="260"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1479">%TRUE if the structure contains a field with the given name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1474">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1475">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="has_field_typed"
- c:identifier="gst_structure_has_field_typed">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1518">Check if @structure contains a field named @fieldname and with GType @type.</doc>
- <source-position filename="gst/gststructure.h" line="263"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1526">%TRUE if the structure contains a field with the given name and type</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1520">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1521">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1522">the type of a value</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="has_name" c:identifier="gst_structure_has_name">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="630">Checks if the structure has the given name</doc>
- <source-position filename="gst/gststructure.h" line="150"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="637">%TRUE if @name matches the name of the structure.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="632">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="633">structure name to check for</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="id_get"
- c:identifier="gst_structure_id_get"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2961">Parses the variable arguments and reads fields from @structure accordingly.
-Variable arguments should be in the form field id quark, field type
-(as a GType), pointer(s) to a variable(s) to hold the return value(s).
-The last variable argument should be %NULL (technically it should be a
-0 quark, but we require %NULL so compilers that support it can check for
-the %NULL terminator and warn if it's not there).
-
-This function is just like gst_structure_get() only that it is slightly
-more efficient since it saves the string-to-quark lookup in the global
-quark hashtable.
-
-For refcounted (mini)objects you will receive a new reference which
-you must release with a suitable _unref\() when no longer needed. For
-strings and boxed types you will receive a copy which you will need to
-release with either g_free() or the suitable function for the boxed type.</doc>
- <source-position filename="gst/gststructure.h" line="208"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2983">%FALSE if there was a problem reading any of the fields (e.g.
- because the field requested did not exist, or was of a type other
- than the type specified), otherwise %TRUE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2963">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="first_field_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2964">the quark of the first field to read</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2965">variable arguments</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="id_get_valist"
- c:identifier="gst_structure_id_get_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2856">Parses the variable arguments and reads fields from @structure accordingly.
-valist-variant of gst_structure_id_get(). Look at the documentation of
-gst_structure_id_get() for more details.</doc>
- <source-position filename="gst/gststructure.h" line="204"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2866">%TRUE, or %FALSE if there was a problem reading any of the fields</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2858">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="first_field_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2859">the quark of the first field to read</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2860">variable arguments</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="id_get_value" c:identifier="gst_structure_id_get_value">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1135">Get the value of the field with GQuark @field.</doc>
- <source-position filename="gst/gststructure.h" line="212"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1142">the #GValue corresponding to the field with the given
-name identifier.</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1137">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1138">the #GQuark of the field to get</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- </parameters>
- </method>
- <method name="id_has_field" c:identifier="gst_structure_id_has_field">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1450">Check if @structure contains a field named @field.</doc>
- <source-position filename="gst/gststructure.h" line="253"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1457">%TRUE if the structure contains a field with the given name</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1452">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1453">#GQuark of the field name</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- </parameters>
- </method>
- <method name="id_has_field_typed"
- c:identifier="gst_structure_id_has_field_typed">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1492">Check if @structure contains a field named @field and with GType @type.</doc>
- <source-position filename="gst/gststructure.h" line="256"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1500">%TRUE if the structure contains a field with the given name and type</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1494">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1495">#GQuark of the field name</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1496">the type of a value</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="id_set"
- c:identifier="gst_structure_id_set"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="903">Identical to gst_structure_set, except that field names are
-passed using the GQuark for the field name. This allows more efficient
-setting of the structure if the caller already knows the associated
-quark values.
-The last variable argument must be %NULL.</doc>
- <source-position filename="gst/gststructure.h" line="188"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="905">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="906">the GQuark for the name of the field to set</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="907">variable arguments</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="id_set_valist"
- c:identifier="gst_structure_id_set_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="927">va_list form of gst_structure_id_set().</doc>
- <source-position filename="gst/gststructure.h" line="192"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="929">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="930">the name of the field to set</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="varargs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="931">variable arguments</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="id_set_value" c:identifier="gst_structure_id_set_value">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="702">Sets the field with the given GQuark @field to @value. If the field
-does not exist, it is created. If the field exists, the previous
-value is replaced and freed.</doc>
- <source-position filename="gst/gststructure.h" line="156"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="704">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="705">a #GQuark representing a field</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="706">the new value of the field</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="id_take_value" c:identifier="gst_structure_id_take_value">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="766">Sets the field with the given GQuark @field to @value. If the field
-does not exist, it is created. If the field exists, the previous
-value is replaced and freed.</doc>
- <source-position filename="gst/gststructure.h" line="172"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="768">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="769">a #GQuark representing a field</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="value" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="770">the new value of the field</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="intersect" c:identifier="gst_structure_intersect">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3050">Intersects @struct1 and @struct2 and returns the intersection.</doc>
- <source-position filename="gst/gststructure.h" line="374"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3057">Intersection of @struct1 and @struct2</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="struct1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3052">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="struct2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3053">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_equal" c:identifier="gst_structure_is_equal">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3020">Tests if the two #GstStructure are equal.</doc>
- <source-position filename="gst/gststructure.h" line="365"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3027">%TRUE if the two structures have the same name and field.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3022">a #GstStructure.</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="structure2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3023">a #GstStructure.</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_subset" c:identifier="gst_structure_is_subset">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3180">Checks if @subset is a subset of @superset, i.e. has the same
-structure name and for all fields that are existing in @superset,
-@subset has a value that is a subset of the value in @superset.</doc>
- <source-position filename="gst/gststructure.h" line="368"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3189">%TRUE if @subset is a subset of @superset</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="subset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3182">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="superset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3183">a potentially greater #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="map_in_place" c:identifier="gst_structure_map_in_place">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1369">Calls the provided function once for each field in the #GstStructure. In
-contrast to gst_structure_foreach(), the function may modify but not delete the
-fields. The structure must be mutable.</doc>
- <source-position filename="gst/gststructure.h" line="239"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1379">%TRUE if the supplied function returns %TRUE For each of the fields,
-%FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1371">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1372">a function to call for each field</doc>
- <type name="StructureMapFunc" c:type="GstStructureMapFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1373">private data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="n_fields" c:identifier="gst_structure_n_fields">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1294">Get the number of fields in the structure.</doc>
- <source-position filename="gst/gststructure.h" line="247"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1300">the number of fields in the structure</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1296">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="nth_field_name"
- c:identifier="gst_structure_nth_field_name">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1310">Get the name of the given field number, counting from 0 onwards.</doc>
- <source-position filename="gst/gststructure.h" line="250"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1317">the name of the given field number</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1312">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1313">the index to get the name of</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_all_fields"
- c:identifier="gst_structure_remove_all_fields">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1242">Removes all fields in a GstStructure.</doc>
- <source-position filename="gst/gststructure.h" line="229"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1244">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_field" c:identifier="gst_structure_remove_field">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1159">Removes the field with the given name. If the field with the given
-name does not exist, the structure is unchanged.</doc>
- <source-position filename="gst/gststructure.h" line="218"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1161">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1162">the name of the field to remove</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_fields"
- c:identifier="gst_structure_remove_fields"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1194">Removes the fields with the given names. If a field does not exist, the
-argument is ignored.</doc>
- <source-position filename="gst/gststructure.h" line="221"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1196">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1197">the name of the field to remove</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1198">%NULL-terminated list of more fieldnames to remove</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_fields_valist"
- c:identifier="gst_structure_remove_fields_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1218">va_list form of gst_structure_remove_fields().</doc>
- <source-position filename="gst/gststructure.h" line="225"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1220">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1221">the name of the field to remove</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="varargs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="1222">%NULL-terminated list of more fieldnames to remove</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="set" c:identifier="gst_structure_set" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="836">Parses the variable arguments and sets fields accordingly. Fields that
-weren't already part of the structure are added as needed.
-Variable arguments should be in the form field name, field type
-(as a GType), value(s). The last variable argument should be %NULL.</doc>
- <source-position filename="gst/gststructure.h" line="180"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="838">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="839">the name of the field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="840">variable arguments</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="set_array"
- c:identifier="gst_structure_set_array"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3362">This is useful in language bindings where unknown GValue types are not
-supported. This function will convert a @array to %GST_TYPE_ARRAY and set
-the field specified by @fieldname. Be aware that this is slower then using
-%GST_TYPE_ARRAY in a #GValue directly.</doc>
- <source-position filename="gst/gststructure.h" line="164"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3364">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3365">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3366">a pointer to a #GValueArray</doc>
- <type name="GObject.ValueArray" c:type="const GValueArray*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_list"
- c:identifier="gst_structure_set_list"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3382">This is useful in language bindings where unknown GValue types are not
-supported. This function will convert a @array to %GST_TYPE_LIST and set
-the field specified by @fieldname. Be aware that this is slower then using
-%GST_TYPE_LIST in a #GValue directly.</doc>
- <source-position filename="gst/gststructure.h" line="168"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3384">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3385">the name of a field</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="3386">a pointer to a #GValueArray</doc>
- <type name="GObject.ValueArray" c:type="const GValueArray*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_name" c:identifier="gst_structure_set_name">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="671">Sets the name of the structure to the given @name. The string
-provided is copied before being used. It must not be empty, start with a
-letter and can be followed by letters, numbers and any of "/-_.:".</doc>
- <source-position filename="gst/gststructure.h" line="153"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="673">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="674">the new name of the structure</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_parent_refcount"
- c:identifier="gst_structure_set_parent_refcount">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="441">Sets the parent_refcount field of #GstStructure. This field is used to
-determine whether a structure is mutable or not. This function should only be
-called by code implementing parent objects of #GstStructure, as described in
-the MT Refcounting section of the design documents.</doc>
- <source-position filename="gst/gststructure.h" line="131"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="451">%TRUE if the parent refcount could be set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="443">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="refcount" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="444">a pointer to the parent's refcount</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_valist"
- c:identifier="gst_structure_set_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="860">va_list form of gst_structure_set().</doc>
- <source-position filename="gst/gststructure.h" line="184"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="862">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="863">the name of the field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="varargs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="864">variable arguments</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_value" c:identifier="gst_structure_set_value">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="724">Sets the field with the given name @field to @value. If the field
-does not exist, it is created. If the field exists, the previous
-value is replaced and freed.</doc>
- <source-position filename="gst/gststructure.h" line="160"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="726">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="727">the name of the field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="728">the new value of the field</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="take_value" c:identifier="gst_structure_take_value">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="787">Sets the field with the given name @field to @value. If the field
-does not exist, it is created. If the field exists, the previous
-value is replaced and freed. The function will take ownership of @value.</doc>
- <source-position filename="gst/gststructure.h" line="176"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="789">a #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="790">the name of the field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="791">the new value of the field</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_string" c:identifier="gst_structure_to_string">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2130">Converts @structure to a human-readable string representation.
-
-For debugging purposes its easier to do something like this:
-|[&lt;!-- language="C" --&gt;
-GST_LOG ("structure is %" GST_PTR_FORMAT, structure);
-]|
-This prints the structure in human readable form.
-
-The current implementation of serialization will lead to unexpected results
-when there are nested #GstCaps / #GstStructure deeper than one level.
-
-Free-function: g_free</doc>
- <source-position filename="gst/gststructure.h" line="332"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2147">a pointer to string allocated by g_malloc().
- g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="2132">a #GstStructure</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="take" c:identifier="gst_structure_take" version="1.18">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="573">Atomically modifies a pointer to point to a new structure.
-The #GstStructure @oldstr_ptr is pointing to is freed and
-@newstr is taken ownership over.
-
-Either @newstr and the value pointed to by @oldstr_ptr may be %NULL.
-
-It is a programming error if both @newstr and the value pointed to by
-@oldstr_ptr refer to the same, non-%NULL structure.</doc>
- <source-position filename="gst/gststructure.h" line="141"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="588">%TRUE if @newstr was different from @oldstr_ptr</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="oldstr_ptr"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="575">pointer to a place of
- a #GstStructure to take</doc>
- <type name="Structure" c:type="GstStructure**"/>
- </parameter>
- <parameter name="newstr"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="577">a new #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <enumeration name="StructureChangeType"
- glib:type-name="GstStructureChangeType"
- glib:get-type="gst_structure_change_type_get_type"
- c:type="GstStructureChangeType">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="271">The type of a %GST_MESSAGE_STRUCTURE_CHANGE.</doc>
- <member name="link"
- value="0"
- c:identifier="GST_STRUCTURE_CHANGE_TYPE_PAD_LINK"
- glib:nick="link">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="273">Pad linking is starting or done.</doc>
- </member>
- <member name="unlink"
- value="1"
- c:identifier="GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK"
- glib:nick="unlink">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="274">Pad unlinking is starting or done.</doc>
- </member>
- </enumeration>
- <callback name="StructureFilterMapFunc" c:type="GstStructureFilterMapFunc">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="73">A function that will be called in gst_structure_filter_and_map_in_place().
-The function may modify @value, and the value will be removed from
-the structure if %FALSE is returned.</doc>
- <source-position filename="gst/gststructure.h" line="86"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="83">%TRUE if the field should be preserved, %FALSE if it
-should be removed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="field_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="75">the #GQuark of the field name</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="76">the #GValue of the field</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="77">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="StructureForeachFunc" c:type="GstStructureForeachFunc">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="41">A function that will be called in gst_structure_foreach(). The function may
-not modify @value.</doc>
- <source-position filename="gst/gststructure.h" line="53"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="50">%TRUE if the foreach operation should continue, %FALSE if
-the foreach operation should stop with %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="field_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="43">the #GQuark of the field name</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="44">the #GValue of the field</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="45">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="StructureMapFunc" c:type="GstStructureMapFunc">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="57">A function that will be called in gst_structure_map_in_place(). The function
-may modify @value.</doc>
- <source-position filename="gst/gststructure.h" line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="66">%TRUE if the map operation should continue, %FALSE if
-the map operation should stop with %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="field_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="59">the #GQuark of the field name</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="60">the #GValue of the field</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gststructure.h"
- line="61">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <class name="SystemClock"
- c:symbol-prefix="system_clock"
- c:type="GstSystemClock"
- parent="Clock"
- glib:type-name="GstSystemClock"
- glib:get-type="gst_system_clock_get_type"
- glib:type-struct="SystemClockClass">
- <doc xml:space="preserve"
- filename="gst/gstsystemclock.c"
- line="23">The GStreamer core provides a GstSystemClock based on the system time.
-Asynchronous callbacks are scheduled from an internal thread.
-
-Clock implementors are encouraged to subclass this systemclock as it
-implements the async notification.
-
-Subclasses can however override all of the important methods for sync and
-async notifications to implement their own callback methods or blocking
-wait operations.</doc>
- <source-position filename="gst/gstsystemclock.h" line="82"/>
- <function name="obtain" c:identifier="gst_system_clock_obtain">
- <doc xml:space="preserve"
- filename="gst/gstsystemclock.c"
- line="602">Get a handle to the default system clock. The refcount of the
-clock will be increased so you need to unref the clock after
-usage.</doc>
- <source-position filename="gst/gstsystemclock.h" line="88"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstsystemclock.c"
- line="609">the default clock.
-
-MT safe.</doc>
- <type name="Clock" c:type="GstClock*"/>
- </return-value>
- </function>
- <function name="set_default"
- c:identifier="gst_system_clock_set_default"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gstsystemclock.c"
- line="563">Sets the default system clock that can be obtained with
-gst_system_clock_obtain().
-
-This is mostly used for testing and debugging purposes when you
-want to have control over the time reported by the default system
-clock.
-
-MT safe.</doc>
- <source-position filename="gst/gstsystemclock.h" line="91"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="new_clock"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstsystemclock.c"
- line="565">a #GstClock</doc>
- <type name="Clock" c:type="GstClock*"/>
- </parameter>
- </parameters>
- </function>
- <property name="clock-type" writable="1" transfer-ownership="none">
- <type name="ClockType"/>
- </property>
- <field name="clock">
- <type name="Clock" c:type="GstClock"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="SystemClockPrivate" c:type="GstSystemClockPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="SystemClockClass"
- c:type="GstSystemClockClass"
- glib:is-gtype-struct-for="SystemClock">
- <source-position filename="gst/gstsystemclock.h" line="82"/>
- <field name="parent_class">
- <type name="ClockClass" c:type="GstClockClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="SystemClockPrivate"
- c:type="GstSystemClockPrivate"
- disguised="1">
- <source-position filename="gst/gstsystemclock.h" line="43"/>
- </record>
- <constant name="TAG_ALBUM" value="album" c:type="GST_TAG_ALBUM">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="575">album containing this data (string)
-
-The album name as it should be displayed, e.g. 'The Jazz Guitar'</doc>
- <source-position filename="gst/gsttaglist.h" line="582"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ALBUM_ARTIST"
- value="album-artist"
- c:type="GST_TAG_ALBUM_ARTIST">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="591">The artist of the entire album, as it should be displayed.</doc>
- <source-position filename="gst/gsttaglist.h" line="596"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ALBUM_ARTIST_SORTNAME"
- value="album-artist-sortname"
- c:type="GST_TAG_ALBUM_ARTIST_SORTNAME">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="597">The artist of the entire album, as it should be sorted.</doc>
- <source-position filename="gst/gsttaglist.h" line="602"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ALBUM_GAIN"
- value="replaygain-album-gain"
- c:type="GST_TAG_ALBUM_GAIN">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="853">album gain in db (double)</doc>
- <source-position filename="gst/gsttaglist.h" line="858"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ALBUM_PEAK"
- value="replaygain-album-peak"
- c:type="GST_TAG_ALBUM_PEAK">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="859">peak of the album (double)</doc>
- <source-position filename="gst/gsttaglist.h" line="864"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ALBUM_SORTNAME"
- value="album-sortname"
- c:type="GST_TAG_ALBUM_SORTNAME">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="583">album containing this data, as used for sorting (string)
-
-The album name as it should be sorted, e.g. 'Jazz Guitar, The'</doc>
- <source-position filename="gst/gsttaglist.h" line="590"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ALBUM_VOLUME_COUNT"
- value="album-disc-count"
- c:type="GST_TAG_ALBUM_VOLUME_COUNT">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="672">count of discs inside collection this disc belongs to (unsigned integer)</doc>
- <source-position filename="gst/gsttaglist.h" line="677"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ALBUM_VOLUME_NUMBER"
- value="album-disc-number"
- c:type="GST_TAG_ALBUM_VOLUME_NUMBER">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="666">disc number inside a collection (unsigned integer)</doc>
- <source-position filename="gst/gsttaglist.h" line="671"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_APPLICATION_DATA"
- value="application-data"
- c:type="GST_TAG_APPLICATION_DATA">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1088">Arbitrary application data (sample)
-
-Some formats allow applications to add their own arbitrary data
-into files. This data is application dependent.</doc>
- <source-position filename="gst/gsttaglist.h" line="1096"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_APPLICATION_NAME"
- value="application-name"
- c:type="GST_TAG_APPLICATION_NAME">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1082">Name of the application used to create the media (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="1087"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ARTIST" value="artist" c:type="GST_TAG_ARTIST">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="557">person(s) responsible for the recording (string)
-
-The artist name as it should be displayed, e.g. 'Jimi Hendrix' or
-'The Guitar Heroes'</doc>
- <source-position filename="gst/gsttaglist.h" line="565"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ARTIST_SORTNAME"
- value="artist-sortname"
- c:type="GST_TAG_ARTIST_SORTNAME">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="566">person(s) responsible for the recording, as used for sorting (string)
-
-The artist name as it should be sorted, e.g. 'Hendrix, Jimi' or
-'Guitar Heroes, The'</doc>
- <source-position filename="gst/gsttaglist.h" line="574"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ATTACHMENT"
- value="attachment"
- c:type="GST_TAG_ATTACHMENT">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="905">generic file attachment (sample) (sample taglist should specify the content
-type and if possible set "filename" to the file name of the
-attachment)</doc>
- <source-position filename="gst/gsttaglist.h" line="912"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_AUDIO_CODEC"
- value="audio-codec"
- c:type="GST_TAG_AUDIO_CODEC">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="780">codec the audio data is stored in (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="785"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_BEATS_PER_MINUTE"
- value="beats-per-minute"
- c:type="GST_TAG_BEATS_PER_MINUTE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="914">number of beats per minute in audio (double)</doc>
- <source-position filename="gst/gsttaglist.h" line="919"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_BITRATE" value="bitrate" c:type="GST_TAG_BITRATE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="798">exact or average bitrate in bits/s (unsigned integer)</doc>
- <source-position filename="gst/gsttaglist.h" line="803"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CODEC" value="codec" c:type="GST_TAG_CODEC">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="768">codec the data is stored in (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="773"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_COMMENT" value="comment" c:type="GST_TAG_COMMENT">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="635">free text commenting the data (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="640"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_COMPOSER" value="composer" c:type="GST_TAG_COMPOSER">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="603">person(s) who composed the recording (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="608"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_COMPOSER_SORTNAME"
- value="composer-sortname"
- c:type="GST_TAG_COMPOSER_SORTNAME">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1049">The composer's name, used for sorting (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="1054"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CONDUCTOR"
- value="conductor"
- c:type="GST_TAG_CONDUCTOR"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="609">conductor/performer refinement (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="616"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CONTACT" value="contact" c:type="GST_TAG_CONTACT">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="738">contact information (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="743"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CONTAINER_FORMAT"
- value="container-format"
- c:type="GST_TAG_CONTAINER_FORMAT">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="792">container format the data is stored in (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="797"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_COPYRIGHT"
- value="copyright"
- c:type="GST_TAG_COPYRIGHT">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="715">copyright notice of the data (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="720"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_COPYRIGHT_URI"
- value="copyright-uri"
- c:type="GST_TAG_COPYRIGHT_URI">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="721">URI to location where copyright details can be found (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="726"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_DATE" value="date" c:type="GST_TAG_DATE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="617">date the data was created (#GDate structure)</doc>
- <source-position filename="gst/gsttaglist.h" line="622"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_DATE_TIME" value="datetime" c:type="GST_TAG_DATE_TIME">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="623">date and time the data was created (#GstDateTime structure)</doc>
- <source-position filename="gst/gsttaglist.h" line="628"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_DESCRIPTION"
- value="description"
- c:type="GST_TAG_DESCRIPTION">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="691">short text describing the content of the data (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="696"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_DEVICE_MANUFACTURER"
- value="device-manufacturer"
- c:type="GST_TAG_DEVICE_MANUFACTURER">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1070">Manufacturer of the device used to create the media (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="1075"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_DEVICE_MODEL"
- value="device-model"
- c:type="GST_TAG_DEVICE_MODEL">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1076">Model of the device used to create the media (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="1081"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_DURATION" value="duration" c:type="GST_TAG_DURATION">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="762">length in GStreamer time units (nanoseconds) (unsigned 64-bit integer)</doc>
- <source-position filename="gst/gsttaglist.h" line="767"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ENCODED_BY"
- value="encoded-by"
- c:type="GST_TAG_ENCODED_BY">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="727">name of the person or organisation that encoded the file. May contain a
-copyright message if the person or organisation also holds the copyright
-(string)
-
-Note: do not use this field to describe the encoding application. Use
-#GST_TAG_APPLICATION_NAME or #GST_TAG_COMMENT for that.</doc>
- <source-position filename="gst/gsttaglist.h" line="737"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ENCODER" value="encoder" c:type="GST_TAG_ENCODER">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="829">encoder used to encode this stream (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="834"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ENCODER_VERSION"
- value="encoder-version"
- c:type="GST_TAG_ENCODER_VERSION">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="835">version of the encoder used to encode this stream (unsigned integer)</doc>
- <source-position filename="gst/gsttaglist.h" line="840"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_EXTENDED_COMMENT"
- value="extended-comment"
- c:type="GST_TAG_EXTENDED_COMMENT">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="641">key/value text commenting the data (string)
-
-Must be in the form of 'key=comment' or
-'key[lc]=comment' where 'lc' is an ISO-639
-language code.
-
-This tag is used for unknown Vorbis comment tags,
-unknown APE tags and certain ID3v2 comment fields.</doc>
- <source-position filename="gst/gsttaglist.h" line="653"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="TAG_FLAG_IS_VALID"
- c:identifier="GST_TAG_FLAG_IS_VALID"
- introspectable="0">
- <source-position filename="gst/gsttaglist.h" line="95"/>
- <parameters>
- <parameter name="flag">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="TAG_GENRE" value="genre" c:type="GST_TAG_GENRE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="629">genre this data belongs to (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="634"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_GEO_LOCATION_CAPTURE_DIRECTION"
- value="geo-location-capture-direction"
- c:type="GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1009">Indicates the direction the device is pointing to when capturing
-a media. It is represented as degrees in floating point representation,
-0 means the geographic north, and increases clockwise (double from 0 to 360)
-
-See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION</doc>
- <source-position filename="gst/gsttaglist.h" line="1018"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_GEO_LOCATION_CITY"
- value="geo-location-city"
- c:type="GST_TAG_GEO_LOCATION_CITY">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="967">The city (english name) where the media has been produced (string).</doc>
- <source-position filename="gst/gsttaglist.h" line="972"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_GEO_LOCATION_COUNTRY"
- value="geo-location-country"
- c:type="GST_TAG_GEO_LOCATION_COUNTRY">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="961">The country (english name) where the media has been produced (string).</doc>
- <source-position filename="gst/gsttaglist.h" line="966"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_GEO_LOCATION_ELEVATION"
- value="geo-location-elevation"
- c:type="GST_TAG_GEO_LOCATION_ELEVATION">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="954">geo elevation of where the media has been recorded or produced in meters
-according to WGS84 (zero is average sea level) (double).</doc>
- <source-position filename="gst/gsttaglist.h" line="960"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_GEO_LOCATION_HORIZONTAL_ERROR"
- value="geo-location-horizontal-error"
- c:type="GST_TAG_GEO_LOCATION_HORIZONTAL_ERROR">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="983">Represents the expected error on the horizontal positioning in
-meters (double).</doc>
- <source-position filename="gst/gsttaglist.h" line="989"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_GEO_LOCATION_LATITUDE"
- value="geo-location-latitude"
- c:type="GST_TAG_GEO_LOCATION_LATITUDE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="936">geo latitude location of where the media has been recorded or produced in
-degrees according to WGS84 (zero at the equator, negative values for southern
-latitudes) (double).</doc>
- <source-position filename="gst/gsttaglist.h" line="943"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_GEO_LOCATION_LONGITUDE"
- value="geo-location-longitude"
- c:type="GST_TAG_GEO_LOCATION_LONGITUDE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="945">geo longitude location of where the media has been recorded or produced in
-degrees according to WGS84 (zero at the prime meridian in Greenwich/UK,
-negative values for western longitudes). (double).</doc>
- <source-position filename="gst/gsttaglist.h" line="952"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_GEO_LOCATION_MOVEMENT_DIRECTION"
- value="geo-location-movement-direction"
- c:type="GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="999">Indicates the movement direction of the device performing the capture
-of a media. It is represented as degrees in floating point representation,
-0 means the geographic north, and increases clockwise (double from 0 to 360)
-
-See also #GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION</doc>
- <source-position filename="gst/gsttaglist.h" line="1008"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_GEO_LOCATION_MOVEMENT_SPEED"
- value="geo-location-movement-speed"
- c:type="GST_TAG_GEO_LOCATION_MOVEMENT_SPEED">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="990">Speed of the capturing device when performing the capture.
-Represented in m/s. (double)
-
-See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION</doc>
- <source-position filename="gst/gsttaglist.h" line="998"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_GEO_LOCATION_NAME"
- value="geo-location-name"
- c:type="GST_TAG_GEO_LOCATION_NAME">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="928">human readable descriptive location of where the media has been recorded or
-produced. (string).</doc>
- <source-position filename="gst/gsttaglist.h" line="934"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_GEO_LOCATION_SUBLOCATION"
- value="geo-location-sublocation"
- c:type="GST_TAG_GEO_LOCATION_SUBLOCATION">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="973">A location 'smaller' than GST_TAG_GEO_LOCATION_CITY that specifies better
-where the media has been produced. (e.g. the neighborhood) (string).
-
-This tag has been added as this is how it is handled/named in XMP's
-Iptc4xmpcore schema.</doc>
- <source-position filename="gst/gsttaglist.h" line="982"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_GROUPING" value="grouping" c:type="GST_TAG_GROUPING">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1055">Groups together media that are related and spans multiple tracks. An
-example are multiple pieces of a concerto. (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="1061"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_HOMEPAGE" value="homepage" c:type="GST_TAG_HOMEPAGE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="685">Homepage for this media (i.e. artist or movie homepage) (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="690"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_IMAGE" value="image" c:type="GST_TAG_IMAGE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="890">image (sample) (sample taglist should specify the content type and preferably
-also set "image-type" field as `GstTagImageType`)</doc>
- <source-position filename="gst/gsttaglist.h" line="896"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_IMAGE_ORIENTATION"
- value="image-orientation"
- c:type="GST_TAG_IMAGE_ORIENTATION">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1097">Represents the 'Orientation' tag from EXIF. Defines how the image
-should be rotated and mirrored for display. (string)
-
-This tag has a predefined set of allowed values:
- "rotate-0"
- "rotate-90"
- "rotate-180"
- "rotate-270"
- "flip-rotate-0"
- "flip-rotate-90"
- "flip-rotate-180"
- "flip-rotate-270"
-
-The naming is adopted according to a possible transformation to perform
-on the image to fix its orientation, obviously equivalent operations will
-yield the same result.
-
-Rotations indicated by the values are in clockwise direction and
-'flip' means an horizontal mirroring.</doc>
- <source-position filename="gst/gsttaglist.h" line="1120"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_INTERPRETED_BY"
- value="interpreted-by"
- c:type="GST_TAG_INTERPRETED_BY"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1129">Information about the people behind a remix and similar
-interpretations of another existing piece (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="1137"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ISRC" value="isrc" c:type="GST_TAG_ISRC">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="703">International Standard Recording Code - see http://www.ifpi.org/isrc/ (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="708"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_KEYWORDS" value="keywords" c:type="GST_TAG_KEYWORDS">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="921">comma separated keywords describing the content (string).</doc>
- <source-position filename="gst/gsttaglist.h" line="926"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_LANGUAGE_CODE"
- value="language-code"
- c:type="GST_TAG_LANGUAGE_CODE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="871">ISO-639-2 or ISO-639-1 code for the language the content is in (string)
-
-There is utility API in libgsttag in gst-plugins-base to obtain a translated
-language name from the language code: `gst_tag_get_language_name()`</doc>
- <source-position filename="gst/gsttaglist.h" line="879"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_LANGUAGE_NAME"
- value="language-name"
- c:type="GST_TAG_LANGUAGE_NAME">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="880">Name of the language the content is in (string)
-
-Free-form name of the language the content is in, if a language code
-is not available. This tag should not be set in addition to a language
-code. It is undefined what language or locale the language name is in.</doc>
- <source-position filename="gst/gsttaglist.h" line="889"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_LICENSE" value="license" c:type="GST_TAG_LICENSE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="744">license of data (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="749"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_LICENSE_URI"
- value="license-uri"
- c:type="GST_TAG_LICENSE_URI">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="750">URI to location where license details can be found (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="755"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="TAG_LIST"
- c:identifier="GST_TAG_LIST"
- introspectable="0">
- <source-position filename="gst/gsttaglist.h" line="110"/>
- <parameters>
- <parameter name="x">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="TAG_LOCATION" value="location" c:type="GST_TAG_LOCATION">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="678">Origin of media as a URI (location, where the original of the file or stream
-is hosted) (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="684"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_LYRICS" value="lyrics" c:type="GST_TAG_LYRICS">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1043">The lyrics of the media (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="1048"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_MAXIMUM_BITRATE"
- value="maximum-bitrate"
- c:type="GST_TAG_MAXIMUM_BITRATE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="817">maximum bitrate in bits/s (unsigned integer)</doc>
- <source-position filename="gst/gsttaglist.h" line="822"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_MIDI_BASE_NOTE"
- value="midi-base-note"
- c:type="GST_TAG_MIDI_BASE_NOTE"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1138">[Midi note number](http://en.wikipedia.org/wiki/Note#Note_designation_in_accordance_with_octave_name)
-of the audio track. This is useful for sample instruments and in particular
-for multi-samples.</doc>
- <source-position filename="gst/gsttaglist.h" line="1147"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_MINIMUM_BITRATE"
- value="minimum-bitrate"
- c:type="GST_TAG_MINIMUM_BITRATE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="811">minimum bitrate in bits/s (unsigned integer)</doc>
- <source-position filename="gst/gsttaglist.h" line="816"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="TAG_MODE_IS_VALID"
- c:identifier="GST_TAG_MODE_IS_VALID"
- introspectable="0">
- <source-position filename="gst/gsttaglist.h" line="74"/>
- <parameters>
- <parameter name="mode">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="TAG_NOMINAL_BITRATE"
- value="nominal-bitrate"
- c:type="GST_TAG_NOMINAL_BITRATE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="804">nominal bitrate in bits/s (unsigned integer). The actual bitrate might be
-different from this target bitrate.</doc>
- <source-position filename="gst/gsttaglist.h" line="810"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ORGANIZATION"
- value="organization"
- c:type="GST_TAG_ORGANIZATION">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="709">organization (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="714"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_PERFORMER"
- value="performer"
- c:type="GST_TAG_PERFORMER">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="756">person(s) performing (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="761"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_PREVIEW_IMAGE"
- value="preview-image"
- c:type="GST_TAG_PREVIEW_IMAGE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="897">image that is meant for preview purposes, e.g. small icon-sized version
-(sample) (sample taglist should specify the content type)</doc>
- <source-position filename="gst/gsttaglist.h" line="903"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_PRIVATE_DATA"
- value="private-data"
- c:type="GST_TAG_PRIVATE_DATA"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1148">Any private data that may be contained in tags (sample).
-
-It is represented by #GstSample in which #GstBuffer contains the
-binary data and the sample's info #GstStructure may contain any
-extra information that identifies the origin or meaning of the data.
-
-Private frames in ID3v2 tags ('PRIV' frames) will be represented
-using this tag, in which case the GstStructure will be named
-"ID3PrivateFrame" and contain a field named "owner" of type string
-which contains the owner-identification string from the tag.</doc>
- <source-position filename="gst/gsttaglist.h" line="1164"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_PUBLISHER"
- value="publisher"
- c:type="GST_TAG_PUBLISHER"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1121">Name of the label or publisher (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="1128"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_REFERENCE_LEVEL"
- value="replaygain-reference-level"
- c:type="GST_TAG_REFERENCE_LEVEL">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="865">reference level of track and album gain values (double)</doc>
- <source-position filename="gst/gsttaglist.h" line="870"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_SERIAL" value="serial" c:type="GST_TAG_SERIAL">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="823">serial number of track (unsigned integer)</doc>
- <source-position filename="gst/gsttaglist.h" line="828"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="TAG_SETTER"
- c:identifier="GST_TAG_SETTER"
- introspectable="0">
- <source-position filename="gst/gsttagsetter.h" line="30"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TAG_SETTER_GET_INTERFACE"
- c:identifier="GST_TAG_SETTER_GET_INTERFACE"
- introspectable="0">
- <source-position filename="gst/gsttagsetter.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="TAG_SHOW_EPISODE_NUMBER"
- value="show-episode-number"
- c:type="GST_TAG_SHOW_EPISODE_NUMBER">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1031">Number of the episode within a season/show (unsigned integer)</doc>
- <source-position filename="gst/gsttaglist.h" line="1036"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_SHOW_NAME"
- value="show-name"
- c:type="GST_TAG_SHOW_NAME">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1019">Name of the show, used for displaying (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="1024"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_SHOW_SEASON_NUMBER"
- value="show-season-number"
- c:type="GST_TAG_SHOW_SEASON_NUMBER">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1037">Number of the season of a show/series (unsigned integer)</doc>
- <source-position filename="gst/gsttaglist.h" line="1042"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_SHOW_SORTNAME"
- value="show-sortname"
- c:type="GST_TAG_SHOW_SORTNAME">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1025">Name of the show, used for sorting (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="1030"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_SUBTITLE_CODEC"
- value="subtitle-codec"
- c:type="GST_TAG_SUBTITLE_CODEC">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="786">codec/format the subtitle data is stored in (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="791"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_TITLE" value="title" c:type="GST_TAG_TITLE">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="541">commonly used title (string)
-
-The title as it should be displayed, e.g. 'The Doll House'</doc>
- <source-position filename="gst/gsttaglist.h" line="548"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_TITLE_SORTNAME"
- value="title-sortname"
- c:type="GST_TAG_TITLE_SORTNAME">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="549">commonly used title, as used for sorting (string)
-
-The title as it should be sorted, e.g. 'Doll House, The'</doc>
- <source-position filename="gst/gsttaglist.h" line="556"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_TRACK_COUNT"
- value="track-count"
- c:type="GST_TAG_TRACK_COUNT">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="660">count of tracks inside collection this track belongs to (unsigned integer)</doc>
- <source-position filename="gst/gsttaglist.h" line="665"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_TRACK_GAIN"
- value="replaygain-track-gain"
- c:type="GST_TAG_TRACK_GAIN">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="841">track gain in db (double)</doc>
- <source-position filename="gst/gsttaglist.h" line="846"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_TRACK_NUMBER"
- value="track-number"
- c:type="GST_TAG_TRACK_NUMBER">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="654">track number inside a collection (unsigned integer)</doc>
- <source-position filename="gst/gsttaglist.h" line="659"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_TRACK_PEAK"
- value="replaygain-track-peak"
- c:type="GST_TAG_TRACK_PEAK">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="847">peak of the track (double)</doc>
- <source-position filename="gst/gsttaglist.h" line="852"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_USER_RATING"
- value="user-rating"
- c:type="GST_TAG_USER_RATING">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="1062">Rating attributed by a person (likely the application user).
-The higher the value, the more the user likes this media
-(unsigned int from 0 to 100)</doc>
- <source-position filename="gst/gsttaglist.h" line="1069"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_VERSION" value="version" c:type="GST_TAG_VERSION">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="697">version of this data (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="702"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_VIDEO_CODEC"
- value="video-codec"
- c:type="GST_TAG_VIDEO_CODEC">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="774">codec the video data is stored in (string)</doc>
- <source-position filename="gst/gsttaglist.h" line="779"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="TASK" c:identifier="GST_TASK" introspectable="0">
- <source-position filename="gst/gsttask.h" line="42"/>
- <parameters>
- <parameter name="task">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_BROADCAST"
- c:identifier="GST_TASK_BROADCAST"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="96">Send a broadcast signal to all waiting task conds</doc>
- <source-position filename="gst/gsttask.h" line="102"/>
- <parameters>
- <parameter name="task">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="98">Task to broadcast</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_CAST"
- c:identifier="GST_TASK_CAST"
- introspectable="0">
- <source-position filename="gst/gsttask.h" line="47"/>
- <parameters>
- <parameter name="task">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_CLASS"
- c:identifier="GST_TASK_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttask.h" line="44"/>
- <parameters>
- <parameter name="tclass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_GET_CLASS"
- c:identifier="GST_TASK_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttask.h" line="46"/>
- <parameters>
- <parameter name="task">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_GET_COND"
- c:identifier="GST_TASK_GET_COND"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="75">Get access to the cond of the task.</doc>
- <source-position filename="gst/gsttask.h" line="81"/>
- <parameters>
- <parameter name="task">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="77">Task to get the cond of</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_GET_LOCK"
- c:identifier="GST_TASK_GET_LOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="104">Get access to the task lock.</doc>
- <source-position filename="gst/gsttask.h" line="110"/>
- <parameters>
- <parameter name="task">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="106">Task to get the lock of</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_POOL"
- c:identifier="GST_TASK_POOL"
- introspectable="0">
- <source-position filename="gst/gsttaskpool.h" line="31"/>
- <parameters>
- <parameter name="pool">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_POOL_CAST"
- c:identifier="GST_TASK_POOL_CAST"
- introspectable="0">
- <source-position filename="gst/gsttaskpool.h" line="36"/>
- <parameters>
- <parameter name="pool">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_POOL_CLASS"
- c:identifier="GST_TASK_POOL_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttaskpool.h" line="33"/>
- <parameters>
- <parameter name="pclass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_POOL_GET_CLASS"
- c:identifier="GST_TASK_POOL_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttaskpool.h" line="35"/>
- <parameters>
- <parameter name="pool">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_SIGNAL"
- c:identifier="GST_TASK_SIGNAL"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="89">Signal the task cond</doc>
- <source-position filename="gst/gsttask.h" line="95"/>
- <parameters>
- <parameter name="task">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="91">Task to signal</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_STATE"
- c:identifier="GST_TASK_STATE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="67">Get access to the state of the task.</doc>
- <source-position filename="gst/gsttask.h" line="73"/>
- <parameters>
- <parameter name="task">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="69">Task to get the state of</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TASK_WAIT"
- c:identifier="GST_TASK_WAIT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="82">Wait for the task cond to be signalled</doc>
- <source-position filename="gst/gsttask.h" line="88"/>
- <parameters>
- <parameter name="task">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="84">Task to wait for</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="TIMEP_FORMAT"
- value="paT"
- c:type="GST_TIMEP_FORMAT"
- version="1.18"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.h"
- line="305">printf format type used to debug GStreamer ClockTime pointers. You can use
-this in combination with GStreamer's debug logging system as well as the
-functions gst_info_vasprintf(), gst_info_strdup_vprintf() and
-gst_info_strdup_printf() to pretty-print #GstClockTime pointers. This can
-only be used on pointers to GstClockTime values.</doc>
- <source-position filename="gst/gstinfo.h" line="316"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="TIMESPEC_TO_TIME"
- c:identifier="GST_TIMESPEC_TO_TIME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="192">Convert a struct timespec (see man pselect) to a #GstClockTime.</doc>
- <source-position filename="gst/gstclock.h" line="198"/>
- <parameters>
- <parameter name="ts">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="194">the timespec to convert</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMEVAL_TO_TIME"
- c:identifier="GST_TIMEVAL_TO_TIME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="163">Convert a GTimeVal to a #GstClockTime.</doc>
- <source-position filename="gst/gstclock.h" line="169"/>
- <parameters>
- <parameter name="tv">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="165">the timeval to convert</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIME_ARGS"
- c:identifier="GST_TIME_ARGS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="228">Format @t for the #GST_TIME_FORMAT format string. Note: @t will be
-evaluated more than once.</doc>
- <source-position filename="gst/gstclock.h" line="235"/>
- <parameters>
- <parameter name="t">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="230">a #GstClockTime</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIME_AS_MSECONDS"
- c:identifier="GST_TIME_AS_MSECONDS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="131">Convert a #GstClockTime to milliseconds (1/1000 of a second).</doc>
- <source-position filename="gst/gstclock.h" line="137"/>
- <parameters>
- <parameter name="time">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="133">the time</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIME_AS_NSECONDS"
- c:identifier="GST_TIME_AS_NSECONDS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="145">Convert a #GstClockTime to nanoseconds (1/1000000000 of a second).</doc>
- <source-position filename="gst/gstclock.h" line="151"/>
- <parameters>
- <parameter name="time">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="147">the time</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIME_AS_SECONDS"
- c:identifier="GST_TIME_AS_SECONDS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="124">Convert a #GstClockTime to seconds.</doc>
- <source-position filename="gst/gstclock.h" line="130"/>
- <parameters>
- <parameter name="time">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="126">the time</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIME_AS_USECONDS"
- c:identifier="GST_TIME_AS_USECONDS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="138">Convert a #GstClockTime to microseconds (1/1000000 of a second).</doc>
- <source-position filename="gst/gstclock.h" line="144"/>
- <parameters>
- <parameter name="time">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="140">the time</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="TIME_FORMAT"
- value="u:%02u:%02u.%09u"
- c:type="GST_TIME_FORMAT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="215">A string that can be used in printf-like format strings to display a
-#GstClockTime value in h:m:s format. Use GST_TIME_ARGS() to construct
-the matching arguments.
-
-Example:
-|[&lt;!-- language="C" --&gt;
-printf("%" GST_TIME_FORMAT "\n", GST_TIME_ARGS(ts));
-]|</doc>
- <source-position filename="gst/gstclock.h" line="227"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="TIME_TO_TIMESPEC"
- c:identifier="GST_TIME_TO_TIMESPEC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="199">Convert a #GstClockTime to a struct timespec (see man pselect)</doc>
- <source-position filename="gst/gstclock.h" line="206"/>
- <parameters>
- <parameter name="t">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="201">The #GstClockTime to convert</doc>
- </parameter>
- <parameter name="ts">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="202">The target timespec</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIME_TO_TIMEVAL"
- c:identifier="GST_TIME_TO_TIMEVAL"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="171">Convert a #GstClockTime to a GTimeVal
-
-&gt; on 32-bit systems, a timeval has a range of only 2^32 - 1 seconds,
-&gt; which is about 68 years. Expect trouble if you want to schedule stuff
-&gt; in your pipeline for 2038.</doc>
- <source-position filename="gst/gstclock.h" line="182"/>
- <parameters>
- <parameter name="t">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="173">The #GstClockTime to convert</doc>
- </parameter>
- <parameter name="tv">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="174">The target timeval</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TOC_ENTRY_TYPE_IS_ALTERNATIVE"
- c:identifier="GST_TOC_ENTRY_TYPE_IS_ALTERNATIVE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="85">Checks if @entry_type indicates that its #GstTocEntry is an alternative.</doc>
- <source-position filename="gst/gsttoc.h" line="91"/>
- <parameters>
- <parameter name="entry_type">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="87">The #GstTocEntryType from a #GstTocEntry</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TOC_ENTRY_TYPE_IS_SEQUENCE"
- c:identifier="GST_TOC_ENTRY_TYPE_IS_SEQUENCE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="93">Checks if @entry_type indicates that its #GstTocEntry is a sequence.</doc>
- <source-position filename="gst/gsttoc.h" line="99"/>
- <parameters>
- <parameter name="entry_type">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="95">The #GstTocEntryType from a #GstTocEntry</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="TOC_REPEAT_COUNT_INFINITE"
- value="-1"
- c:type="GST_TOC_REPEAT_COUNT_INFINITE"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="120">Special value for the repeat_count set in gst_toc_entry_set_loop() or
-returned by gst_toc_entry_set_loop() to indicate infinite looping.</doc>
- <source-position filename="gst/gsttoc.h" line="128"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="TOC_SETTER"
- c:identifier="GST_TOC_SETTER"
- introspectable="0">
- <source-position filename="gst/gsttocsetter.h" line="30"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TOC_SETTER_GET_IFACE"
- c:identifier="GST_TOC_SETTER_GET_IFACE"
- introspectable="0">
- <source-position filename="gst/gsttocsetter.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACER" c:identifier="GST_TRACER" introspectable="0">
- <source-position filename="gst/gsttracer.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACER_CAST"
- c:identifier="GST_TRACER_CAST"
- introspectable="0">
- <source-position filename="gst/gsttracer.h" line="42"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACER_CLASS"
- c:identifier="GST_TRACER_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttracer.h" line="38"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACER_FACTORY"
- c:identifier="GST_TRACER_FACTORY"
- introspectable="0">
- <source-position filename="gst/gsttracerfactory.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACER_FACTORY_CAST"
- c:identifier="GST_TRACER_FACTORY_CAST"
- introspectable="0">
- <source-position filename="gst/gsttracerfactory.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACER_FACTORY_CLASS"
- c:identifier="GST_TRACER_FACTORY_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttracerfactory.h" line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACER_FACTORY_GET_CLASS"
- c:identifier="GST_TRACER_FACTORY_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttracerfactory.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACER_GET_CLASS"
- c:identifier="GST_TRACER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttracer.h" line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACER_RECORD"
- c:identifier="GST_TRACER_RECORD"
- introspectable="0">
- <source-position filename="gst/gsttracerrecord.h" line="40"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACER_RECORD_CAST"
- c:identifier="GST_TRACER_RECORD_CAST"
- introspectable="0">
- <source-position filename="gst/gsttracerrecord.h" line="45"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACER_RECORD_CLASS"
- c:identifier="GST_TRACER_RECORD_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttracerrecord.h" line="41"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRACER_RECORD_GET_CLASS"
- c:identifier="GST_TRACER_RECORD_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttracerrecord.h" line="44"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TYPE_FIND_FACTORY"
- c:identifier="GST_TYPE_FIND_FACTORY"
- introspectable="0">
- <source-position filename="gst/gsttypefindfactory.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TYPE_FIND_FACTORY_CLASS"
- c:identifier="GST_TYPE_FIND_FACTORY_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttypefindfactory.h" line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TYPE_FIND_FACTORY_GET_CLASS"
- c:identifier="GST_TYPE_FIND_FACTORY_GET_CLASS"
- introspectable="0">
- <source-position filename="gst/gsttypefindfactory.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <enumeration name="TagFlag"
- glib:type-name="GstTagFlag"
- glib:get-type="gst_tag_flag_get_type"
- c:type="GstTagFlag">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="76">Extra tag flags used when registering tags.</doc>
- <member name="undefined"
- value="0"
- c:identifier="GST_TAG_FLAG_UNDEFINED"
- glib:nick="undefined">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="78">undefined flag</doc>
- </member>
- <member name="meta"
- value="1"
- c:identifier="GST_TAG_FLAG_META"
- glib:nick="meta">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="79">tag is meta data</doc>
- </member>
- <member name="encoded"
- value="2"
- c:identifier="GST_TAG_FLAG_ENCODED"
- glib:nick="encoded">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="80">tag is encoded</doc>
- </member>
- <member name="decoded"
- value="3"
- c:identifier="GST_TAG_FLAG_DECODED"
- glib:nick="decoded">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="81">tag is decoded</doc>
- </member>
- <member name="count"
- value="4"
- c:identifier="GST_TAG_FLAG_COUNT"
- glib:nick="count">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="82">number of tag flags</doc>
- </member>
- </enumeration>
- <callback name="TagForeachFunc" c:type="GstTagForeachFunc">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="114">A function that will be called in gst_tag_list_foreach(). The function may
-not modify the tag list.</doc>
- <source-position filename="gst/gsttaglist.h" line="123"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="116">the #GstTagList</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="117">a name of a tag in @list</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="118">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="TagList"
- c:type="GstTagList"
- glib:type-name="GstTagList"
- glib:get-type="gst_tag_list_get_type"
- c:symbol-prefix="tag_list">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="22">List of tags and values used to describe media metadata.
-
-Strings in structures must be ASCII or UTF-8 encoded. Other encodings are
-not allowed. Strings must not be empty or %NULL.</doc>
- <source-position filename="gst/gsttaglist.h" line="106"/>
- <field name="mini_object" writable="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="99">the parent type</doc>
- <type name="MiniObject" c:type="GstMiniObject"/>
- </field>
- <constructor name="new"
- c:identifier="gst_tag_list_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="761">Creates a new taglist and appends the values for the given tags. It expects
-tag-value pairs like gst_tag_list_add(), and a %NULL terminator after the
-last pair. The type of the values is implicit and is documented in the API
-reference, but can also be queried at runtime with gst_tag_get_type(). It
-is an error to pass a value of a type not matching the tag type into this
-function. The tag list will make copies of any arguments passed
-(e.g. strings, buffers).
-
-After creation you might also want to set a #GstTagScope on the returned
-taglist to signal if the contained tags are global or stream tags. By
-default stream scope is assumes. See gst_tag_list_set_scope().
-
-Free-function: gst_tag_list_unref</doc>
- <source-position filename="gst/gsttaglist.h" line="204"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="780">a new #GstTagList. Free with gst_tag_list_unref()
- when no longer needed.</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="763">tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="764">%NULL-terminated list of values to set</doc>
- <varargs/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_empty" c:identifier="gst_tag_list_new_empty">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="741">Creates a new empty GstTagList.
-
-Free-function: gst_tag_list_unref</doc>
- <source-position filename="gst/gsttaglist.h" line="201"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="748">An empty tag list</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </return-value>
- </constructor>
- <constructor name="new_from_string"
- c:identifier="gst_tag_list_new_from_string">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="877">Deserializes a tag list.</doc>
- <source-position filename="gst/gsttaglist.h" line="219"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="883">a new #GstTagList, or %NULL in case of an
-error.</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <parameter name="str" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="879">a string created with gst_tag_list_to_string()</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_valist"
- c:identifier="gst_tag_list_new_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="799">Just like gst_tag_list_new(), only that it takes a va_list argument.
-Useful mostly for language bindings.
-
-Free-function: gst_tag_list_unref</doc>
- <source-position filename="gst/gsttaglist.h" line="207"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="808">a new #GstTagList. Free with gst_tag_list_unref()
- when no longer needed.</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="801">tag / value pairs to set</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="add" c:identifier="gst_tag_list_add" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1214">Sets the values for the given tags using the specified mode.</doc>
- <source-position filename="gst/gsttaglist.h" line="245"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1216">list to set tags in</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1217">the mode to use</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1218">tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1219">%NULL-terminated list of values to set</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="add_valist"
- c:identifier="gst_tag_list_add_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1264">Sets the values for the given tags using the specified mode.</doc>
- <source-position filename="gst/gsttaglist.h" line="255"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1266">list to set tags in</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1267">the mode to use</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1268">tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1269">tag / value pairs to set</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_valist_values"
- c:identifier="gst_tag_list_add_valist_values"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1318">Sets the GValues for the given tags using the specified mode.</doc>
- <source-position filename="gst/gsttaglist.h" line="260"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1320">list to set tags in</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1321">the mode to use</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1322">tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1323">tag / GValue pairs to set</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_value" c:identifier="gst_tag_list_add_value">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1354">Sets the GValue for a given tag using the specified mode.</doc>
- <source-position filename="gst/gsttaglist.h" line="265"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1356">list to set tags in</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1357">the mode to use</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1358">tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1359">GValue for this tag</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_values"
- c:identifier="gst_tag_list_add_values"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1239">Sets the GValues for the given tags using the specified mode.</doc>
- <source-position filename="gst/gsttaglist.h" line="250"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1241">list to set tags in</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1242">the mode to use</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1243">tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1244">GValues to set</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_tag_list_copy">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="2066">Creates a new #GstTagList as a copy of the old @taglist. The new taglist
-will have a refcount of 1, owned by the caller, and will be writable as
-a result.
-
-Note that this function is the semantic equivalent of a gst_tag_list_ref()
-followed by a gst_tag_list_make_writable(). If you only want to hold on to a
-reference to the data, you should use gst_tag_list_ref().
-
-When you are finished with the taglist, call gst_tag_list_unref() on it.</doc>
- <source-position filename="gst/gsttaglist.h" line="457"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="2080">the new #GstTagList</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="taglist" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="2068">a #GstTagList.</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="foreach" c:identifier="gst_tag_list_foreach">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1410">Calls the given function for each tag inside the tag list. Note that if there
-is no tag, the function won't be called at all.</doc>
- <source-position filename="gst/gsttaglist.h" line="273"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1412">list to iterate over</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1413">function to be called for each tag</doc>
- <type name="TagForeachFunc" c:type="GstTagForeachFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1414">user specified data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_boolean" c:identifier="gst_tag_list_get_boolean">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1564">Copies the contents for the given tag into the value, merging multiple values
-into one if multiple values are associated with the tag.</doc>
- <source-position filename="gst/gsttaglist.h" line="289"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1573">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1566">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1567">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1568">location for the result</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_boolean_index"
- c:identifier="gst_tag_list_get_boolean_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1576">Gets the value that is at the given index for the given tag in the given
-list.</doc>
- <source-position filename="gst/gsttaglist.h" line="293"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1586">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1578">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1579">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1580">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1581">location for the result</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_date" c:identifier="gst_tag_list_get_date">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1865">Copies the first date for the given tag in the taglist into the variable
-pointed to by @value. Free the date with g_date_free() when it is no longer
-needed.
-
-Free-function: g_date_free</doc>
- <source-position filename="gst/gsttaglist.h" line="375"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1878">%TRUE, if a date was copied, %FALSE if the tag didn't exist in the
- given list or if it was %NULL.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1867">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1868">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1869">address of a GDate pointer
- variable to store the result into</doc>
- <type name="GLib.Date" c:type="GDate**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_date_index" c:identifier="gst_tag_list_get_date_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1898">Gets the date that is at the given index for the given tag in the given
-list and copies it into the variable pointed to by @value. Free the date
-with g_date_free() when it is no longer needed.
-
-Free-function: g_date_free</doc>
- <source-position filename="gst/gsttaglist.h" line="379"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1911">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list or if it was %NULL.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1900">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1901">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1902">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1903">location for the result</doc>
- <type name="GLib.Date" c:type="GDate**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_date_time" c:identifier="gst_tag_list_get_date_time">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1930">Copies the first datetime for the given tag in the taglist into the variable
-pointed to by @value. Unref the date with gst_date_time_unref() when
-it is no longer needed.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gsttaglist.h" line="384"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1943">%TRUE, if a datetime was copied, %FALSE if the tag didn't exist in
- the given list or if it was %NULL.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1932">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1933">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1934">address of a #GstDateTime
- pointer variable to store the result into</doc>
- <type name="DateTime" c:type="GstDateTime**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_date_time_index"
- c:identifier="gst_tag_list_get_date_time_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1964">Gets the datetime that is at the given index for the given tag in the given
-list and copies it into the variable pointed to by @value. Unref the datetime
-with gst_date_time_unref() when it is no longer needed.
-
-Free-function: gst_date_time_unref</doc>
- <source-position filename="gst/gsttaglist.h" line="388"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1977">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list or if it was %NULL.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1966">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1967">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1968">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1969">location for the result</doc>
- <type name="DateTime" c:type="GstDateTime**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_double" c:identifier="gst_tag_list_get_double">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1720">Copies the contents for the given tag into the value, merging multiple values
-into one if multiple values are associated with the tag.</doc>
- <source-position filename="gst/gsttaglist.h" line="343"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1729">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1722">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1723">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1724">location for the result</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_double_index"
- c:identifier="gst_tag_list_get_double_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1732">Gets the value that is at the given index for the given tag in the given
-list.</doc>
- <source-position filename="gst/gsttaglist.h" line="347"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1742">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1734">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1735">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1736">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1737">location for the result</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_float" c:identifier="gst_tag_list_get_float">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1694">Copies the contents for the given tag into the value, merging multiple values
-into one if multiple values are associated with the tag.</doc>
- <source-position filename="gst/gsttaglist.h" line="334"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1703">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1696">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1697">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1698">location for the result</doc>
- <type name="gfloat" c:type="gfloat*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_float_index"
- c:identifier="gst_tag_list_get_float_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1706">Gets the value that is at the given index for the given tag in the given
-list.</doc>
- <source-position filename="gst/gsttaglist.h" line="338"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1716">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1708">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1709">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1710">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1711">location for the result</doc>
- <type name="gfloat" c:type="gfloat*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int" c:identifier="gst_tag_list_get_int">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1590">Copies the contents for the given tag into the value, merging multiple values
-into one if multiple values are associated with the tag.</doc>
- <source-position filename="gst/gsttaglist.h" line="298"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1599">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1592">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1593">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1594">location for the result</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int64" c:identifier="gst_tag_list_get_int64">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1642">Copies the contents for the given tag into the value, merging multiple values
-into one if multiple values are associated with the tag.</doc>
- <source-position filename="gst/gsttaglist.h" line="316"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1651">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1644">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1645">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1646">location for the result</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int64_index"
- c:identifier="gst_tag_list_get_int64_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1654">Gets the value that is at the given index for the given tag in the given
-list.</doc>
- <source-position filename="gst/gsttaglist.h" line="320"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1664">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1656">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1657">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1658">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1659">location for the result</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int_index" c:identifier="gst_tag_list_get_int_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1602">Gets the value that is at the given index for the given tag in the given
-list.</doc>
- <source-position filename="gst/gsttaglist.h" line="302"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1612">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1604">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1605">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1606">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1607">location for the result</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pointer" c:identifier="gst_tag_list_get_pointer">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1746">Copies the contents for the given tag into the value, merging multiple values
-into one if multiple values are associated with the tag.</doc>
- <source-position filename="gst/gsttaglist.h" line="366"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1755">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1748">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1749">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1750">location for the result</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pointer_index"
- c:identifier="gst_tag_list_get_pointer_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1758">Gets the value that is at the given index for the given tag in the given
-list.</doc>
- <source-position filename="gst/gsttaglist.h" line="370"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1768">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1760">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1761">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1762">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1763">location for the result</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_sample" c:identifier="gst_tag_list_get_sample">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1996">Copies the first sample for the given tag in the taglist into the variable
-pointed to by @sample. Free the sample with gst_sample_unref() when it is
-no longer needed. You can retrieve the buffer from the sample using
-gst_sample_get_buffer() and the associated caps (if any) with
-gst_sample_get_caps().
-
-Free-function: gst_sample_unref</doc>
- <source-position filename="gst/gsttaglist.h" line="393"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="2011">%TRUE, if a sample was returned, %FALSE if the tag didn't exist in
- the given list or if it was %NULL.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1998">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1999">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="sample"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="2000">address of a GstSample
- pointer variable to store the result into</doc>
- <type name="Sample" c:type="GstSample**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_sample_index"
- c:identifier="gst_tag_list_get_sample_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="2031">Gets the sample that is at the given index for the given tag in the given
-list and copies it into the variable pointed to by @sample. Free the sample
-with gst_sample_unref() when it is no longer needed. You can retrieve the
-buffer from the sample using gst_sample_get_buffer() and the associated
-caps (if any) with gst_sample_get_caps().
-
-Free-function: gst_sample_unref</doc>
- <source-position filename="gst/gsttaglist.h" line="397"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="2047">%TRUE, if a sample was copied, %FALSE if the tag didn't exist in the
- given list or if it was %NULL.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="2033">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="2034">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="2035">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="sample"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="2036">address of a GstSample
- pointer variable to store the result into</doc>
- <type name="Sample" c:type="GstSample**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_scope" c:identifier="gst_tag_list_get_scope">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="843">Gets the scope of @list.</doc>
- <source-position filename="gst/gsttaglist.h" line="213"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="849">The scope of @list</doc>
- <type name="TagScope" c:type="GstTagScope"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="845">a #GstTagList</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_string" c:identifier="gst_tag_list_get_string">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1785">Copies the contents for the given tag into the value, possibly merging
-multiple values into one if multiple values are associated with the tag.
-
-Use gst_tag_list_get_string_index (list, tag, 0, value) if you want
-to retrieve the first string associated with this tag unmodified.
-
-The resulting string in @value will be in UTF-8 encoding and should be
-freed by the caller using g_free when no longer needed. The
-returned string is also guaranteed to be non-%NULL and non-empty.
-
-Free-function: g_free</doc>
- <source-position filename="gst/gsttaglist.h" line="352"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1803">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1787">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1788">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1789">location for the result</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_string_index"
- c:identifier="gst_tag_list_get_string_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1806">Gets the value that is at the given index for the given tag in the given
-list.
-
-The resulting string in @value will be in UTF-8 encoding and should be
-freed by the caller using g_free when no longer needed. The
-returned string is also guaranteed to be non-%NULL and non-empty.
-
-Free-function: g_free</doc>
- <source-position filename="gst/gsttaglist.h" line="356"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1822">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1808">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1809">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1810">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1811">location for the result</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_tag_size" c:identifier="gst_tag_list_get_tag_size">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1189">Checks how many value are stored in this tag list for the given tag.</doc>
- <source-position filename="gst/gsttaglist.h" line="242"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1196">The number of tags stored</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1191">a taglist</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1192">the tag to query</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint" c:identifier="gst_tag_list_get_uint">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1616">Copies the contents for the given tag into the value, merging multiple values
-into one if multiple values are associated with the tag.</doc>
- <source-position filename="gst/gsttaglist.h" line="307"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1625">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1618">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1619">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1620">location for the result</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint64" c:identifier="gst_tag_list_get_uint64">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1668">Copies the contents for the given tag into the value, merging multiple values
-into one if multiple values are associated with the tag.</doc>
- <source-position filename="gst/gsttaglist.h" line="325"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1677">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1670">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1671">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1672">location for the result</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint64_index"
- c:identifier="gst_tag_list_get_uint64_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1680">Gets the value that is at the given index for the given tag in the given
-list.</doc>
- <source-position filename="gst/gsttaglist.h" line="329"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1690">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1682">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1683">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1684">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1685">location for the result</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint_index" c:identifier="gst_tag_list_get_uint_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1628">Gets the value that is at the given index for the given tag in the given
-list.</doc>
- <source-position filename="gst/gsttaglist.h" line="311"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1638">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1630">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1631">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1632">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1633">location for the result</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_value_index"
- c:identifier="gst_tag_list_get_value_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1435">Gets the value that is at the given index for the given tag in the given
-list.</doc>
- <source-position filename="gst/gsttaglist.h" line="278"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1444">The GValue for the specified
- entry or %NULL if the tag wasn't available or the tag
- doesn't have as many entries</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1437">a #GstTagList</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1438">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1439">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert" c:identifier="gst_tag_list_insert">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1120">Inserts the tags of the @from list into the first list using the given mode.</doc>
- <source-position filename="gst/gsttaglist.h" line="234"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="into" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1122">list to merge into</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </instance-parameter>
- <parameter name="from" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1123">list to merge from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1124">the mode to use</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_empty" c:identifier="gst_tag_list_is_empty">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="939">Checks if the given taglist is empty.</doc>
- <source-position filename="gst/gsttaglist.h" line="228"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="945">%TRUE if the taglist is empty, otherwise %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="941">A #GstTagList.</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_equal" c:identifier="gst_tag_list_is_equal">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="988">Checks if the two given taglists are equal.</doc>
- <source-position filename="gst/gsttaglist.h" line="231"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="995">%TRUE if the taglists are equal, otherwise %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="990">a #GstTagList.</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="list2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="991">a #GstTagList.</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </parameter>
- </parameters>
- </method>
- <method name="merge" c:identifier="gst_tag_list_merge">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1148">Merges the two given lists into a new list. If one of the lists is %NULL, a
-copy of the other is returned. If both lists are %NULL, %NULL is returned.
-
-Free-function: gst_tag_list_unref</doc>
- <source-position filename="gst/gsttaglist.h" line="238"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1159">the new list</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="list1"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1150">first list to merge</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="list2"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1151">second list to merge</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1152">the mode to use</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="n_tags" c:identifier="gst_tag_list_n_tags">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="904">Get the number of tags in @list.</doc>
- <source-position filename="gst/gsttaglist.h" line="222"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="910">The number of tags in @list.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="906">A #GstTagList.</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="nth_tag_name" c:identifier="gst_tag_list_nth_tag_name">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="921">Get the name of the tag in @list at @index.</doc>
- <source-position filename="gst/gsttaglist.h" line="225"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="928">The name of the tag at @index.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="923">A #GstTagList.</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="924">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_string_index"
- c:identifier="gst_tag_list_peek_string_index">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1832">Peeks at the value that is at the given index for the given tag in the given
-list.
-
-The resulting string in @value will be in UTF-8 encoding and doesn't need
-to be freed by the caller. The returned string is also guaranteed to
-be non-%NULL and non-empty.</doc>
- <source-position filename="gst/gsttaglist.h" line="361"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1846">%TRUE, if a value was set, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1834">a #GstTagList to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1835">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1836">number of entry to read out</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1837">location for the result</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_tag_list_ref" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="403">Add a reference to a #GstTagList mini object.
-
-From this point on, until the caller calls gst_tag_list_unref() or
-gst_tag_list_make_writable(), it is guaranteed that the taglist object will
-not change. To use a #GstTagList object, you must always have a refcount on
-it -- either the one made implicitly by e.g. gst_tag_list_new(), or via
-taking one explicitly with this function.</doc>
- <source-position filename="gst/gsttaglist.h" line="417"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="415">the same #GstTagList mini object.</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="taglist" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="405">the #GstTagList to reference</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_tag" c:identifier="gst_tag_list_remove_tag">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1375">Removes the given tag from the taglist.</doc>
- <source-position filename="gst/gsttaglist.h" line="270"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1377">list to remove tag from</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </instance-parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1378">tag to remove</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_scope" c:identifier="gst_tag_list_set_scope">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="825">Sets the scope of @list to @scope. By default the scope
-of a taglist is stream scope.</doc>
- <source-position filename="gst/gsttaglist.h" line="210"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="827">a #GstTagList</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </instance-parameter>
- <parameter name="scope" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="828">new scope for @list</doc>
- <type name="TagScope" c:type="GstTagScope"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_string" c:identifier="gst_tag_list_to_string">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="859">Serializes a tag list to a string.</doc>
- <source-position filename="gst/gsttaglist.h" line="216"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="865">a newly-allocated string, or %NULL in case of
- an error. The string must be freed with g_free() when no longer
- needed.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="861">a #GstTagList</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unref"
- c:identifier="gst_tag_list_unref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="424">Unref a #GstTagList, and and free all its memory when the refcount reaches 0.</doc>
- <source-position filename="gst/gsttaglist.h" line="430"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="taglist" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="426">a #GstTagList.</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="copy_value" c:identifier="gst_tag_list_copy_value">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1472">Copies the contents for the given tag into the value,
-merging multiple values into one if multiple values are associated
-with the tag.
-You must g_value_unset() the value after use.</doc>
- <source-position filename="gst/gsttaglist.h" line="282"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1483">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1474">uninitialized #GValue to copy into</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1475">list to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1476">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <callback name="TagMergeFunc" c:type="GstTagMergeFunc">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="127">A function for merging multiple values of a tag used when registering
-tags.</doc>
- <source-position filename="gst/gsttaglist.h" line="135"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="129">the destination #GValue</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="130">the source #GValue</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </callback>
- <enumeration name="TagMergeMode"
- glib:type-name="GstTagMergeMode"
- glib:get-type="gst_tag_merge_mode_get_type"
- c:type="GstTagMergeMode">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="33">The different tag merging modes are basically replace, overwrite and append,
-but they can be seen from two directions. Given two taglists: (A) the tags
-already in the element and (B) the ones that are supplied to the element (
-e.g. via gst_tag_setter_merge_tags() / gst_tag_setter_add_tags() or a
-%GST_EVENT_TAG), how are these tags merged?
-In the table below this is shown for the cases that a tag exists in the list
-(A) or does not exists (!A) and combinations thereof.
-
-| merge mode | A + B | A + !B | !A + B | !A + !B |
-| ----------- | ----- | ------ | ------ | ------- |
-| REPLACE_ALL | B | ø | B | ø |
-| REPLACE | B | A | B | ø |
-| APPEND | A, B | A | B | ø |
-| PREPEND | B, A | A | B | ø |
-| KEEP | A | A | B | ø |
-| KEEP_ALL | A | A | ø | ø |</doc>
- <member name="undefined"
- value="0"
- c:identifier="GST_TAG_MERGE_UNDEFINED"
- glib:nick="undefined">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="35">undefined merge mode</doc>
- </member>
- <member name="replace_all"
- value="1"
- c:identifier="GST_TAG_MERGE_REPLACE_ALL"
- glib:nick="replace-all">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="36">replace all tags (clear list and append)</doc>
- </member>
- <member name="replace"
- value="2"
- c:identifier="GST_TAG_MERGE_REPLACE"
- glib:nick="replace">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="37">replace tags</doc>
- </member>
- <member name="append"
- value="3"
- c:identifier="GST_TAG_MERGE_APPEND"
- glib:nick="append">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="38">append tags</doc>
- </member>
- <member name="prepend"
- value="4"
- c:identifier="GST_TAG_MERGE_PREPEND"
- glib:nick="prepend">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="39">prepend tags</doc>
- </member>
- <member name="keep"
- value="5"
- c:identifier="GST_TAG_MERGE_KEEP"
- glib:nick="keep">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="40">keep existing tags</doc>
- </member>
- <member name="keep_all"
- value="6"
- c:identifier="GST_TAG_MERGE_KEEP_ALL"
- glib:nick="keep-all">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="41">keep all existing tags</doc>
- </member>
- <member name="count"
- value="7"
- c:identifier="GST_TAG_MERGE_COUNT"
- glib:nick="count">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="42">the number of merge modes</doc>
- </member>
- </enumeration>
- <enumeration name="TagScope"
- glib:type-name="GstTagScope"
- glib:get-type="gst_tag_scope_get_type"
- c:type="GstTagScope">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="187">GstTagScope specifies if a taglist applies to the complete
-medium or only to one single stream.</doc>
- <member name="stream"
- value="0"
- c:identifier="GST_TAG_SCOPE_STREAM"
- glib:nick="stream">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="189">tags specific to this single stream</doc>
- </member>
- <member name="global"
- value="1"
- c:identifier="GST_TAG_SCOPE_GLOBAL"
- glib:nick="global">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="190">global tags for the complete medium</doc>
- </member>
- </enumeration>
- <interface name="TagSetter"
- c:symbol-prefix="tag_setter"
- c:type="GstTagSetter"
- glib:type-name="GstTagSetter"
- glib:get-type="gst_tag_setter_get_type"
- glib:type-struct="TagSetterInterface">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="22">Element interface that allows setting of media metadata.
-
-Elements that support changing a stream's metadata will implement this
-interface. Examples of such elements are 'vorbisenc', 'theoraenc' and
-'id3v2mux'.
-
-If you just want to retrieve metadata in your application then all you
-need to do is watch for tag messages on your pipeline's bus. This
-interface is only for setting metadata, not for extracting it. To set tags
-from the application, find tagsetter elements and set tags using e.g.
-gst_tag_setter_merge_tags() or gst_tag_setter_add_tags(). Also consider
-setting the #GstTagMergeMode that is used for tag events that arrive at the
-tagsetter element (default mode is to keep existing tags).
-The application should do that before the element goes to %GST_STATE_PAUSED.
-
-Elements implementing the #GstTagSetter interface often have to merge
-any tags received from upstream and the tags set by the application via
-the interface. This can be done like this:
-
-|[&lt;!-- language="C" --&gt;
-GstTagMergeMode merge_mode;
-const GstTagList *application_tags;
-const GstTagList *event_tags;
-GstTagSetter *tagsetter;
-GstTagList *result;
-
-tagsetter = GST_TAG_SETTER (element);
-
-merge_mode = gst_tag_setter_get_tag_merge_mode (tagsetter);
-application_tags = gst_tag_setter_get_tag_list (tagsetter);
-event_tags = (const GstTagList *) element-&gt;event_tags;
-
-GST_LOG_OBJECT (tagsetter, "merging tags, merge mode = %d", merge_mode);
-GST_LOG_OBJECT (tagsetter, "event tags: %" GST_PTR_FORMAT, event_tags);
-GST_LOG_OBJECT (tagsetter, "set tags: %" GST_PTR_FORMAT, application_tags);
-
-result = gst_tag_list_merge (application_tags, event_tags, merge_mode);
-
-GST_LOG_OBJECT (tagsetter, "final tags: %" GST_PTR_FORMAT, result);
-]|</doc>
- <source-position filename="gst/gsttagsetter.h" line="57"/>
- <prerequisite name="Element"/>
- <method name="add_tag_valist"
- c:identifier="gst_tag_setter_add_tag_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="244">Adds the given tag / value pairs on the setter using the given merge mode.
-The list must be terminated with %NULL.</doc>
- <source-position filename="gst/gsttagsetter.h" line="80"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="246">a #GstTagSetter</doc>
- <type name="TagSetter" c:type="GstTagSetter*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="247">the mode to use</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="248">tag to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="249">tag / value pairs to set</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_tag_valist_values"
- c:identifier="gst_tag_setter_add_tag_valist_values"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="274">Adds the given tag / GValue pairs on the setter using the given merge mode.
-The list must be terminated with %NULL.</doc>
- <source-position filename="gst/gsttagsetter.h" line="85"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="276">a #GstTagSetter</doc>
- <type name="TagSetter" c:type="GstTagSetter*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="277">the mode to use</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="278">tag to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="var_args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="279">tag / GValue pairs to set</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_tag_value" c:identifier="gst_tag_setter_add_tag_value">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="305">Adds the given tag / GValue pair on the setter using the given merge mode.</doc>
- <source-position filename="gst/gsttagsetter.h" line="90"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="307">a #GstTagSetter</doc>
- <type name="TagSetter" c:type="GstTagSetter*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="308">the mode to use</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="309">tag to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="310">GValue to set for the tag</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_tag_values"
- c:identifier="gst_tag_setter_add_tag_values"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="220">Adds the given tag / GValue pairs on the setter using the given merge mode.
-The list must be terminated with %NULL.</doc>
- <source-position filename="gst/gsttagsetter.h" line="75"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="222">a #GstTagSetter</doc>
- <type name="TagSetter" c:type="GstTagSetter*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="223">the mode to use</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="224">tag to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="225">more tag / GValue pairs to set</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="add_tags"
- c:identifier="gst_tag_setter_add_tags"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="196">Adds the given tag / value pairs on the setter using the given merge mode.
-The list must be terminated with %NULL.</doc>
- <source-position filename="gst/gsttagsetter.h" line="70"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="198">a #GstTagSetter</doc>
- <type name="TagSetter" c:type="GstTagSetter*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="199">the mode to use</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="200">tag to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="201">more tag / value pairs to set</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="get_tag_list" c:identifier="gst_tag_setter_get_tag_list">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="335">Returns the current list of tags the setter uses. The list should not be
-modified or freed.
-
-This function is not thread-safe.</doc>
- <source-position filename="gst/gsttagsetter.h" line="96"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="344">a current snapshot of the
- taglist used in the setter or %NULL if none is used.</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="337">a #GstTagSetter</doc>
- <type name="TagSetter" c:type="GstTagSetter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tag_merge_mode"
- c:identifier="gst_tag_setter_get_tag_merge_mode">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="379">Queries the mode by which tags inside the setter are overwritten by tags
-from events</doc>
- <source-position filename="gst/gsttagsetter.h" line="102"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="386">the merge mode used inside the element.</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="381">a #GstTagSetter</doc>
- <type name="TagSetter" c:type="GstTagSetter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="merge_tags" c:identifier="gst_tag_setter_merge_tags">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="166">Merges the given list into the setter's list using the given mode.</doc>
- <source-position filename="gst/gsttagsetter.h" line="66"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="168">a #GstTagSetter</doc>
- <type name="TagSetter" c:type="GstTagSetter*"/>
- </instance-parameter>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="169">a tag list to merge from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="170">the mode to merge with</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="reset_tags" c:identifier="gst_tag_setter_reset_tags">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="142">Reset the internal taglist. Elements should call this from within the
-state-change handler.</doc>
- <source-position filename="gst/gsttagsetter.h" line="63"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="144">a #GstTagSetter</doc>
- <type name="TagSetter" c:type="GstTagSetter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_tag_merge_mode"
- c:identifier="gst_tag_setter_set_tag_merge_mode">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="355">Sets the given merge mode that is used for adding tags from events to tags
-specified by this interface. The default is #GST_TAG_MERGE_KEEP, which keeps
-the tags set with this interface and discards tags from events.</doc>
- <source-position filename="gst/gsttagsetter.h" line="99"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="357">a #GstTagSetter</doc>
- <type name="TagSetter" c:type="GstTagSetter*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.c"
- line="358">The mode with which tags are added</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- </parameters>
- </method>
- </interface>
- <record name="TagSetterInterface"
- c:type="GstTagSetterInterface"
- glib:is-gtype-struct-for="TagSetter">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.h"
- line="42">#GstTagSetterInterface interface.</doc>
- <source-position filename="gst/gsttagsetter.h" line="57"/>
- <field name="g_iface">
- <doc xml:space="preserve"
- filename="gst/gsttagsetter.h"
- line="44">parent interface type.</doc>
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- </record>
- <class name="Task"
- c:symbol-prefix="task"
- c:type="GstTask"
- parent="Object"
- glib:type-name="GstTask"
- glib:get-type="gst_task_get_type"
- glib:type-struct="TaskClass">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="23">#GstTask is used by #GstElement and #GstPad to provide the data passing
-threads in a #GstPipeline.
-
-A #GstPad will typically start a #GstTask to push or pull data to/from the
-peer pads. Most source elements start a #GstTask to push data. In some cases
-a demuxer element can start a #GstTask to pull data from a peer element. This
-is typically done when the demuxer can perform random access on the upstream
-peer element for improved performance.
-
-Although convenience functions exist on #GstPad to start/pause/stop tasks, it
-might sometimes be needed to create a #GstTask manually if it is not related to
-a #GstPad.
-
-Before the #GstTask can be run, it needs a #GRecMutex that can be set with
-gst_task_set_lock().
-
-The task can be started, paused and stopped with gst_task_start(), gst_task_pause()
-and gst_task_stop() respectively or with the gst_task_set_state() function.
-
-A #GstTask will repeatedly call the #GstTaskFunction with the user data
-that was provided when creating the task with gst_task_new(). While calling
-the function it will acquire the provided lock. The provided lock is released
-when the task pauses or stops.
-
-Stopping a task with gst_task_stop() will not immediately make sure the task is
-not running anymore. Use gst_task_join() to make sure the task is completely
-stopped and the thread is stopped.
-
-After creating a #GstTask, use gst_object_unref() to free its resources. This can
-only be done when the task is not running anymore.
-
-Task functions can send a #GstMessage to send out-of-band data to the
-application. The application can receive messages from the #GstBus in its
-mainloop.
-
-For debugging purposes, the task will configure its object name as the thread
-name on Linux. Please note that the object name should be configured before the
-task is started; changing the object name after the task has been started, has
-no effect on the thread name.</doc>
- <source-position filename="gst/gsttask.h" line="165"/>
- <constructor name="new" c:identifier="gst_task_new">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="395">Create a new Task that will repeatedly call the provided @func
-with @user_data as a parameter. Typically the task will run in
-a new thread.
-
-The function cannot be changed after the task has been created. You
-must create a new #GstTask to change the function.
-
-This function will not yet create and start a thread. Use gst_task_start() or
-gst_task_pause() to create and start the GThread.
-
-Before the task can be used, a #GRecMutex must be configured using the
-gst_task_set_lock() function. This lock will always be acquired while
-@func is called.</doc>
- <source-position filename="gst/gsttask.h" line="174"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="415">A new #GstTask.
-
-MT safe.</doc>
- <type name="Task" c:type="GstTask*"/>
- </return-value>
- <parameters>
- <parameter name="func"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="397">The #GstTaskFunction to use</doc>
- <type name="TaskFunction" c:type="GstTaskFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="398">User data to pass to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="399">the function to call when @user_data is no longer needed.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </constructor>
- <function name="cleanup_all" c:identifier="gst_task_cleanup_all">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="367">Wait for all tasks to be stopped. This is mainly used internally
-to ensure proper cleanup of internal data structures in test suites.
-
-MT safe.</doc>
- <source-position filename="gst/gsttask.h" line="168"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </function>
- <method name="get_pool" c:identifier="gst_task_get_pool">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="474">Get the #GstTaskPool that this task will use for its streaming
-threads.
-
-MT safe.</doc>
- <source-position filename="gst/gsttask.h" line="180"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="483">the #GstTaskPool used by @task. gst_object_unref()
-after usage.</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </return-value>
- <parameters>
- <instance-parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="476">a #GstTask</doc>
- <type name="Task" c:type="GstTask*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_state" c:identifier="gst_task_get_state">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="612">Get the current state of the task.</doc>
- <source-position filename="gst/gsttask.h" line="196"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="618">The #GstTaskState of the task
-
-MT safe.</doc>
- <type name="TaskState" c:type="GstTaskState"/>
- </return-value>
- <parameters>
- <instance-parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="614">The #GstTask to query</doc>
- <type name="Task" c:type="GstTask*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="join" c:identifier="gst_task_join">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="822">Joins @task. After this call, it is safe to unref the task
-and clean up the lock set with gst_task_set_lock().
-
-The task will automatically be stopped with this call.
-
-This function cannot be called from within a task function as this
-would cause a deadlock. The function will detect this and print a
-g_warning.</doc>
- <source-position filename="gst/gsttask.h" line="214"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="835">%TRUE if the task could be joined.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="824">The #GstTask to join</doc>
- <type name="Task" c:type="GstTask*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pause" c:identifier="gst_task_pause">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="777">Pauses @task. This method can also be called on a task in the
-stopped state, in which case a thread will be started and will remain
-in the paused state. This function does not wait for the task to complete
-the paused state.</doc>
- <source-position filename="gst/gsttask.h" line="208"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="786">%TRUE if the task could be paused.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="779">The #GstTask to pause</doc>
- <type name="Task" c:type="GstTask*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="resume" c:identifier="gst_task_resume" version="1.18">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="796">Resume @task in case it was paused. If the task was stopped, it will
-remain in that state and this function will return %FALSE.</doc>
- <source-position filename="gst/gsttask.h" line="211"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="803">%TRUE if the task could be resumed.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="798">The #GstTask to resume</doc>
- <type name="Task" c:type="GstTask*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_enter_callback"
- c:identifier="gst_task_set_enter_callback">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="536">Call @enter_func when the task function of @task is entered. @user_data will
-be passed to @enter_func and @notify will be called when @user_data is no
-longer referenced.</doc>
- <source-position filename="gst/gsttask.h" line="186"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="538">The #GstTask to use</doc>
- <type name="Task" c:type="GstTask*"/>
- </instance-parameter>
- <parameter name="enter_func"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="539">a #GstTaskThreadFunc</doc>
- <type name="TaskThreadFunc" c:type="GstTaskThreadFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="540">user data passed to @enter_func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="541">called when @user_data is no longer referenced</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_leave_callback"
- c:identifier="gst_task_set_leave_callback">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="574">Call @leave_func when the task function of @task is left. @user_data will
-be passed to @leave_func and @notify will be called when @user_data is no
-longer referenced.</doc>
- <source-position filename="gst/gsttask.h" line="191"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="576">The #GstTask to use</doc>
- <type name="Task" c:type="GstTask*"/>
- </instance-parameter>
- <parameter name="leave_func"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="577">a #GstTaskThreadFunc</doc>
- <type name="TaskThreadFunc" c:type="GstTaskThreadFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="578">user data passed to @leave_func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="579">called when @user_data is no longer referenced</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_lock" c:identifier="gst_task_set_lock">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="439">Set the mutex used by the task. The mutex will be acquired before
-calling the #GstTaskFunction.
-
-This function has to be called before calling gst_task_pause() or
-gst_task_start().
-
-MT safe.</doc>
- <source-position filename="gst/gsttask.h" line="177"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="441">The #GstTask to use</doc>
- <type name="Task" c:type="GstTask*"/>
- </instance-parameter>
- <parameter name="mutex" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="442">The #GRecMutex to use</doc>
- <type name="GLib.RecMutex" c:type="GRecMutex*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_pool" c:identifier="gst_task_set_pool">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="503">Set @pool as the new GstTaskPool for @task. Any new streaming threads that
-will be created by @task will now use @pool.
-
-MT safe.</doc>
- <source-position filename="gst/gsttask.h" line="183"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="505">a #GstTask</doc>
- <type name="Task" c:type="GstTask*"/>
- </instance-parameter>
- <parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="506">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_state" c:identifier="gst_task_set_state">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="713">Sets the state of @task to @state.
-
-The @task must have a lock associated with it using
-gst_task_set_lock() when going to GST_TASK_STARTED or GST_TASK_PAUSED or
-this function will return %FALSE.
-
-MT safe.</doc>
- <source-position filename="gst/gsttask.h" line="199"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="726">%TRUE if the state could be changed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="715">a #GstTask</doc>
- <type name="Task" c:type="GstTask*"/>
- </instance-parameter>
- <parameter name="state" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="716">the new task state</doc>
- <type name="TaskState" c:type="GstTaskState"/>
- </parameter>
- </parameters>
- </method>
- <method name="start" c:identifier="gst_task_start">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="742">Starts @task. The @task must have a lock associated with it using
-gst_task_set_lock() or this function will return %FALSE.</doc>
- <source-position filename="gst/gsttask.h" line="202"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="749">%TRUE if the task could be started.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="744">The #GstTask to start</doc>
- <type name="Task" c:type="GstTask*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="stop" c:identifier="gst_task_stop">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="759">Stops @task. This method merely schedules the task to stop and
-will not wait for the task to have completely stopped. Use
-gst_task_join() to stop and wait for completion.</doc>
- <source-position filename="gst/gsttask.h" line="205"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="767">%TRUE if the task could be stopped.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.c"
- line="761">The #GstTask to stop</doc>
- <type name="Task" c:type="GstTask*"/>
- </instance-parameter>
- </parameters>
- </method>
- <field name="object">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="state">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="124">the state of the task</doc>
- <type name="TaskState" c:type="GstTaskState"/>
- </field>
- <field name="cond">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="125">used to pause/resume the task</doc>
- <type name="GLib.Cond" c:type="GCond"/>
- </field>
- <field name="lock">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="126">The lock taken when iterating the task function</doc>
- <type name="GLib.RecMutex" c:type="GRecMutex*"/>
- </field>
- <field name="func">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="127">the function executed by this task</doc>
- <type name="TaskFunction" c:type="GstTaskFunction"/>
- </field>
- <field name="user_data">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="128">user_data passed to the task function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="notify">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="129">GDestroyNotify for @user_data</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="running">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="130">a flag indicating that the task is running</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="thread" readable="0" private="1">
- <type name="GLib.Thread" c:type="GThread*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TaskPrivate" c:type="GstTaskPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TaskClass"
- c:type="GstTaskClass"
- glib:is-gtype-struct-for="Task">
- <source-position filename="gst/gsttask.h" line="165"/>
- <field name="parent_class">
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="pool" readable="0" private="1">
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <callback name="TaskFunction" c:type="GstTaskFunction">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="31">A function that will repeatedly be called in the thread created by
-a #GstTask.</doc>
- <source-position filename="gst/gsttask.h" line="38"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="0">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="33">user data passed to the function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <class name="TaskPool"
- c:symbol-prefix="task_pool"
- c:type="GstTaskPool"
- parent="Object"
- glib:type-name="GstTaskPool"
- glib:get-type="gst_task_pool_get_type"
- glib:type-struct="TaskPoolClass">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="22">This object provides an abstraction for creating threads. The default
-implementation uses a regular GThreadPool to start tasks.
-
-Subclasses can be made to create custom threads.</doc>
- <source-position filename="gst/gsttaskpool.h" line="97"/>
- <constructor name="new" c:identifier="gst_task_pool_new">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="169">Create a new default task pool. The default task pool will use a regular
-GThreadPool for threads.</doc>
- <source-position filename="gst/gsttaskpool.h" line="103"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="175">a new #GstTaskPool. gst_object_unref() after usage.</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </return-value>
- </constructor>
- <virtual-method name="cleanup" invoker="cleanup">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="212">Wait for all tasks to be stopped. This is mainly used internally
-to ensure proper cleanup of internal data structures in test suites.
-
-MT safe.</doc>
- <source-position filename="gst/gsttaskpool.h" line="78"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="214">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="dispose_handle"
- invoker="dispose_handle"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="297">Dispose of the handle returned by gst_task_pool_push(). This does
-not need to be called with the default implementation as the default
-#GstTaskPoolClass::push implementation always returns %NULL. This does not need to be
-called either when calling gst_task_pool_join(), but should be called
-when joining is not necessary, but gst_task_pool_push() returned a
-non-%NULL value.
-
-This method should only be called with the same @pool instance that provided
-@id.</doc>
- <source-position filename="gst/gsttaskpool.h" line="93"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="299">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </instance-parameter>
- <parameter name="id"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="300">the id</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="join" invoker="join">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="272">Join a task and/or return it to the pool. @id is the id obtained from
-gst_task_pool_push(). The default implementation does nothing, as the
-default #GstTaskPoolClass::push implementation always returns %NULL.
-
-This method should only be called with the same @pool instance that provided
-@id.</doc>
- <source-position filename="gst/gsttaskpool.h" line="82"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="274">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </instance-parameter>
- <parameter name="id"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="275">the id</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="prepare" invoker="prepare" throws="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="190">Prepare the taskpool for accepting gst_task_pool_push() operations.
-
-MT safe.</doc>
- <source-position filename="gst/gsttaskpool.h" line="77"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="192">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="push" invoker="push" throws="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="234">Start the execution of a new thread from @pool.</doc>
- <source-position filename="gst/gsttaskpool.h" line="80"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="243">a pointer that should be used
-for the gst_task_pool_join function. This pointer can be %NULL, you
-must check @error to detect errors. If the pointer is not %NULL and
-gst_task_pool_join() is not used, call gst_task_pool_dispose_handle()
-instead.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="236">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="async"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="237">the function to call</doc>
- <type name="TaskPoolFunction" c:type="GstTaskPoolFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="238">data to pass to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="cleanup" c:identifier="gst_task_pool_cleanup">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="212">Wait for all tasks to be stopped. This is mainly used internally
-to ensure proper cleanup of internal data structures in test suites.
-
-MT safe.</doc>
- <source-position filename="gst/gsttaskpool.h" line="118"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="214">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="dispose_handle"
- c:identifier="gst_task_pool_dispose_handle"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="297">Dispose of the handle returned by gst_task_pool_push(). This does
-not need to be called with the default implementation as the default
-#GstTaskPoolClass::push implementation always returns %NULL. This does not need to be
-called either when calling gst_task_pool_join(), but should be called
-when joining is not necessary, but gst_task_pool_push() returned a
-non-%NULL value.
-
-This method should only be called with the same @pool instance that provided
-@id.</doc>
- <source-position filename="gst/gsttaskpool.h" line="115"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="299">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </instance-parameter>
- <parameter name="id"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="300">the id</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="join" c:identifier="gst_task_pool_join">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="272">Join a task and/or return it to the pool. @id is the id obtained from
-gst_task_pool_push(). The default implementation does nothing, as the
-default #GstTaskPoolClass::push implementation always returns %NULL.
-
-This method should only be called with the same @pool instance that provided
-@id.</doc>
- <source-position filename="gst/gsttaskpool.h" line="112"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="274">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </instance-parameter>
- <parameter name="id"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="275">the id</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="prepare" c:identifier="gst_task_pool_prepare" throws="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="190">Prepare the taskpool for accepting gst_task_pool_push() operations.
-
-MT safe.</doc>
- <source-position filename="gst/gsttaskpool.h" line="106"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="192">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="push" c:identifier="gst_task_pool_push" throws="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="234">Start the execution of a new thread from @pool.</doc>
- <source-position filename="gst/gsttaskpool.h" line="109"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="243">a pointer that should be used
-for the gst_task_pool_join function. This pointer can be %NULL, you
-must check @error to detect errors. If the pointer is not %NULL and
-gst_task_pool_join() is not used, call gst_task_pool_dispose_handle()
-instead.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="236">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="async"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="237">the function to call</doc>
- <type name="TaskPoolFunction" c:type="GstTaskPoolFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="238">data to pass to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <field name="object">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="pool" readable="0" private="1">
- <type name="GLib.ThreadPool" c:type="GThreadPool*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TaskPoolClass"
- c:type="GstTaskPoolClass"
- glib:is-gtype-struct-for="TaskPool">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.h"
- line="63">The #GstTaskPoolClass object.</doc>
- <source-position filename="gst/gsttaskpool.h" line="97"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.h"
- line="65">the parent class structure</doc>
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="prepare">
- <callback name="prepare" throws="1">
- <source-position filename="gst/gsttaskpool.h" line="77"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="192">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="cleanup">
- <callback name="cleanup">
- <source-position filename="gst/gsttaskpool.h" line="78"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="214">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="push">
- <callback name="push" throws="1">
- <source-position filename="gst/gsttaskpool.h" line="80"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="243">a pointer that should be used
-for the gst_task_pool_join function. This pointer can be %NULL, you
-must check @error to detect errors. If the pointer is not %NULL and
-gst_task_pool_join() is not used, call gst_task_pool_dispose_handle()
-instead.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="236">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="async"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="237">the function to call</doc>
- <type name="TaskPoolFunction" c:type="GstTaskPoolFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="238">data to pass to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="join">
- <callback name="join">
- <source-position filename="gst/gsttaskpool.h" line="82"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="274">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </parameter>
- <parameter name="id"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="275">the id</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="dispose_handle">
- <callback name="dispose_handle">
- <source-position filename="gst/gsttaskpool.h" line="93"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pool" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="299">a #GstTaskPool</doc>
- <type name="TaskPool" c:type="GstTaskPool*"/>
- </parameter>
- <parameter name="id"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.c"
- line="300">the id</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <callback name="TaskPoolFunction" c:type="GstTaskPoolFunction">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.h"
- line="41">Task function, see gst_task_pool_push().</doc>
- <source-position filename="gst/gsttaskpool.h" line="47"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="0">
- <doc xml:space="preserve"
- filename="gst/gsttaskpool.h"
- line="43">user data for the task function</doc>
- <type name="gpointer" c:type="void*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="TaskPrivate" c:type="GstTaskPrivate" disguised="1">
- <source-position filename="gst/gsttask.h" line="51"/>
- </record>
- <enumeration name="TaskState"
- glib:type-name="GstTaskState"
- glib:get-type="gst_task_state_get_type"
- c:type="GstTaskState">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="53">The different states a task can be in</doc>
- <member name="started"
- value="0"
- c:identifier="GST_TASK_STARTED"
- glib:nick="started">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="55">the task is started and running</doc>
- </member>
- <member name="stopped"
- value="1"
- c:identifier="GST_TASK_STOPPED"
- glib:nick="stopped">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="56">the task is stopped</doc>
- </member>
- <member name="paused"
- value="2"
- c:identifier="GST_TASK_PAUSED"
- glib:nick="paused">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="57">the task is paused</doc>
- </member>
- </enumeration>
- <callback name="TaskThreadFunc" c:type="GstTaskThreadFunc">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="112">Custom GstTask thread callback functions that can be installed.</doc>
- <source-position filename="gst/gsttask.h" line="120"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="task" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="114">The #GstTask</doc>
- <type name="Task" c:type="GstTask*"/>
- </parameter>
- <parameter name="thread" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="115">The #GThread</doc>
- <type name="GLib.Thread" c:type="GThread*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="gst/gsttask.h"
- line="116">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="TimedValue" c:type="GstTimedValue">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="52">Structure for saving a timestamp and a value.</doc>
- <source-position filename="gst/gstcontrolsource.h" line="63"/>
- <field name="timestamp" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="54">timestamp of the value change</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="value" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstcontrolsource.h"
- line="55">the corresponding value</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- </record>
- <record name="Toc"
- c:type="GstToc"
- glib:type-name="GstToc"
- glib:get-type="gst_toc_get_type"
- c:symbol-prefix="toc">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="22">#GstToc functions are used to create/free #GstToc and #GstTocEntry structures.
-Also they are used to convert #GstToc into #GstStructure and vice versa.
-
-#GstToc lets you to inform other elements in pipeline or application that playing
-source has some kind of table of contents (TOC). These may be chapters, editions,
-angles or other types. For example: DVD chapters, Matroska chapters or cue sheet
-TOC. Such TOC will be useful for applications to display instead of just a
-playlist.
-
-Using TOC is very easy. Firstly, create #GstToc structure which represents root
-contents of the source. You can also attach TOC-specific tags to it. Then fill
-it with #GstTocEntry entries by appending them to the #GstToc using
-gst_toc_append_entry(), and appending subentries to a #GstTocEntry using
-gst_toc_entry_append_sub_entry().
-
-Note that root level of the TOC can contain only either editions or chapters. You
-should not mix them together at the same level. Otherwise you will get serialization
-/deserialization errors. Make sure that no one of the entries has negative start and
- stop values.
-
-Use gst_event_new_toc() to create a new TOC #GstEvent, and gst_event_parse_toc() to
-parse received TOC event. Use gst_event_new_toc_select() to create a new TOC select #GstEvent,
-and gst_event_parse_toc_select() to parse received TOC select event. The same rule for
-the #GstMessage: gst_message_new_toc() to create new TOC #GstMessage, and
-gst_message_parse_toc() to parse received TOC message.
-
-TOCs can have global scope or current scope. Global scope TOCs contain
-all entries that can possibly be selected using a toc select event, and
-are what an application is usually interested in. TOCs with current scope
-only contain the parts of the TOC relevant to the currently selected/playing
-stream; the current scope TOC is used by downstream elements such as muxers
-to write correct TOC entries when transcoding files, for example. When
-playing a DVD, the global TOC would contain a hierarchy of all titles,
-chapters and angles, for example, while the current TOC would only contain
-the chapters for the currently playing title if playback of a specific
-title was requested.
-
-Applications and plugins should not rely on TOCs having a certain kind of
-structure, but should allow for different alternatives. For example, a
-simple CUE sheet embedded in a file may be presented as a flat list of
-track entries, or could have a top-level edition node (or some other
-alternative type entry) with track entries underneath that node; or even
-multiple top-level edition nodes (or some other alternative type entries)
-each with track entries underneath, in case the source file has extracted
-a track listing from different sources).</doc>
- <source-position filename="gst/gsttoc.h" line="41"/>
- <constructor name="new" c:identifier="gst_toc_new">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="126">Create a new #GstToc structure.</doc>
- <source-position filename="gst/gsttoc.h" line="141"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="132">newly allocated #GstToc structure, free it
- with gst_toc_unref().</doc>
- <type name="Toc" c:type="GstToc*"/>
- </return-value>
- <parameters>
- <parameter name="scope" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="128">scope of this TOC</doc>
- <type name="TocScope" c:type="GstTocScope"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="append_entry" c:identifier="gst_toc_append_entry">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="226">Appends the #GstTocEntry @entry to @toc.</doc>
- <source-position filename="gst/gsttoc.h" line="156"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="toc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="228">A #GstToc instance</doc>
- <type name="Toc" c:type="GstToc*"/>
- </instance-parameter>
- <parameter name="entry" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="229">A #GstTocEntry</doc>
- <type name="TocEntry" c:type="GstTocEntry*"/>
- </parameter>
- </parameters>
- </method>
- <method name="dump" c:identifier="gst_toc_dump">
- <source-position filename="gst/gsttoc.h" line="162"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="toc" transfer-ownership="none">
- <type name="Toc" c:type="GstToc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="find_entry" c:identifier="gst_toc_find_entry">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="365">Find #GstTocEntry with given @uid in the @toc.</doc>
- <source-position filename="gst/gsttoc.h" line="180"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="372">#GstTocEntry with specified
-@uid from the @toc, or %NULL if not found.</doc>
- <type name="TocEntry" c:type="GstTocEntry*"/>
- </return-value>
- <parameters>
- <instance-parameter name="toc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="367">#GstToc to search in.</doc>
- <type name="Toc" c:type="const GstToc*"/>
- </instance-parameter>
- <parameter name="uid" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="368">UID to find #GstTocEntry with.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_entries" c:identifier="gst_toc_get_entries">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="251">Gets the list of #GstTocEntry of @toc.</doc>
- <source-position filename="gst/gsttoc.h" line="159"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="257">A #GList of #GstTocEntry for @entry</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="TocEntry"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="toc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="253">A #GstToc instance</doc>
- <type name="Toc" c:type="const GstToc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_scope" c:identifier="gst_toc_get_scope">
- <source-position filename="gst/gsttoc.h" line="144"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="159">scope of @toc</doc>
- <type name="TocScope" c:type="GstTocScope"/>
- </return-value>
- <parameters>
- <instance-parameter name="toc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="157">a #GstToc instance</doc>
- <type name="Toc" c:type="const GstToc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tags" c:identifier="gst_toc_get_tags">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="210">Gets the tags for @toc.</doc>
- <source-position filename="gst/gsttoc.h" line="153"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="216">A #GstTagList for @entry</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="toc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="212">A #GstToc instance</doc>
- <type name="Toc" c:type="const GstToc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="merge_tags" c:identifier="gst_toc_merge_tags">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="187">Merge @tags into the existing tags of @toc using @mode.</doc>
- <source-position filename="gst/gsttoc.h" line="150"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="toc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="189">A #GstToc instance</doc>
- <type name="Toc" c:type="GstToc*"/>
- </instance-parameter>
- <parameter name="tags"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="190">A #GstTagList or %NULL</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="191">A #GstTagMergeMode</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_tags" c:identifier="gst_toc_set_tags">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="169">Set a #GstTagList with tags for the complete @toc.</doc>
- <source-position filename="gst/gsttoc.h" line="147"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="toc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="171">A #GstToc instance</doc>
- <type name="Toc" c:type="GstToc*"/>
- </instance-parameter>
- <parameter name="tags"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="172">A #GstTagList or %NULL</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <record name="TocEntry"
- c:type="GstTocEntry"
- glib:type-name="GstTocEntry"
- glib:get-type="gst_toc_entry_get_type"
- c:symbol-prefix="toc_entry">
- <source-position filename="gst/gsttoc.h" line="40"/>
- <constructor name="new" c:identifier="gst_toc_entry_new">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="286">Create new #GstTocEntry structure.</doc>
- <source-position filename="gst/gsttoc.h" line="172"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="293">newly allocated #GstTocEntry structure, free it with gst_toc_entry_unref().</doc>
- <type name="TocEntry" c:type="GstTocEntry*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="288">entry type.</doc>
- <type name="TocEntryType" c:type="GstTocEntryType"/>
- </parameter>
- <parameter name="uid" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="289">unique ID (UID) in the whole TOC.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="append_sub_entry"
- c:identifier="gst_toc_entry_append_sub_entry">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="666">Appends the #GstTocEntry @subentry to @entry.</doc>
- <source-position filename="gst/gsttoc.h" line="189"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="668">A #GstTocEntry instance</doc>
- <type name="TocEntry" c:type="GstTocEntry*"/>
- </instance-parameter>
- <parameter name="subentry" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="669">A #GstTocEntry</doc>
- <type name="TocEntry" c:type="GstTocEntry*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_entry_type"
- c:identifier="gst_toc_entry_get_entry_type">
- <source-position filename="gst/gsttoc.h" line="183"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="612">@entry's entry type</doc>
- <type name="TocEntryType" c:type="GstTocEntryType"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="610">a #GstTocEntry</doc>
- <type name="TocEntry" c:type="const GstTocEntry*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_loop"
- c:identifier="gst_toc_entry_get_loop"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="543">Get @loop_type and @repeat_count values from the @entry and write them into
-appropriate storages. Loops are e.g. used by sampled instruments. GStreamer
-is not automatically applying the loop. The application can process this
-meta data and use it e.g. to send a seek-event to loop a section.</doc>
- <source-position filename="gst/gsttoc.h" line="219"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="556">%TRUE if all non-%NULL storage pointers were filled with appropriate
-values, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="545">#GstTocEntry to get values from.</doc>
- <type name="TocEntry" c:type="const GstTocEntry*"/>
- </instance-parameter>
- <parameter name="loop_type"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="546">the storage for the loop_type
- value, leave %NULL if not need.</doc>
- <type name="TocLoopType" c:type="GstTocLoopType*"/>
- </parameter>
- <parameter name="repeat_count"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="548">the storage for the repeat_count
- value, leave %NULL if not need.</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_parent" c:identifier="gst_toc_entry_get_parent">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="782">Gets the parent #GstTocEntry of @entry.</doc>
- <source-position filename="gst/gsttoc.h" line="225"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="788">The parent #GstTocEntry of @entry</doc>
- <type name="TocEntry" c:type="GstTocEntry*"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="784">A #GstTocEntry instance</doc>
- <type name="TocEntry" c:type="GstTocEntry*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_start_stop_times"
- c:identifier="gst_toc_entry_get_start_stop_times">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="495">Get @start and @stop values from the @entry and write them into appropriate
-storages.</doc>
- <source-position filename="gst/gsttoc.h" line="213"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="506">%TRUE if all non-%NULL storage pointers were filled with appropriate
-values, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="497">#GstTocEntry to get values from.</doc>
- <type name="TocEntry" c:type="const GstTocEntry*"/>
- </instance-parameter>
- <parameter name="start"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="498">the storage for the start value, leave
- %NULL if not need.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- <parameter name="stop"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="500">the storage for the stop value, leave
- %NULL if not need.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_sub_entries"
- c:identifier="gst_toc_entry_get_sub_entries">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="692">Gets the sub-entries of @entry.</doc>
- <source-position filename="gst/gsttoc.h" line="192"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="698">A #GList of #GstTocEntry of @entry</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="TocEntry"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="694">A #GstTocEntry instance</doc>
- <type name="TocEntry" c:type="const GstTocEntry*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tags" c:identifier="gst_toc_entry_get_tags">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="750">Gets the tags for @entry.</doc>
- <source-position filename="gst/gsttoc.h" line="201"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="756">A #GstTagList for @entry</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="752">A #GstTocEntry instance</doc>
- <type name="TocEntry" c:type="const GstTocEntry*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_toc" c:identifier="gst_toc_entry_get_toc">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="766">Gets the parent #GstToc of @entry.</doc>
- <source-position filename="gst/gsttoc.h" line="222"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="772">The parent #GstToc of @entry</doc>
- <type name="Toc" c:type="GstToc*"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="768">A #GstTocEntry instance</doc>
- <type name="TocEntry" c:type="GstTocEntry*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_uid" c:identifier="gst_toc_entry_get_uid">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="650">Gets the UID of @entry.</doc>
- <source-position filename="gst/gsttoc.h" line="186"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="656">The UID of @entry</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="652">A #GstTocEntry instance</doc>
- <type name="TocEntry" c:type="const GstTocEntry*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_alternative"
- c:identifier="gst_toc_entry_is_alternative">
- <source-position filename="gst/gsttoc.h" line="204"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="626">%TRUE if @entry's type is an alternative type, otherwise %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="624">a #GstTocEntry</doc>
- <type name="TocEntry" c:type="const GstTocEntry*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_sequence" c:identifier="gst_toc_entry_is_sequence">
- <source-position filename="gst/gsttoc.h" line="207"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="640">%TRUE if @entry's type is a sequence type, otherwise %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="638">a #GstTocEntry</doc>
- <type name="TocEntry" c:type="const GstTocEntry*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="merge_tags" c:identifier="gst_toc_entry_merge_tags">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="726">Merge @tags into the existing tags of @entry using @mode.</doc>
- <source-position filename="gst/gsttoc.h" line="198"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="728">A #GstTocEntry instance</doc>
- <type name="TocEntry" c:type="GstTocEntry*"/>
- </instance-parameter>
- <parameter name="tags"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="729">A #GstTagList or %NULL</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="730">A #GstTagMergeMode</doc>
- <type name="TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_loop"
- c:identifier="gst_toc_entry_set_loop"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="523">Set @loop_type and @repeat_count values for the @entry.</doc>
- <source-position filename="gst/gsttoc.h" line="216"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="525">#GstTocEntry to set values.</doc>
- <type name="TocEntry" c:type="GstTocEntry*"/>
- </instance-parameter>
- <parameter name="loop_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="526">loop_type value to set.</doc>
- <type name="TocLoopType" c:type="GstTocLoopType"/>
- </parameter>
- <parameter name="repeat_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="527">repeat_count value to set.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_start_stop_times"
- c:identifier="gst_toc_entry_set_start_stop_times">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="477">Set @start and @stop values for the @entry.</doc>
- <source-position filename="gst/gsttoc.h" line="210"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="479">#GstTocEntry to set values.</doc>
- <type name="TocEntry" c:type="GstTocEntry*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="480">start value to set.</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="stop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="481">stop value to set.</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_tags" c:identifier="gst_toc_entry_set_tags">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="708">Set a #GstTagList with tags for the complete @entry.</doc>
- <source-position filename="gst/gsttoc.h" line="195"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="entry" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="710">A #GstTocEntry instance</doc>
- <type name="TocEntry" c:type="GstTocEntry*"/>
- </instance-parameter>
- <parameter name="tags"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="711">A #GstTagList or %NULL</doc>
- <type name="TagList" c:type="GstTagList*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <enumeration name="TocEntryType"
- glib:type-name="GstTocEntryType"
- glib:get-type="gst_toc_entry_type_get_type"
- c:type="GstTocEntryType">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="61">The different types of TOC entries (see #GstTocEntry).
-
-There are two types of TOC entries: alternatives or parts in a sequence.</doc>
- <member name="angle"
- value="-3"
- c:identifier="GST_TOC_ENTRY_TYPE_ANGLE"
- glib:nick="angle">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="63">entry is an angle (i.e. an alternative)</doc>
- </member>
- <member name="version"
- value="-2"
- c:identifier="GST_TOC_ENTRY_TYPE_VERSION"
- glib:nick="version">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="64">entry is a version (i.e. alternative)</doc>
- </member>
- <member name="edition"
- value="-1"
- c:identifier="GST_TOC_ENTRY_TYPE_EDITION"
- glib:nick="edition">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="65">entry is an edition (i.e. alternative)</doc>
- </member>
- <member name="invalid"
- value="0"
- c:identifier="GST_TOC_ENTRY_TYPE_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="66">invalid entry type value</doc>
- </member>
- <member name="title"
- value="1"
- c:identifier="GST_TOC_ENTRY_TYPE_TITLE"
- glib:nick="title">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="67">entry is a title (i.e. a part of a sequence)</doc>
- </member>
- <member name="track"
- value="2"
- c:identifier="GST_TOC_ENTRY_TYPE_TRACK"
- glib:nick="track">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="68">entry is a track (i.e. a part of a sequence)</doc>
- </member>
- <member name="chapter"
- value="3"
- c:identifier="GST_TOC_ENTRY_TYPE_CHAPTER"
- glib:nick="chapter">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="69">entry is a chapter (i.e. a part of a sequence)</doc>
- </member>
- <function name="get_nick" c:identifier="gst_toc_entry_type_get_nick">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="576">Converts @type to a string representation.</doc>
- <source-position filename="gst/gsttoc.h" line="229"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="582">Returns a human-readable string for @type. This string is
- only for debugging purpose and should not be displayed in a user
- interface.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="578">a #GstTocEntryType.</doc>
- <type name="TocEntryType" c:type="GstTocEntryType"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <enumeration name="TocLoopType"
- version="1.4"
- glib:type-name="GstTocLoopType"
- glib:get-type="gst_toc_loop_type_get_type"
- c:type="GstTocLoopType">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="101">How a #GstTocEntry should be repeated. By default, entries are played a
-single time.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_TOC_LOOP_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="103">single forward playback</doc>
- </member>
- <member name="forward"
- value="1"
- c:identifier="GST_TOC_LOOP_FORWARD"
- glib:nick="forward">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="104">repeat forward</doc>
- </member>
- <member name="reverse"
- value="2"
- c:identifier="GST_TOC_LOOP_REVERSE"
- glib:nick="reverse">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="105">repeat backward</doc>
- </member>
- <member name="ping_pong"
- value="3"
- c:identifier="GST_TOC_LOOP_PING_PONG"
- glib:nick="ping-pong">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="106">repeat forward and backward</doc>
- </member>
- </enumeration>
- <enumeration name="TocScope"
- glib:type-name="GstTocScope"
- glib:get-type="gst_toc_scope_get_type"
- c:type="GstTocScope">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="43">The scope of a TOC.</doc>
- <member name="global"
- value="1"
- c:identifier="GST_TOC_SCOPE_GLOBAL"
- glib:nick="global">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="45">global TOC representing all selectable options
- (this is what applications are usually interested in)</doc>
- </member>
- <member name="current"
- value="2"
- c:identifier="GST_TOC_SCOPE_CURRENT"
- glib:nick="current">
- <doc xml:space="preserve"
- filename="gst/gsttoc.h"
- line="47">TOC for the currently active/selected stream
- (this is a TOC representing the current stream from start to EOS,
- and is what a TOC writer / muxer is usually interested in; it will
- usually be a subset of the global TOC, e.g. just the chapters of
- the current title, or the chapters selected for playback from the
- current title)</doc>
- </member>
- </enumeration>
- <interface name="TocSetter"
- c:symbol-prefix="toc_setter"
- c:type="GstTocSetter"
- glib:type-name="GstTocSetter"
- glib:get-type="gst_toc_setter_get_type"
- glib:type-struct="TocSetterInterface">
- <doc xml:space="preserve"
- filename="gst/gsttocsetter.c"
- line="22">Element interface that allows setting of the TOC.
-
-Elements that support some kind of chapters or editions (or tracks like in
-the FLAC cue sheet) will implement this interface.
-
-If you just want to retrieve the TOC in your application then all you
-need to do is watch for TOC messages on your pipeline's bus (or you can
-perform TOC query). This interface is only for setting TOC data, not for
-extracting it. To set TOC from the application, find proper tocsetter element
-and set TOC using gst_toc_setter_set_toc().
-
-Elements implementing the #GstTocSetter interface can extend existing TOC
-by getting extend UID for that (you can use gst_toc_find_entry() to retrieve it)
-with any TOC entries received from downstream.</doc>
- <source-position filename="gst/gsttocsetter.h" line="55"/>
- <prerequisite name="Element"/>
- <method name="get_toc" c:identifier="gst_toc_setter_get_toc">
- <doc xml:space="preserve"
- filename="gst/gsttocsetter.c"
- line="124">Return current TOC the setter uses. The TOC should not be
-modified without making it writable first.</doc>
- <source-position filename="gst/gsttocsetter.h" line="64"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttocsetter.c"
- line="131">TOC set, or %NULL. Unref with
- gst_toc_unref() when no longer needed</doc>
- <type name="Toc" c:type="GstToc*"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttocsetter.c"
- line="126">a #GstTocSetter.</doc>
- <type name="TocSetter" c:type="GstTocSetter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reset" c:identifier="gst_toc_setter_reset">
- <doc xml:space="preserve"
- filename="gst/gsttocsetter.c"
- line="109">Reset the internal TOC. Elements should call this from within the
-state-change handler.</doc>
- <source-position filename="gst/gsttocsetter.h" line="61"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttocsetter.c"
- line="111">a #GstTocSetter.</doc>
- <type name="TocSetter" c:type="GstTocSetter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_toc" c:identifier="gst_toc_setter_set_toc">
- <doc xml:space="preserve"
- filename="gst/gsttocsetter.c"
- line="153">Set the given TOC on the setter. Previously set TOC will be
-unreffed before setting a new one.</doc>
- <source-position filename="gst/gsttocsetter.h" line="67"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="setter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttocsetter.c"
- line="155">a #GstTocSetter.</doc>
- <type name="TocSetter" c:type="GstTocSetter*"/>
- </instance-parameter>
- <parameter name="toc"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttocsetter.c"
- line="156">a #GstToc to set.</doc>
- <type name="Toc" c:type="GstToc*"/>
- </parameter>
- </parameters>
- </method>
- </interface>
- <record name="TocSetterInterface"
- c:type="GstTocSetterInterface"
- glib:is-gtype-struct-for="TocSetter">
- <doc xml:space="preserve"
- filename="gst/gsttocsetter.h"
- line="41">#GstTocSetterInterface interface.</doc>
- <source-position filename="gst/gsttocsetter.h" line="55"/>
- <field name="g_iface">
- <doc xml:space="preserve"
- filename="gst/gsttocsetter.h"
- line="43">parent interface type.</doc>
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- </record>
- <class name="Tracer"
- c:symbol-prefix="tracer"
- c:type="GstTracer"
- version="1.8"
- parent="Object"
- abstract="1"
- glib:type-name="GstTracer"
- glib:get-type="gst_tracer_get_type"
- glib:type-struct="TracerClass">
- <doc xml:space="preserve"
- filename="gst/gsttracer.c"
- line="22">Tracing modules will subclass #GstTracer and register through
-gst_tracer_register(). Modules can attach to various hook-types - see
-gst_tracing_register_hook(). When invoked they receive hook specific
-contextual data, which they must not modify.</doc>
- <source-position filename="gst/gsttracer.h" line="61"/>
- <function name="register" c:identifier="gst_tracer_register">
- <doc xml:space="preserve"
- filename="gst/gsttracer.c"
- line="131">Create a new tracer-factory capable of instantiating objects of the
-@type and add the factory to @plugin.</doc>
- <source-position filename="gst/gsttracer.h" line="73"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttracer.c"
- line="140">%TRUE, if the registering succeeded, %FALSE on error</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="plugin"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttracer.c"
- line="133">A #GstPlugin, or %NULL for a static typefind function</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttracer.c"
- line="134">The name for registering</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttracer.c"
- line="135">GType of tracer to register</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </function>
- <property name="params"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <field name="parent">
- <type name="Object" c:type="GstObject"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TracerPrivate" c:type="GstTracerPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TracerClass"
- c:type="GstTracerClass"
- glib:is-gtype-struct-for="Tracer">
- <source-position filename="gst/gsttracer.h" line="61"/>
- <field name="parent_class">
- <type name="ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="TracerFactory"
- c:symbol-prefix="tracer_factory"
- c:type="GstTracerFactory"
- version="1.8"
- parent="PluginFeature"
- glib:type-name="GstTracerFactory"
- glib:get-type="gst_tracer_factory_get_type"
- glib:type-struct="TracerFactoryClass">
- <doc xml:space="preserve"
- filename="gst/gsttracerfactory.c"
- line="22">Use gst_tracer_factory_get_list() to get a list of tracer factories known to
-GStreamer.</doc>
- <source-position filename="gst/gsttracerfactory.h" line="47"/>
- <function name="get_list"
- c:identifier="gst_tracer_factory_get_list"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gsttracerfactory.c"
- line="59">Gets the list of all registered tracer factories. You must free the
-list using gst_plugin_feature_list_free().
-
-The returned factories are sorted by factory name.
-
-Free-function: gst_plugin_feature_list_free</doc>
- <source-position filename="gst/gsttracerfactory.h" line="55"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttracerfactory.c"
- line="69">the list of all
- registered #GstTracerFactory.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="TracerFactory"/>
- </type>
- </return-value>
- </function>
- <method name="get_tracer_type"
- c:identifier="gst_tracer_factory_get_tracer_type"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gsttracerfactory.c"
- line="81">Get the #GType for elements managed by this factory. The type can
-only be retrieved if the element factory is loaded, which can be
-assured with gst_plugin_feature_load().</doc>
- <source-position filename="gst/gsttracerfactory.h" line="58"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttracerfactory.c"
- line="89">the #GType for tracers managed by this factory or 0 if
-the factory is not loaded.</doc>
- <type name="GType" c:type="GType"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttracerfactory.c"
- line="83">factory to get managed #GType from</doc>
- <type name="TracerFactory" c:type="GstTracerFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- </class>
- <record name="TracerFactoryClass"
- c:type="GstTracerFactoryClass"
- disguised="1"
- glib:is-gtype-struct-for="TracerFactory">
- <source-position filename="gst/gsttracerfactory.h" line="47"/>
- </record>
- <record name="TracerPrivate" c:type="GstTracerPrivate" disguised="1">
- <source-position filename="gst/gsttracer.h" line="33"/>
- </record>
- <class name="TracerRecord"
- c:symbol-prefix="tracer_record"
- c:type="GstTracerRecord"
- version="1.8"
- parent="Object"
- glib:type-name="GstTracerRecord"
- glib:get-type="gst_tracer_record_get_type"
- glib:type-struct="TracerRecordClass">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.c"
- line="22">Tracing modules will create instances of this class to announce the data they
-will log and create a log formatter.</doc>
- <source-position filename="gst/gsttracerrecord.h" line="37"/>
- <constructor name="new"
- c:identifier="gst_tracer_record_new"
- version="1.8"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.c"
- line="153">Create a new tracer record. The record instance can be used to efficiently
-log entries using gst_tracer_record_log().
-
-The @name without the ".class" suffix will be used for the log records.
-There must be fields for each value that gets logged where the field name is
-the value name. The field must be a #GstStructure describing the value. The
-sub structure must contain a field called 'type' of %G_TYPE_GTYPE that
-contains the GType of the value. The resulting #GstTracerRecord will take
-ownership of the field structures.
-
-The way to deal with optional values is to log an additional boolean before
-the optional field, that if %TRUE signals that the optional field is valid
-and %FALSE signals that the optional field should be ignored. One must still
-log a placeholder value for the optional field though. Please also note, that
-pointer type values must not be NULL - the underlying serialisation can not
-handle that right now.
-
-&gt; Please note that this is still under discussion and subject to change.</doc>
- <source-position filename="gst/gsttracerrecord.h" line="95"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.c"
- line="179">a new #GstTracerRecord</doc>
- <type name="TracerRecord" c:type="GstTracerRecord*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.c"
- line="155">name of new record, must end on ".class".</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="firstfield" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.c"
- line="156">name of first field to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.c"
- line="157">additional arguments</doc>
- <varargs/>
- </parameter>
- </parameters>
- </constructor>
- <method name="log"
- c:identifier="gst_tracer_record_log"
- version="1.8"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.c"
- line="239">Serialzes the trace event into the log.
-
-Right now this is using the gstreamer debug log with the level TRACE (7) and
-the category "GST_TRACER".
-
-&gt; Please note that this is still under discussion and subject to change.</doc>
- <source-position filename="gst/gsttracerrecord.h" line="99"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.c"
- line="241">the tracer-record</doc>
- <type name="TracerRecord" c:type="GstTracerRecord*"/>
- </instance-parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.c"
- line="242">the args as described in the spec-</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- </class>
- <record name="TracerRecordClass"
- c:type="GstTracerRecordClass"
- disguised="1"
- glib:is-gtype-struct-for="TracerRecord">
- <source-position filename="gst/gsttracerrecord.h" line="37"/>
- </record>
- <bitfield name="TracerValueFlags"
- glib:type-name="GstTracerValueFlags"
- glib:get-type="gst_tracer_value_flags_get_type"
- c:type="GstTracerValueFlags">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.h"
- line="75">Flag that describe the value. These flags help applications processing the
-logs to understand the values.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_TRACER_VALUE_FLAGS_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.h"
- line="77">no flags</doc>
- </member>
- <member name="optional"
- value="1"
- c:identifier="GST_TRACER_VALUE_FLAGS_OPTIONAL"
- glib:nick="optional">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.h"
- line="78">the value is optional. When using this flag
- one need to have an additional boolean arg before this value in the
- var-args list passed to gst_tracer_record_log().</doc>
- </member>
- <member name="aggregated"
- value="2"
- c:identifier="GST_TRACER_VALUE_FLAGS_AGGREGATED"
- glib:nick="aggregated">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.h"
- line="81">the value is a combined figure, since the
- start of tracing. Examples are averages or timestamps.</doc>
- </member>
- </bitfield>
- <enumeration name="TracerValueScope"
- version="1.8"
- glib:type-name="GstTracerValueScope"
- glib:get-type="gst_tracer_value_scope_get_type"
- c:type="GstTracerValueScope">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.h"
- line="52">Tracing record will contain fields that contain a measured value or extra
-meta-data. One such meta data are values that tell where a measurement was
-taken. This enumerating declares to which scope such a meta data field
-relates to. If it is e.g. %GST_TRACER_VALUE_SCOPE_PAD, then each of the log
-events may contain values for different #GstPads.</doc>
- <member name="process"
- value="0"
- c:identifier="GST_TRACER_VALUE_SCOPE_PROCESS"
- glib:nick="process">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.h"
- line="54">the value is related to the process</doc>
- </member>
- <member name="thread"
- value="1"
- c:identifier="GST_TRACER_VALUE_SCOPE_THREAD"
- glib:nick="thread">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.h"
- line="55">the value is related to a thread</doc>
- </member>
- <member name="element"
- value="2"
- c:identifier="GST_TRACER_VALUE_SCOPE_ELEMENT"
- glib:nick="element">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.h"
- line="56">the value is related to an #GstElement</doc>
- </member>
- <member name="pad"
- value="3"
- c:identifier="GST_TRACER_VALUE_SCOPE_PAD"
- glib:nick="pad">
- <doc xml:space="preserve"
- filename="gst/gsttracerrecord.h"
- line="57">the value is related to a #GstPad</doc>
- </member>
- </enumeration>
- <record name="TypeFind" c:type="GstTypeFind">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="22">The following functions allow you to detect the media type of an unknown
-stream.</doc>
- <source-position filename="gst/gsttypefind.h" line="92"/>
- <field name="peek">
- <callback name="peek">
- <source-position filename="gst/gsttypefind.h" line="77"/>
- <return-value transfer-ownership="none">
- <type name="guint8" c:type="const guint8*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="suggest">
- <callback name="suggest">
- <source-position filename="gst/gsttypefind.h" line="81"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="probability" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="data" writable="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.h"
- line="70">The data used by the caller of the typefinding function.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="get_length">
- <callback name="get_length">
- <source-position filename="gst/gsttypefind.h" line="88"/>
- <return-value transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="get_length" c:identifier="gst_type_find_get_length">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="200">Get the length of the data stream.</doc>
- <source-position filename="gst/gsttypefind.h" line="116"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="206">The length of the data stream, or 0 if it is not available.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="find" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="202">The #GstTypeFind the function was called with</doc>
- <type name="TypeFind" c:type="GstTypeFind*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="peek" c:identifier="gst_type_find_peek">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="106">Returns the @size bytes of the stream to identify beginning at offset. If
-offset is a positive number, the offset is relative to the beginning of the
-stream, if offset is a negative number the offset is relative to the end of
-the stream. The returned memory is valid until the typefinding function
-returns and must not be freed.</doc>
- <source-position filename="gst/gsttypefind.h" line="103"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="118">the
- requested data, or %NULL if that data is not available.</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="find" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="108">The #GstTypeFind object the function was called with</doc>
- <type name="TypeFind" c:type="GstTypeFind*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="109">The offset</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="110">The number of bytes to return</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="suggest" c:identifier="gst_type_find_suggest">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="129">If a #GstTypeFindFunction calls this function it suggests the caps with the
-given probability. A #GstTypeFindFunction may supply different suggestions
-in one call.
-It is up to the caller of the #GstTypeFindFunction to interpret these values.</doc>
- <source-position filename="gst/gsttypefind.h" line="107"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="find" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="131">The #GstTypeFind object the function was called with</doc>
- <type name="TypeFind" c:type="GstTypeFind*"/>
- </instance-parameter>
- <parameter name="probability" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="132">The probability in percent that the suggestion is right</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="133">The fixed #GstCaps to suggest</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="suggest_simple"
- c:identifier="gst_type_find_suggest_simple"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="151">If a #GstTypeFindFunction calls this function it suggests the caps with the
-given probability. A #GstTypeFindFunction may supply different suggestions
-in one call. It is up to the caller of the #GstTypeFindFunction to interpret
-these values.
-
-This function is similar to gst_type_find_suggest(), only that instead of
-passing a #GstCaps argument you can create the caps on the fly in the same
-way as you can with gst_caps_new_simple().
-
-Make sure you terminate the list of arguments with a %NULL argument and that
-the values passed have the correct type (in terms of width in bytes when
-passed to the vararg function - this applies particularly to gdouble and
-guint64 arguments).</doc>
- <source-position filename="gst/gsttypefind.h" line="111"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="find" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="153">The #GstTypeFind object the function was called with</doc>
- <type name="TypeFind" c:type="GstTypeFind*"/>
- </instance-parameter>
- <parameter name="probability" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="154">The probability in percent that the suggestion is right</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="media_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="155">the media type of the suggested caps</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="fieldname"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="156">first field of the suggested caps, or %NULL</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="157">additional arguments to the suggested caps in the same format as the
- arguments passed to gst_structure_new() (ie. triplets of field name,
- field GType and field value)</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <function name="register" c:identifier="gst_type_find_register">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="42">Registers a new typefind function to be used for typefinding. After
-registering this function will be available for typefinding.
-This function is typically called during an element's plugin initialization.</doc>
- <source-position filename="gst/gsttypefind.h" line="121"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="61">%TRUE on success, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="plugin"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="44">A #GstPlugin, or %NULL for a static typefind function</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="45">The name for registering</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="rank" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="46">The rank (or importance) of this typefind function</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="notified"
- closure="6"
- destroy="7">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="47">The #GstTypeFindFunction to use</doc>
- <type name="TypeFindFunction" c:type="GstTypeFindFunction"/>
- </parameter>
- <parameter name="extensions"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="48">Optional comma-separated list of extensions
- that could belong to this type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="possible_caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="50">Optionally the caps that could be returned when typefinding
- succeeds</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="52">Optional user data. This user data must be available until the plugin
- is unloaded.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="data_notify"
- transfer-ownership="none"
- scope="async">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="54">a #GDestroyNotify that will be called on @data when the plugin
- is unloaded.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <class name="TypeFindFactory"
- c:symbol-prefix="type_find_factory"
- c:type="GstTypeFindFactory"
- parent="PluginFeature"
- glib:type-name="GstTypeFindFactory"
- glib:get-type="gst_type_find_factory_get_type"
- glib:type-struct="TypeFindFactoryClass">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="22">These functions allow querying information about registered typefind
-functions. How to create and register these functions is described in
-the section &lt;link linkend="gstreamer-Writing-typefind-functions"&gt;
-"Writing typefind functions"&lt;/link&gt;.
-
-The following example shows how to write a very simple typefinder that
-identifies the given data. You can get quite a bit more complicated than
-that though.
-|[&lt;!-- language="C" --&gt;
- typedef struct {
- guint8 *data;
- guint size;
- guint probability;
- GstCaps *data;
- } MyTypeFind;
- static void
- my_peek (gpointer data, gint64 offset, guint size)
- {
- MyTypeFind *find = (MyTypeFind *) data;
- if (offset &amp;gt;= 0 &amp;amp;&amp;amp; offset + size &amp;lt;= find-&gt;size) {
- return find-&gt;data + offset;
- }
- return NULL;
- }
- static void
- my_suggest (gpointer data, guint probability, GstCaps *caps)
- {
- MyTypeFind *find = (MyTypeFind *) data;
- if (probability &amp;gt; find-&gt;probability) {
- find-&gt;probability = probability;
- gst_caps_replace (&amp;amp;find-&gt;caps, caps);
- }
- }
- static GstCaps *
- find_type (guint8 *data, guint size)
- {
- GList *walk, *type_list;
- MyTypeFind find = {data, size, 0, NULL};
- GstTypeFind gst_find = {my_peek, my_suggest, &amp;amp;find, };
- walk = type_list = gst_type_find_factory_get_list ();
- while (walk) {
- GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (walk-&gt;data);
- walk = g_list_next (walk)
- gst_type_find_factory_call_function (factory, &amp;amp;gst_find);
- }
- g_list_free (type_list);
- return find.caps;
- };
-]|</doc>
- <source-position filename="gst/gsttypefindfactory.h" line="45"/>
- <function name="get_list" c:identifier="gst_type_find_factory_get_list">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="135">Gets the list of all registered typefind factories. You must free the
-list using gst_plugin_feature_list_free().
-
-The returned factories are sorted by highest rank first, and then by
-factory name.
-
-Free-function: gst_plugin_feature_list_free</doc>
- <source-position filename="gst/gsttypefindfactory.h" line="53"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="146">the list of all
- registered #GstTypeFindFactory.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="TypeFindFactory"/>
- </type>
- </return-value>
- </function>
- <method name="call_function"
- c:identifier="gst_type_find_factory_call_function">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="192">Calls the #GstTypeFindFunction associated with this factory.</doc>
- <source-position filename="gst/gsttypefindfactory.h" line="65"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="194">A #GstTypeFindFactory</doc>
- <type name="TypeFindFactory" c:type="GstTypeFindFactory*"/>
- </instance-parameter>
- <parameter name="find" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="195">a properly setup #GstTypeFind entry. The get_data
- and suggest_type members must be set.</doc>
- <type name="TypeFind" c:type="GstTypeFind*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_caps" c:identifier="gst_type_find_factory_get_caps">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="156">Gets the #GstCaps associated with a typefind factory.</doc>
- <source-position filename="gst/gsttypefindfactory.h" line="59"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="162">the #GstCaps associated with this factory</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="158">A #GstTypeFindFactory</doc>
- <type name="TypeFindFactory" c:type="GstTypeFindFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_extensions"
- c:identifier="gst_type_find_factory_get_extensions">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="172">Gets the extensions associated with a #GstTypeFindFactory. The returned
-array should not be changed. If you need to change stuff in it, you should
-copy it using g_strdupv(). This function may return %NULL to indicate
-a 0-length list.</doc>
- <source-position filename="gst/gsttypefindfactory.h" line="56"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="181">
- a %NULL-terminated array of extensions associated with this factory</doc>
- <array c:type="const gchar* const*">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="174">A #GstTypeFindFactory</doc>
- <type name="TypeFindFactory" c:type="GstTypeFindFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_function"
- c:identifier="gst_type_find_factory_has_function">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="221">Check whether the factory has a typefind function. Typefind factories
-without typefind functions are a last-effort fallback mechanism to
-e.g. assume a certain media type based on the file extension.</doc>
- <source-position filename="gst/gsttypefindfactory.h" line="62"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="229">%TRUE if the factory has a typefind functions set, otherwise %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="factory" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefindfactory.c"
- line="223">A #GstTypeFindFactory</doc>
- <type name="TypeFindFactory" c:type="GstTypeFindFactory*"/>
- </instance-parameter>
- </parameters>
- </method>
- </class>
- <record name="TypeFindFactoryClass"
- c:type="GstTypeFindFactoryClass"
- disguised="1"
- glib:is-gtype-struct-for="TypeFindFactory">
- <source-position filename="gst/gsttypefindfactory.h" line="45"/>
- </record>
- <callback name="TypeFindFunction" c:type="GstTypeFindFunction">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.h"
- line="36">A function that will be called by typefinding.</doc>
- <source-position filename="gst/gsttypefind.h" line="43"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="find" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.h"
- line="38">A #GstTypeFind structure</doc>
- <type name="TypeFind" c:type="GstTypeFind*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.h"
- line="39">optional data to pass to the function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <enumeration name="TypeFindProbability"
- glib:type-name="GstTypeFindProbability"
- glib:get-type="gst_type_find_probability_get_type"
- c:type="GstTypeFindProbability">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.h"
- line="45">The probability of the typefind function. Higher values have more certainty
-in doing a reliable typefind.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_TYPE_FIND_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.h"
- line="47">type undetected.</doc>
- </member>
- <member name="minimum"
- value="1"
- c:identifier="GST_TYPE_FIND_MINIMUM"
- glib:nick="minimum">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.h"
- line="48">unlikely typefind.</doc>
- </member>
- <member name="possible"
- value="50"
- c:identifier="GST_TYPE_FIND_POSSIBLE"
- glib:nick="possible">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.h"
- line="49">possible type detected.</doc>
- </member>
- <member name="likely"
- value="80"
- c:identifier="GST_TYPE_FIND_LIKELY"
- glib:nick="likely">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.h"
- line="50">likely a type was detected.</doc>
- </member>
- <member name="nearly_certain"
- value="99"
- c:identifier="GST_TYPE_FIND_NEARLY_CERTAIN"
- glib:nick="nearly-certain">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.h"
- line="51">nearly certain that a type was detected.</doc>
- </member>
- <member name="maximum"
- value="100"
- c:identifier="GST_TYPE_FIND_MAXIMUM"
- glib:nick="maximum">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.h"
- line="52">very certain a type was detected.</doc>
- </member>
- </enumeration>
- <function-macro name="URI" c:identifier="GST_URI" introspectable="0">
- <source-position filename="gst/gsturi.h" line="192"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <enumeration name="URIError"
- glib:type-name="GstURIError"
- glib:get-type="gst_uri_error_get_type"
- c:type="GstURIError"
- glib:error-domain="gst-uri-error-quark">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="49">Different URI-related errors that can occur.</doc>
- <member name="unsupported_protocol"
- value="0"
- c:identifier="GST_URI_ERROR_UNSUPPORTED_PROTOCOL"
- glib:nick="unsupported-protocol">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="51">The protocol is not supported</doc>
- </member>
- <member name="bad_uri"
- value="1"
- c:identifier="GST_URI_ERROR_BAD_URI"
- glib:nick="bad-uri">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="52">There was a problem with the URI</doc>
- </member>
- <member name="bad_state"
- value="2"
- c:identifier="GST_URI_ERROR_BAD_STATE"
- glib:nick="bad-state">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="53">Could not set or change the URI because the
- URI handler was in a state where that is not possible or not permitted</doc>
- </member>
- <member name="bad_reference"
- value="3"
- c:identifier="GST_URI_ERROR_BAD_REFERENCE"
- glib:nick="bad-reference">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="55">There was a problem with the entity that
- the URI references</doc>
- </member>
- <function name="quark" c:identifier="gst_uri_error_quark">
- <attribute name="doc.skip" value="true"/>
- <return-value transfer-ownership="none">
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- </enumeration>
- <interface name="URIHandler"
- c:symbol-prefix="uri_handler"
- c:type="GstURIHandler"
- glib:type-name="GstURIHandler"
- glib:get-type="gst_uri_handler_get_type"
- glib:type-struct="URIHandlerInterface">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="26">The #GstURIHandler is an interface that is implemented by Source and Sink
-#GstElement to unify handling of URI.
-
-An application can use the following functions to quickly get an element
-that handles the given URI for reading or writing
-(gst_element_make_from_uri()).
-
-Source and Sink plugins should implement this interface when possible.</doc>
- <source-position filename="gst/gsturi.h" line="132"/>
- <virtual-method name="get_uri" invoker="get_uri">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="749">Gets the currently handled URI.</doc>
- <source-position filename="gst/gsturi.h" line="128"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="755">the URI currently handled by
- the @handler. Returns %NULL if there are no URI currently
- handled. The returned string must be freed with g_free() when no
- longer needed.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="handler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="751">A #GstURIHandler</doc>
- <type name="URIHandler" c:type="GstURIHandler*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_uri" invoker="set_uri" throws="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="778">Tries to set the URI of the given handler.</doc>
- <source-position filename="gst/gsturi.h" line="129"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="787">%TRUE if the URI was set successfully, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="handler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="780">A #GstURIHandler</doc>
- <type name="URIHandler" c:type="GstURIHandler*"/>
- </instance-parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="781">URI to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="get_protocols"
- c:identifier="gst_uri_handler_get_protocols">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="719">Gets the list of protocols supported by @handler. This list may not be
-modified.</doc>
- <source-position filename="gst/gsturi.h" line="175"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="726">the
- supported protocols. Returns %NULL if the @handler isn't
- implemented properly, or the @handler doesn't support any
- protocols.</doc>
- <array c:type="const gchar* const*">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="handler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="721">A #GstURIHandler.</doc>
- <type name="URIHandler" c:type="GstURIHandler*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_uri" c:identifier="gst_uri_handler_get_uri">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="749">Gets the currently handled URI.</doc>
- <source-position filename="gst/gsturi.h" line="178"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="755">the URI currently handled by
- the @handler. Returns %NULL if there are no URI currently
- handled. The returned string must be freed with g_free() when no
- longer needed.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="handler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="751">A #GstURIHandler</doc>
- <type name="URIHandler" c:type="GstURIHandler*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_uri_type" c:identifier="gst_uri_handler_get_uri_type">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="692">Gets the type of the given URI handler</doc>
- <source-position filename="gst/gsturi.h" line="172"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="698">the #GstURIType of the URI handler.
-Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly.</doc>
- <type name="URIType" c:type="GstURIType"/>
- </return-value>
- <parameters>
- <instance-parameter name="handler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="694">A #GstURIHandler.</doc>
- <type name="URIHandler" c:type="GstURIHandler*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_uri" c:identifier="gst_uri_handler_set_uri" throws="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="778">Tries to set the URI of the given handler.</doc>
- <source-position filename="gst/gsturi.h" line="181"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="787">%TRUE if the URI was set successfully, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="handler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="780">A #GstURIHandler</doc>
- <type name="URIHandler" c:type="GstURIHandler*"/>
- </instance-parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="781">URI to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- </interface>
- <record name="URIHandlerInterface"
- c:type="GstURIHandlerInterface"
- glib:is-gtype-struct-for="URIHandler">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="108">Any #GstElement using this interface should implement these methods.</doc>
- <source-position filename="gst/gsturi.h" line="132"/>
- <field name="parent">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="110">The parent interface type</doc>
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- <field name="get_type">
- <callback name="get_type">
- <source-position filename="gst/gsturi.h" line="124"/>
- <return-value transfer-ownership="none">
- <type name="URIType" c:type="GstURIType"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_protocols">
- <callback name="get_protocols">
- <source-position filename="gst/gsturi.h" line="125"/>
- <return-value transfer-ownership="none">
- <array c:type="const gchar* const*">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_uri">
- <callback name="get_uri">
- <source-position filename="gst/gsturi.h" line="128"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="755">the URI currently handled by
- the @handler. Returns %NULL if there are no URI currently
- handled. The returned string must be freed with g_free() when no
- longer needed.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="handler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="751">A #GstURIHandler</doc>
- <type name="URIHandler" c:type="GstURIHandler*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_uri">
- <callback name="set_uri" throws="1">
- <source-position filename="gst/gsturi.h" line="129"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="787">%TRUE if the URI was set successfully, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="handler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="780">A #GstURIHandler</doc>
- <type name="URIHandler" c:type="GstURIHandler*"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="781">URI to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- </record>
- <enumeration name="URIType"
- glib:type-name="GstURIType"
- glib:get-type="gst_uri_type_get_type"
- c:type="GstURIType">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="68">The different types of URI direction.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_URI_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="70">The URI direction is unknown</doc>
- </member>
- <member name="sink"
- value="1"
- c:identifier="GST_URI_SINK"
- glib:nick="sink">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="71">The URI is a consumer.</doc>
- </member>
- <member name="src" value="2" c:identifier="GST_URI_SRC" glib:nick="src">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="72">The URI is a producer.</doc>
- </member>
- </enumeration>
- <function-macro name="URI_CAST"
- c:identifier="GST_URI_CAST"
- introspectable="0">
- <source-position filename="gst/gsturi.h" line="190"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="URI_CONST_CAST"
- c:identifier="GST_URI_CONST_CAST"
- introspectable="0">
- <source-position filename="gst/gsturi.h" line="191"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="URI_HANDLER"
- c:identifier="GST_URI_HANDLER"
- introspectable="0">
- <source-position filename="gst/gsturi.h" line="93"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="URI_HANDLER_GET_INTERFACE"
- c:identifier="GST_URI_HANDLER_GET_INTERFACE"
- introspectable="0">
- <source-position filename="gst/gsturi.h" line="95"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="URI_NO_PORT" value="0" c:type="GST_URI_NO_PORT">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="202">Value for #GstUri&lt;!-- --&gt;.port to indicate no port number.</doc>
- <source-position filename="gst/gsturi.h" line="207"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="URI_TYPE_IS_VALID"
- c:identifier="GST_URI_TYPE_IS_VALID"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="83">Tests if the type direction is valid.</doc>
- <source-position filename="gst/gsturi.h" line="89"/>
- <parameters>
- <parameter name="type">
- <doc xml:space="preserve"
- filename="gst/gsturi.h"
- line="85">A #GstURIType</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="USECOND" value="1000" c:type="GST_USECOND">
- <doc xml:space="preserve"
- filename="gst/gstclock.h"
- line="110">Constant that defines one GStreamer microsecond.</doc>
- <source-position filename="gst/gstclock.h" line="115"/>
- <type name="ClockTimeDiff" c:type="GstClockTimeDiff"/>
- </constant>
- <record name="Uri"
- c:type="GstUri"
- glib:type-name="GstUri"
- glib:get-type="gst_uri_get_type"
- c:symbol-prefix="uri">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="954">A #GstUri object can be used to parse and split a URI string into its
-constituent parts. Two #GstUri objects can be joined to make a new #GstUri
-using the algorithm described in RFC3986.</doc>
- <source-position filename="gst/gsturi.h" line="200"/>
- <constructor name="new" c:identifier="gst_uri_new" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1421">Creates a new #GstUri object with the given URI parts. The path and query
-strings will be broken down into their elements. All strings should not be
-escaped except where indicated.</doc>
- <source-position filename="gst/gsturi.h" line="219"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1438">A new #GstUri object.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </return-value>
- <parameters>
- <parameter name="scheme"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1423">The scheme for the new URI.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="userinfo"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1424">The user-info for the new URI.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="host"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1425">The host name for the new URI.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="port" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1426">The port number for the new URI or %GST_URI_NO_PORT.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="path"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1427">The path for the new URI with '/' separating path
- elements.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="query"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1429">The query string for the new URI with '&amp;' separating
- query elements. Elements containing '&amp;' characters
- should encode them as "&amp;percnt;26".</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="fragment"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1432">The fragment name for the new URI.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="append_path"
- c:identifier="gst_uri_append_path"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2470">Append a path onto the end of the path in the URI. The path is not
-normalized, call #gst_uri_normalize() to normalize the path.</doc>
- <source-position filename="gst/gsturi.h" line="311"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2478">%TRUE if the path was appended successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2472">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="relative_path" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2473">Relative path to append to the end of the current path.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="append_path_segment"
- c:identifier="gst_uri_append_path_segment"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2508">Append a single path segment onto the end of the URI path.</doc>
- <source-position filename="gst/gsturi.h" line="314"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2515">%TRUE if the path was appended successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2510">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="path_segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2511">The path segment string to append to the URI path.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="equal" c:identifier="gst_uri_equal" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1698">Compares two #GstUri objects to see if they represent the same normalized
-URI.</doc>
- <source-position filename="gst/gsturi.h" line="245"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1706">%TRUE if the normalized versions of the two URI's would be equal.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="first" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1700">First #GstUri to compare.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- <parameter name="second" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1701">Second #GstUri to compare.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </parameter>
- </parameters>
- </method>
- <method name="from_string_with_base"
- c:identifier="gst_uri_from_string_with_base"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1672">Like gst_uri_from_string() but also joins with a base URI.</doc>
- <source-position filename="gst/gsturi.h" line="242"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1679">A new #GstUri object.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </return-value>
- <parameters>
- <instance-parameter name="base"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1674">The base URI to join the new URI with.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1675">The URI string to parse.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_fragment"
- c:identifier="gst_uri_get_fragment"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2805">Get the fragment name from the URI or %NULL if it doesn't exist.
-If @uri is %NULL then returns %NULL.</doc>
- <source-position filename="gst/gsturi.h" line="346"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2812">The host name from the #GstUri object or %NULL.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2807">This #GstUri object.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_host" c:identifier="gst_uri_get_host" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2203">Get the host name from the URI or %NULL if it doesn't exist.
-If @uri is %NULL then returns %NULL.</doc>
- <source-position filename="gst/gsturi.h" line="281"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2210">The host name from the #GstUri object or %NULL.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2205">This #GstUri object.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_media_fragment_table"
- c:identifier="gst_uri_get_media_fragment_table"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2847">Get the media fragment table from the URI, as defined by "Media Fragments URI 1.0".
-Hash table returned by this API is a list of "key-value" pairs, and the each
-pair is generated by splitting "URI fragment" per "&amp;" sub-delims, then "key"
-and "value" are split by "=" sub-delims. The "key" returned by this API may
-be undefined keyword by standard.
-A value may be %NULL to indicate that the key should appear in the fragment
-string in the URI, but does not have a value. Free the returned #GHashTable
-with #g_hash_table_unref() when it is no longer required.
-Modifying this hash table does not affect the fragment in the URI.
-
-See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frags/</doc>
- <source-position filename="gst/gsturi.h" line="352"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2863">The
- fragment hash table from the URI.</doc>
- <type name="GLib.HashTable" c:type="GHashTable*">
- <type name="utf8"/>
- <type name="utf8"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2849">The #GstUri to get the fragment table from.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_path" c:identifier="gst_uri_get_path" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2286">Extract the path string from the URI object.</doc>
- <source-position filename="gst/gsturi.h" line="293"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2292">The path from the URI. Once finished
- with the string should be g_free()'d.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2288">The #GstUri to get the path from.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_path_segments"
- c:identifier="gst_uri_get_path_segments"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2414">Get a list of path segments from the URI.</doc>
- <source-position filename="gst/gsturi.h" line="305"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2420">A #GList of path segment
- strings or %NULL if no path segments are available. Free the list
- when no longer needed with g_list_free_full(list, g_free).</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="utf8"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2416">The #GstUri to get the path from.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_path_string"
- c:identifier="gst_uri_get_path_string"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2349">Extract the path string from the URI object as a percent encoded URI path.</doc>
- <source-position filename="gst/gsturi.h" line="299"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2355">The path from the URI. Once finished
- with the string should be g_free()'d.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2351">The #GstUri to get the path from.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_port" c:identifier="gst_uri_get_port" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2245">Get the port number from the URI or %GST_URI_NO_PORT if it doesn't exist.
-If @uri is %NULL then returns %GST_URI_NO_PORT.</doc>
- <source-position filename="gst/gsturi.h" line="287"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2252">The port number from the #GstUri object or %GST_URI_NO_PORT.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2247">This #GstUri object.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_query_keys"
- c:identifier="gst_uri_get_query_keys"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2782">Get a list of the query keys from the URI.</doc>
- <source-position filename="gst/gsturi.h" line="343"/>
- <return-value transfer-ownership="container">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2788">A list of keys from
- the URI query. Free the list with g_list_free().</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="utf8"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2784">The #GstUri to examine.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_query_string"
- c:identifier="gst_uri_get_query_string"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2536">Get a percent encoded URI query string from the @uri.</doc>
- <source-position filename="gst/gsturi.h" line="317"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2542">A percent encoded query string. Use
- g_free() when no longer needed.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2538">The #GstUri to get the query string from.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_query_table"
- c:identifier="gst_uri_get_query_table"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2607">Get the query table from the URI. Keys and values in the table are freed
-with g_free when they are deleted. A value may be %NULL to indicate that
-the key should appear in the query string in the URI, but does not have a
-value. Free the returned #GHashTable with #g_hash_table_unref() when it is
-no longer required. Modifying this hash table will modify the query in the
-URI.</doc>
- <source-position filename="gst/gsturi.h" line="323"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2618">The query
- hash table from the URI.</doc>
- <type name="GLib.HashTable" c:type="GHashTable*">
- <type name="utf8"/>
- <type name="utf8"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2609">The #GstUri to get the query table from.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_query_value"
- c:identifier="gst_uri_get_query_value"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2755">Get the value associated with the @query_key key. Will return %NULL if the
-key has no value or if the key does not exist in the URI query table. Because
-%NULL is returned for both missing keys and keys with no value, you should
-use gst_uri_query_has_key() to determine if a key is present in the URI
-query.</doc>
- <source-position filename="gst/gsturi.h" line="339"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2766">The value for the given key, or %NULL if not found.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2757">The #GstUri to examine.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- <parameter name="query_key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2758">The key to lookup.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_scheme" c:identifier="gst_uri_get_scheme">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2121">Get the scheme name from the URI or %NULL if it doesn't exist.
-If @uri is %NULL then returns %NULL.</doc>
- <source-position filename="gst/gsturi.h" line="269"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2128">The scheme from the #GstUri object or %NULL.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2123">This #GstUri object.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_userinfo"
- c:identifier="gst_uri_get_userinfo"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2161">Get the userinfo (usually in the form "username:password") from the URI
-or %NULL if it doesn't exist. If @uri is %NULL then returns %NULL.</doc>
- <source-position filename="gst/gsturi.h" line="275"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2168">The userinfo from the #GstUri object or %NULL.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2163">This #GstUri object.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_normalized"
- c:identifier="gst_uri_is_normalized"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2046">Tests the @uri to see if it is normalized. A %NULL @uri is considered to be
-normalized.</doc>
- <source-position filename="gst/gsturi.h" line="263"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2053">TRUE if the URI is normalized or is %NULL.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2048">The #GstUri to test to see if it is normalized.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_writable"
- c:identifier="gst_uri_is_writable"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1926">Check if it is safe to write to this #GstUri.
-
-Check if the refcount of @uri is exactly 1, meaning that no other
-reference exists to the #GstUri and that the #GstUri is therefore writable.
-
-Modification of a #GstUri should only be done after verifying that it is
-writable.</doc>
- <source-position filename="gst/gsturi.h" line="254"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1938">%TRUE if it is safe to write to the object.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1928">The #GstUri object to test.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="join" c:identifier="gst_uri_join" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1809">Join a reference URI onto a base URI using the method from RFC 3986.
-If either URI is %NULL then the other URI will be returned with the ref count
-increased.</doc>
- <source-position filename="gst/gsturi.h" line="248"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1819">A #GstUri which represents the base
- with the reference URI joined on.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </return-value>
- <parameters>
- <instance-parameter name="base_uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1811">The base URI to join another to.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="ref_uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1812">The reference URI to join onto the
- base URI.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </parameter>
- </parameters>
- </method>
- <method name="make_writable"
- c:identifier="gst_uri_make_writable"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1949">Make the #GstUri writable.
-
-Checks if @uri is writable, and if so the original object is returned. If
-not, then a writable copy is made and returned. This gives away the
-reference to @uri and returns a reference to the new #GstUri.
-If @uri is %NULL then %NULL is returned.</doc>
- <source-position filename="gst/gsturi.h" line="257"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1960">A writable version of @uri.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1951">The #GstUri object to make writable.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="new_with_base"
- c:identifier="gst_uri_new_with_base"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1462">Like gst_uri_new(), but joins the new URI onto a base URI.</doc>
- <source-position filename="gst/gsturi.h" line="227"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1478">The new URI joined onto @base.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </return-value>
- <parameters>
- <instance-parameter name="base"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1464">The base URI to join the new URI to.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="scheme"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1465">The scheme for the new URI.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="userinfo"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1466">The user-info for the new URI.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="host"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1467">The host name for the new URI.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="port" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1468">The port number for the new URI or %GST_URI_NO_PORT.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="path"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1469">The path for the new URI with '/' separating path
- elements.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="query"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1471">The query string for the new URI with '&amp;' separating
- query elements. Elements containing '&amp;' characters
- should encode them as "&amp;percnt;26".</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="fragment"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1474">The fragment name for the new URI.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="normalize" c:identifier="gst_uri_normalize" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2093">Normalization will remove extra path segments ("." and "..") from the URI. It
-will also convert the scheme and host name to lower case and any
-percent-encoded values to uppercase.
-
-The #GstUri object must be writable. Check with gst_uri_is_writable() or use
-gst_uri_make_writable() first.</doc>
- <source-position filename="gst/gsturi.h" line="266"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2104">TRUE if the URI was modified.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2095">The #GstUri to normalize.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="query_has_key"
- c:identifier="gst_uri_query_has_key"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2732">Check if there is a query table entry for the @query_key key.</doc>
- <source-position filename="gst/gsturi.h" line="335"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2739">%TRUE if @query_key exists in the URI query table.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2734">The #GstUri to examine.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- <parameter name="query_key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2735">The key to lookup.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_query_key"
- c:identifier="gst_uri_remove_query_key"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2701">Remove an entry from the query table by key.</doc>
- <source-position filename="gst/gsturi.h" line="332"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2708">%TRUE if the key existed in the table and was removed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2703">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="query_key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2704">The key to remove.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_fragment"
- c:identifier="gst_uri_set_fragment"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2823">Sets the fragment string in the URI. Use a value of %NULL in @fragment to
-unset the fragment string.</doc>
- <source-position filename="gst/gsturi.h" line="349"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2831">%TRUE if the fragment was set/unset successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2825">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="fragment"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2826">The fragment string to set.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_host" c:identifier="gst_uri_set_host" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2221">Set or unset the host for the URI.</doc>
- <source-position filename="gst/gsturi.h" line="284"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2228">%TRUE if the host was set/unset successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2223">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="host" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2224">The new host string to set or %NULL to unset.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_path" c:identifier="gst_uri_set_path" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2324">Sets or unsets the path in the URI.</doc>
- <source-position filename="gst/gsturi.h" line="296"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2332">%TRUE if the path was set successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2326">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="path" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2327">The new path to set with path segments separated by '/', or use %NULL
- to unset the path.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_path_segments"
- c:identifier="gst_uri_set_path_segments"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2440">Replace the path segments list in the URI.</doc>
- <source-position filename="gst/gsturi.h" line="308"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2448">%TRUE if the path segments were set successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2442">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="path_segments"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2443">The new
- path list to set.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="utf8"/>
- </type>
- </parameter>
- </parameters>
- </method>
- <method name="set_path_string"
- c:identifier="gst_uri_set_path_string"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2390">Sets or unsets the path in the URI.</doc>
- <source-position filename="gst/gsturi.h" line="302"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2398">%TRUE if the path was set successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2392">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="path" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2393">The new percent encoded path to set with path segments separated by
-'/', or use %NULL to unset the path.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_port" c:identifier="gst_uri_set_port" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2263">Set or unset the port number for the URI.</doc>
- <source-position filename="gst/gsturi.h" line="290"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2270">%TRUE if the port number was set/unset successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2265">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="port" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2266">The new port number to set or %GST_URI_NO_PORT to unset.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_query_string"
- c:identifier="gst_uri_set_query_string"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2580">Sets or unsets the query table in the URI.</doc>
- <source-position filename="gst/gsturi.h" line="320"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2588">%TRUE if the query table was set successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2582">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2583">The new percent encoded query string to use to populate the query
- table, or use %NULL to unset the query table.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_query_table"
- c:identifier="gst_uri_set_query_table"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2635">Set the query table to use in the URI. The old table is unreferenced and a
-reference to the new one is used instead. A value if %NULL for @query_table
-will remove the query string from the URI.</doc>
- <source-position filename="gst/gsturi.h" line="326"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2645">%TRUE if the new table was successfully used for the query table.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2637">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="query_table"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2638">The new
- query table to use.</doc>
- <type name="GLib.HashTable" c:type="GHashTable*">
- <type name="utf8"/>
- <type name="utf8"/>
- </type>
- </parameter>
- </parameters>
- </method>
- <method name="set_query_value"
- c:identifier="gst_uri_set_query_value"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2669">This inserts or replaces a key in the query table. A @query_value of %NULL
-indicates that the key has no associated value, but will still be present in
-the query string.</doc>
- <source-position filename="gst/gsturi.h" line="329"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2679">%TRUE if the query table was successfully updated.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2671">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="query_key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2672">The key for the query entry.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="query_value"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2673">The value for the key.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_scheme"
- c:identifier="gst_uri_set_scheme"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2137">Set or unset the scheme for the URI.</doc>
- <source-position filename="gst/gsturi.h" line="272"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2144">%TRUE if the scheme was set/unset successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2139">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="scheme" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2140">The new scheme to set or %NULL to unset the scheme.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_userinfo"
- c:identifier="gst_uri_set_userinfo"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2179">Set or unset the user information for the URI.</doc>
- <source-position filename="gst/gsturi.h" line="278"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2186">%TRUE if the user information was set/unset successfully.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2181">The #GstUri to modify.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </instance-parameter>
- <parameter name="userinfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="2182">The new user-information string to set or %NULL to unset.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_string" c:identifier="gst_uri_to_string" version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1972">Convert the URI to a string.
-
-Returns the URI as held in this object as a #gchar* nul-terminated string.
-The caller should g_free() the string once they are finished with it.
-The string is put together as described in RFC 3986.</doc>
- <source-position filename="gst/gsturi.h" line="260"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1982">The string version of the URI.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1974">This #GstUri to convert to a string.</doc>
- <type name="Uri" c:type="const GstUri*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="construct"
- c:identifier="gst_uri_construct"
- deprecated="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="490">Constructs a URI for a given valid protocol and location.
-
-Free-function: g_free</doc>
- <doc-deprecated xml:space="preserve">Use GstURI instead.</doc-deprecated>
- <source-position filename="gst/gsturi.h" line="155"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="499">a new string for this URI. Returns %NULL if the
- given URI protocol is not valid, or the given location is %NULL.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="492">Protocol for URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="location" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="493">Location for URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="from_string"
- c:identifier="gst_uri_from_string"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1627">Parses a URI string into a new #GstUri object. Will return NULL if the URI
-cannot be parsed.</doc>
- <source-position filename="gst/gsturi.h" line="236"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1634">A new #GstUri object, or NULL.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1629">The URI string to parse.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="from_string_escaped"
- c:identifier="gst_uri_from_string_escaped"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1644">Parses a URI string into a new #GstUri object. Will return NULL if the URI
-cannot be parsed. This is identical to gst_uri_from_string() except that
-the userinfo and fragment components of the URI will not be unescaped while
-parsing.
-
-Use this when you need to extract a username and password from the userinfo
-such as https://user:password@example.com since either may contain
-a URI-escaped ':' character. gst_uri_from_string() will unescape the entire
-userinfo component, which will make it impossible to know which ':'
-delineates the username and password.
-
-The same applies to the fragment component of the URI, such as
-https://example.com/path#fragment which may contain a URI-escaped '#'.</doc>
- <source-position filename="gst/gsturi.h" line="239"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1662">A new #GstUri object, or NULL.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1646">The URI string to parse.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_location" c:identifier="gst_uri_get_location">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="441">Extracts the location out of a given valid URI, ie. the protocol and "://"
-are stripped from the URI, which means that the location returned includes
-the hostname if one is specified. The returned string must be freed using
-g_free().
-
-Free-function: g_free</doc>
- <source-position filename="gst/gsturi.h" line="152"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="452">the location for this URI. Returns
- %NULL if the URI isn't valid. If the URI does not contain a location, an
- empty string is returned.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="443">A URI string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_protocol" c:identifier="gst_uri_get_protocol">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="393">Extracts the protocol out of a given valid URI. The returned string must be
-freed using g_free().</doc>
- <source-position filename="gst/gsturi.h" line="146"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="400">The protocol for this URI.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="395">A URI string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="has_protocol" c:identifier="gst_uri_has_protocol">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="415">Checks if the protocol of a given valid URI matches @protocol.</doc>
- <source-position filename="gst/gsturi.h" line="149"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="422">%TRUE if the protocol matches.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="417">a URI string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="418">a protocol string (e.g. "http")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="is_valid" c:identifier="gst_uri_is_valid">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="372">Tests if the given string is a valid URI identifier. URIs start with a valid
-scheme followed by ":" and maybe a string identifying the location.</doc>
- <source-position filename="gst/gsturi.h" line="143"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="379">%TRUE if the string is a valid URI</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="374">A URI string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="join_strings"
- c:identifier="gst_uri_join_strings"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1898">This is a convenience function to join two URI strings and return the result.
-The returned string should be g_free()'d after use.</doc>
- <source-position filename="gst/gsturi.h" line="251"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1906">A string representing the percent-encoded join of
- the two URIs.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="base_uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1900">The percent-encoded base URI.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="ref_uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1901">The percent-encoded reference URI to join to the @base_uri.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="protocol_is_supported"
- c:identifier="gst_uri_protocol_is_supported">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="585">Checks if an element exists that supports the given URI protocol. Note
-that a positive return value does not imply that a subsequent call to
-gst_element_make_from_uri() is guaranteed to work.</doc>
- <source-position filename="gst/gsturi.h" line="140"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="594">%TRUE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="587">Whether to check for a source or a sink</doc>
- <type name="URIType" c:type="const GstURIType"/>
- </parameter>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="588">Protocol that should be checked for (e.g. "http" or "smb")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="protocol_is_valid"
- c:identifier="gst_uri_protocol_is_valid">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="350">Tests if the given string is a valid protocol identifier. Protocols
-must consist of alphanumeric characters, '+', '-' and '.' and must
-start with a alphabetic character. See RFC 3986 Section 3.1.</doc>
- <source-position filename="gst/gsturi.h" line="137"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="358">%TRUE if the string is a valid protocol identifier, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="352">A string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <constant name="VALUE_EQUAL" value="0" c:type="GST_VALUE_EQUAL">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="414">Indicates that the first value provided to a comparison function
-(gst_value_compare()) is equal to the second one.</doc>
- <source-position filename="gst/gstvalue.h" line="420"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VALUE_GREATER_THAN"
- value="1"
- c:type="GST_VALUE_GREATER_THAN">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="422">Indicates that the first value provided to a comparison function
-(gst_value_compare()) is greater than the second one.</doc>
- <source-position filename="gst/gstvalue.h" line="428"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="VALUE_HOLDS_ARRAY"
- c:identifier="GST_VALUE_HOLDS_ARRAY"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="132">Checks if the given #GValue contains a #GST_TYPE_ARRAY value.</doc>
- <source-position filename="gst/gstvalue.h" line="138"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="134">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_BITMASK"
- c:identifier="GST_VALUE_HOLDS_BITMASK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="196">Checks if the given #GValue contains a #GST_TYPE_BITMASK value.</doc>
- <source-position filename="gst/gstvalue.h" line="202"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="198">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_BUFFER"
- c:identifier="GST_VALUE_HOLDS_BUFFER"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="164">Checks if the given #GValue contains a #GST_TYPE_BUFFER value.</doc>
- <source-position filename="gst/gstvalue.h" line="170"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="166">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_CAPS"
- c:identifier="GST_VALUE_HOLDS_CAPS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="140">Checks if the given #GValue contains a #GST_TYPE_CAPS value.</doc>
- <source-position filename="gst/gstvalue.h" line="146"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="142">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_CAPS_FEATURES"
- c:identifier="GST_VALUE_HOLDS_CAPS_FEATURES"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="156">Checks if the given #GValue contains a #GST_TYPE_CAPS_FEATURES value.</doc>
- <source-position filename="gst/gstvalue.h" line="162"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="158">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_DATE_TIME"
- c:identifier="GST_VALUE_HOLDS_DATE_TIME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="188">Checks if the given #GValue contains a #GST_TYPE_DATE_TIME value.</doc>
- <source-position filename="gst/gstvalue.h" line="194"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="190">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_DOUBLE_RANGE"
- c:identifier="GST_VALUE_HOLDS_DOUBLE_RANGE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="108">Checks if the given #GValue contains a #GST_TYPE_DOUBLE_RANGE value.</doc>
- <source-position filename="gst/gstvalue.h" line="114"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="110">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_FLAG_SET"
- c:identifier="GST_VALUE_HOLDS_FLAG_SET"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="204">Checks if the given #GValue contains a #GST_TYPE_FLAG_SET value.</doc>
- <source-position filename="gst/gstvalue.h" line="212"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="206">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_FRACTION"
- c:identifier="GST_VALUE_HOLDS_FRACTION"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="180">Checks if the given #GValue contains a #GST_TYPE_FRACTION value.</doc>
- <source-position filename="gst/gstvalue.h" line="186"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="182">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_FRACTION_RANGE"
- c:identifier="GST_VALUE_HOLDS_FRACTION_RANGE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="116">Checks if the given #GValue contains a #GST_TYPE_FRACTION_RANGE value.</doc>
- <source-position filename="gst/gstvalue.h" line="122"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="118">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_INT64_RANGE"
- c:identifier="GST_VALUE_HOLDS_INT64_RANGE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="100">Checks if the given #GValue contains a #GST_TYPE_INT64_RANGE value.</doc>
- <source-position filename="gst/gstvalue.h" line="106"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="102">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_INT_RANGE"
- c:identifier="GST_VALUE_HOLDS_INT_RANGE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="92">Checks if the given #GValue contains a #GST_TYPE_INT_RANGE value.</doc>
- <source-position filename="gst/gstvalue.h" line="98"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="94">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_LIST"
- c:identifier="GST_VALUE_HOLDS_LIST"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="124">Checks if the given #GValue contains a #GST_TYPE_LIST value.</doc>
- <source-position filename="gst/gstvalue.h" line="130"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="126">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_SAMPLE"
- c:identifier="GST_VALUE_HOLDS_SAMPLE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="172">Checks if the given #GValue contains a #GST_TYPE_SAMPLE value.</doc>
- <source-position filename="gst/gstvalue.h" line="178"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="174">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VALUE_HOLDS_STRUCTURE"
- c:identifier="GST_VALUE_HOLDS_STRUCTURE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="148">Checks if the given #GValue contains a #GST_TYPE_STRUCTURE value.</doc>
- <source-position filename="gst/gstvalue.h" line="154"/>
- <parameters>
- <parameter name="x">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="150">the #GValue to check</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VALUE_LESS_THAN" value="-1" c:type="GST_VALUE_LESS_THAN">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="406">Indicates that the first value provided to a comparison function
-(gst_value_compare()) is lesser than the second one.</doc>
- <source-position filename="gst/gstvalue.h" line="412"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VALUE_UNORDERED" value="2" c:type="GST_VALUE_UNORDERED">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="430">Indicates that the comparison function (gst_value_compare()) can not
-determine a order for the two provided values.</doc>
- <source-position filename="gst/gstvalue.h" line="436"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VERSION_MAJOR" value="1" c:type="GST_VERSION_MAJOR">
- <doc xml:space="preserve"
- filename="gst/gstversion.h"
- line="46">The major version of GStreamer at compile time:</doc>
- <source-position filename="gst/gstversion.h" line="51"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VERSION_MICRO" value="0" c:type="GST_VERSION_MICRO">
- <doc xml:space="preserve"
- filename="gst/gstversion.h"
- line="58">The micro version of GStreamer at compile time:</doc>
- <source-position filename="gst/gstversion.h" line="63"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VERSION_MINOR" value="19" c:type="GST_VERSION_MINOR">
- <doc xml:space="preserve"
- filename="gst/gstversion.h"
- line="52">The minor version of GStreamer at compile time:</doc>
- <source-position filename="gst/gstversion.h" line="57"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VERSION_NANO" value="1" c:type="GST_VERSION_NANO">
- <doc xml:space="preserve"
- filename="gst/gstversion.h"
- line="64">The nano version of GStreamer at compile time:
-Actual releases have 0, GIT versions have 1, prerelease versions have 2-...</doc>
- <source-position filename="gst/gstversion.h" line="70"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <class name="ValueArray"
- c:symbol-prefix="value_array"
- c:type="GstValueArray"
- glib:type-name="GstValueArray"
- glib:get-type="gst_value_array_get_type"
- glib:fundamental="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="316">A fundamental type that describes an ordered list of #GValue</doc>
- <function name="append_and_take_value"
- c:identifier="gst_value_array_append_and_take_value"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="992">Appends @append_value to the GstValueArray in @value.</doc>
- <source-position filename="gst/gstvalue.h" line="607"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="994">a #GValue of type #GST_TYPE_ARRAY</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="append_value" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="995">the value to append</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="append_value"
- c:identifier="gst_value_array_append_value">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="964">Appends @append_value to the GstValueArray in @value.</doc>
- <source-position filename="gst/gstvalue.h" line="604"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="966">a #GValue of type #GST_TYPE_ARRAY</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="append_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="967">the value to append</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_size" c:identifier="gst_value_array_get_size">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1033">Gets the number of values contained in @value.</doc>
- <source-position filename="gst/gstvalue.h" line="613"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1039">the number of values</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1035">a #GValue of type #GST_TYPE_ARRAY</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_value" c:identifier="gst_value_array_get_value">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1049">Gets the value that is a member of the array contained in @value and
-has the index @index.</doc>
- <source-position filename="gst/gstvalue.h" line="616"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1057">the value at the given index</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1051">a #GValue of type #GST_TYPE_ARRAY</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1052">index of value to get from the array</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="init" c:identifier="gst_value_array_init" version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="323">Initializes and pre-allocates a #GValue of type #GST_VALUE_ARRAY.</doc>
- <source-position filename="gst/gstvalue.h" line="619"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="330">The #GValue structure that has been passed in</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="325">A zero-filled (uninitialized) #GValue structure</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="prealloc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="326">The number of entries to pre-allocate in the array</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="prepend_value"
- c:identifier="gst_value_array_prepend_value">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1012">Prepends @prepend_value to the GstValueArray in @value.</doc>
- <source-position filename="gst/gstvalue.h" line="610"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1014">a #GValue of type #GST_TYPE_ARRAY</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="prepend_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1015">the value to prepend</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- </class>
- <callback name="ValueCompareFunc" c:type="GstValueCompareFunc">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="438">Used together with gst_value_compare() to compare #GValue items.</doc>
- <source-position filename="gst/gstvalue.h" line="448"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="445">one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL, GST_VALUE_GREATER_THAN
-or GST_VALUE_UNORDERED</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="value1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="440">first value for comparison</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="value2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="441">second value for comparison</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="ValueDeserializeFunc" c:type="GstValueDeserializeFunc">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="463">Used by gst_value_deserialize() to parse a non-binary form into the #GValue.</doc>
- <source-position filename="gst/gstvalue.h" line="472"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="470">%TRUE for success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="465">a #GValue</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="s" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="466">a string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="ValueDeserializeWithPSpecFunc"
- c:type="GstValueDeserializeWithPSpecFunc"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="475">Used by gst_value_deserialize_with_pspec() to parse a non-binary form into the #GValue.</doc>
- <source-position filename="gst/gstvalue.h" line="486"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="483">%TRUE for success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="477">a #GValue</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="s" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="478">a string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="pspec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="479">a #GParamSpec describing the expected value</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- </parameters>
- </callback>
- <class name="ValueList"
- c:symbol-prefix="value_list"
- glib:type-name="GstValueList"
- glib:get-type="gst_value_list_get_type"
- glib:fundamental="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="295">A fundamental type that describes an unordered list of #GValue</doc>
- <function name="append_and_take_value"
- c:identifier="gst_value_list_append_and_take_value"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="663">Appends @append_value to the GstValueList in @value.</doc>
- <source-position filename="gst/gstvalue.h" line="578"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="665">a #GValue of type #GST_TYPE_LIST</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="append_value" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="666">the value to append</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="append_value" c:identifier="gst_value_list_append_value">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="683">Appends @append_value to the GstValueList in @value.</doc>
- <source-position filename="gst/gstvalue.h" line="575"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="685">a #GValue of type #GST_TYPE_LIST</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="append_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="686">the value to append</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="concat" c:identifier="gst_value_list_concat">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="725">Concatenates copies of @value1 and @value2 into a list. Values that are not
-of type #GST_TYPE_LIST are treated as if they were lists of length 1.
-@dest will be initialized to the type #GST_TYPE_LIST.</doc>
- <source-position filename="gst/gstvalue.h" line="584"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="727">an uninitialized #GValue to take the result</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="value1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="728">a #GValue</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="value2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="729">a #GValue</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_size" c:identifier="gst_value_list_get_size">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="929">Gets the number of values contained in @value.</doc>
- <source-position filename="gst/gstvalue.h" line="592"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="935">the number of values</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="931">a #GValue of type #GST_TYPE_LIST</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_value" c:identifier="gst_value_list_get_value">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="945">Gets the value that is a member of the list contained in @value and
-has the index @index.</doc>
- <source-position filename="gst/gstvalue.h" line="595"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="953">the value at the given index</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="947">a #GValue of type #GST_TYPE_LIST</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="948">index of value to get from the list</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="init" c:identifier="gst_value_list_init" version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="292">Initializes and pre-allocates a #GValue of type #GST_VALUE_LIST.</doc>
- <source-position filename="gst/gstvalue.h" line="599"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="299">The #GValue structure that has been passed in</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="294">A zero-filled (uninitialized) #GValue structure</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="prealloc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="295">The number of entries to pre-allocate in the list</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="merge" c:identifier="gst_value_list_merge">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="828">Merges copies of @value1 and @value2. Values that are not
-of type #GST_TYPE_LIST are treated as if they were lists of length 1.
-
-The result will be put into @dest and will either be a list that will not
-contain any duplicates, or a non-list type (if @value1 and @value2
-were equal).</doc>
- <source-position filename="gst/gstvalue.h" line="588"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="830">an uninitialized #GValue to take the result</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="value1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="831">a #GValue</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="value2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="832">a #GValue</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="prepend_value"
- c:identifier="gst_value_list_prepend_value">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="704">Prepends @prepend_value to the GstValueList in @value.</doc>
- <source-position filename="gst/gstvalue.h" line="581"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="706">a #GValue of type #GST_TYPE_LIST</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="prepend_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="707">the value to prepend</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- </class>
- <callback name="ValueSerializeFunc" c:type="GstValueSerializeFunc">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="451">Used by gst_value_serialize() to obtain a non-binary form of the #GValue.
-
-Free-function: g_free</doc>
- <source-position filename="gst/gstvalue.h" line="461"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="459">the string representation of the value</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="value1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="453">a #GValue</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="ValueTable" c:type="GstValueTable">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="492">VTable for the #GValue @type.</doc>
- <source-position filename="gst/gstvalue.h" line="519"/>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="494">a #GType</doc>
- <type name="GType" c:type="GType"/>
- </field>
- <field name="compare" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="495">a #GstValueCompareFunc</doc>
- <type name="ValueCompareFunc" c:type="GstValueCompareFunc"/>
- </field>
- <field name="serialize" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="496">a #GstValueSerializeFunc</doc>
- <type name="ValueSerializeFunc" c:type="GstValueSerializeFunc"/>
- </field>
- <field name="deserialize" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="497">a #GstValueDeserializeFunc</doc>
- <type name="ValueDeserializeFunc" c:type="GstValueDeserializeFunc"/>
- </field>
- <field name="deserialize_with_pspec" version="1.20" writable="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.h"
- line="508">a #GstValueDeserializeWithPSpecFunc</doc>
- <type name="ValueDeserializeWithPSpecFunc"
- c:type="GstValueDeserializeWithPSpecFunc"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <function-macro name="WRITE_UINT16_BE"
- c:identifier="GST_WRITE_UINT16_BE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="507">Store a 16 bit unsigned integer value in big endian format into the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="523"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="509">memory location</doc>
- </parameter>
- <parameter name="val">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="510">value to store</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WRITE_UINT16_LE"
- c:identifier="GST_WRITE_UINT16_LE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="514">Store a 16 bit unsigned integer value in little endian format into the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="524"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="516">memory location</doc>
- </parameter>
- <parameter name="val">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="517">value to store</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WRITE_UINT24_BE"
- c:identifier="GST_WRITE_UINT24_BE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="477">Store a 24 bit unsigned integer value in big endian format into the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="484"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="479">memory location</doc>
- </parameter>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="480">value to store</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WRITE_UINT24_LE"
- c:identifier="GST_WRITE_UINT24_LE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="492">Store a 24 bit unsigned integer value in little endian format into the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="499"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="494">memory location</doc>
- </parameter>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="495">value to store</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WRITE_UINT32_BE"
- c:identifier="GST_WRITE_UINT32_BE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="435">Store a 32 bit unsigned integer value in big endian format into the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="451"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="437">memory location</doc>
- </parameter>
- <parameter name="val">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="438">value to store</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WRITE_UINT32_LE"
- c:identifier="GST_WRITE_UINT32_LE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="442">Store a 32 bit unsigned integer value in little endian format into the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="452"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="444">memory location</doc>
- </parameter>
- <parameter name="val">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="445">value to store</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WRITE_UINT64_BE"
- c:identifier="GST_WRITE_UINT64_BE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="385">Store a 64 bit unsigned integer value in big endian format into the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="401"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="387">memory location</doc>
- </parameter>
- <parameter name="val">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="388">value to store</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WRITE_UINT64_LE"
- c:identifier="GST_WRITE_UINT64_LE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="392">Store a 64 bit unsigned integer value in little endian format into the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="402"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="394">memory location</doc>
- </parameter>
- <parameter name="val">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="395">value to store</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WRITE_UINT8"
- c:identifier="GST_WRITE_UINT8"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="545">Store an 8 bit unsigned integer value into the memory buffer.</doc>
- <source-position filename="gst/gstutils.h" line="552"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="547">memory location</doc>
- </parameter>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="548">value to store</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="buffer_get_max_memory"
- c:identifier="gst_buffer_get_max_memory"
- moved-to="Buffer.get_max_memory"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="500">Get the maximum amount of memory blocks that a buffer can hold. This is a
-compile time constant that can be queried with the function.
-
-When more memory blocks are added, existing memory blocks will be merged
-together to make room for the new block.</doc>
- <source-position filename="gst/gstbuffer.h" line="284"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="509">the maximum amount of memory blocks that a buffer can hold.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- </function>
- <function-macro name="buffer_get_parent_buffer_meta"
- c:identifier="gst_buffer_get_parent_buffer_meta"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="736">Find and return a #GstParentBufferMeta if one exists on the
-buffer</doc>
- <source-position filename="gst/gstbuffer.h" line="742"/>
- <parameters>
- <parameter name="b">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="738">a #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_get_protection_meta"
- c:identifier="gst_buffer_get_protection_meta"
- introspectable="0">
- <source-position filename="gst/gstprotection.h" line="81"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_is_writable"
- c:identifier="gst_buffer_is_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="545">Tests if you can safely write to a buffer's metadata or its memory array.
-It is only safe to change buffer metadata when the current reference is
-writable, i.e. nobody can see the modifications you will make.</doc>
- <source-position filename="gst/gstbuffer.h" line="552"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="547">a #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_list_add"
- c:identifier="gst_buffer_list_add"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="402">Append @b at the end of @l.</doc>
- <source-position filename="gst/gstbufferlist.h" line="239"/>
- <parameters>
- <parameter name="l">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="404">a #GstBufferList</doc>
- </parameter>
- <parameter name="b">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.c"
- line="405">a #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_list_is_writable"
- c:identifier="gst_buffer_list_is_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="182">Tests if you can safely add buffers and groups into a buffer list.</doc>
- <source-position filename="gst/gstbufferlist.h" line="188"/>
- <parameters>
- <parameter name="list">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="184">a #GstBufferList</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_list_make_writable"
- c:identifier="gst_buffer_list_make_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="190">Makes a writable buffer list from the given buffer list. If the source buffer
-list is already writable, this will simply return the same buffer list. A
-copy will otherwise be made using gst_buffer_list_copy().</doc>
- <source-position filename="gst/gstbufferlist.h" line="201"/>
- <parameters>
- <parameter name="list">
- <doc xml:space="preserve"
- filename="gst/gstbufferlist.h"
- line="192">a #GstBufferList</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_make_writable"
- c:identifier="gst_buffer_make_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="554">Returns a writable copy of @buf. If the source buffer is
-already writable, this will simply return the same buffer.
-
-Use this function to ensure that a buffer can be safely modified before
-making changes to it, including changing the metadata such as PTS/DTS.
-
-If the reference count of the source buffer @buf is exactly one, the caller
-is the sole owner and this function will return the buffer object unchanged.
-
-If there is more than one reference on the object, a copy will be made using
-gst_buffer_copy(). The passed-in @buf will be unreffed in that case, and the
-caller will now own a reference to the new returned buffer object. Note
-that this just copies the buffer structure itself, the underlying memory is
-not copied if it can be shared amongst multiple buffers.
-
-In short, this function unrefs the buf in the argument and refs the buffer
-that it returns. Don't access the argument after calling this function unless
-you have an additional reference to it.</doc>
- <source-position filename="gst/gstbuffer.h" line="579"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="556">a #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_new_and_alloc"
- c:identifier="gst_buffer_new_and_alloc"
- introspectable="0">
- <source-position filename="gst/gstcompat.h" line="42"/>
- <parameters>
- <parameter name="s">
- </parameter>
- </parameters>
- </function-macro>
- <function name="buffer_replace"
- c:identifier="gst_buffer_replace"
- moved-to="Buffer.replace"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="582">Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
-modification is done atomically (so this is useful for ensuring thread safety
-in some cases), and the reference counts are updated appropriately (the old
-buffer is unreffed, the new is reffed).
-
-Either @nbuf or the #GstBuffer pointed to by @obuf may be %NULL.</doc>
- <source-position filename="gst/gstbuffer.h" line="598"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="596">%TRUE when @obuf was different from @nbuf.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="obuf"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="584">pointer to a pointer to
- a #GstBuffer to be replaced.</doc>
- <type name="Buffer" c:type="GstBuffer**"/>
- </parameter>
- <parameter name="nbuf"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="586">pointer to a #GstBuffer that will
- replace the buffer pointed to by @obuf.</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="calculate_linear_regression"
- c:identifier="gst_calculate_linear_regression"
- version="1.12"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4278">Calculates the linear regression of the values @xy and places the
-result in @m_num, @m_denom, @b and @xbase, representing the function
- y(x) = m_num/m_denom * (x - xbase) + b
-that has the least-square distance from all points @x and @y.
-
-@r_squared will contain the remaining error.
-
-If @temp is not %NULL, it will be used as temporary space for the function,
-in which case the function works without any allocation at all. If @temp is
-%NULL, an allocation will take place. @temp should have at least the same
-amount of memory allocated as @xy, i.e. 2*n*sizeof(GstClockTime).
-
-&gt; This function assumes (x,y) values with reasonable large differences
-&gt; between them. It will not calculate the exact results if the differences
-&gt; between neighbouring values are too small due to not being able to
-&gt; represent sub-integer values during the calculations.</doc>
- <source-position filename="gst/gstutils.h" line="1216"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4306">%TRUE if the linear regression was successfully calculated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="xy" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4280">Pairs of (x,y) values</doc>
- <type name="ClockTime" c:type="const GstClockTime*"/>
- </parameter>
- <parameter name="temp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4281">Temporary scratch space used by the function</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4282">number of (x,y) pairs</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="m_num"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4283">numerator of calculated slope</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="m_denom"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4284">denominator of calculated slope</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="b"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4285">Offset at Y-axis</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="xbase"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4286">Offset at X-axis</doc>
- <type name="ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="r_squared"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4287">R-squared</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </function>
- <function name="caps_features_from_string"
- c:identifier="gst_caps_features_from_string"
- moved-to="CapsFeatures.from_string"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="486">Creates a #GstCapsFeatures from a string representation.
-
-Free-function: gst_caps_features_free</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="85"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="494">a new #GstCapsFeatures or
- %NULL when the string could not be parsed. Free with
- gst_caps_features_free() after use.</doc>
- <type name="CapsFeatures" c:type="GstCapsFeatures*"/>
- </return-value>
- <parameters>
- <parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="488">a string representation of a #GstCapsFeatures.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="caps_from_string"
- c:identifier="gst_caps_from_string"
- moved-to="Caps.from_string">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2476">Converts @caps from a string representation.
-
-The current implementation of serialization will lead to unexpected results
-when there are nested #GstCaps / #GstStructure deeper than one level.</doc>
- <source-position filename="gst/gstcaps.h" line="581"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2485">a newly allocated #GstCaps</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="string" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.c"
- line="2478">a string to convert to #GstCaps</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="caps_is_writable"
- c:identifier="gst_caps_is_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="253">Tests if you can safely modify @caps. It is only safe to modify caps when
-there is only one owner of the caps - ie, the object is writable.</doc>
- <source-position filename="gst/gstcaps.h" line="260"/>
- <parameters>
- <parameter name="caps">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="255">a #GstCaps</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="caps_make_writable"
- c:identifier="gst_caps_make_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="262">Returns a writable copy of @caps.
-
-If there is only one reference count on @caps, the caller must be the owner,
-and so this function will return the caps object unchanged. If on the other
-hand there is more than one reference on the object, a new caps object will
-be returned. The caller's reference on @caps will be removed, and instead the
-caller will own a reference to the returned object.
-
-In short, this function unrefs the caps in the argument and refs the caps
-that it returns. Don't access the argument after calling this function. See
-also: gst_caps_ref().</doc>
- <source-position filename="gst/gstcaps.h" line="281"/>
- <parameters>
- <parameter name="caps">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="264">a #GstCaps</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="caps_replace"
- c:identifier="gst_caps_replace"
- moved-to="Caps.replace"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="283">Modifies a pointer to a #GstCaps to point to a different #GstCaps. The
-modification is done atomically (so this is useful for ensuring thread safety
-in some cases), and the reference counts are updated appropriately (the old
-caps is unreffed, the new is reffed).
-
-Either @new_caps or the #GstCaps pointed to by @old_caps may be %NULL.</doc>
- <source-position filename="gst/gstcaps.h" line="299"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="297">%TRUE if @new_caps was different from @old_caps</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="old_caps"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="285">pointer to a pointer
- to a #GstCaps to be replaced.</doc>
- <type name="Caps" c:type="GstCaps**"/>
- </parameter>
- <parameter name="new_caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="287">pointer to a #GstCaps that will
- replace the caps pointed to by @old_caps.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="caps_take"
- c:identifier="gst_caps_take"
- moved-to="Caps.take"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="306">Modifies a pointer to a #GstCaps to point to a different #GstCaps. This
-function is similar to gst_caps_replace() except that it takes ownership
-of @new_caps.</doc>
- <source-position filename="gst/gstcaps.h" line="319"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="317">%TRUE if @new_caps was different from @old_caps</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="old_caps"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="308">pointer to a pointer to a #GstCaps to be
- replaced.</doc>
- <type name="Caps" c:type="GstCaps**"/>
- </parameter>
- <parameter name="new_caps"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstcaps.h"
- line="310">pointer to a #GstCaps that will
- replace the caps pointed to by @old_caps.</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="clear_mini_object"
- c:identifier="gst_clear_mini_object"
- version="1.16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="676">Clears a reference to a #GstMiniObject.
-
-@object_ptr must not be %NULL.
-
-If the reference is %NULL then this function does nothing.
-Otherwise, the reference count of the object is decreased using
-gst_mini_object_unref() and the pointer is set to %NULL.
-
-A macro is also included that allows this function to be used without
-pointer casts.</doc>
- <source-position filename="gst/gstminiobject.h" line="238"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object_ptr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="678">a pointer to a #GstMiniObject reference</doc>
- <type name="MiniObject" c:type="GstMiniObject**"/>
- </parameter>
- </parameters>
- </function>
- <function name="clear_object"
- c:identifier="gst_clear_object"
- version="1.16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="299">Clears a reference to a #GstObject.
-
-@object_ptr must not be %NULL.
-
-If the reference is %NULL then this function does nothing.
-Otherwise, the reference count of the object is decreased using
-gst_object_unref() and the pointer is set to %NULL.
-
-A macro is also included that allows this function to be used without
-pointer casts.</doc>
- <source-position filename="gst/gstobject.h" line="258"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object_ptr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstobject.c"
- line="301">a pointer to a #GstObject reference</doc>
- <type name="Object" c:type="GstObject**"/>
- </parameter>
- </parameters>
- </function>
- <function name="clear_structure"
- c:identifier="gst_clear_structure"
- version="1.16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="549">Clears a reference to a #GstStructure.
-
-@structure_ptr must not be %NULL.
-
-If the reference is %NULL then this function does nothing.
-Otherwise, the structure is free'd using gst_structure_free() and the
-pointer is set to %NULL.
-
-A macro is also included that allows this function to be used without
-pointer casts.</doc>
- <source-position filename="gst/gststructure.h" line="137"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="structure_ptr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="551">a pointer to a #GstStructure reference</doc>
- <type name="Structure" c:type="GstStructure**"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="context_is_writable"
- c:identifier="gst_context_is_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcontext.h"
- line="94">Tests if you can safely write into a context's structure or validly
-modify the seqnum and timestamp fields.</doc>
- <source-position filename="gst/gstcontext.h" line="101"/>
- <parameters>
- <parameter name="context">
- <doc xml:space="preserve"
- filename="gst/gstcontext.h"
- line="96">a #GstContext</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="context_make_writable"
- c:identifier="gst_context_make_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstcontext.h"
- line="102">Checks if a context is writable. If not, a writable copy is made and
-returned.</doc>
- <source-position filename="gst/gstcontext.h" line="113"/>
- <parameters>
- <parameter name="context">
- <doc xml:space="preserve"
- filename="gst/gstcontext.h"
- line="104">the context to make writable</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="core_error_quark"
- c:identifier="gst_core_error_quark"
- moved-to="CoreError.quark">
- <attribute name="doc.skip" value="true"/>
- <return-value transfer-ownership="none">
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- <function name="debug_add_log_function"
- c:identifier="gst_debug_add_log_function">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1374">Adds the logging function to the list of logging functions.
-Be sure to use #G_GNUC_NO_INSTRUMENT on that function, it is needed.</doc>
- <source-position filename="gst/gstinfo.h" line="440"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="func"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1376">the function to use</doc>
- <type name="LogFunction" c:type="GstLogFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1377">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1378">called when @user_data is not used anymore</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_add_ring_buffer_logger"
- c:identifier="gst_debug_add_ring_buffer_logger"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="3365">Adds a memory ringbuffer based debug logger that stores up to
-@max_size_per_thread bytes of logs per thread and times out threads after
-@thread_timeout seconds of inactivity.
-
-Logs can be fetched with gst_debug_ring_buffer_logger_get_logs() and the
-logger can be removed again with gst_debug_remove_ring_buffer_logger().
-Only one logger at a time is possible.</doc>
- <source-position filename="gst/gstinfo.h" line="1794"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="max_size_per_thread" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="3367">Maximum size of log per thread in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="thread_timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="3368">Timeout for threads in seconds</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_bin_to_dot_data"
- c:identifier="gst_debug_bin_to_dot_data">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.c"
- line="796">To aid debugging applications one can use this method to obtain the whole
-network of gstreamer elements that form the pipeline into an dot file.
-This data can be processed with graphviz to get an image.</doc>
- <source-position filename="gst/gstdebugutils.h" line="65"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.c"
- line="805">a string containing the pipeline in graphviz
-dot format.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.c"
- line="798">the top-level pipeline that should be analyzed</doc>
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="details" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.c"
- line="799">type of #GstDebugGraphDetails to use</doc>
- <type name="DebugGraphDetails" c:type="GstDebugGraphDetails"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_bin_to_dot_file"
- c:identifier="gst_debug_bin_to_dot_file">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.c"
- line="824">To aid debugging applications one can use this method to write out the whole
-network of gstreamer elements that form the pipeline into an dot file.
-This file can be processed with graphviz to get an image.
-
-``` shell
- dot -Tpng -oimage.png graph_lowlevel.dot
-```</doc>
- <source-position filename="gst/gstdebugutils.h" line="68"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.c"
- line="826">the top-level pipeline that should be analyzed</doc>
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="details" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.c"
- line="827">type of #GstDebugGraphDetails to use</doc>
- <type name="DebugGraphDetails" c:type="GstDebugGraphDetails"/>
- </parameter>
- <parameter name="file_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.c"
- line="828">output base filename (e.g. "myplayer")</doc>
- <type name="filename" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_bin_to_dot_file_with_ts"
- c:identifier="gst_debug_bin_to_dot_file_with_ts">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.c"
- line="876">This works like gst_debug_bin_to_dot_file(), but adds the current timestamp
-to the filename, so that it can be used to take multiple snapshots.</doc>
- <source-position filename="gst/gstdebugutils.h" line="71"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="bin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.c"
- line="878">the top-level pipeline that should be analyzed</doc>
- <type name="Bin" c:type="GstBin*"/>
- </parameter>
- <parameter name="details" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.c"
- line="879">type of #GstDebugGraphDetails to use</doc>
- <type name="DebugGraphDetails" c:type="GstDebugGraphDetails"/>
- </parameter>
- <parameter name="file_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdebugutils.c"
- line="880">output base filename (e.g. "myplayer")</doc>
- <type name="filename" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_construct_term_color"
- c:identifier="gst_debug_construct_term_color">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="955">Constructs a string that can be used for getting the desired color in color
-terminals.
-You need to free the string after use.</doc>
- <source-position filename="gst/gstinfo.h" line="512"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="963">a string containing the color
- definition</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="colorinfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="957">the color info</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_construct_win_color"
- c:identifier="gst_debug_construct_win_color">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="991">Constructs an integer that can be used for getting the desired color in
-windows' terminals (cmd.exe). As there is no mean to underline, we simply
-ignore this attribute.
-
-This function returns 0 on non-windows machines.</doc>
- <source-position filename="gst/gstinfo.h" line="515"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1001">an integer containing the color definition</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="colorinfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="993">the color info</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_get_all_categories"
- c:identifier="gst_debug_get_all_categories">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1937">Returns a snapshot of a all categories that are currently in use . This list
-may change anytime.
-The caller has to free the list after use.</doc>
- <source-position filename="gst/gstinfo.h" line="508"/>
- <return-value transfer-ownership="container">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1944">the list of
- debug categories</doc>
- <type name="GLib.SList" c:type="GSList*">
- <type name="DebugCategory"/>
- </type>
- </return-value>
- </function>
- <function name="debug_get_color_mode"
- c:identifier="gst_debug_get_color_mode"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1597">Changes the coloring mode for debug output.</doc>
- <source-position filename="gst/gstinfo.h" line="468"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1602">see @GstDebugColorMode for possible values.</doc>
- <type name="DebugColorMode" c:type="GstDebugColorMode"/>
- </return-value>
- </function>
- <function name="debug_get_default_threshold"
- c:identifier="gst_debug_get_default_threshold">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1661">Returns the default threshold that is used for new categories.</doc>
- <source-position filename="gst/gstinfo.h" line="474"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1666">the default threshold level</doc>
- <type name="DebugLevel" c:type="GstDebugLevel"/>
- </return-value>
- </function>
- <function name="debug_get_stack_trace"
- c:identifier="gst_debug_get_stack_trace"
- version="1.12">
- <source-position filename="gst/gstinfo.h" line="1791"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="3097">a stack trace, if libunwind or glibc backtrace are
-present, else %NULL.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="3094">A set of #GstStackTraceFlags to determine how the stack trace should
-look like. Pass #GST_STACK_TRACE_SHOW_NONE to retrieve a minimal backtrace.</doc>
- <type name="StackTraceFlags" c:type="GstStackTraceFlags"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_is_active" c:identifier="gst_debug_is_active">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1632">Checks if debugging output is activated.</doc>
- <source-position filename="gst/gstinfo.h" line="453"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1637">%TRUE, if debugging is activated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="debug_is_colored" c:identifier="gst_debug_is_colored">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1583">Checks if the debugging output should be colored.</doc>
- <source-position filename="gst/gstinfo.h" line="465"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1588">%TRUE, if the debug output should be colored.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="debug_level_get_name"
- c:identifier="gst_debug_level_get_name"
- moved-to="DebugLevel.get_name">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1338">Get the string representation of a debugging level</doc>
- <source-position filename="gst/gstinfo.h" line="437"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1344">the name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1340">the level to get the name for</doc>
- <type name="DebugLevel" c:type="GstDebugLevel"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_log" c:identifier="gst_debug_log" introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="458">Logs the given message using the currently registered debugging handlers.</doc>
- <source-position filename="gst/gstinfo.h" line="358"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="460">category to log</doc>
- <type name="DebugCategory" c:type="GstDebugCategory*"/>
- </parameter>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="461">level of the message is in</doc>
- <type name="DebugLevel" c:type="GstDebugLevel"/>
- </parameter>
- <parameter name="file" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="462">the file that emitted the message, usually the __FILE__ identifier</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="function" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="463">the function that emitted the message</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="line" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="464">the line from that the message was emitted, usually __LINE__</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="object"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="465">the object this message relates to,
- or %NULL if none</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="467">a printf style format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="468">optional arguments for the format</doc>
- <varargs/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_log_default" c:identifier="gst_debug_log_default">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1217">The default logging handler used by GStreamer. Logging functions get called
-whenever a macro like GST_DEBUG or similar is used. By default this function
-is setup to output the message and additional info to stderr (or the log file
-specified via the GST_DEBUG_FILE environment variable) as received via
-@user_data.
-
-You can add other handlers by using gst_debug_add_log_function().
-And you can remove this handler by calling
-gst_debug_remove_log_function(gst_debug_log_default);</doc>
- <source-position filename="gst/gstinfo.h" line="427"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1219">category to log</doc>
- <type name="DebugCategory" c:type="GstDebugCategory*"/>
- </parameter>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1220">level of the message</doc>
- <type name="DebugLevel" c:type="GstDebugLevel"/>
- </parameter>
- <parameter name="file" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1221">the file that emitted the message, usually the __FILE__ identifier</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="function" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1222">the function that emitted the message</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="line" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1223">the line from that the message was emitted, usually __LINE__</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="object"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1225">the object this message relates to,
- or %NULL if none</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1224">the actual message</doc>
- <type name="DebugMessage" c:type="GstDebugMessage*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1227">the FILE* to log to</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_log_get_line"
- c:identifier="gst_debug_log_get_line"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1139">Returns the string representation for the specified debug log message
-formatted in the same way as gst_debug_log_default() (the default handler),
-without color. The purpose is to make it easy for custom log output
-handlers to get a log output that is identical to what the default handler
-would write out.</doc>
- <source-position filename="gst/gstinfo.h" line="418"/>
- <return-value transfer-ownership="full">
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1141">category to log</doc>
- <type name="DebugCategory" c:type="GstDebugCategory*"/>
- </parameter>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1142">level of the message</doc>
- <type name="DebugLevel" c:type="GstDebugLevel"/>
- </parameter>
- <parameter name="file" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1143">the file that emitted the message, usually the __FILE__ identifier</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="function" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1144">the function that emitted the message</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="line" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1145">the line from that the message was emitted, usually __LINE__</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="object"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1146">the object this message relates to,
- or %NULL if none</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1148">the actual message</doc>
- <type name="DebugMessage" c:type="GstDebugMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_log_valist"
- c:identifier="gst_debug_log_valist"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="508">Logs the given message using the currently registered debugging handlers.</doc>
- <source-position filename="gst/gstinfo.h" line="367"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="510">category to log</doc>
- <type name="DebugCategory" c:type="GstDebugCategory*"/>
- </parameter>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="511">level of the message is in</doc>
- <type name="DebugLevel" c:type="GstDebugLevel"/>
- </parameter>
- <parameter name="file" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="512">the file that emitted the message, usually the __FILE__ identifier</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="function" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="513">the function that emitted the message</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="line" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="514">the line from that the message was emitted, usually __LINE__</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="object"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="515">the object this message relates to,
- or %NULL if none</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="517">a printf style format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="518">optional arguments for the format</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_print_stack_trace"
- c:identifier="gst_debug_print_stack_trace">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="3127">If libunwind, glibc backtrace or DbgHelp are present
-a stack trace is printed.</doc>
- <source-position filename="gst/gstinfo.h" line="1788"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </function>
- <function name="debug_remove_log_function"
- c:identifier="gst_debug_remove_log_function">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1466">Removes all registered instances of the given logging functions.</doc>
- <source-position filename="gst/gstinfo.h" line="444"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1473">How many instances of the function were removed</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="func"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="call">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1468">the log function to remove, or %NULL to
- remove the default log function</doc>
- <type name="LogFunction" c:type="GstLogFunction"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_remove_log_function_by_data"
- c:identifier="gst_debug_remove_log_function_by_data">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1502">Removes all registered instances of log functions with the given user data.</doc>
- <source-position filename="gst/gstinfo.h" line="447"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1508">How many instances of the function were removed</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1504">user data of the log function to remove</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_remove_ring_buffer_logger"
- c:identifier="gst_debug_remove_ring_buffer_logger"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="3406">Removes any previously added ring buffer logger with
-gst_debug_add_ring_buffer_logger().</doc>
- <source-position filename="gst/gstinfo.h" line="1796"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </function>
- <function name="debug_ring_buffer_logger_get_logs"
- c:identifier="gst_debug_ring_buffer_logger_get_logs"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="3299">Fetches the current logs per thread from the ring buffer logger. See
-gst_debug_add_ring_buffer_logger() for details.</doc>
- <source-position filename="gst/gstinfo.h" line="1798"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="3305">NULL-terminated array of
-strings with the debug output per thread</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- </function>
- <function name="debug_set_active" c:identifier="gst_debug_set_active">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1612">If activated, debugging messages are sent to the debugging
-handlers.
-It makes sense to deactivate it for speed issues.
-&gt; This function is not threadsafe. It makes sense to only call it
-during initialization.</doc>
- <source-position filename="gst/gstinfo.h" line="450"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1614">Whether to use debugging output or not</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_set_color_mode"
- c:identifier="gst_debug_set_color_mode"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1545">Changes the coloring mode for debug output.
-
-This function may be called before gst_init().</doc>
- <source-position filename="gst/gstinfo.h" line="459"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1547">The coloring mode for debug output. See @GstDebugColorMode.</doc>
- <type name="DebugColorMode" c:type="GstDebugColorMode"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_set_color_mode_from_string"
- c:identifier="gst_debug_set_color_mode_from_string"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1561">Changes the coloring mode for debug output.
-
-This function may be called before gst_init().</doc>
- <source-position filename="gst/gstinfo.h" line="462"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1563">The coloring mode for debug output. One of the following:
-"on", "auto", "off", "disable", "unix".</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_set_colored" c:identifier="gst_debug_set_colored">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1527">Sets or unsets the use of coloured debugging output.
-Same as gst_debug_set_color_mode () with the argument being
-being GST_DEBUG_COLOR_MODE_ON or GST_DEBUG_COLOR_MODE_OFF.
-
-This function may be called before gst_init().</doc>
- <source-position filename="gst/gstinfo.h" line="456"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="colored" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1529">Whether to use colored output or not</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_set_default_threshold"
- c:identifier="gst_debug_set_default_threshold">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1645">Sets the default threshold to the given level and updates all categories to
-use this threshold.
-
-This function may be called before gst_init().</doc>
- <source-position filename="gst/gstinfo.h" line="471"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1647">level to set</doc>
- <type name="DebugLevel" c:type="GstDebugLevel"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_set_threshold_for_name"
- c:identifier="gst_debug_set_threshold_for_name">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1724">Sets all categories which match the given glob style pattern to the given
-level.</doc>
- <source-position filename="gst/gstinfo.h" line="477"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1726">name of the categories to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1727">level to set them to</doc>
- <type name="DebugLevel" c:type="GstDebugLevel"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_set_threshold_from_string"
- c:identifier="gst_debug_set_threshold_from_string"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2043">Sets the debug logging wanted in the same form as with the GST_DEBUG
-environment variable. You can use wildcards such as '*', but note that
-the order matters when you use wild cards, e.g. "foosrc:6,*src:3,*:2" sets
-everything to log level 2.</doc>
- <source-position filename="gst/gstinfo.h" line="480"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2045">comma-separated list of "category:level" pairs to be used
- as debug logging levels</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="reset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2047">%TRUE to clear all previously-set debug levels before setting
- new thresholds
-%FALSE if adding the threshold described by @list to the one already set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_unset_threshold_for_name"
- c:identifier="gst_debug_unset_threshold_for_name">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1752">Resets all categories with the given name back to the default level.</doc>
- <source-position filename="gst/gstinfo.h" line="483"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="1754">name of the categories to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="deinit" c:identifier="gst_deinit">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="1086">Clean up any resources created by GStreamer in gst_init().
-
-It is normally not needed to call this function in a normal application
-as the resources will automatically be freed when the program terminates.
-This function is therefore mostly used by testsuites and other memory
-profiling tools.
-
-After this call GStreamer (including this method) should not be used anymore.</doc>
- <source-position filename="gst/gst.h" line="113"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </function>
- <function name="dynamic_type_register"
- c:identifier="gst_dynamic_type_register"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst/gstdynamictypefactory.c"
- line="144">Registers a new #GstDynamicTypeFactory in the registry</doc>
- <source-position filename="gst/gstdynamictypefactory.h" line="57"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="plugin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdynamictypefactory.c"
- line="146">The #GstPlugin to register @dyn_type for</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstdynamictypefactory.c"
- line="147">The #GType to register dynamically</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="element_factory_get_author"
- c:identifier="gst_element_factory_get_author"
- introspectable="0">
- <source-position filename="gst/gstcompat.h" line="75"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="element_factory_get_description"
- c:identifier="gst_element_factory_get_description"
- introspectable="0">
- <source-position filename="gst/gstcompat.h" line="74"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="element_factory_get_documentation_uri"
- c:identifier="gst_element_factory_get_documentation_uri"
- introspectable="0">
- <source-position filename="gst/gstcompat.h" line="76"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="element_factory_get_icon_name"
- c:identifier="gst_element_factory_get_icon_name"
- introspectable="0">
- <source-position filename="gst/gstcompat.h" line="77"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="element_factory_get_klass"
- c:identifier="gst_element_factory_get_klass"
- introspectable="0">
- <source-position filename="gst/gstcompat.h" line="73"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="element_factory_get_longname"
- c:identifier="gst_element_factory_get_longname"
- introspectable="0">
- <source-position filename="gst/gstcompat.h" line="72"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="element_get_name"
- c:identifier="gst_element_get_name"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="797">Returns a copy of the name of @elem.
-Caller should g_free() the return value after usage.
-For a nameless element, this returns %NULL, which you can safely g_free()
-as well.</doc>
- <source-position filename="gst/gstelement.h" line="810"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="799">a #GstElement to get the name of @elem.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="element_get_parent"
- c:identifier="gst_element_get_parent"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="821">Get the parent of an element.</doc>
- <source-position filename="gst/gstelement.h" line="829"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="823">a #GstElement to get the parent of.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="element_set_name"
- c:identifier="gst_element_set_name"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="812">Sets the name of the element, getting rid of the old name if there was one.</doc>
- <source-position filename="gst/gstelement.h" line="819"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="814">a #GstElement to set the name of.</doc>
- </parameter>
- <parameter name="name">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="815">the new name</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="element_set_parent"
- c:identifier="gst_element_set_parent"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="831">Sets the parent of an element.</doc>
- <source-position filename="gst/gstelement.h" line="838"/>
- <parameters>
- <parameter name="elem">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="833">a #GstElement to set the parent of.</doc>
- </parameter>
- <parameter name="parent">
- <doc xml:space="preserve"
- filename="gst/gstelement.h"
- line="834">the new parent #GstObject of the element.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="error_get_message" c:identifier="gst_error_get_message">
- <doc xml:space="preserve"
- filename="gst/gsterror.c"
- line="286">Get a string describing the error message in the current locale.</doc>
- <source-position filename="gst/gsterror.h" line="246"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsterror.c"
- line="293">a newly allocated string describing
- the error message (in UTF-8 encoding)</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="domain" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsterror.c"
- line="288">the GStreamer error domain this error belongs to.</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="code" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsterror.c"
- line="289">the error code belonging to the domain.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="event_is_writable"
- c:identifier="gst_event_is_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="304">Tests if you can safely write data into a event's structure or validly
-modify the seqnum and timestamp field.</doc>
- <source-position filename="gst/gstevent.h" line="310"/>
- <parameters>
- <parameter name="ev">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="306">a #GstEvent</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="event_make_writable"
- c:identifier="gst_event_make_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="312">Makes a writable event from the given event. If the source event is
-already writable, this will simply return the same event. A copy will
-otherwise be made using gst_event_copy().</doc>
- <source-position filename="gst/gstevent.h" line="322"/>
- <parameters>
- <parameter name="ev">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="314">a #GstEvent</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="event_replace"
- c:identifier="gst_event_replace"
- moved-to="Event.replace"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="324">Modifies a pointer to a #GstEvent to point to a different #GstEvent. The
-modification is done atomically (so this is useful for ensuring thread safety
-in some cases), and the reference counts are updated appropriately (the old
-event is unreffed, the new one is reffed).
-
-Either @new_event or the #GstEvent pointed to by @old_event may be %NULL.</doc>
- <source-position filename="gst/gstevent.h" line="340"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="338">%TRUE if @new_event was different from @old_event</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="old_event"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="326">pointer to a
- pointer to a #GstEvent to be replaced.</doc>
- <type name="Event" c:type="GstEvent**"/>
- </parameter>
- <parameter name="new_event"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="328">pointer to a #GstEvent that will
- replace the event pointed to by @old_event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </function>
- <function name="event_steal"
- c:identifier="gst_event_steal"
- moved-to="Event.steal"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="347">Atomically replace the #GstEvent pointed to by @old_event with %NULL and
-return the original event.</doc>
- <source-position filename="gst/gstevent.h" line="357"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="355">the #GstEvent that was in @old_event</doc>
- <type name="Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="old_event"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="349">pointer to a
- pointer to a #GstEvent to be stolen.</doc>
- <type name="Event" c:type="GstEvent**"/>
- </parameter>
- </parameters>
- </function>
- <function name="event_take"
- c:identifier="gst_event_take"
- moved-to="Event.take"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="364">Modifies a pointer to a #GstEvent to point to a different #GstEvent. This
-function is similar to gst_event_replace() except that it takes ownership of
-@new_event.
-
-Either @new_event or the #GstEvent pointed to by @old_event may be %NULL.</doc>
- <source-position filename="gst/gstevent.h" line="379"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="377">%TRUE if @new_event was different from @old_event</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="old_event"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="366">pointer to a
- pointer to a #GstEvent to be stolen.</doc>
- <type name="Event" c:type="GstEvent**"/>
- </parameter>
- <parameter name="new_event"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstevent.h"
- line="368">pointer to a #GstEvent that will
- replace the event pointed to by @old_event.</doc>
- <type name="Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </function>
- <function name="event_type_get_flags"
- c:identifier="gst_event_type_get_flags"
- moved-to="EventType.get_flags">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="198">Gets the #GstEventTypeFlags associated with @type.</doc>
- <source-position filename="gst/gstevent.h" line="448"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="204">a #GstEventTypeFlags.</doc>
- <type name="EventTypeFlags" c:type="GstEventTypeFlags"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="200">a #GstEventType</doc>
- <type name="EventType" c:type="GstEventType"/>
- </parameter>
- </parameters>
- </function>
- <function name="event_type_get_name"
- c:identifier="gst_event_type_get_name"
- moved-to="EventType.get_name">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="158">Get a printable name for the given event type. Do not modify or free.</doc>
- <source-position filename="gst/gstevent.h" line="441"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="164">a reference to the static name of the event.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="160">the event type</doc>
- <type name="EventType" c:type="GstEventType"/>
- </parameter>
- </parameters>
- </function>
- <function name="event_type_to_quark"
- c:identifier="gst_event_type_to_quark"
- moved-to="EventType.to_quark">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="178">Get the unique quark for the given event type.</doc>
- <source-position filename="gst/gstevent.h" line="444"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="184">the quark associated with the event type</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstevent.c"
- line="180">the event type</doc>
- <type name="EventType" c:type="GstEventType"/>
- </parameter>
- </parameters>
- </function>
- <function name="filename_to_uri"
- c:identifier="gst_filename_to_uri"
- throws="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="893">Similar to g_filename_to_uri(), but attempts to handle relative file paths
-as well. Before converting @filename into an URI, it will be prefixed by
-the current working directory if it is a relative path, and then the path
-will be canonicalised so that it doesn't contain any './' or '../' segments.
-
-On Windows @filename should be in UTF-8 encoding.</doc>
- <source-position filename="gst/gsturi.h" line="158"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="905">newly-allocated URI string, or NULL on error. The caller must
- free the URI string with g_free() when no longer needed.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="filename" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="895">absolute or relative file name path</doc>
- <type name="filename" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="flow_get_name" c:identifier="gst_flow_get_name">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="226">Gets a string representing the given flow return.</doc>
- <source-position filename="gst/gstpad.h" line="186"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="232">a static string with the name of the flow return.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="ret" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="228">a #GstFlowReturn to get the name of.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </parameter>
- </parameters>
- </function>
- <function name="flow_to_quark" c:identifier="gst_flow_to_quark">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="248">Get the unique quark for the given GstFlowReturn.</doc>
- <source-position filename="gst/gstpad.h" line="189"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="254">the quark associated with the flow return or 0 if an
-invalid return was specified.</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- <parameters>
- <parameter name="ret" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="250">a #GstFlowReturn to get the quark of.</doc>
- <type name="FlowReturn" c:type="GstFlowReturn"/>
- </parameter>
- </parameters>
- </function>
- <function name="format_get_by_nick"
- c:identifier="gst_format_get_by_nick"
- moved-to="Format.get_by_nick">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="172">Return the format registered with the given nick.</doc>
- <source-position filename="gst/gstformat.h" line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="178">The format with @nick or GST_FORMAT_UNDEFINED
-if the format was not registered.</doc>
- <type name="Format" c:type="GstFormat"/>
- </return-value>
- <parameters>
- <parameter name="nick" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="174">The nick of the format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="format_get_details"
- c:identifier="gst_format_get_details"
- moved-to="Format.get_details">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="223">Get details about the given format.</doc>
- <source-position filename="gst/gstformat.h" line="119"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="229">The #GstFormatDefinition for @format or %NULL
-on failure.
-
-MT safe.</doc>
- <type name="FormatDefinition" c:type="const GstFormatDefinition*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="225">The format to get details of</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="format_get_name"
- c:identifier="gst_format_get_name"
- moved-to="Format.get_name">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="83">Get a printable name for the given format. Do not modify or free.</doc>
- <source-position filename="gst/gstformat.h" line="96"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="89">a reference to the static name of the format
-or %NULL if the format is unknown.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="85">a #GstFormat</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="format_iterate_definitions"
- c:identifier="gst_format_iterate_definitions"
- moved-to="Format.iterate_definitions">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="246">Iterate all the registered formats. The format definition is read
-only.</doc>
- <source-position filename="gst/gstformat.h" line="122"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="252">a GstIterator of #GstFormatDefinition.</doc>
- <type name="Iterator" c:type="GstIterator*"/>
- </return-value>
- </function>
- <function name="format_register"
- c:identifier="gst_format_register"
- moved-to="Format.register">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="129">Create a new GstFormat based on the nick or return an
-already registered format with that nick.</doc>
- <source-position filename="gst/gstformat.h" line="104"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="137">A new GstFormat or an already registered format
-with the same nick.
-
-MT safe.</doc>
- <type name="Format" c:type="GstFormat"/>
- </return-value>
- <parameters>
- <parameter name="nick" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="131">The nick of the new format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="132">The description of the new format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="format_to_quark"
- c:identifier="gst_format_to_quark"
- moved-to="Format.to_quark">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="106">Get the unique quark for the given format.</doc>
- <source-position filename="gst/gstformat.h" line="99"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="112">the quark associated with the format or 0 if the format
-is unknown.</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="108">a #GstFormat</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="formats_contains" c:identifier="gst_formats_contains">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="198">See if the given format is inside the format array.</doc>
- <source-position filename="gst/gstformat.h" line="113"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="205">%TRUE if the format is found inside the array</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="formats" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="200">The format array to search</doc>
- <array c:type="const GstFormat*">
- <type name="Format" c:type="GstFormat"/>
- </array>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="201">the format to find</doc>
- <type name="Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="gdouble_to_guint64"
- c:identifier="gst_gdouble_to_guint64"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="68">Convert @value to a guint64.</doc>
- <source-position filename="gst/gstutils.h" line="77"/>
- <parameters>
- <parameter name="value">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="70">the #gdouble value to convert</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="get_main_executable_path"
- c:identifier="gst_get_main_executable_path"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="367">This helper is mostly helpful for plugins that need to
-inspect the folder of the main executable to determine
-their set of features.
-
-When a plugin is initialized from the gst-plugin-scanner
-external process, the returned path will be the same as from the
-parent process.</doc>
- <source-position filename="gst/gst.h" line="137"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="378">The path of the executable that
- initialized GStreamer, or %NULL if it could not be determined.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- </function>
- <docsection name="gst">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="23">GStreamer is a framework for constructing graphs of various filters
-(termed elements here) that will handle streaming media. Any discrete
-(packetizable) media type is supported, with provisions for automatically
-determining source type. Formatting/framing information is provided with
-a powerful negotiation framework. Plugins are heavily used to provide for
-all elements, allowing one to construct plugins outside of the GST
-library, even released binary-only if license require (please don't).
-GStreamer covers a wide range of use cases including: playback, recording,
-editing, serving streams, voice over ip and video calls.
-
-The `GStreamer` library should be initialized with
-gst_init() before it can be used. You should pass pointers to the main argc
-and argv variables so that GStreamer can process its own command line
-options, as shown in the following example.
-
-## Initializing the gstreamer library
-
-|[ &lt;!-- language="C" --&gt;
-int
-main (int argc, char *argv[])
-{
- // initialize the GStreamer library
- gst_init (&amp;amp;argc, &amp;amp;argv);
- ...
-}
-]|
-
-It's allowed to pass two %NULL pointers to gst_init() in case you don't want
-to pass the command line args to GStreamer.
-
-You can also use GOption to initialize your own parameters as shown in
-the next code fragment:
-
-## Initializing own parameters when initializing gstreamer
-|[ &lt;!-- language="C" --&gt;
-static gboolean stats = FALSE;
-...
-int
-main (int argc, char *argv[])
-{
- GOptionEntry options[] = {
- {"tags", 't', 0, G_OPTION_ARG_NONE, &amp;amp;tags,
- N_("Output tags (also known as metadata)"), NULL},
- {NULL}
- };
- ctx = g_option_context_new ("[ADDITIONAL ARGUMENTS]");
- g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
- g_option_context_add_group (ctx, gst_init_get_option_group ());
- if (!g_option_context_parse (ctx, &amp;amp;argc, &amp;amp;argv, &amp;amp;err)) {
- g_print ("Error initializing: &amp;percnt;s\n", GST_STR_NULL (err-&gt;message));
- exit (1);
- }
- g_option_context_free (ctx);
-...
-}
-]|
-
-Use gst_version() to query the library version at runtime or use the
-GST_VERSION_* macros to find the version at compile time. Optionally
-gst_version_string() returns a printable string.
-
-The gst_deinit() call is used to clean up all internal resources used
-by GStreamer. It is mostly used in unit tests to check for leaks.</doc>
- </docsection>
- <docsection name="gstcompat">
- <doc xml:space="preserve"
- filename="gst/gstcompat.h"
- line="26">Please do not use these in new code.
-These symbols are only available by defining GST_DISABLE_DEPRECATED.
-This can be done in CFLAGS for compiling old code.</doc>
- </docsection>
- <docsection name="gsterror">
- <doc xml:space="preserve"
- filename="gst/gsterror.c"
- line="20">GStreamer elements can throw non-fatal warnings and fatal errors.
-Higher-level elements and applications can programmatically filter
-the ones they are interested in or can recover from,
-and have a default handler handle the rest of them.
-
-The rest of this section will use the term "error"
-to mean both (non-fatal) warnings and (fatal) errors; they are treated
-similarly.
-
-Errors from elements are the combination of a #GError and a debug string.
-The #GError contains:
-- a domain type: CORE, LIBRARY, RESOURCE or STREAM
-- a code: an enum value specific to the domain
-- a translated, human-readable message
-- a non-translated additional debug string, which also contains
-- file and line information
-
-Elements do not have the context required to decide what to do with
-errors. As such, they should only inform about errors, and stop their
-processing. In short, an element doesn't know what it is being used for.
-
-It is the application or compound element using the given element that
-has more context about the use of the element. Errors can be received by
-listening to the #GstBus of the element/pipeline for #GstMessage objects with
-the type %GST_MESSAGE_ERROR or %GST_MESSAGE_WARNING. The thrown errors should
-be inspected, and filtered if appropriate.
-
-An application is expected to, by default, present the user with a
-dialog box (or an equivalent) showing the error message. The dialog
-should also allow a way to get at the additional debug information,
-so the user can provide bug reporting information.
-
-A compound element is expected to forward errors by default higher up
-the hierarchy; this is done by default in the same way as for other types
-of #GstMessage.
-
-When applications or compound elements trigger errors that they can
-recover from, they can filter out these errors and take appropriate action.
-For example, an application that gets an error from xvimagesink
-that indicates all XVideo ports are taken, the application can attempt
-to use another sink instead.
-
-Elements throw errors using the #GST_ELEMENT_ERROR convenience macro:
-
-## Throwing an error
-
- |[
- GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
- (_("No file name specified for reading.")), (NULL));
- ]|
-
-Things to keep in mind:
-
- * Don't go off inventing new error codes. The ones
- currently provided should be enough. If you find your type of error
- does not fit the current codes, you should use FAILED.
- * Don't provide a message if the default one suffices.
- this keeps messages more uniform. Use (%NULL) - not forgetting the
- parentheses.
- * If you do supply a custom message, it should be
- marked for translation. The message should start with a capital
- and end with a period. The message should describe the error in short,
- in a human-readable form, and without any complex technical terms.
- A user interface will present this message as the first thing a user
- sees. Details, technical info, ... should go in the debug string.
-
- * The debug string can be as you like. Again, use (%NULL)
- if there's nothing to add - file and line number will still be
- passed. #GST_ERROR_SYSTEM can be used as a shortcut to give
- debug information on a system call error.</doc>
- </docsection>
- <docsection name="gstformat">
- <doc xml:space="preserve"
- filename="gst/gstformat.c"
- line="24">GstFormats functions are used to register a new format to the gstreamer
-core. Formats can be used to perform seeking or conversions/query
-operations.</doc>
- </docsection>
- <docsection name="gstinfo">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="25">GStreamer's debugging subsystem is an easy way to get information about what
-the application is doing. It is not meant for programming errors. Use GLib
-methods (g_warning and friends) for that.
-
-The debugging subsystem works only after GStreamer has been initialized
-- for example by calling gst_init().
-
-The debugging subsystem is used to log informational messages while the
-application runs. Each messages has some properties attached to it. Among
-these properties are the debugging category, the severity (called "level"
-here) and an optional #GObject it belongs to. Each of these messages is sent
-to all registered debugging handlers, which then handle the messages.
-GStreamer attaches a default handler on startup, which outputs requested
-messages to stderr.
-
-Messages are output by using shortcut macros like #GST_DEBUG,
-#GST_CAT_ERROR_OBJECT or similar. These all expand to calling gst_debug_log()
-with the right parameters.
-The only thing a developer will probably want to do is define his own
-categories. This is easily done with 3 lines. At the top of your code,
-declare
-the variables and set the default category.
-|[&lt;!-- language="C" --&gt;
- GST_DEBUG_CATEGORY_STATIC (my_category); // define category (statically)
- #define GST_CAT_DEFAULT my_category // set as default
-]|
-After that you only need to initialize the category.
-|[&lt;!-- language="C" --&gt;
- GST_DEBUG_CATEGORY_INIT (my_category, "my category",
- 0, "This is my very own");
-]|
-Initialization must be done before the category is used first.
-Plugins do this
-in their plugin_init function, libraries and applications should do that
-during their initialization.
-
-The whole debugging subsystem can be disabled at build time with passing the
---disable-gst-debug switch to configure. If this is done, every function,
-macro and even structs described in this file evaluate to default values or
-nothing at all.
-So don't take addresses of these functions or use other tricks.
-If you must do that for some reason, there is still an option.
-If the debugging
-subsystem was compiled out, GST_DISABLE_GST_DEBUG is defined in
-&amp;lt;gst/gst.h&amp;gt;,
-so you can check that before doing your trick.
-Disabling the debugging subsystem will give you a slight (read: unnoticeable)
-speed increase and will reduce the size of your compiled code. The GStreamer
-library itself becomes around 10% smaller.
-
-Please note that there are naming conventions for the names of debugging
-categories. These are explained at GST_DEBUG_CATEGORY_INIT().</doc>
- </docsection>
- <docsection name="gstparamspec">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="19">GParamSpec implementations specific to GStreamer.</doc>
- </docsection>
- <docsection name="gstparse">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="25">These function allow to create a pipeline based on the syntax used in the
-gst-launch-1.0 utility (see man-page for syntax documentation).
-
-Please note that these functions take several measures to create
-somewhat dynamic pipelines. Due to that such pipelines are not always
-reusable (set the state to NULL and back to PLAYING).</doc>
- </docsection>
- <docsection name="gstprotection">
- <doc xml:space="preserve"
- filename="gst/gstprotection.c"
- line="20">The GstProtectionMeta class enables the information needed to decrypt a
-#GstBuffer to be attached to that buffer.
-
-Typically, a demuxer element would attach GstProtectionMeta objects
-to the buffers that it pushes downstream. The demuxer would parse the
-protection information for a video/audio frame from its input data and use
-this information to populate the #GstStructure @info field,
-which is then encapsulated in a GstProtectionMeta object and attached to
-the corresponding output buffer using the gst_buffer_add_protection_meta()
-function. The information in this attached GstProtectionMeta would be
-used by a downstream decrypter element to recover the original unencrypted
-frame.</doc>
- </docsection>
- <docsection name="gststreams">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="27">A #GstStream is a high-level object defining a stream of data which is, or
-can be, present in a #GstPipeline.
-
-It is defined by a unique identifier, a "Stream ID". A #GstStream does not
-automatically imply the stream is present within a pipeline or element.
-
-Any element that can introduce new streams in a pipeline should create the
-appropriate #GstStream object, and can convey that object via the
-%GST_EVENT_STREAM_START event and/or the #GstStreamCollection.
-
-Elements that do not modify the nature of the stream can add extra information
-on it (such as enrich the #GstCaps, or #GstTagList). This is typically done
-by parsing elements.</doc>
- </docsection>
- <docsection name="gstvalue">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="20">GValue implementations specific to GStreamer.
-
-Note that operations on the same #GValue from multiple threads may lead to
-undefined behaviour.</doc>
- </docsection>
- <docsection name="gstversion">
- <doc xml:space="preserve"
- filename="gst/gstversion.h"
- line="28">Use the GST_VERSION_* macros e.g. when defining own plugins. The GStreamer
-runtime checks if these plugin and core version match and refuses to use a
-plugin compiled against a different version of GStreamer.
-You can also use the macros to keep the GStreamer version information in
-your application.
-
-Use the gst_version() function if you want to know which version of
-GStreamer you are currently linked against.
-
-The version macros get defined by including "gst/gst.h".</doc>
- </docsection>
- <function-macro name="guint64_to_gdouble"
- c:identifier="gst_guint64_to_gdouble"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="59">Convert @value to a gdouble.</doc>
- <source-position filename="gst/gstutils.h" line="78"/>
- <parameters>
- <parameter name="value">
- <doc xml:space="preserve"
- filename="gst/gstutils.h"
- line="61">the #guint64 value to convert</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="info_strdup_printf"
- c:identifier="gst_info_strdup_printf"
- version="1.8"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2578">Allocates, fills and returns a 0-terminated string from the printf style
-@format string and corresponding arguments.
-
-See gst_info_vasprintf() for when this function is required.
-
-Free with g_free().</doc>
- <source-position filename="gst/gstinfo.h" line="525"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2590">a newly allocated null terminated string or %NULL on any error</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2580">a printf style format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2581">the printf arguments for @format</doc>
- <varargs/>
- </parameter>
- </parameters>
- </function>
- <function name="info_strdup_vprintf"
- c:identifier="gst_info_strdup_vprintf"
- version="1.8"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2551">Allocates, fills and returns a null terminated string from the printf style
-@format string and @args.
-
-See gst_info_vasprintf() for when this function is required.
-
-Free with g_free().</doc>
- <source-position filename="gst/gstinfo.h" line="522"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2563">a newly allocated null terminated string or %NULL on any error</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2553">a printf style format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2554">the va_list of printf arguments for @format</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </function>
- <function name="info_vasprintf"
- c:identifier="gst_info_vasprintf"
- version="1.8"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2522">Allocates and fills a string large enough (including the terminating null
-byte) to hold the specified printf style @format and @args.
-
-This function deals with the GStreamer specific printf specifiers
-#GST_PTR_FORMAT and #GST_SEGMENT_FORMAT. If you do not have these specifiers
-in your @format string, you do not need to use this function and can use
-alternatives such as g_vasprintf().
-
-Free @result with g_free().</doc>
- <source-position filename="gst/gstinfo.h" line="518"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2538">the length of the string allocated into @result or -1 on any error</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="result"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2524">the resulting string</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2525">a printf style format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="args" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2526">the va_list of printf arguments for @format</doc>
- <type name="va_list" c:type="va_list"/>
- </parameter>
- </parameters>
- </function>
- <function name="init" c:identifier="gst_init">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="442">Initializes the GStreamer library, setting up internal path lists,
-registering built-in elements, and loading standard plugins.
-
-Unless the plugin registry is disabled at compile time, the registry will be
-loaded. By default this will also check if the registry cache needs to be
-updated and rescan all plugins if needed. See gst_update_registry() for
-details and section
-&lt;link linkend="gst-running"&gt;Running GStreamer Applications&lt;/link&gt;
-for how to disable automatic registry updates.
-
-&gt; This function will terminate your program if it was unable to initialize
-&gt; GStreamer for some reason. If you want your program to fall back,
-&gt; use gst_init_check() instead.
-
-WARNING: This function does not work in the same way as corresponding
-functions in other glib-style libraries, such as gtk_init\(\). In
-particular, unknown command line options cause this function to
-abort program execution.</doc>
- <source-position filename="gst/gst.h" line="101"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="argc"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="444">pointer to application's argc</doc>
- <type name="gint" c:type="int*"/>
- </parameter>
- <parameter name="argv"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="445">pointer to application's argv</doc>
- <array length="0" zero-terminated="0" c:type="char***">
- <type name="utf8" c:type="char**"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="init_check" c:identifier="gst_init_check" throws="1">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="389">Initializes the GStreamer library, setting up internal path lists,
-registering built-in elements, and loading standard plugins.
-
-This function will return %FALSE if GStreamer could not be initialized
-for some reason. If you want your program to fail fatally,
-use gst_init() instead.</doc>
- <source-position filename="gst/gst.h" line="104"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="402">%TRUE if GStreamer could be initialized.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="argc"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="391">pointer to application's argc</doc>
- <type name="gint" c:type="int*"/>
- </parameter>
- <parameter name="argv"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="392">pointer to application's argv</doc>
- <array length="0" zero-terminated="0" c:type="char***">
- <type name="utf8" c:type="char**"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="init_get_option_group"
- c:identifier="gst_init_get_option_group"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="225">Returns a #GOptionGroup with GStreamer's argument specifications. The
-group is set up to use standard GOption callbacks, so when using this
-group in combination with GOption parsing methods, all argument parsing
-and initialization is automated.
-
-This function is useful if you want to integrate GStreamer with other
-libraries that use GOption (see g_option_context_add_group() ).
-
-If you use this function, you should make sure you initialise the GLib
-threading system as one of the very first things in your program
-(see the example at the beginning of this section).</doc>
- <source-position filename="gst/gst.h" line="110"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="240">a pointer to GStreamer's option group.</doc>
- <type name="GLib.OptionGroup" c:type="GOptionGroup*"/>
- </return-value>
- </function>
- <function name="is_caps_features" c:identifier="gst_is_caps_features">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="121">Checks if @obj is a #GstCapsFeatures</doc>
- <source-position filename="gst/gstcapsfeatures.h" line="52"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstcapsfeatures.c"
- line="126">%TRUE if @obj is a #GstCapsFeatures %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="obj"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gconstpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="is_initialized" c:identifier="gst_is_initialized">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="481">Use this function to check if GStreamer has been initialized with gst_init()
-or gst_init_check().</doc>
- <source-position filename="gst/gst.h" line="107"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="487">%TRUE if initialization has been done, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="library_error_quark"
- c:identifier="gst_library_error_quark"
- moved-to="LibraryError.quark">
- <attribute name="doc.skip" value="true"/>
- <return-value transfer-ownership="none">
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- <function name="make_element_message_details"
- c:identifier="gst_make_element_message_details"
- version="1.10"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3843">Create a #GstStructure to be used with #gst_element_message_full_with_details</doc>
- <source-position filename="gst/gstelement.h" line="351"/>
- <return-value transfer-ownership="full">
- <type name="Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3845">Name of the first field to set</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstelement.c"
- line="3846">variable arguments in the same form as #GstStructure</doc>
- <varargs/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="memory_is_writable"
- c:identifier="gst_memory_is_writable"
- introspectable="0">
- <source-position filename="gst/gstmemory.h" line="365"/>
- <parameters>
- <parameter name="m">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="memory_lock"
- c:identifier="gst_memory_lock"
- introspectable="0">
- <source-position filename="gst/gstmemory.h" line="363"/>
- <parameters>
- <parameter name="m">
- </parameter>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="memory_make_writable"
- c:identifier="gst_memory_make_writable"
- introspectable="0">
- <source-position filename="gst/gstmemory.h" line="366"/>
- <parameters>
- <parameter name="m">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="memory_unlock"
- c:identifier="gst_memory_unlock"
- introspectable="0">
- <source-position filename="gst/gstmemory.h" line="364"/>
- <parameters>
- <parameter name="m">
- </parameter>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="message_is_writable"
- c:identifier="gst_message_is_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="430">Tests if you can safely write into a message's structure or validly
-modify the seqnum and timestamp fields.</doc>
- <source-position filename="gst/gstmessage.h" line="437"/>
- <parameters>
- <parameter name="msg">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="432">a #GstMessage</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="message_make_writable"
- c:identifier="gst_message_make_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="438">Checks if a message is writable. If not, a writable copy is made and
-returned.</doc>
- <source-position filename="gst/gstmessage.h" line="449"/>
- <parameters>
- <parameter name="msg">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="440">the message to make writable</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="message_new_duration"
- c:identifier="gst_message_new_duration"
- introspectable="0">
- <source-position filename="gst/gstcompat.h" line="87"/>
- <parameters>
- <parameter name="src">
- </parameter>
- <parameter name="fmt">
- </parameter>
- <parameter name="dur">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="message_parse_duration"
- c:identifier="gst_message_parse_duration"
- introspectable="0">
- <source-position filename="gst/gstcompat.h" line="89"/>
- <parameters>
- <parameter name="msg">
- </parameter>
- <parameter name="fmt">
- </parameter>
- <parameter name="dur">
- </parameter>
- </parameters>
- </function-macro>
- <function name="message_replace"
- c:identifier="gst_message_replace"
- moved-to="Message.replace"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="450">Modifies a pointer to a #GstMessage to point to a different #GstMessage. The
-modification is done atomically (so this is useful for ensuring thread safety
-in some cases), and the reference counts are updated appropriately (the old
-message is unreffed, the new one is reffed).
-
-Either @new_message or the #GstMessage pointed to by @old_message may be %NULL.</doc>
- <source-position filename="gst/gstmessage.h" line="466"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="464">%TRUE if @new_message was different from @old_message</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="old_message"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="452">pointer to a
- pointer to a #GstMessage to be replaced.</doc>
- <type name="Message" c:type="GstMessage**"/>
- </parameter>
- <parameter name="new_message"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmessage.h"
- line="454">pointer to a #GstMessage that will
- replace the message pointed to by @old_message.</doc>
- <type name="Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="message_type_get_name"
- c:identifier="gst_message_type_get_name"
- moved-to="MessageType.get_name">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="140">Get a printable name for the given message type. Do not modify or free.</doc>
- <source-position filename="gst/gstmessage.h" line="358"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="146">a reference to the static name of the message.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="142">the message type</doc>
- <type name="MessageType" c:type="GstMessageType"/>
- </parameter>
- </parameters>
- </function>
- <function name="message_type_to_quark"
- c:identifier="gst_message_type_to_quark"
- moved-to="MessageType.to_quark">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="160">Get the unique quark for the given message type.</doc>
- <source-position filename="gst/gstmessage.h" line="361"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="166">the quark associated with the message type</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmessage.c"
- line="162">the message type</doc>
- <type name="MessageType" c:type="GstMessageType"/>
- </parameter>
- </parameters>
- </function>
- <function name="meta_api_type_get_tags"
- c:identifier="gst_meta_api_type_get_tags"
- moved-to="Meta.api_type_get_tags"
- version="1.2">
- <source-position filename="gst/gstmeta.h" line="273"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="335">an array of tags as strings.</doc>
- <array c:type="const gchar* const*">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <parameter name="api" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="333">an API</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </function>
- <function name="meta_api_type_has_tag"
- c:identifier="gst_meta_api_type_has_tag"
- moved-to="Meta.api_type_has_tag">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="313">Check if @api was registered with @tag.</doc>
- <source-position filename="gst/gstmeta.h" line="246"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="320">%TRUE if @api was registered with @tag.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="api" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="315">an API</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="316">the tag to check</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- </parameters>
- </function>
- <function name="meta_api_type_register"
- c:identifier="gst_meta_api_type_register"
- moved-to="Meta.api_type_register">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="115">Register and return a GType for the @api and associate it with
-@tags.</doc>
- <source-position filename="gst/gstmeta.h" line="243"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="123">a unique GType for @api.</doc>
- <type name="GType" c:type="GType"/>
- </return-value>
- <parameters>
- <parameter name="api" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="117">an API to register</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="tags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="118">tags for @api</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="meta_get_info"
- c:identifier="gst_meta_get_info"
- moved-to="Meta.get_info">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="415">Lookup a previously registered meta info structure by its implementation name
-@impl.</doc>
- <source-position filename="gst/gstmeta.h" line="270"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="422">a #GstMetaInfo with @impl, or
-%NULL when no such metainfo exists.</doc>
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- <parameters>
- <parameter name="impl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="417">the name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="meta_register"
- c:identifier="gst_meta_register"
- moved-to="Meta.register">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="353">Register a new #GstMeta implementation.
-
-The same @info can be retrieved later with gst_meta_get_info() by using
-@impl as the key.</doc>
- <source-position filename="gst/gstmeta.h" line="249"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="367">a #GstMetaInfo that can be used to
-access metadata.</doc>
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- <parameters>
- <parameter name="api" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="355">the type of the #GstMeta API</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="impl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="356">the name of the #GstMeta implementation</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="357">the size of the #GstMeta structure</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="init_func" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="358">a #GstMetaInitFunction</doc>
- <type name="MetaInitFunction" c:type="GstMetaInitFunction"/>
- </parameter>
- <parameter name="free_func" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="359">a #GstMetaFreeFunction</doc>
- <type name="MetaFreeFunction" c:type="GstMetaFreeFunction"/>
- </parameter>
- <parameter name="transform_func"
- transfer-ownership="none"
- scope="async">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="360">a #GstMetaTransformFunction</doc>
- <type name="MetaTransformFunction"
- c:type="GstMetaTransformFunction"/>
- </parameter>
- </parameters>
- </function>
- <function name="meta_register_custom"
- c:identifier="gst_meta_register_custom"
- moved-to="Meta.register_custom"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="236">Register a new custom #GstMeta implementation, backed by an opaque
-structure holding a #GstStructure.
-
-The registered info can be retrieved later with gst_meta_get_info() by using
-@name as the key.
-
-The backing #GstStructure can be retrieved with
-gst_custom_meta_get_structure(), its mutability is conditioned by the
-writability of the buffer the meta is attached to.
-
-When @transform_func is %NULL, the meta and its backing #GstStructure
-will always be copied when the transform operation is copy, other operations
-are discarded, copy regions are ignored.</doc>
- <source-position filename="gst/gstmeta.h" line="256"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="258">a #GstMetaInfo that can be used to
-access metadata.</doc>
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="238">the name of the #GstMeta implementation</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="tags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="239">tags for @api</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- <parameter name="transform_func"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="notified"
- closure="3"
- destroy="4">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="240">a #GstMetaTransformFunction</doc>
- <type name="CustomMetaTransformFunction"
- c:type="GstCustomMetaTransformFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="241">user data passed to @transform_func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="destroy_data" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gstmeta.c"
- line="242">#GDestroyNotify for user_data</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </function>
- <function name="mini_object_replace"
- c:identifier="gst_mini_object_replace"
- moved-to="MiniObject.replace">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="700">Atomically modifies a pointer to point to a new mini-object.
-The reference count of @olddata is decreased and the reference count of
-@newdata is increased.
-
-Either @newdata and the value pointed to by @olddata may be %NULL.</doc>
- <source-position filename="gst/gstminiobject.h" line="285"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="712">%TRUE if @newdata was different from @olddata</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="olddata"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="702">pointer to a pointer to a
- mini-object to be replaced</doc>
- <type name="MiniObject" c:type="GstMiniObject**"/>
- </parameter>
- <parameter name="newdata"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="704">pointer to new mini-object</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </parameter>
- </parameters>
- </function>
- <function name="mini_object_steal"
- c:identifier="gst_mini_object_steal"
- moved-to="MiniObject.steal"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="746">Replace the current #GstMiniObject pointer to by @olddata with %NULL and
-return the old value.</doc>
- <source-position filename="gst/gstminiobject.h" line="291"/>
- <return-value nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="754">the #GstMiniObject at @oldata</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </return-value>
- <parameters>
- <parameter name="olddata"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="748">pointer to a pointer to a mini-object to
- be stolen</doc>
- <type name="MiniObject" c:type="GstMiniObject**"/>
- </parameter>
- </parameters>
- </function>
- <function name="mini_object_take"
- c:identifier="gst_mini_object_take"
- moved-to="MiniObject.take">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="776">Modifies a pointer to point to a new mini-object. The modification
-is done atomically. This version is similar to gst_mini_object_replace()
-except that it does not increase the refcount of @newdata and thus
-takes ownership of @newdata.
-
-Either @newdata and the value pointed to by @olddata may be %NULL.</doc>
- <source-position filename="gst/gstminiobject.h" line="288"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="789">%TRUE if @newdata was different from @olddata</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="olddata"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="778">pointer to a pointer to a mini-object to
- be replaced</doc>
- <type name="MiniObject" c:type="GstMiniObject**"/>
- </parameter>
- <parameter name="newdata" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstminiobject.c"
- line="780">pointer to new mini-object</doc>
- <type name="MiniObject" c:type="GstMiniObject*"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="pad_get_caps_reffed"
- c:identifier="gst_pad_get_caps_reffed"
- introspectable="0">
- <source-position filename="gst/gstcompat.h" line="79"/>
- <parameters>
- <parameter name="p">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_get_name"
- c:identifier="gst_pad_get_name"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1294">Get a copy of the name of the pad. g_free() after usage.
-
-MT safe.</doc>
- <source-position filename="gst/gstpad.h" line="1302"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1296">the pad to get the name from</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_get_parent"
- c:identifier="gst_pad_get_parent"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1303">Get the parent of @pad. This function increases the refcount
-of the parent object so you should gst_object_unref() it after usage.
-Can return %NULL if the pad did not have a parent.
-
-MT safe.</doc>
- <source-position filename="gst/gstpad.h" line="1315"/>
- <parameters>
- <parameter name="pad">
- <doc xml:space="preserve"
- filename="gst/gstpad.h"
- line="1305">the pad to get the parent of</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="pad_mode_get_name"
- c:identifier="gst_pad_mode_get_name"
- moved-to="PadMode.get_name">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="944">Return the name of a pad mode, for use in debug messages mostly.</doc>
- <source-position filename="gst/gstpad.h" line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="950">short mnemonic for pad mode @mode</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="946">the pad mode</doc>
- <type name="PadMode" c:type="GstPadMode"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="pad_peer_get_caps_reffed"
- c:identifier="gst_pad_peer_get_caps_reffed"
- introspectable="0">
- <source-position filename="gst/gstcompat.h" line="80"/>
- <parameters>
- <parameter name="p">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_set_activate_function"
- c:identifier="gst_pad_set_activate_function"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1698">Calls gst_pad_set_activate_function_full() with %NULL for the user_data and
-notify.</doc>
- <source-position filename="gst/gstpad.h" line="1412"/>
- <parameters>
- <parameter name="p">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1700">a #GstPad.</doc>
- </parameter>
- <parameter name="f">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1701">the #GstPadActivateFunction to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_set_activatemode_function"
- c:identifier="gst_pad_set_activatemode_function"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1735">Calls gst_pad_set_activatemode_function_full() with %NULL for the user_data and
-notify.</doc>
- <source-position filename="gst/gstpad.h" line="1413"/>
- <parameters>
- <parameter name="p">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1737">a #GstPad.</doc>
- </parameter>
- <parameter name="f">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1738">the #GstPadActivateModeFunction to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_set_chain_function"
- c:identifier="gst_pad_set_chain_function"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1770">Calls gst_pad_set_chain_function_full() with %NULL for the user_data and
-notify.</doc>
- <source-position filename="gst/gstpad.h" line="1414"/>
- <parameters>
- <parameter name="p">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1772">a sink #GstPad.</doc>
- </parameter>
- <parameter name="f">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1773">the #GstPadChainFunction to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_set_chain_list_function"
- c:identifier="gst_pad_set_chain_list_function"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1805">Calls gst_pad_set_chain_list_function_full() with %NULL for the user_data and
-notify.</doc>
- <source-position filename="gst/gstpad.h" line="1415"/>
- <parameters>
- <parameter name="p">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1807">a sink #GstPad.</doc>
- </parameter>
- <parameter name="f">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1808">the #GstPadChainListFunction to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_set_event_full_function"
- c:identifier="gst_pad_set_event_full_function"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1922">Calls gst_pad_set_event_full_function_full() with %NULL for the user_data and
-notify.</doc>
- <source-position filename="gst/gstpad.h" line="1418"/>
- <parameters>
- <parameter name="p">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1924">a #GstPad of either direction.</doc>
- </parameter>
- <parameter name="f">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1925">the #GstPadEventFullFunction to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_set_event_function"
- c:identifier="gst_pad_set_event_function"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1878">Calls gst_pad_set_event_function_full() with %NULL for the user_data and
-notify.</doc>
- <source-position filename="gst/gstpad.h" line="1417"/>
- <parameters>
- <parameter name="p">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1880">a #GstPad of either direction.</doc>
- </parameter>
- <parameter name="f">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1881">the #GstPadEventFunction to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_set_getrange_function"
- c:identifier="gst_pad_set_getrange_function"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1842">Calls gst_pad_set_getrange_function_full() with %NULL for the user_data and
-notify.</doc>
- <source-position filename="gst/gstpad.h" line="1416"/>
- <parameters>
- <parameter name="p">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1844">a source #GstPad.</doc>
- </parameter>
- <parameter name="f">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1845">the #GstPadGetRangeFunction to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_set_iterate_internal_links_function"
- c:identifier="gst_pad_set_iterate_internal_links_function"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1991">Calls gst_pad_set_iterate_internal_links_function_full() with %NULL
-for the user_data and notify.</doc>
- <source-position filename="gst/gstpad.h" line="1540"/>
- <parameters>
- <parameter name="p">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1993">a #GstPad of either direction.</doc>
- </parameter>
- <parameter name="f">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1994">the #GstPadIterIntLinkFunction to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_set_link_function"
- c:identifier="gst_pad_set_link_function"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2025">Calls gst_pad_set_link_function_full() with %NULL
-for the user_data and notify.</doc>
- <source-position filename="gst/gstpad.h" line="1433"/>
- <parameters>
- <parameter name="p">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2027">a #GstPad.</doc>
- </parameter>
- <parameter name="f">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2028">the #GstPadLinkFunction to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_set_query_function"
- c:identifier="gst_pad_set_query_function"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1958">Calls gst_pad_set_query_function_full() with %NULL for the user_data and
-notify.</doc>
- <source-position filename="gst/gstpad.h" line="1561"/>
- <parameters>
- <parameter name="p">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1960">a #GstPad of either direction.</doc>
- </parameter>
- <parameter name="f">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="1961">the #GstPadQueryFunction to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="pad_set_unlink_function"
- c:identifier="gst_pad_set_unlink_function"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2068">Calls gst_pad_set_unlink_function_full() with %NULL
-for the user_data and notify.</doc>
- <source-position filename="gst/gstpad.h" line="1434"/>
- <parameters>
- <parameter name="p">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2070">a #GstPad.</doc>
- </parameter>
- <parameter name="f">
- <doc xml:space="preserve"
- filename="gst/gstpad.c"
- line="2071">the #GstPadUnlinkFunction to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="param_spec_array"
- c:identifier="gst_param_spec_array"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="330">This function creates a GstArray GParamSpec for use by objects/elements
-that want to expose properties of GstArray type. This function is
-typically * used in connection with g_object_class_install_property() in a
-GObjects's instance_init function.</doc>
- <source-position filename="gst/gstparamspecs.h" line="181"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="343">a newly created parameter specification</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="332">canonical name of the property specified</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="nick" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="333">nick name for the property specified</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="blurb" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="334">description of the property specified</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="element_spec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="335">GParamSpec of the array</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="336">flags for the property specified</doc>
- <type name="GObject.ParamFlags" c:type="GParamFlags"/>
- </parameter>
- </parameters>
- </function>
- <function name="param_spec_fraction"
- c:identifier="gst_param_spec_fraction">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="149">This function creates a fraction GParamSpec for use by objects/elements
-that want to expose properties of fraction type. This function is typically
-used in connection with g_object_class_install_property() in a GObjects's
-instance_init function.</doc>
- <source-position filename="gst/gstparamspecs.h" line="173"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="167">a newly created parameter specification</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="151">canonical name of the property specified</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="nick" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="152">nick name for the property specified</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="blurb" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="153">description of the property specified</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="min_num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="154">minimum value (fraction numerator)</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="min_denom" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="155">minimum value (fraction denominator)</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="max_num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="156">maximum value (fraction numerator)</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="max_denom" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="157">maximum value (fraction denominator)</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="default_num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="158">default value (fraction numerator)</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="default_denom" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="159">default value (fraction denominator)</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparamspecs.c"
- line="160">flags for the property specified</doc>
- <type name="GObject.ParamFlags" c:type="GParamFlags"/>
- </parameter>
- </parameters>
- </function>
- <function name="parent_buffer_meta_api_get_type"
- c:identifier="gst_parent_buffer_meta_api_get_type">
- <attribute name="doc.skip" value="true"/>
- <source-position filename="gst/gstbuffer.h" line="730"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="parent_buffer_meta_get_info"
- c:identifier="gst_parent_buffer_meta_get_info"
- moved-to="ParentBufferMeta.get_info"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2675">Get the global #GstMetaInfo describing the #GstParentBufferMeta meta.</doc>
- <source-position filename="gst/gstbuffer.h" line="747"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2680">The #GstMetaInfo</doc>
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="parse_bin_from_description"
- c:identifier="gst_parse_bin_from_description"
- throws="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3393">This is a convenience wrapper around gst_parse_launch() to create a
-#GstBin from a gst-launch-style pipeline description. See
-gst_parse_launch() and the gst-launch man page for details about the
-syntax. Ghost pads on the bin for unlinked source or sink pads
-within the bin can automatically be created (but only a maximum of
-one ghost pad for each direction will be created; if you expect
-multiple unlinked source pads or multiple unlinked sink pads
-and want them all ghosted, you will have to create the ghost pads
-yourself).</doc>
- <source-position filename="gst/gstutils.h" line="1148"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3410">a
- newly-created bin, or %NULL if an error occurred.</doc>
- <type name="Bin" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="bin_description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3395">command line describing the bin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="ghost_unlinked_pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3396">whether to automatically create ghost pads
- for unlinked source or sink pads within the bin</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="parse_bin_from_description_full"
- c:identifier="gst_parse_bin_from_description_full"
- throws="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3421">This is a convenience wrapper around gst_parse_launch() to create a
-#GstBin from a gst-launch-style pipeline description. See
-gst_parse_launch() and the gst-launch man page for details about the
-syntax. Ghost pads on the bin for unlinked source or sink pads
-within the bin can automatically be created (but only a maximum of
-one ghost pad for each direction will be created; if you expect
-multiple unlinked source pads or multiple unlinked sink pads
-and want them all ghosted, you will have to create the ghost pads
-yourself).</doc>
- <source-position filename="gst/gstutils.h" line="1152"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3441">a newly-created
- element, which is guaranteed to be a bin unless
- #GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS was passed, or %NULL if an error
- occurred.</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="bin_description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3423">command line describing the bin</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="ghost_unlinked_pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3424">whether to automatically create ghost pads
- for unlinked source or sink pads within the bin</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="context"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3426">a parse context allocated with
- gst_parse_context_new(), or %NULL</doc>
- <type name="ParseContext" c:type="GstParseContext*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3428">parsing options, or #GST_PARSE_FLAG_NONE</doc>
- <type name="ParseFlags" c:type="GstParseFlags"/>
- </parameter>
- </parameters>
- </function>
- <function name="parse_error_quark"
- c:identifier="gst_parse_error_quark"
- moved-to="ParseError.quark">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="52">Get the error quark used by the parsing subsystem.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="57">the quark of the parse errors.</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- <function name="parse_launch" c:identifier="gst_parse_launch" throws="1">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="286">Create a new pipeline based on command line syntax.
-Please note that you might get a return value that is not %NULL even though
-the @error is set. In this case there was a recoverable parsing error and you
-can try to play the pipeline.
-
-To create a sub-pipeline (bin) for embedding into an existing pipeline
-use gst_parse_bin_from_description().</doc>
- <source-position filename="gst/gstparse.h" line="118"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="299">a new element on success, %NULL on
- failure. If more than one toplevel element is specified by the
- @pipeline_description, all elements are put into a #GstPipeline, which
- than is returned.</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="pipeline_description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="288">the command line describing the pipeline</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="parse_launch_full"
- c:identifier="gst_parse_launch_full"
- throws="1">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="311">Create a new pipeline based on command line syntax.
-Please note that you might get a return value that is not %NULL even though
-the @error is set. In this case there was a recoverable parsing error and you
-can try to play the pipeline.
-
-To create a sub-pipeline (bin) for embedding into an existing pipeline
-use gst_parse_bin_from_description_full().</doc>
- <source-position filename="gst/gstparse.h" line="124"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="327">a new element on success, %NULL on
- failure. If more than one toplevel element is specified by the
- @pipeline_description, all elements are put into a #GstPipeline, which
- then is returned (unless the GST_PARSE_FLAG_PLACE_IN_BIN flag is set, in
- which case they are put in a #GstBin instead).</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="pipeline_description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="313">the command line describing the pipeline</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="context"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="314">a parse context allocated with
- gst_parse_context_new(), or %NULL</doc>
- <type name="ParseContext" c:type="GstParseContext*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="316">parsing options, or #GST_PARSE_FLAG_NONE</doc>
- <type name="ParseFlags" c:type="GstParseFlags"/>
- </parameter>
- </parameters>
- </function>
- <function name="parse_launchv" c:identifier="gst_parse_launchv" throws="1">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="212">Create a new element based on command line syntax.
-@error will contain an error message if an erroneous pipeline is specified.
-An error does not mean that the pipeline could not be constructed.</doc>
- <source-position filename="gst/gstparse.h" line="121"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="221">a new element on success and %NULL
-on failure.</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="argv" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="214">null-terminated array of arguments</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="parse_launchv_full"
- c:identifier="gst_parse_launchv_full"
- throws="1">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="230">Create a new element based on command line syntax.
-@error will contain an error message if an erroneous pipeline is specified.
-An error does not mean that the pipeline could not be constructed.</doc>
- <source-position filename="gst/gstparse.h" line="129"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="242">a new element on success; on
- failure, either %NULL or a partially-constructed bin or element will be
- returned and @error will be set (unless you passed
- #GST_PARSE_FLAG_FATAL_ERRORS in @flags, then %NULL will always be returned
- on failure)</doc>
- <type name="Element" c:type="GstElement*"/>
- </return-value>
- <parameters>
- <parameter name="argv" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="232">null-terminated array of arguments</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- <parameter name="context"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="233">a parse context allocated with
- gst_parse_context_new(), or %NULL</doc>
- <type name="ParseContext" c:type="GstParseContext*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstparse.c"
- line="235">parsing options, or #GST_PARSE_FLAG_NONE</doc>
- <type name="ParseFlags" c:type="GstParseFlags"/>
- </parameter>
- </parameters>
- </function>
- <function name="plugin_error_quark"
- c:identifier="gst_plugin_error_quark"
- moved-to="PluginError.quark">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="44">Get the error quark.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstplugin.h"
- line="49">The error quark used in GError messages</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- <function-macro name="plugin_feature_get_name"
- c:identifier="gst_plugin_feature_get_name"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="71">Returns the name of @feature.
-For a nameless plugin feature, this returns %NULL.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="81"/>
- <parameters>
- <parameter name="feature">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="73">a #GstPluginFeature to get the name of @feature.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="plugin_feature_set_name"
- c:identifier="gst_plugin_feature_set_name"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="83">Sets the name of the plugin feature, getting rid of the old name if there was one.</doc>
- <source-position filename="gst/gstpluginfeature.h" line="90"/>
- <parameters>
- <parameter name="feature">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="85">a #GstPluginFeature to set the name of.</doc>
- </parameter>
- <parameter name="name">
- <doc xml:space="preserve"
- filename="gst/gstpluginfeature.h"
- line="86">the new name</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="poll_new"
- c:identifier="gst_poll_new"
- moved-to="Poll.new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="662">Create a new file descriptor set. If @controllable, it
-is possible to restart or flush a call to gst_poll_wait() with
-gst_poll_restart() and gst_poll_set_flushing() respectively.
-
-Free-function: gst_poll_free</doc>
- <source-position filename="gst/gstpoll.h" line="65"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="672">a new #GstPoll, or %NULL in
- case of an error. Free with gst_poll_free().</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </return-value>
- <parameters>
- <parameter name="controllable" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="664">whether it should be possible to control a wait.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="poll_new_timer"
- c:identifier="gst_poll_new_timer"
- moved-to="Poll.new_timer"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="731">Create a new poll object that can be used for scheduling cancellable
-timeouts.
-
-A timeout is performed with gst_poll_wait(). Multiple timeouts can be
-performed from different threads.
-
-Free-function: gst_poll_free</doc>
- <source-position filename="gst/gstpoll.h" line="68"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpoll.c"
- line="742">a new #GstPoll, or %NULL in
- case of an error. Free with gst_poll_free().</doc>
- <type name="Poll" c:type="GstPoll*"/>
- </return-value>
- </function>
- <function name="preset_get_app_dir"
- c:identifier="gst_preset_get_app_dir"
- moved-to="Preset.get_app_dir">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1234">Gets the directory for application specific presets if set by the
-application.</doc>
- <source-position filename="gst/gstpreset.h" line="111"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1240">the directory or %NULL, don't free or modify
-the string</doc>
- <type name="filename" c:type="const gchar*"/>
- </return-value>
- </function>
- <function name="preset_set_app_dir"
- c:identifier="gst_preset_set_app_dir"
- moved-to="Preset.set_app_dir">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1212">Sets an extra directory as an absolute path that should be considered when
-looking for presets. Any presets in the application dir will shadow the
-system presets.</doc>
- <source-position filename="gst/gstpreset.h" line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1220">%TRUE for success, %FALSE if the dir already has been set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="app_dir" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstpreset.c"
- line="1214">the application specific preset dir</doc>
- <type name="filename" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="print"
- c:identifier="gst_print"
- version="1.12"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2607">Outputs a formatted message via the GLib print handler. The default print
-handler simply outputs the message to stdout.
-
-This function will not append a new-line character at the end, unlike
-gst_println() which will.
-
-All strings must be in ASCII or UTF-8 encoding.
-
-This function differs from g_print() in that it supports all the additional
-printf specifiers that are supported by GStreamer's debug logging system,
-such as #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.
-
-This function is primarily for printing debug output.</doc>
- <source-position filename="gst/gstinfo.h" line="528"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2609">a printf style format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2610">the printf arguments for @format</doc>
- <varargs/>
- </parameter>
- </parameters>
- </function>
- <function name="printerr"
- c:identifier="gst_printerr"
- version="1.12"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2693">Outputs a formatted message via the GLib error message handler. The default
-handler simply outputs the message to stderr.
-
-This function will not append a new-line character at the end, unlike
-gst_printerrln() which will.
-
-All strings must be in ASCII or UTF-8 encoding.
-
-This function differs from g_printerr() in that it supports the additional
-printf specifiers that are supported by GStreamer's debug logging system,
-such as #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.
-
-This function is primarily for printing debug output.</doc>
- <source-position filename="gst/gstinfo.h" line="534"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2695">a printf style format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2696">the printf arguments for @format</doc>
- <varargs/>
- </parameter>
- </parameters>
- </function>
- <function name="printerrln"
- c:identifier="gst_printerrln"
- version="1.12"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2736">Outputs a formatted message via the GLib error message handler. The default
-handler simply outputs the message to stderr.
-
-This function will append a new-line character at the end, unlike
-gst_printerr() which will not.
-
-All strings must be in ASCII or UTF-8 encoding.
-
-This function differs from g_printerr() in that it supports the additional
-printf specifiers that are supported by GStreamer's debug logging system,
-such as #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.
-
-This function is primarily for printing debug output.</doc>
- <source-position filename="gst/gstinfo.h" line="537"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2738">a printf style format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2739">the printf arguments for @format</doc>
- <varargs/>
- </parameter>
- </parameters>
- </function>
- <function name="println"
- c:identifier="gst_println"
- version="1.12"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2650">Outputs a formatted message via the GLib print handler. The default print
-handler simply outputs the message to stdout.
-
-This function will append a new-line character at the end, unlike
-gst_print() which will not.
-
-All strings must be in ASCII or UTF-8 encoding.
-
-This function differs from g_print() in that it supports all the additional
-printf specifiers that are supported by GStreamer's debug logging system,
-such as #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.
-
-This function is primarily for printing debug output.</doc>
- <source-position filename="gst/gstinfo.h" line="531"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2652">a printf style format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstinfo.c"
- line="2653">the printf arguments for @format</doc>
- <varargs/>
- </parameter>
- </parameters>
- </function>
- <function name="protection_filter_systems_by_available_decryptors"
- c:identifier="gst_protection_filter_systems_by_available_decryptors"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstprotection.c"
- line="197">Iterates the supplied list of UUIDs and checks the GstRegistry for
-all the decryptors supporting one of the supplied UUIDs.</doc>
- <source-position filename="gst/gstprotection.h" line="96"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstprotection.c"
- line="206">
-A null terminated array containing all
-the @system_identifiers supported by the set of available decryptors, or
-%NULL if no matches were found.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <parameter name="system_identifiers" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstprotection.c"
- line="199">
-A null terminated array of strings that contains the UUID values of each
-protection system that is to be checked.</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="protection_meta_api_get_type"
- c:identifier="gst_protection_meta_api_get_type">
- <attribute name="doc.skip" value="true"/>
- <source-position filename="gst/gstprotection.h" line="77"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="protection_meta_get_info"
- c:identifier="gst_protection_meta_get_info"
- moved-to="ProtectionMeta.get_info">
- <source-position filename="gst/gstprotection.h" line="87"/>
- <return-value transfer-ownership="none">
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="protection_select_system"
- c:identifier="gst_protection_select_system"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstprotection.c"
- line="159">Iterates the supplied list of UUIDs and checks the GstRegistry for
-an element that supports one of the supplied UUIDs. If more than one
-element matches, the system ID of the highest ranked element is selected.</doc>
- <source-position filename="gst/gstprotection.h" line="93"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstprotection.c"
- line="169">One of the strings from
-@system_identifiers that indicates the highest ranked element that
-implements the protection system indicated by that system ID, or %NULL if no
-element has been found.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="system_identifiers" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstprotection.c"
- line="161">A null terminated array of strings
-that contains the UUID values of each protection system that is to be
-checked.</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function-macro name="query_is_writable"
- c:identifier="gst_query_is_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="297">Tests if you can safely write data into a query's structure.</doc>
- <source-position filename="gst/gstquery.h" line="302"/>
- <parameters>
- <parameter name="q">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="299">a #GstQuery</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="query_make_writable"
- c:identifier="gst_query_make_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="304">Makes a writable query from the given query.</doc>
- <source-position filename="gst/gstquery.h" line="311"/>
- <parameters>
- <parameter name="q">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="306">a #GstQuery to make writable</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="query_replace"
- c:identifier="gst_query_replace"
- moved-to="Query.replace"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="313">Modifies a pointer to a #GstQuery to point to a different #GstQuery. The
-modification is done atomically (so this is useful for ensuring thread safety
-in some cases), and the reference counts are updated appropriately (the old
-query is unreffed, the new one is reffed).
-
-Either @new_query or the #GstQuery pointed to by @old_query may be %NULL.</doc>
- <source-position filename="gst/gstquery.h" line="329"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="327">%TRUE if @new_query was different from @old_query</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="old_query"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="315">pointer to a pointer to a
- #GstQuery to be replaced.</doc>
- <type name="Query" c:type="GstQuery**"/>
- </parameter>
- <parameter name="new_query"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstquery.h"
- line="317">pointer to a #GstQuery that will
- replace the query pointed to by @old_query.</doc>
- <type name="Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </function>
- <function name="query_type_get_flags"
- c:identifier="gst_query_type_get_flags"
- moved-to="QueryType.get_flags">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="169">Gets the #GstQueryTypeFlags associated with @type.</doc>
- <source-position filename="gst/gstquery.h" line="225"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="175">a #GstQueryTypeFlags.</doc>
- <type name="QueryTypeFlags" c:type="GstQueryTypeFlags"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="171">a #GstQueryType</doc>
- <type name="QueryType" c:type="GstQueryType"/>
- </parameter>
- </parameters>
- </function>
- <function name="query_type_get_name"
- c:identifier="gst_query_type_get_name"
- moved-to="QueryType.get_name">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="129">Get a printable name for the given query type. Do not modify or free.</doc>
- <source-position filename="gst/gstquery.h" line="218"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="135">a reference to the static name of the query.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="131">the query type</doc>
- <type name="QueryType" c:type="GstQueryType"/>
- </parameter>
- </parameters>
- </function>
- <function name="query_type_to_quark"
- c:identifier="gst_query_type_to_quark"
- moved-to="QueryType.to_quark">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="149">Get the unique quark for the given query type.</doc>
- <source-position filename="gst/gstquery.h" line="221"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="155">the quark associated with the query type</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstquery.c"
- line="151">the query type</doc>
- <type name="QueryType" c:type="GstQueryType"/>
- </parameter>
- </parameters>
- </function>
- <function name="reference_timestamp_meta_api_get_type"
- c:identifier="gst_reference_timestamp_meta_api_get_type">
- <attribute name="doc.skip" value="true"/>
- <source-position filename="gst/gstbuffer.h" line="788"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="reference_timestamp_meta_get_info"
- c:identifier="gst_reference_timestamp_meta_get_info"
- moved-to="ReferenceTimestampMeta.get_info"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2847">Get the global #GstMetaInfo describing the #GstReferenceTimestampMeta meta.</doc>
- <source-position filename="gst/gstbuffer.h" line="792"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.c"
- line="2852">The #GstMetaInfo</doc>
- <type name="MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="resource_error_quark"
- c:identifier="gst_resource_error_quark"
- moved-to="ResourceError.quark">
- <attribute name="doc.skip" value="true"/>
- <return-value transfer-ownership="none">
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- <function-macro name="sample_is_writable"
- c:identifier="gst_sample_is_writable"
- version="1.16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="121">Tests if you can safely set the buffer and / or buffer list of @sample.</doc>
- <source-position filename="gst/gstsample.h" line="129"/>
- <parameters>
- <parameter name="sample">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="123">A #GstSample</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="sample_make_writable"
- c:identifier="gst_sample_make_writable"
- version="1.16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="131">Returns a writable copy of @sample. If the source sample is
-already writable, this will simply return the same sample.
-
-Use this function to ensure that a sample can be safely modified before
-making changes to it, for example before calling gst_sample_set_buffer()
-
-If the reference count of the source sample @sample is exactly one, the caller
-is the sole owner and this function will return the sample object unchanged.
-
-If there is more than one reference on the object, a copy will be made using
-gst_sample_copy(). The passed-in @sample will be unreffed in that case, and the
-caller will now own a reference to the new returned sample object.
-
-In short, this function unrefs the sample in the argument and refs the sample
-that it returns. Don't access the argument after calling this function unless
-you have an additional reference to it.</doc>
- <source-position filename="gst/gstsample.h" line="157"/>
- <parameters>
- <parameter name="sample">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="133">A #GstSample</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="segtrap_is_enabled" c:identifier="gst_segtrap_is_enabled">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="1312">Some functions in the GStreamer core might install a custom SIGSEGV handler
-to better catch and report errors to the application. Currently this feature
-is enabled by default when loading plugins.
-
-Applications might want to disable this behaviour with the
-gst_segtrap_set_enabled() function. This is typically done if the application
-wants to install its own handler without GStreamer interfering.</doc>
- <source-position filename="gst/gst.h" line="122"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="1323">%TRUE if GStreamer is allowed to install a custom SIGSEGV handler.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="segtrap_set_enabled"
- c:identifier="gst_segtrap_set_enabled">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="1332">Applications might want to disable/enable the SIGSEGV handling of
-the GStreamer core. See gst_segtrap_is_enabled() for more information.</doc>
- <source-position filename="gst/gst.h" line="125"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="1334">whether a custom SIGSEGV handler should be installed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="state_change_get_name"
- c:identifier="gst_state_change_get_name"
- moved-to="StateChange.get_name"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1331">Gets a string representing the given state transition.</doc>
- <source-position filename="gst/gstutils.h" line="999"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1337">a string with the name of the state
- result.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="transition" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="1333">a #GstStateChange to get the name of.</doc>
- <type name="StateChange" c:type="GstStateChange"/>
- </parameter>
- </parameters>
- </function>
- <function name="static_caps_get_type"
- c:identifier="gst_static_caps_get_type">
- <attribute name="doc.skip" value="true"/>
- <source-position filename="gst/gstcaps.h" line="432"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="static_pad_template_get_type"
- c:identifier="gst_static_pad_template_get_type">
- <attribute name="doc.skip" value="true"/>
- <source-position filename="gst/gstpadtemplate.h" line="208"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="stream_error_quark"
- c:identifier="gst_stream_error_quark"
- moved-to="StreamError.quark">
- <attribute name="doc.skip" value="true"/>
- <return-value transfer-ownership="none">
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- <function name="stream_type_get_name"
- c:identifier="gst_stream_type_get_name"
- moved-to="StreamType.get_name"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="540">Get a descriptive string for a given #GstStreamType</doc>
- <source-position filename="gst/gststreams.h" line="153"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="546">A string describing the stream type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="stype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststreams.c"
- line="542">a #GstStreamType</doc>
- <type name="StreamType" c:type="GstStreamType"/>
- </parameter>
- </parameters>
- </function>
- <function name="structure_take"
- c:identifier="gst_structure_take"
- moved-to="Structure.take"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="573">Atomically modifies a pointer to point to a new structure.
-The #GstStructure @oldstr_ptr is pointing to is freed and
-@newstr is taken ownership over.
-
-Either @newstr and the value pointed to by @oldstr_ptr may be %NULL.
-
-It is a programming error if both @newstr and the value pointed to by
-@oldstr_ptr refer to the same, non-%NULL structure.</doc>
- <source-position filename="gst/gststructure.h" line="141"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="588">%TRUE if @newstr was different from @oldstr_ptr</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="oldstr_ptr"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="575">pointer to a place of
- a #GstStructure to take</doc>
- <type name="Structure" c:type="GstStructure**"/>
- </parameter>
- <parameter name="newstr"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gststructure.c"
- line="577">a new #GstStructure</doc>
- <type name="Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_exists" c:identifier="gst_tag_exists">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="564">Checks if the given type is already registered.</doc>
- <source-position filename="gst/gsttaglist.h" line="168"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="570">%TRUE if the type is already registered</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="566">name of the tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_description"
- c:identifier="gst_tag_get_description">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="625">Returns the human-readable description of this tag, You must not change or
-free this string.</doc>
- <source-position filename="gst/gsttaglist.h" line="177"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="632">the human-readable description of this tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="627">the tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_flag" c:identifier="gst_tag_get_flag">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="646">Gets the flag of @tag.</doc>
- <source-position filename="gst/gsttaglist.h" line="180"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="652">the flag of this tag.</doc>
- <type name="TagFlag" c:type="GstTagFlag"/>
- </return-value>
- <parameters>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="648">the tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_nick" c:identifier="gst_tag_get_nick">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="600">Returns the human-readable name of this tag, You must not change or free
-this string.</doc>
- <source-position filename="gst/gsttaglist.h" line="174"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="607">the human-readable name of this tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="602">the tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_type" c:identifier="gst_tag_get_type">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="580">Gets the #GType used for this tag.</doc>
- <source-position filename="gst/gsttaglist.h" line="171"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="586">the #GType of this tag</doc>
- <type name="GType" c:type="GType"/>
- </return-value>
- <parameters>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="582">the tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_is_fixed" c:identifier="gst_tag_is_fixed">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="666">Checks if the given tag is fixed. A fixed tag can only contain one value.
-Unfixed tags can contain lists of values.</doc>
- <source-position filename="gst/gsttaglist.h" line="183"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="673">%TRUE, if the given tag is fixed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="668">tag to check</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_copy_value"
- c:identifier="gst_tag_list_copy_value"
- moved-to="TagList.copy_value">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1472">Copies the contents for the given tag into the value,
-merging multiple values into one if multiple values are associated
-with the tag.
-You must g_value_unset() the value after use.</doc>
- <source-position filename="gst/gsttaglist.h" line="282"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1483">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the
- given list.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1474">uninitialized #GValue to copy into</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1475">list to get the tag from</doc>
- <type name="TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="1476">tag to read out</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="tag_list_free"
- c:identifier="gst_tag_list_free"
- introspectable="0">
- <source-position filename="gst/gstcompat.h" line="84"/>
- <parameters>
- <parameter name="taglist">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="tag_list_is_writable"
- c:identifier="gst_tag_list_is_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="509">Tests if you can safely modify @taglist. It is only safe to modify taglist
-when there is only one owner of the taglist - ie, the refcount is 1.</doc>
- <source-position filename="gst/gsttaglist.h" line="516"/>
- <parameters>
- <parameter name="taglist">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="511">a #GstTagList</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="tag_list_make_writable"
- c:identifier="gst_tag_list_make_writable"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="518">Returns a writable copy of @taglist.
-
-If there is only one reference count on @taglist, the caller must be the
-owner, and so this function will return the taglist object unchanged. If on
-the other hand there is more than one reference on the object, a new taglist
-object will be returned (which will be a copy of @taglist). The caller's
-reference on @taglist will be removed, and instead the caller will own a
-reference to the returned object.
-
-In short, this function unrefs the taglist in the argument and refs the
-taglist that it returns. Don't access the argument after calling this
-function. See also: gst_tag_list_ref().</doc>
- <source-position filename="gst/gsttaglist.h" line="538"/>
- <parameters>
- <parameter name="taglist">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.h"
- line="520">a #GstTagList</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="tag_merge_strings_with_comma"
- c:identifier="gst_tag_merge_strings_with_comma">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="432">This is a convenience function for the func argument of gst_tag_register().
-It concatenates all given strings using a comma. The tag must be registered
-as a G_TYPE_STRING or this function will fail.</doc>
- <source-position filename="gst/gsttaglist.h" line="163"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="434">uninitialized GValue to store result in</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="435">GValue to copy from</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_merge_use_first"
- c:identifier="gst_tag_merge_use_first">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="415">This is a convenience function for the func argument of gst_tag_register().
-It creates a copy of the first value from the list.</doc>
- <source-position filename="gst/gsttaglist.h" line="160"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="417">uninitialized GValue to store result in</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="418">GValue to copy from</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_register"
- c:identifier="gst_tag_register"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="473">Registers a new tag type for the use with GStreamer's type system. If a type
-with that name is already registered, that one is used.
-The old registration may have used a different type however. So don't rely
-on your supplied values.
-
-Important: if you do not supply a merge function the implication will be
-that there can only be one single value for this tag in a tag list and
-any additional values will silently be discarded when being added (unless
-#GST_TAG_MERGE_REPLACE, #GST_TAG_MERGE_REPLACE_ALL, or
-#GST_TAG_MERGE_PREPEND is used as merge mode, in which case the new
-value will replace the old one in the list).
-
-The merge function will be called from gst_tag_list_copy_value() when
-it is required that one or more values for a tag be condensed into
-one single value. This may happen from gst_tag_list_get_string(),
-gst_tag_list_get_int(), gst_tag_list_get_double() etc. What will happen
-exactly in that case depends on how the tag was registered and if a
-merge function was supplied and if so which one.
-
-Two default merge functions are provided: gst_tag_merge_use_first() and
-gst_tag_merge_strings_with_comma().</doc>
- <source-position filename="gst/gsttaglist.h" line="143"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="475">the name or identifier string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="flag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="476">a flag describing the type of tag info</doc>
- <type name="TagFlag" c:type="GstTagFlag"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="477">the type this data is in</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="nick" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="478">human-readable name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="blurb" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="479">a human-readable description about this tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="func"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="480">function for merging multiple values of this tag, or %NULL</doc>
- <type name="TagMergeFunc" c:type="GstTagMergeFunc"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_register_static"
- c:identifier="gst_tag_register_static"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="517">Registers a new tag type for the use with GStreamer's type system.
-
-Same as gst_tag_register(), but @name, @nick, and @blurb must be
-static strings or inlined strings, as they will not be copied. (GStreamer
-plugins will be made resident once loaded, so this function can be used
-even from dynamically loaded plugins.)</doc>
- <source-position filename="gst/gsttaglist.h" line="150"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="519">the name or identifier string (string constant)</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="flag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="520">a flag describing the type of tag info</doc>
- <type name="TagFlag" c:type="GstTagFlag"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="521">the type this data is in</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="nick" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="522">human-readable name or short description (string constant)</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="blurb" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="523">a human-readable description for this tag (string constant)</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="func"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttaglist.c"
- line="524">function for merging multiple values of this tag, or %NULL</doc>
- <type name="TagMergeFunc" c:type="GstTagMergeFunc"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="toc_copy"
- c:identifier="gst_toc_copy"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="447">Copy #GstToc with all subentries (deep copy).</doc>
- <source-position filename="gst/gsttoc.h" line="166"/>
- <parameters>
- <parameter name="toc">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="449">#GstToc to copy.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="toc_entry_copy"
- c:identifier="gst_toc_entry_copy"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="412">Copy #GstTocEntry with all subentries (deep copy).</doc>
- <source-position filename="gst/gsttoc.h" line="176"/>
- <parameters>
- <parameter name="entry">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="414">#GstTocEntry to copy.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="toc_entry_make_writable"
- c:identifier="gst_toc_entry_make_writable"
- introspectable="0">
- <source-position filename="gst/gsttoc.h" line="177"/>
- <parameters>
- <parameter name="entry">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="toc_entry_ref"
- c:identifier="gst_toc_entry_ref"
- introspectable="0">
- <source-position filename="gst/gsttoc.h" line="174"/>
- <parameters>
- <parameter name="entry">
- </parameter>
- </parameters>
- </function-macro>
- <function name="toc_entry_type_get_nick"
- c:identifier="gst_toc_entry_type_get_nick"
- moved-to="TocEntryType.get_nick">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="576">Converts @type to a string representation.</doc>
- <source-position filename="gst/gsttoc.h" line="229"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="582">Returns a human-readable string for @type. This string is
- only for debugging purpose and should not be displayed in a user
- interface.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttoc.c"
- line="578">a #GstTocEntryType.</doc>
- <type name="TocEntryType" c:type="GstTocEntryType"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="toc_entry_unref"
- c:identifier="gst_toc_entry_unref"
- introspectable="0">
- <source-position filename="gst/gsttoc.h" line="175"/>
- <parameters>
- <parameter name="entry">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="toc_make_writable"
- c:identifier="gst_toc_make_writable"
- introspectable="0">
- <source-position filename="gst/gsttoc.h" line="167"/>
- <parameters>
- <parameter name="toc">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="toc_ref"
- c:identifier="gst_toc_ref"
- introspectable="0">
- <source-position filename="gst/gsttoc.h" line="164"/>
- <parameters>
- <parameter name="toc">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="toc_unref"
- c:identifier="gst_toc_unref"
- introspectable="0">
- <source-position filename="gst/gsttoc.h" line="165"/>
- <parameters>
- <parameter name="toc">
- </parameter>
- </parameters>
- </function-macro>
- <function name="tracing_get_active_tracers"
- c:identifier="gst_tracing_get_active_tracers"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gsttracerutils.c"
- line="199">Get a list of all active tracer objects owned by the tracing framework for
-the entirety of the run-time of the process or till gst_deinit() is called.</doc>
- <source-position filename="gst/gsttracer.h" line="76"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsttracerutils.c"
- line="205">A #GList of
-#GstTracer objects</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Tracer"/>
- </type>
- </return-value>
- </function>
- <function name="tracing_register_hook"
- c:identifier="gst_tracing_register_hook"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst/gsttracerutils.c"
- line="181">Register @func to be called when the trace hook @detail is getting invoked.
-Use %NULL for @detail to register to all hooks.</doc>
- <source-position filename="gst/gsttracer.h" line="67"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="tracer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttracerutils.c"
- line="183">the tracer</doc>
- <type name="Tracer" c:type="GstTracer*"/>
- </parameter>
- <parameter name="detail" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttracerutils.c"
- line="184">the detailed hook</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="func" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gsttracerutils.c"
- line="185">the callback</doc>
- <type name="GObject.Callback" c:type="GCallback"/>
- </parameter>
- </parameters>
- </function>
- <function name="type_find_get_type" c:identifier="gst_type_find_get_type">
- <attribute name="doc.skip" value="true"/>
- <source-position filename="gst/gsttypefind.h" line="98"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="type_find_register"
- c:identifier="gst_type_find_register"
- moved-to="TypeFind.register">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="42">Registers a new typefind function to be used for typefinding. After
-registering this function will be available for typefinding.
-This function is typically called during an element's plugin initialization.</doc>
- <source-position filename="gst/gsttypefind.h" line="121"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="61">%TRUE on success, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="plugin"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="44">A #GstPlugin, or %NULL for a static typefind function</doc>
- <type name="Plugin" c:type="GstPlugin*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="45">The name for registering</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="rank" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="46">The rank (or importance) of this typefind function</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="notified"
- closure="6"
- destroy="7">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="47">The #GstTypeFindFunction to use</doc>
- <type name="TypeFindFunction" c:type="GstTypeFindFunction"/>
- </parameter>
- <parameter name="extensions"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="48">Optional comma-separated list of extensions
- that could belong to this type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="possible_caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="50">Optionally the caps that could be returned when typefinding
- succeeds</doc>
- <type name="Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="52">Optional user data. This user data must be available until the plugin
- is unloaded.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="data_notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst/gsttypefind.c"
- line="54">a #GDestroyNotify that will be called on @data when the plugin
- is unloaded.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </function>
- <function name="type_is_plugin_api"
- c:identifier="gst_type_is_plugin_api"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4547">Checks if @type is plugin API. See gst_type_mark_as_plugin_api() for
-details.</doc>
- <source-position filename="gst/gstutils.h" line="1226"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4555">%TRUE if @type is plugin API or %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4549">a GType</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="flags"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4550">What #GstPluginAPIFlags the plugin was marked with</doc>
- <type name="PluginAPIFlags" c:type="GstPluginAPIFlags*"/>
- </parameter>
- </parameters>
- </function>
- <function name="type_mark_as_plugin_api"
- c:identifier="gst_type_mark_as_plugin_api"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4521">Marks @type as plugin API. This should be called in `class_init` of
-elements that expose new types (i.e. enums, flags or internal GObjects) via
-properties, signals or pad templates.
-
-Types exposed by plugins are not automatically added to the documentation
-as they might originate from another library and should in that case be
-documented via that library instead.
-
-By marking a type as plugin API it will be included in the documentation of
-the plugin that defines it.</doc>
- <source-position filename="gst/gstutils.h" line="1223"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4523">a GType</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4524">a set of #GstPluginAPIFlags to further inform cache generation.</doc>
- <type name="PluginAPIFlags" c:type="GstPluginAPIFlags"/>
- </parameter>
- </parameters>
- </function>
- <function name="update_registry" c:identifier="gst_update_registry">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1829">Forces GStreamer to re-scan its plugin paths and update the default
-plugin registry.
-
-Applications will almost never need to call this function, it is only
-useful if the application knows new plugins have been installed (or old
-ones removed) since the start of the application (or, to be precise, the
-first call to gst_init()) and the application wants to make use of any
-newly-installed plugins without restarting the application.
-
-Applications should assume that the registry update is neither atomic nor
-thread-safe and should therefore not have any dynamic pipelines running
-(including the playbin and decodebin elements) and should also not create
-any elements or access the GStreamer registry while the update is in
-progress.
-
-Note that this function may block for a significant amount of time.</doc>
- <source-position filename="gst/gst.h" line="134"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstregistry.c"
- line="1849">%TRUE if the registry has been updated successfully (does not
- imply that there were changes), otherwise %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="uri_construct"
- c:identifier="gst_uri_construct"
- moved-to="Uri.construct"
- deprecated="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="490">Constructs a URI for a given valid protocol and location.
-
-Free-function: g_free</doc>
- <doc-deprecated xml:space="preserve">Use GstURI instead.</doc-deprecated>
- <source-position filename="gst/gsturi.h" line="155"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="499">a new string for this URI. Returns %NULL if the
- given URI protocol is not valid, or the given location is %NULL.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="492">Protocol for URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="location" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="493">Location for URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="uri_error_quark"
- c:identifier="gst_uri_error_quark"
- moved-to="URIError.quark">
- <attribute name="doc.skip" value="true"/>
- <return-value transfer-ownership="none">
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- <function name="uri_from_string"
- c:identifier="gst_uri_from_string"
- moved-to="Uri.from_string"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1627">Parses a URI string into a new #GstUri object. Will return NULL if the URI
-cannot be parsed.</doc>
- <source-position filename="gst/gsturi.h" line="236"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1634">A new #GstUri object, or NULL.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1629">The URI string to parse.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="uri_from_string_escaped"
- c:identifier="gst_uri_from_string_escaped"
- moved-to="Uri.from_string_escaped"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1644">Parses a URI string into a new #GstUri object. Will return NULL if the URI
-cannot be parsed. This is identical to gst_uri_from_string() except that
-the userinfo and fragment components of the URI will not be unescaped while
-parsing.
-
-Use this when you need to extract a username and password from the userinfo
-such as https://user:password@example.com since either may contain
-a URI-escaped ':' character. gst_uri_from_string() will unescape the entire
-userinfo component, which will make it impossible to know which ':'
-delineates the username and password.
-
-The same applies to the fragment component of the URI, such as
-https://example.com/path#fragment which may contain a URI-escaped '#'.</doc>
- <source-position filename="gst/gsturi.h" line="239"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1662">A new #GstUri object, or NULL.</doc>
- <type name="Uri" c:type="GstUri*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1646">The URI string to parse.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="uri_get_location"
- c:identifier="gst_uri_get_location"
- moved-to="Uri.get_location">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="441">Extracts the location out of a given valid URI, ie. the protocol and "://"
-are stripped from the URI, which means that the location returned includes
-the hostname if one is specified. The returned string must be freed using
-g_free().
-
-Free-function: g_free</doc>
- <source-position filename="gst/gsturi.h" line="152"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="452">the location for this URI. Returns
- %NULL if the URI isn't valid. If the URI does not contain a location, an
- empty string is returned.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="443">A URI string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="uri_get_protocol"
- c:identifier="gst_uri_get_protocol"
- moved-to="Uri.get_protocol">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="393">Extracts the protocol out of a given valid URI. The returned string must be
-freed using g_free().</doc>
- <source-position filename="gst/gsturi.h" line="146"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="400">The protocol for this URI.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="395">A URI string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="uri_has_protocol"
- c:identifier="gst_uri_has_protocol"
- moved-to="Uri.has_protocol">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="415">Checks if the protocol of a given valid URI matches @protocol.</doc>
- <source-position filename="gst/gsturi.h" line="149"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="422">%TRUE if the protocol matches.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="417">a URI string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="418">a protocol string (e.g. "http")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="uri_is_valid"
- c:identifier="gst_uri_is_valid"
- moved-to="Uri.is_valid">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="372">Tests if the given string is a valid URI identifier. URIs start with a valid
-scheme followed by ":" and maybe a string identifying the location.</doc>
- <source-position filename="gst/gsturi.h" line="143"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="379">%TRUE if the string is a valid URI</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="374">A URI string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="uri_join_strings"
- c:identifier="gst_uri_join_strings"
- moved-to="Uri.join_strings"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1898">This is a convenience function to join two URI strings and return the result.
-The returned string should be g_free()'d after use.</doc>
- <source-position filename="gst/gsturi.h" line="251"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1906">A string representing the percent-encoded join of
- the two URIs.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="base_uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1900">The percent-encoded base URI.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="ref_uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="1901">The percent-encoded reference URI to join to the @base_uri.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="uri_protocol_is_supported"
- c:identifier="gst_uri_protocol_is_supported"
- moved-to="Uri.protocol_is_supported">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="585">Checks if an element exists that supports the given URI protocol. Note
-that a positive return value does not imply that a subsequent call to
-gst_element_make_from_uri() is guaranteed to work.</doc>
- <source-position filename="gst/gsturi.h" line="140"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="594">%TRUE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="587">Whether to check for a source or a sink</doc>
- <type name="URIType" c:type="const GstURIType"/>
- </parameter>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="588">Protocol that should be checked for (e.g. "http" or "smb")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="uri_protocol_is_valid"
- c:identifier="gst_uri_protocol_is_valid"
- moved-to="Uri.protocol_is_valid">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="350">Tests if the given string is a valid protocol identifier. Protocols
-must consist of alphanumeric characters, '+', '-' and '.' and must
-start with a alphabetic character. See RFC 3986 Section 3.1.</doc>
- <source-position filename="gst/gsturi.h" line="137"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="358">%TRUE if the string is a valid protocol identifier, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gsturi.c"
- line="352">A string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_array_binary_search"
- c:identifier="gst_util_array_binary_search">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3531">Searches inside @array for @search_data by using the comparison function
-@search_func. @array must be sorted ascending.
-
-As @search_data is always passed as second argument to @search_func it's
-not required that @search_data has the same type as the array elements.
-
-The complexity of this search function is O(log (num_elements)).</doc>
- <source-position filename="gst/gstutils.h" line="1187"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3549">The address of the found
-element or %NULL if nothing was found</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <parameter name="array"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3533">the sorted input array</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="num_elements" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3534">number of elements in the array</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="element_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3535">size of every element in bytes</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="search_func"
- transfer-ownership="none"
- scope="call"
- closure="6">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3536">function to compare two elements, @search_data will always be passed as second argument</doc>
- <type name="GLib.CompareDataFunc" c:type="GCompareDataFunc"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3537">search mode that should be used</doc>
- <type name="SearchMode" c:type="GstSearchMode"/>
- </parameter>
- <parameter name="search_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3538">element that should be found</doc>
- <type name="gpointer" c:type="gconstpointer"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3539">data to pass to @search_func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_double_to_fraction"
- c:identifier="gst_util_double_to_fraction">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3695">Transforms a #gdouble to a fraction and simplifies
-the result.</doc>
- <source-position filename="gst/gstutils.h" line="1204"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3697">#gdouble to transform</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="dest_n"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3698">pointer to a #gint to hold the result numerator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="dest_d"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3699">pointer to a #gint to hold the result denominator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_dump_buffer"
- c:identifier="gst_util_dump_buffer"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="97">Dumps the buffer memory into a hex representation. Useful for debugging.</doc>
- <source-position filename="gst/gstutils.h" line="51"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="99">a #GstBuffer whose memory to dump</doc>
- <type name="Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_dump_mem" c:identifier="gst_util_dump_mem">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="84">Dumps the memory block into a hex representation. Useful for debugging.</doc>
- <source-position filename="gst/gstutils.h" line="48"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="mem" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="86">a pointer to the memory to dump</doc>
- <array length="1" zero-terminated="0" c:type="const guchar*">
- <type name="guint8" c:type="guchar"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="87">the size of the memory block to dump</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_fraction_add" c:identifier="gst_util_fraction_add">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3853">Adds the fractions @a_n/@a_d and @b_n/@b_d and stores
-the result in @res_n and @res_d.</doc>
- <source-position filename="gst/gstutils.h" line="1210"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3865">%FALSE on overflow, %TRUE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="a_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3855">Numerator of first value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="a_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3856">Denominator of first value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="b_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3857">Numerator of second value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="b_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3858">Denominator of second value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="res_n"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3859">Pointer to #gint to hold the result numerator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="res_d"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3860">Pointer to #gint to hold the result denominator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_fraction_compare"
- c:identifier="gst_util_fraction_compare">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3918">Compares the fractions @a_n/@a_d and @b_n/@b_d and returns
--1 if a &lt; b, 0 if a = b and 1 if a &gt; b.</doc>
- <source-position filename="gst/gstutils.h" line="1213"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3928">-1 if a &lt; b; 0 if a = b; 1 if a &gt; b.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="a_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3920">Numerator of first value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="a_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3921">Denominator of first value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="b_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3922">Numerator of second value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="b_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3923">Denominator of second value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_fraction_multiply"
- c:identifier="gst_util_fraction_multiply">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3789">Multiplies the fractions @a_n/@a_d and @b_n/@b_d and stores
-the result in @res_n and @res_d.</doc>
- <source-position filename="gst/gstutils.h" line="1207"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3801">%FALSE on overflow, %TRUE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="a_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3791">Numerator of first value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="a_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3792">Denominator of first value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="b_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3793">Numerator of second value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="b_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3794">Denominator of second value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="res_n"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3795">Pointer to #gint to hold the result numerator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="res_d"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3796">Pointer to #gint to hold the result denominator</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_fraction_to_double"
- c:identifier="gst_util_fraction_to_double">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3669">Transforms a fraction to a #gdouble.</doc>
- <source-position filename="gst/gstutils.h" line="1201"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="src_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3671">Fraction numerator as #gint</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="src_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3672">Fraction denominator #gint</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3673">pointer to a #gdouble for the result</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_gdouble_to_guint64"
- c:identifier="gst_util_gdouble_to_guint64">
- <source-position filename="gst/gstutils.h" line="54"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="320">@value casted to #guint64</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="318">The #gdouble value to convert guint64 double</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_get_object_array"
- c:identifier="gst_util_get_object_array"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="260">Get a property of type %GST_TYPE_ARRAY and transform it into a
-#GValueArray. This allow language bindings to get GST_TYPE_ARRAY
-properties which are otherwise not an accessible type.</doc>
- <source-position filename="gst/gstutils.h" line="45"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="262">the object to set the array to</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="263">the name of the property to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="array"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="264">a return #GValueArray</doc>
- <type name="GObject.ValueArray" c:type="GValueArray**"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_get_timestamp" c:identifier="gst_util_get_timestamp">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3509">Get a timestamp as GstClockTime to be used for interval measurements.
-The timestamp should not be interpreted in any other way.</doc>
- <source-position filename="gst/gstutils.h" line="1158"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3515">the timestamp</doc>
- <type name="ClockTime" c:type="GstClockTime"/>
- </return-value>
- </function>
- <function name="util_greatest_common_divisor"
- c:identifier="gst_util_greatest_common_divisor">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3622">Calculates the greatest common divisor of @a
-and @b.</doc>
- <source-position filename="gst/gstutils.h" line="1195"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3630">Greatest common divisor of @a and @b</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="a" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3624">First value as #gint</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="b" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3625">Second value as #gint</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_greatest_common_divisor_int64"
- c:identifier="gst_util_greatest_common_divisor_int64">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3645">Calculates the greatest common divisor of @a
-and @b.</doc>
- <source-position filename="gst/gstutils.h" line="1198"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3653">Greatest common divisor of @a and @b</doc>
- <type name="gint64" c:type="gint64"/>
- </return-value>
- <parameters>
- <parameter name="a" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3647">First value as #gint64</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="b" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="3648">Second value as #gint64</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_group_id_next" c:identifier="gst_util_group_id_next">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4232">Return a constantly incrementing group id.
-
-This function is used to generate a new group-id for the
-stream-start event.
-
-This function never returns %GST_GROUP_ID_INVALID (which is 0)</doc>
- <source-position filename="gst/gstutils.h" line="133"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="4242">A constantly incrementing unsigned integer, which might
-overflow back to 0 at some point.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- </function>
- <function name="util_guint64_to_gdouble"
- c:identifier="gst_util_guint64_to_gdouble">
- <source-position filename="gst/gstutils.h" line="57"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="305">@value casted to #gdouble</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="303">The #guint64 value to convert to double</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_seqnum_compare"
- c:identifier="gst_util_seqnum_compare">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="855">Compare two sequence numbers, handling wraparound.
-
-The current implementation just returns (gint32)(@s1 - @s2).</doc>
- <source-position filename="gst/gstutils.h" line="118"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="864">A negative number if @s1 is before @s2, 0 if they are equal, or a
-positive number if @s1 is after @s2.</doc>
- <type name="gint32" c:type="gint32"/>
- </return-value>
- <parameters>
- <parameter name="s1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="857">A sequence number.</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="s2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="858">Another sequence number.</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_seqnum_next" c:identifier="gst_util_seqnum_next">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="826">Return a constantly incrementing sequence number.
-
-This function is used internally to GStreamer to be able to determine which
-events and messages are "the same". For example, elements may set the seqnum
-on a segment-done message to be the same as that of the last seek event, to
-indicate that event and the message correspond to the same segment.
-
-This function never returns %GST_SEQNUM_INVALID (which is 0).</doc>
- <source-position filename="gst/gstutils.h" line="115"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="838">A constantly incrementing 32-bit unsigned integer, which might
-overflow at some point. Use gst_util_seqnum_compare() to make sure
-you handle wraparound correctly.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- </function>
- <function name="util_set_object_arg"
- c:identifier="gst_util_set_object_arg">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="172">Converts the string value to the type of the objects argument and
-sets the argument with it.
-
-Note that this function silently returns if @object has no property named
-@name or when @value cannot be converted to the type of the property.</doc>
- <source-position filename="gst/gstutils.h" line="39"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="174">the object to set the argument of</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="175">the name of the argument to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="176">the string value to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_set_object_array"
- c:identifier="gst_util_set_object_array"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="225">Transfer a #GValueArray to %GST_TYPE_ARRAY and set this value on the
-specified property name. This allow language bindings to set GST_TYPE_ARRAY
-properties which are otherwise not an accessible type.</doc>
- <source-position filename="gst/gstutils.h" line="42"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="227">the object to set the array to</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="228">the name of the property to set</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="229">a #GValueArray containing the values</doc>
- <type name="GObject.ValueArray" c:type="const GValueArray*"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_set_value_from_string"
- c:identifier="gst_util_set_value_from_string">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="141">Converts the string to the type of the value and
-sets the value with it.
-
-Note that this function is dangerous as it does not return any indication
-if the conversion worked or not.</doc>
- <source-position filename="gst/gstutils.h" line="36"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="143">the value to set</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="value_str" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="144">the string to get the value from</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_uint64_scale" c:identifier="gst_util_uint64_scale">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="646">Scale @val by the rational number @num / @denom, avoiding overflows and
-underflows and without loss of precision.
-
-This function can potentially be very slow if val and num are both
-greater than G_MAXUINT32.</doc>
- <source-position filename="gst/gstutils.h" line="85"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="658">@val * @num / @denom. In the case of an overflow, this
-function returns G_MAXUINT64. If the result is not exactly
-representable as an integer it is truncated. See also
-gst_util_uint64_scale_round(), gst_util_uint64_scale_ceil(),
-gst_util_uint64_scale_int(), gst_util_uint64_scale_int_round(),
-gst_util_uint64_scale_int_ceil().</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="648">the number to scale</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="649">the numerator of the scale ratio</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="denom" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="650">the denominator of the scale ratio</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_uint64_scale_ceil"
- c:identifier="gst_util_uint64_scale_ceil">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="696">Scale @val by the rational number @num / @denom, avoiding overflows and
-underflows and without loss of precision.
-
-This function can potentially be very slow if val and num are both
-greater than G_MAXUINT32.</doc>
- <source-position filename="gst/gstutils.h" line="91"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="708">@val * @num / @denom. In the case of an overflow, this
-function returns G_MAXUINT64. If the result is not exactly
-representable as an integer, it is rounded up. See also
-gst_util_uint64_scale(), gst_util_uint64_scale_round(),
-gst_util_uint64_scale_int(), gst_util_uint64_scale_int_round(),
-gst_util_uint64_scale_int_ceil().</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="698">the number to scale</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="699">the numerator of the scale ratio</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="denom" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="700">the denominator of the scale ratio</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_uint64_scale_int"
- c:identifier="gst_util_uint64_scale_int">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="755">Scale @val by the rational number @num / @denom, avoiding overflows and
-underflows and without loss of precision. @num must be non-negative and
-@denom must be positive.</doc>
- <source-position filename="gst/gstutils.h" line="94"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="765">@val * @num / @denom. In the case of an overflow, this
-function returns G_MAXUINT64. If the result is not exactly
-representable as an integer, it is truncated. See also
-gst_util_uint64_scale_int_round(), gst_util_uint64_scale_int_ceil(),
-gst_util_uint64_scale(), gst_util_uint64_scale_round(),
-gst_util_uint64_scale_ceil().</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="757">guint64 (such as a #GstClockTime) to scale.</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="758">numerator of the scale factor.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="denom" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="759">denominator of the scale factor.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_uint64_scale_int_ceil"
- c:identifier="gst_util_uint64_scale_int_ceil">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="803">Scale @val by the rational number @num / @denom, avoiding overflows and
-underflows and without loss of precision. @num must be non-negative and
-@denom must be positive.</doc>
- <source-position filename="gst/gstutils.h" line="100"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="813">@val * @num / @denom. In the case of an overflow, this
-function returns G_MAXUINT64. If the result is not exactly
-representable as an integer, it is rounded up. See also
-gst_util_uint64_scale_int(), gst_util_uint64_scale_int_round(),
-gst_util_uint64_scale(), gst_util_uint64_scale_round(),
-gst_util_uint64_scale_ceil().</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="805">guint64 (such as a #GstClockTime) to scale.</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="806">numerator of the scale factor.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="denom" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="807">denominator of the scale factor.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_uint64_scale_int_round"
- c:identifier="gst_util_uint64_scale_int_round">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="778">Scale @val by the rational number @num / @denom, avoiding overflows and
-underflows and without loss of precision. @num must be non-negative and
-@denom must be positive.</doc>
- <source-position filename="gst/gstutils.h" line="97"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="788">@val * @num / @denom. In the case of an overflow, this
-function returns G_MAXUINT64. If the result is not exactly
-representable as an integer, it is rounded to the nearest integer
-(half-way cases are rounded up). See also gst_util_uint64_scale_int(),
-gst_util_uint64_scale_int_ceil(), gst_util_uint64_scale(),
-gst_util_uint64_scale_round(), gst_util_uint64_scale_ceil().</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="780">guint64 (such as a #GstClockTime) to scale.</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="781">numerator of the scale factor.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="denom" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="782">denominator of the scale factor.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="util_uint64_scale_round"
- c:identifier="gst_util_uint64_scale_round">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="671">Scale @val by the rational number @num / @denom, avoiding overflows and
-underflows and without loss of precision.
-
-This function can potentially be very slow if val and num are both
-greater than G_MAXUINT32.</doc>
- <source-position filename="gst/gstutils.h" line="88"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="683">@val * @num / @denom. In the case of an overflow, this
-function returns G_MAXUINT64. If the result is not exactly
-representable as an integer, it is rounded to the nearest integer
-(half-way cases are rounded up). See also gst_util_uint64_scale(),
-gst_util_uint64_scale_ceil(), gst_util_uint64_scale_int(),
-gst_util_uint64_scale_int_round(), gst_util_uint64_scale_int_ceil().</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="673">the number to scale</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="674">the numerator of the scale ratio</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="denom" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstutils.c"
- line="675">the denominator of the scale ratio</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_can_compare" c:identifier="gst_value_can_compare">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5720">Determines if @value1 and @value2 can be compared.</doc>
- <source-position filename="gst/gstvalue.h" line="767"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5727">%TRUE if the values can be compared</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="value1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5722">a value to compare</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="value2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5723">another value to compare</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_can_intersect"
- c:identifier="gst_value_can_intersect">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6002">Determines if intersecting two values will produce a valid result.
-Two values will produce a valid intersection if they have the same
-type.</doc>
- <source-position filename="gst/gstvalue.h" line="790"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6011">%TRUE if the values can intersect</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="value1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6004">a value to intersect</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="value2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6005">another value to intersect</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_can_subtract" c:identifier="gst_value_can_subtract">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6242">Checks if it's possible to subtract @subtrahend from @minuend.</doc>
- <source-position filename="gst/gstvalue.h" line="800"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6249">%TRUE if a subtraction is possible</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="minuend" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6244">the value to subtract from</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="subtrahend" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6245">the value to subtract</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_can_union" c:identifier="gst_value_can_union">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5895">Determines if @value1 and @value2 can be non-trivially unioned.
-Any two values can be trivially unioned by adding both of them
-to a GstValueList. However, certain types have the possibility
-to be unioned in a simpler way. For example, an integer range
-and an integer can be unioned if the integer is a subset of the
-integer range. If there is the possibility that two values can
-be unioned, this function returns %TRUE.</doc>
- <source-position filename="gst/gstvalue.h" line="780"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5908">%TRUE if there is a function allowing the two values to
-be unioned.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="value1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5897">a value to union</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="value2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5898">another value to union</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_compare" c:identifier="gst_value_compare">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5814">Compares @value1 and @value2. If @value1 and @value2 cannot be
-compared, the function returns GST_VALUE_UNORDERED. Otherwise,
-if @value1 is greater than @value2, GST_VALUE_GREATER_THAN is returned.
-If @value1 is less than @value2, GST_VALUE_LESS_THAN is returned.
-If the values are equal, GST_VALUE_EQUAL is returned.</doc>
- <source-position filename="gst/gstvalue.h" line="764"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5825">comparison result</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="value1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5816">a value to compare</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="value2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5817">another value to compare</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_deserialize" c:identifier="gst_value_deserialize">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6428">Tries to deserialize a string into the type specified by the given GValue.
-If the operation succeeds, %TRUE is returned, %FALSE otherwise.</doc>
- <source-position filename="gst/gstvalue.h" line="564"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6437">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6430">#GValue to fill with contents of
- deserialization</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6432">string to deserialize</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_deserialize_with_pspec"
- c:identifier="gst_value_deserialize_with_pspec"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6475">Tries to deserialize a string into the type specified by the given GValue.
-@pspec may be used to guide the deserializing of nested members.
-If the operation succeeds, %TRUE is returned, %FALSE otherwise.</doc>
- <source-position filename="gst/gstvalue.h" line="568"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6486">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6477">#GValue to fill with contents of
- deserialization</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6479">string to deserialize</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="pspec"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6480">the #GParamSpec describing the expected value</doc>
- <type name="GObject.ParamSpec" c:type="GParamSpec*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_fixate" c:identifier="gst_value_fixate">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6585">Fixate @src into a new value @dest.
-For ranges, the first element is taken. For lists and arrays, the
-first item is fixated and returned.
-If @src is already fixed, this function returns %FALSE.</doc>
- <source-position filename="gst/gstvalue.h" line="809"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6595">%TRUE if @dest contains a fixated version of @src.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6587">the #GValue destination</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6588">the #GValue to fixate</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_fraction_multiply"
- c:identifier="gst_value_fraction_multiply">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6811">Multiplies the two #GValue items containing a #GST_TYPE_FRACTION and sets
-@product to the product of the two fractions.</doc>
- <source-position filename="gst/gstvalue.h" line="716"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6820">%FALSE in case of an error (like integer overflow), %TRUE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="product" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6813">a GValue initialized to #GST_TYPE_FRACTION</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="factor1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6814">a GValue initialized to #GST_TYPE_FRACTION</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="factor2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6815">a GValue initialized to #GST_TYPE_FRACTION</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_fraction_subtract"
- c:identifier="gst_value_fraction_subtract">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6846">Subtracts the @subtrahend from the @minuend and sets @dest to the result.</doc>
- <source-position filename="gst/gstvalue.h" line="720"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6854">%FALSE in case of an error (like integer overflow), %TRUE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6848">a GValue initialized to #GST_TYPE_FRACTION</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="minuend" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6849">a GValue initialized to #GST_TYPE_FRACTION</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="subtrahend" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6850">a GValue initialized to #GST_TYPE_FRACTION</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_bitmask" c:identifier="gst_value_get_bitmask">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7222">Gets the bitmask specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="745"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7228">the bitmask.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7224">a GValue initialized to #GST_TYPE_BITMASK</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="value_get_buffer"
- c:identifier="gst_value_get_buffer"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="691">Receives a #GstBuffer as the value of @v. Does not return a reference to
-the buffer, so the pointer is only valid for as long as the caller owns
-a reference to @v.</doc>
- <source-position filename="gst/gstbuffer.h" line="700"/>
- <parameters>
- <parameter name="v">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="693">a #GValue to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="value_get_caps" c:identifier="gst_value_get_caps">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2197">Gets the contents of @value. The reference count of the returned
-#GstCaps will not be modified, therefore the caller must take one
-before getting rid of the @value.</doc>
- <source-position filename="gst/gstvalue.h" line="677"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2205">the contents of @value</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2199">a GValue initialized to GST_TYPE_CAPS</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_caps_features"
- c:identifier="gst_value_get_caps_features">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2932">Gets the contents of @value.</doc>
- <source-position filename="gst/gstvalue.h" line="697"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2938">the contents of @value</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2934">a GValue initialized to GST_TYPE_CAPS_FEATURES</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_double_range_max"
- c:identifier="gst_value_get_double_range_max">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1831">Gets the maximum of the range specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="672"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1837">the maximum of the range</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1833">a GValue initialized to GST_TYPE_DOUBLE_RANGE</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_double_range_min"
- c:identifier="gst_value_get_double_range_min">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1815">Gets the minimum of the range specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="669"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1821">the minimum of the range</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1817">a GValue initialized to GST_TYPE_DOUBLE_RANGE</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_flagset_flags"
- c:identifier="gst_value_get_flagset_flags"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7381">Retrieve the flags field of a GstFlagSet @value.</doc>
- <source-position filename="gst/gstvalue.h" line="756"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7387">the flags field of the flagset instance.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7383">a GValue initialized to #GST_TYPE_FLAG_SET</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_flagset_mask"
- c:identifier="gst_value_get_flagset_mask"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7399">Retrieve the mask field of a GstFlagSet @value.</doc>
- <source-position filename="gst/gstvalue.h" line="759"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7405">the mask field of the flagset instance.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7401">a GValue initialized to #GST_TYPE_FLAG_SET</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_fraction_denominator"
- c:identifier="gst_value_get_fraction_denominator">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6795">Gets the denominator of the fraction specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="713"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6801">the denominator of the fraction.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6797">a GValue initialized to #GST_TYPE_FRACTION</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_fraction_numerator"
- c:identifier="gst_value_get_fraction_numerator">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6779">Gets the numerator of the fraction specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="710"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6785">the numerator of the fraction.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6781">a GValue initialized to #GST_TYPE_FRACTION</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_fraction_range_max"
- c:identifier="gst_value_get_fraction_range_max">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2095">Gets the maximum of the range specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="740"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2101">the maximum of the range</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2097">a GValue initialized to GST_TYPE_FRACTION_RANGE</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_fraction_range_min"
- c:identifier="gst_value_get_fraction_range_min">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2072">Gets the minimum of the range specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="737"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2078">the minimum of the range</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2074">a GValue initialized to GST_TYPE_FRACTION_RANGE</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_int64_range_max"
- c:identifier="gst_value_get_int64_range_max">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1652">Gets the maximum of the range specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="657"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1658">the maximum of the range</doc>
- <type name="gint64" c:type="gint64"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1654">a GValue initialized to GST_TYPE_INT64_RANGE</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_int64_range_min"
- c:identifier="gst_value_get_int64_range_min">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1636">Gets the minimum of the range specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="654"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1642">the minimum of the range</doc>
- <type name="gint64" c:type="gint64"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1638">a GValue initialized to GST_TYPE_INT64_RANGE</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_int64_range_step"
- c:identifier="gst_value_get_int64_range_step">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1668">Gets the step of the range specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="660"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1674">the step of the range</doc>
- <type name="gint64" c:type="gint64"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1670">a GValue initialized to GST_TYPE_INT64_RANGE</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_int_range_max"
- c:identifier="gst_value_get_int_range_max">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1406">Gets the maximum of the range specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="637"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1412">the maximum of the range</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1408">a GValue initialized to GST_TYPE_INT_RANGE</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_int_range_min"
- c:identifier="gst_value_get_int_range_min">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1390">Gets the minimum of the range specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="634"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1396">the minimum of the range</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1392">a GValue initialized to GST_TYPE_INT_RANGE</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_get_int_range_step"
- c:identifier="gst_value_get_int_range_step">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1422">Gets the step of the range specified by @value.</doc>
- <source-position filename="gst/gstvalue.h" line="640"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1428">the step of the range</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1424">a GValue initialized to GST_TYPE_INT_RANGE</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="value_get_sample"
- c:identifier="gst_value_get_sample"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="195">Receives a #GstSample as the value of @v. Does not return a reference to
-the sample, so the pointer is only valid for as long as the caller owns
-a reference to @v.</doc>
- <source-position filename="gst/gstsample.h" line="205"/>
- <parameters>
- <parameter name="v">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="197">a #GValue to query</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="value_get_structure"
- c:identifier="gst_value_get_structure">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2844">Gets the contents of @value.</doc>
- <source-position filename="gst/gstvalue.h" line="687"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2850">the contents of @value</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2846">a GValue initialized to GST_TYPE_STRUCTURE</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_init_and_copy"
- c:identifier="gst_value_init_and_copy">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6333">Initialises the target value to be of the same type as source and then copies
-the contents from source to target.</doc>
- <source-position filename="gst/gstvalue.h" line="558"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6335">the target value</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6336">the source value</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_intersect" c:identifier="gst_value_intersect">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6061">Calculates the intersection of two values. If the values have
-a non-empty intersection, the value representing the intersection
-is placed in @dest, unless %NULL. If the intersection is non-empty,
-@dest is not modified.</doc>
- <source-position filename="gst/gstvalue.h" line="786"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6075">%TRUE if the intersection is non-empty</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6063">
- a uninitialized #GValue that will hold the calculated
- intersection value. May be %NULL if the resulting set if not
- needed.</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="value1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6067">a value to intersect</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="value2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6068">another value to intersect</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_is_fixed" c:identifier="gst_value_is_fixed">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6537">Tests if the given GValue, if available in a GstStructure (or any other
-container) contains a "fixed" (which means: one value) or an "unfixed"
-(which means: multiple possible values, such as data lists or data
-ranges) value.</doc>
- <source-position filename="gst/gstvalue.h" line="806"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6546">true if the value is "fixed".</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6539">the #GValue to check</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_is_subset" c:identifier="gst_value_is_subset">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="4313">Check that @value1 is a subset of @value2.</doc>
- <source-position filename="gst/gstvalue.h" line="770"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="4320">%TRUE is @value1 is a subset of @value2</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="value1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="4315">a #GValue</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="value2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="4316">a #GValue</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_register" c:identifier="gst_value_register">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6308">Registers functions to perform calculations on #GValue items of a given
-type. Each type can only be added once.</doc>
- <source-position filename="gst/gstvalue.h" line="555"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="table" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6310">structure containing functions to register</doc>
- <type name="ValueTable" c:type="const GstValueTable*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_serialize" c:identifier="gst_value_serialize">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6376">tries to transform the given @value into a string representation that allows
-getting back this string later on using gst_value_deserialize().
-
-Free-function: g_free</doc>
- <source-position filename="gst/gstvalue.h" line="561"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6385">the serialization for @value
-or %NULL if none exists</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6378">a #GValue to serialize</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_set_bitmask" c:identifier="gst_value_set_bitmask">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7207">Sets @value to the bitmask specified by @bitmask.</doc>
- <source-position filename="gst/gstvalue.h" line="748"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7209">a GValue initialized to #GST_TYPE_BITMASK</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="bitmask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7210">the bitmask</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="value_set_buffer"
- c:identifier="gst_value_set_buffer"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="675">Sets @b as the value of @v. Caller retains reference to buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="681"/>
- <parameters>
- <parameter name="v">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="677">a #GValue to receive the data</doc>
- </parameter>
- <parameter name="b">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="678">a #GstBuffer to assign to the GstValue</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="value_set_caps" c:identifier="gst_value_set_caps">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2179">Sets the contents of @value to @caps. A reference to the
-provided @caps will be taken by the @value.</doc>
- <source-position filename="gst/gstvalue.h" line="680"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2181">a GValue initialized to GST_TYPE_CAPS</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2182">the caps to set the value to</doc>
- <type name="Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_set_caps_features"
- c:identifier="gst_value_set_caps_features">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2915">Sets the contents of @value to @features.</doc>
- <source-position filename="gst/gstvalue.h" line="700"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2917">a GValue initialized to GST_TYPE_CAPS_FEATURES</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="features" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2918">the features to set the value to</doc>
- <type name="CapsFeatures" c:type="const GstCapsFeatures*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_set_double_range"
- c:identifier="gst_value_set_double_range">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1797">Sets @value to the range specified by @start and @end.</doc>
- <source-position filename="gst/gstvalue.h" line="665"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1799">a GValue initialized to GST_TYPE_DOUBLE_RANGE</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1800">the start of the range</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1801">the end of the range</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_set_flagset"
- c:identifier="gst_value_set_flagset"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7359">Sets @value to the flags and mask values provided in @flags and @mask.
-The @flags value indicates the values of flags, the @mask represents
-which bits in the flag value have been set, and which are "don't care"</doc>
- <source-position filename="gst/gstvalue.h" line="753"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7361">a GValue initialized to %GST_TYPE_FLAG_SET</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7362">The value of the flags set or unset</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="7363">The mask indicate which flags bits must match for comparisons</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_set_fraction" c:identifier="gst_value_set_fraction">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6740">Sets @value to the fraction specified by @numerator over @denominator.
-The fraction gets reduced to the smallest numerator and denominator,
-and if necessary the sign is moved to the numerator.</doc>
- <source-position filename="gst/gstvalue.h" line="706"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6742">a GValue initialized to #GST_TYPE_FRACTION</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="numerator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6743">the numerator of the fraction</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="denominator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6744">the denominator of the fraction</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_set_fraction_range"
- c:identifier="gst_value_set_fraction_range">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1997">Sets @value to the range specified by @start and @end.</doc>
- <source-position filename="gst/gstvalue.h" line="727"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1999">a GValue initialized to GST_TYPE_FRACTION_RANGE</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2000">the start of the range (a GST_TYPE_FRACTION GValue)</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2001">the end of the range (a GST_TYPE_FRACTION GValue)</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_set_fraction_range_full"
- c:identifier="gst_value_set_fraction_range_full">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2026">Sets @value to the range specified by @numerator_start/@denominator_start
-and @numerator_end/@denominator_end.</doc>
- <source-position filename="gst/gstvalue.h" line="731"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2028">a GValue initialized to GST_TYPE_FRACTION_RANGE</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="numerator_start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2029">the numerator start of the range</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="denominator_start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2030">the denominator start of the range</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="numerator_end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2031">the numerator end of the range</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="denominator_end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2032">the denominator end of the range</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_set_int64_range"
- c:identifier="gst_value_set_int64_range">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1622">Sets @value to the range specified by @start and @end.</doc>
- <source-position filename="gst/gstvalue.h" line="645"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1624">a GValue initialized to GST_TYPE_INT64_RANGE</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1625">the start of the range</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1626">the end of the range</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_set_int64_range_step"
- c:identifier="gst_value_set_int64_range_step">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1598">Sets @value to the range specified by @start, @end and @step.</doc>
- <source-position filename="gst/gstvalue.h" line="649"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1600">a GValue initialized to GST_TYPE_INT64_RANGE</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1601">the start of the range</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1602">the end of the range</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="step" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1603">the step of the range</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_set_int_range"
- c:identifier="gst_value_set_int_range">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1376">Sets @value to the range specified by @start and @end.</doc>
- <source-position filename="gst/gstvalue.h" line="625"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1378">a GValue initialized to GST_TYPE_INT_RANGE</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1379">the start of the range</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1380">the end of the range</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_set_int_range_step"
- c:identifier="gst_value_set_int_range_step">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1350">Sets @value to the range specified by @start, @end and @step.</doc>
- <source-position filename="gst/gstvalue.h" line="629"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1352">a GValue initialized to GST_TYPE_INT_RANGE</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1353">the start of the range</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1354">the end of the range</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="step" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="1355">the step of the range</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="value_set_sample"
- c:identifier="gst_value_set_sample"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="179">Sets @b as the value of @v. Caller retains reference to sample.</doc>
- <source-position filename="gst/gstsample.h" line="186"/>
- <parameters>
- <parameter name="v">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="181">a #GValue to receive the data</doc>
- </parameter>
- <parameter name="b">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="182">a #GstSample to assign to the GstValue</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="value_set_structure"
- c:identifier="gst_value_set_structure">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2827">Sets the contents of @value to @structure.</doc>
- <source-position filename="gst/gstvalue.h" line="690"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2829">a GValue initialized to GST_TYPE_STRUCTURE</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="structure" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="2830">the structure to set the value to</doc>
- <type name="Structure" c:type="const GstStructure*"/>
- </parameter>
- </parameters>
- </function>
- <function name="value_subtract" c:identifier="gst_value_subtract">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6177">Subtracts @subtrahend from @minuend and stores the result in @dest.
-Note that this means subtraction as in sets, not as in mathematics.</doc>
- <source-position filename="gst/gstvalue.h" line="796"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6189">%TRUE if the subtraction is not empty</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6179">the destination value
- for the result if the subtraction is not empty. May be %NULL,
- in which case the resulting set will not be computed, which can
- give a fair speedup.</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="minuend" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6183">the value to subtract from</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="subtrahend" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="6184">the value to subtract</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="value_take_buffer"
- c:identifier="gst_value_take_buffer"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="683">Sets @b as the value of @v. Caller gives away reference to buffer.</doc>
- <source-position filename="gst/gstbuffer.h" line="689"/>
- <parameters>
- <parameter name="v">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="685">a #GValue to receive the data</doc>
- </parameter>
- <parameter name="b">
- <doc xml:space="preserve"
- filename="gst/gstbuffer.h"
- line="686">a #GstBuffer to assign to the GstValue</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="value_take_sample"
- c:identifier="gst_value_take_sample"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="187">Sets @b as the value of @v. Caller gives away reference to sample.</doc>
- <source-position filename="gst/gstsample.h" line="194"/>
- <parameters>
- <parameter name="v">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="189">a #GValue to receive the data</doc>
- </parameter>
- <parameter name="b">
- <doc xml:space="preserve"
- filename="gst/gstsample.h"
- line="190">a #GstSample to assign to the GstValue</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="value_union" c:identifier="gst_value_union">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5935">Creates a GValue corresponding to the union of @value1 and @value2.</doc>
- <source-position filename="gst/gstvalue.h" line="776"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5943">%TRUE if the union succeeded.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5937">the destination value</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- <parameter name="value1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5938">a value to union</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- <parameter name="value2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst/gstvalue.c"
- line="5939">another value to union</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="version" c:identifier="gst_version">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="1264">Gets the version number of the GStreamer library.</doc>
- <source-position filename="gst/gst.h" line="116"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="major"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="1266">pointer to a guint to store the major version number</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="minor"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="1267">pointer to a guint to store the minor version number</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="micro"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="1268">pointer to a guint to store the micro version number</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="nano"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="1269">pointer to a guint to store the nano version number</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="version_string" c:identifier="gst_version_string">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="1287">This function returns a string that is useful for describing this version
-of GStreamer to the outside world: user agent strings, logging, ...</doc>
- <source-position filename="gst/gst.h" line="119"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst/gst.c"
- line="1293">a newly allocated string describing this version
- of GStreamer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- </function>
- </namespace>
-</repository>
diff --git a/girs/GstApp-1.0.gir b/girs/GstApp-1.0.gir
deleted file mode 100644
index dc7023befa..0000000000
--- a/girs/GstApp-1.0.gir
+++ /dev/null
@@ -1,2538 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="Gst" version="1.0"/>
- <include name="GstBase" version="1.0"/>
- <package name="gstreamer-app-1.0"/>
- <c:include name="gst/app/app.h"/>
- <namespace name="GstApp"
- version="1.0"
- shared-library="libgstapp-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <function-macro name="APP_SINK"
- c:identifier="GST_APP_SINK"
- introspectable="0">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="30"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="APP_SINK_CAST"
- c:identifier="GST_APP_SINK_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="APP_SINK_CLASS"
- c:identifier="GST_APP_SINK_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="32"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="APP_SRC"
- c:identifier="GST_APP_SRC"
- introspectable="0">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="APP_SRC_CAST"
- c:identifier="GST_APP_SRC_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="APP_SRC_CLASS"
- c:identifier="GST_APP_SRC_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="33"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <class name="AppSink"
- c:symbol-prefix="app_sink"
- c:type="GstAppSink"
- parent="GstBase.BaseSink"
- glib:type-name="GstAppSink"
- glib:get-type="gst_app_sink_get_type"
- glib:type-struct="AppSinkClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="20">Appsink is a sink plugin that supports many different methods for making
-the application get a handle on the GStreamer data in a pipeline. Unlike
-most GStreamer elements, Appsink provides external API functions.
-
-appsink can be used by linking to the gstappsink.h header file to access the
-methods or by using the appsink action signals and properties.
-
-The normal way of retrieving samples from appsink is by using the
-gst_app_sink_pull_sample() and gst_app_sink_pull_preroll() methods.
-These methods block until a sample becomes available in the sink or when the
-sink is shut down or reaches EOS. There are also timed variants of these
-methods, gst_app_sink_try_pull_sample() and gst_app_sink_try_pull_preroll(),
-which accept a timeout parameter to limit the amount of time to wait.
-
-Appsink will internally use a queue to collect buffers from the streaming
-thread. If the application is not pulling samples fast enough, this queue
-will consume a lot of memory over time. The "max-buffers" property can be
-used to limit the queue size. The "drop" property controls whether the
-streaming thread blocks or if older buffers are dropped when the maximum
-queue size is reached. Note that blocking the streaming thread can negatively
-affect real-time performance and should be avoided.
-
-If a blocking behaviour is not desirable, setting the "emit-signals" property
-to %TRUE will make appsink emit the "new-sample" and "new-preroll" signals
-when a sample can be pulled without blocking.
-
-The "caps" property on appsink can be used to control the formats that
-appsink can receive. This property can contain non-fixed caps, the format of
-the pulled samples can be obtained by getting the sample caps.
-
-If one of the pull-preroll or pull-sample methods return %NULL, the appsink
-is stopped or in the EOS state. You can check for the EOS state with the
-"eos" property or with the gst_app_sink_is_eos() method.
-
-The eos signal can also be used to be informed when the EOS state is reached
-to avoid polling.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="103"/>
- <implements name="Gst.URIHandler"/>
- <virtual-method name="eos">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="91"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="new_preroll">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="92"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="new_sample">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="93"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="pull_preroll" invoker="pull_preroll">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1479">Get the last preroll sample in @appsink. This was the sample that caused the
-appsink to preroll in the PAUSED state.
-
-This function is typically used when dealing with a pipeline in the PAUSED
-state. Calling this function after doing a seek will give the sample right
-after the seek position.
-
-Calling this function will clear the internal reference to the preroll
-buffer.
-
-Note that the preroll sample will also be returned as the first sample
-when calling gst_app_sink_pull_sample().
-
-If an EOS event was received before any buffers, this function returns
-%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
-
-This function blocks until a preroll sample or EOS is received or the appsink
-element is set to the READY/NULL state.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="96"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1502">a #GstSample or NULL when the appsink is stopped or EOS.
- Call gst_sample_unref() after usage.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1481">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="pull_sample" invoker="pull_sample">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1511">This function blocks until a sample or EOS becomes available or the appsink
-element is set to the READY/NULL state.
-
-This function will only return samples when the appsink is in the PLAYING
-state. All rendered buffers will be put in a queue so that the application
-can pull samples at its own rate. Note that when the application does not
-pull samples fast enough, the queued buffers could consume a lot of memory,
-especially when dealing with raw video frames.
-
-If an EOS event was received before any buffers, this function returns
-%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="97"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1527">a #GstSample or NULL when the appsink is stopped or EOS.
- Call gst_sample_unref() after usage.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1513">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="try_pull_preroll"
- invoker="try_pull_preroll"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1536">Get the last preroll sample in @appsink. This was the sample that caused the
-appsink to preroll in the PAUSED state.
-
-This function is typically used when dealing with a pipeline in the PAUSED
-state. Calling this function after doing a seek will give the sample right
-after the seek position.
-
-Calling this function will clear the internal reference to the preroll
-buffer.
-
-Note that the preroll sample will also be returned as the first sample
-when calling gst_app_sink_pull_sample().
-
-If an EOS event was received before any buffers or the timeout expires,
-this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS
-condition.
-
-This function blocks until a preroll sample or EOS is received, the appsink
-element is set to the READY/NULL state, or the timeout expires.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="98"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1561">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.
- Call gst_sample_unref() after usage.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1538">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1539">the maximum amount of time to wait for the preroll sample</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="try_pull_sample"
- invoker="try_pull_sample"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1639">This function blocks until a sample or EOS becomes available or the appsink
-element is set to the READY/NULL state or the timeout expires.
-
-This function will only return samples when the appsink is in the PLAYING
-state. All rendered buffers will be put in a queue so that the application
-can pull samples at its own rate. Note that when the application does not
-pull samples fast enough, the queued buffers could consume a lot of memory,
-especially when dealing with raw video frames.
-
-If an EOS event was received before any buffers or the timeout expires,
-this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS
-condition.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="99"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1657">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.
-Call gst_sample_unref() after usage.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1641">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1642">the maximum amount of time to wait for a sample</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="get_buffer_list_support"
- c:identifier="gst_app_sink_get_buffer_list_support"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1399">Check if @appsink supports buffer lists.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="139"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1405">%TRUE if @appsink supports buffer lists.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1401">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_caps" c:identifier="gst_app_sink_get_caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1144">Get the configured caps on @appsink.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="112"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1150">the #GstCaps accepted by the sink. gst_caps_unref() after usage.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1146">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_drop" c:identifier="gst_app_sink_get_drop">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1343">Check if @appsink will drop old buffers when the maximum amount of queued
-buffers is reached.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="133"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1350">%TRUE if @appsink is dropping old buffers when the queue is
-filled.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1345">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_emit_signals"
- c:identifier="gst_app_sink_get_emit_signals">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1239">Check if appsink will emit the "new-preroll" and "new-sample" signals.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="121"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1245">%TRUE if @appsink is emitting the "new-preroll" and "new-sample"
-signals.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1241">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_max_buffers"
- c:identifier="gst_app_sink_get_max_buffers">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1292">Get the maximum amount of buffers that can be queued in @appsink.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="127"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1298">The maximum amount of buffers that can be queued.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1294">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_wait_on_eos"
- c:identifier="gst_app_sink_get_wait_on_eos">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1452">Check if @appsink will wait for all buffers to be consumed when an EOS is
-received.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="145"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1459">%TRUE if @appsink will wait for all buffers to be consumed when an
-EOS is received.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1454">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_eos" c:identifier="gst_app_sink_is_eos">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1171">Check if @appsink is EOS, which is when no more samples can be pulled because
-an EOS event was received.
-
-This function also returns %TRUE when the appsink is not in the PAUSED or
-PLAYING state.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="115"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1181">%TRUE if no more samples can be pulled and the appsink is EOS.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1173">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pull_preroll" c:identifier="gst_app_sink_pull_preroll">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1479">Get the last preroll sample in @appsink. This was the sample that caused the
-appsink to preroll in the PAUSED state.
-
-This function is typically used when dealing with a pipeline in the PAUSED
-state. Calling this function after doing a seek will give the sample right
-after the seek position.
-
-Calling this function will clear the internal reference to the preroll
-buffer.
-
-Note that the preroll sample will also be returned as the first sample
-when calling gst_app_sink_pull_sample().
-
-If an EOS event was received before any buffers, this function returns
-%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
-
-This function blocks until a preroll sample or EOS is received or the appsink
-element is set to the READY/NULL state.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="148"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1502">a #GstSample or NULL when the appsink is stopped or EOS.
- Call gst_sample_unref() after usage.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1481">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pull_sample" c:identifier="gst_app_sink_pull_sample">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1511">This function blocks until a sample or EOS becomes available or the appsink
-element is set to the READY/NULL state.
-
-This function will only return samples when the appsink is in the PLAYING
-state. All rendered buffers will be put in a queue so that the application
-can pull samples at its own rate. Note that when the application does not
-pull samples fast enough, the queued buffers could consume a lot of memory,
-especially when dealing with raw video frames.
-
-If an EOS event was received before any buffers, this function returns
-%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="151"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1527">a #GstSample or NULL when the appsink is stopped or EOS.
- Call gst_sample_unref() after usage.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1513">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_buffer_list_support"
- c:identifier="gst_app_sink_set_buffer_list_support"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1370">Instruct @appsink to enable or disable buffer list support.
-
-For backwards-compatibility reasons applications need to opt in
-to indicate that they will be able to handle buffer lists.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="136"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1372">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- <parameter name="enable_lists" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1373">enable or disable buffer list support</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_callbacks"
- c:identifier="gst_app_sink_set_callbacks"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1752">Set callbacks which will be executed for each new preroll, new sample and eos.
-This is an alternative to using the signals, it has lower overhead and is thus
-less expensive, but also less flexible.
-
-If callbacks are installed, no signals will be emitted for performance
-reasons.
-
-Before 1.16.3 it was not possible to change the callbacks in a thread-safe
-way.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="160"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1754">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- <parameter name="callbacks" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1755">the callbacks</doc>
- <type name="AppSinkCallbacks" c:type="GstAppSinkCallbacks*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1756">a user_data argument for the callbacks</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1757">a destroy notify function</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_caps" c:identifier="gst_app_sink_set_caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1111">Set the capabilities on the appsink element. This function takes
-a copy of the caps structure. After calling this method, the sink will only
-accept caps that match @caps. If @caps is non-fixed, or incomplete,
-you must check the caps on the samples to get the actual used caps.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="109"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1113">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1114">caps to set</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_drop" c:identifier="gst_app_sink_set_drop">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1317">Instruct @appsink to drop old buffers when the maximum amount of queued
-buffers is reached.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="130"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1319">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- <parameter name="drop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1320">the new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_emit_signals"
- c:identifier="gst_app_sink_set_emit_signals">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1216">Make appsink emit the "new-preroll" and "new-sample" signals. This option is
-by default disabled because signal emission is expensive and unneeded when
-the application prefers to operate in pull mode.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="118"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1218">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- <parameter name="emit" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1219">the new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_max_buffers"
- c:identifier="gst_app_sink_set_max_buffers">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1265">Set the maximum amount of buffers that can be queued in @appsink. After this
-amount of buffers are queued in appsink, any more buffers will block upstream
-elements until a sample is pulled from @appsink.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="124"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1267">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- <parameter name="max" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1268">the maximum number of buffers to queue</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_wait_on_eos"
- c:identifier="gst_app_sink_set_wait_on_eos">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1426">Instruct @appsink to wait for all buffers to be consumed when an EOS is received.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="142"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1428">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- <parameter name="wait" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1429">the new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="try_pull_preroll"
- c:identifier="gst_app_sink_try_pull_preroll"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1536">Get the last preroll sample in @appsink. This was the sample that caused the
-appsink to preroll in the PAUSED state.
-
-This function is typically used when dealing with a pipeline in the PAUSED
-state. Calling this function after doing a seek will give the sample right
-after the seek position.
-
-Calling this function will clear the internal reference to the preroll
-buffer.
-
-Note that the preroll sample will also be returned as the first sample
-when calling gst_app_sink_pull_sample().
-
-If an EOS event was received before any buffers or the timeout expires,
-this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS
-condition.
-
-This function blocks until a preroll sample or EOS is received, the appsink
-element is set to the READY/NULL state, or the timeout expires.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="154"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1561">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.
- Call gst_sample_unref() after usage.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1538">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1539">the maximum amount of time to wait for the preroll sample</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="try_pull_sample"
- c:identifier="gst_app_sink_try_pull_sample"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1639">This function blocks until a sample or EOS becomes available or the appsink
-element is set to the READY/NULL state or the timeout expires.
-
-This function will only return samples when the appsink is in the PLAYING
-state. All rendered buffers will be put in a queue so that the application
-can pull samples at its own rate. Note that when the application does not
-pull samples fast enough, the queued buffers could consume a lot of memory,
-especially when dealing with raw video frames.
-
-If an EOS event was received before any buffers or the timeout expires,
-this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS
-condition.</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="157"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1657">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.
-Call gst_sample_unref() after usage.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1641">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1642">the maximum amount of time to wait for a sample</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <property name="buffer-list" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="caps" writable="1" transfer-ownership="none">
- <type name="Gst.Caps"/>
- </property>
- <property name="drop" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="emit-signals" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="eos" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="max-buffers" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="wait-on-eos" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="basesink">
- <type name="GstBase.BaseSink" c:type="GstBaseSink"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AppSinkPrivate" c:type="GstAppSinkPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="eos" when="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="283">Signal that the end-of-stream has been reached. This signal is emitted from
-the streaming thread.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="new-preroll" when="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="294">Signal that a new preroll sample is available.
-
-This signal is emitted from the streaming thread and only when the
-"emit-signals" property is %TRUE.
-
-The new preroll sample can be retrieved with the "pull-preroll" action
-signal or gst_app_sink_pull_preroll() either from this signal callback
-or from any other thread.
-
-Note that this signal is only emitted when the "emit-signals" property is
-set to %TRUE, which it is not by default for performance reasons.</doc>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn"/>
- </return-value>
- </glib:signal>
- <glib:signal name="new-sample" when="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="314">Signal that a new sample is available.
-
-This signal is emitted from the streaming thread and only when the
-"emit-signals" property is %TRUE.
-
-The new sample can be retrieved with the "pull-sample" action
-signal or gst_app_sink_pull_sample() either from this signal callback
-or from any other thread.
-
-Note that this signal is only emitted when the "emit-signals" property is
-set to %TRUE, which it is not by default for performance reasons.</doc>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn"/>
- </return-value>
- </glib:signal>
- <glib:signal name="pull-preroll" when="last" action="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="335">Get the last preroll sample in @appsink. This was the sample that caused the
-appsink to preroll in the PAUSED state.
-
-This function is typically used when dealing with a pipeline in the PAUSED
-state. Calling this function after doing a seek will give the sample right
-after the seek position.
-
-Calling this function will clear the internal reference to the preroll
-buffer.
-
-Note that the preroll sample will also be returned as the first sample
-when calling gst_app_sink_pull_sample() or the "pull-sample" action signal.
-
-If an EOS event was received before any buffers, this function returns
-%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
-
-This function blocks until a preroll sample or EOS is received or the appsink
-element is set to the READY/NULL state.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="358">a #GstSample or NULL when the appsink is stopped or EOS.</doc>
- <type name="Gst.Sample"/>
- </return-value>
- </glib:signal>
- <glib:signal name="pull-sample" when="last" action="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="364">This function blocks until a sample or EOS becomes available or the appsink
-element is set to the READY/NULL state.
-
-This function will only return samples when the appsink is in the PLAYING
-state. All rendered samples will be put in a queue so that the application
-can pull samples at its own rate.
-
-Note that when the application does not pull samples fast enough, the
-queued samples could consume a lot of memory, especially when dealing with
-raw video frames. It's possible to control the behaviour of the queue with
-the "drop" and "max-buffers" properties.
-
-If an EOS event was received before any buffers, this function returns
-%NULL. Use gst_app_sink_is_eos () to check for the EOS condition.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="383">a #GstSample or NULL when the appsink is stopped or EOS.</doc>
- <type name="Gst.Sample"/>
- </return-value>
- </glib:signal>
- <glib:signal name="try-pull-preroll"
- when="last"
- action="1"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="389">Get the last preroll sample in @appsink. This was the sample that caused the
-appsink to preroll in the PAUSED state.
-
-This function is typically used when dealing with a pipeline in the PAUSED
-state. Calling this function after doing a seek will give the sample right
-after the seek position.
-
-Calling this function will clear the internal reference to the preroll
-buffer.
-
-Note that the preroll sample will also be returned as the first sample
-when calling gst_app_sink_pull_sample() or the "pull-sample" action signal.
-
-If an EOS event was received before any buffers or the timeout expires,
-this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS
-condition.
-
-This function blocks until a preroll sample or EOS is received, the appsink
-element is set to the READY/NULL state, or the timeout expires.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="414">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.</doc>
- <type name="Gst.Sample"/>
- </return-value>
- <parameters>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="392">the maximum amount of time to wait for the preroll sample</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="try-pull-sample"
- when="last"
- action="1"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="423">This function blocks until a sample or EOS becomes available or the appsink
-element is set to the READY/NULL state or the timeout expires.
-
-This function will only return samples when the appsink is in the PLAYING
-state. All rendered samples will be put in a queue so that the application
-can pull samples at its own rate.
-
-Note that when the application does not pull samples fast enough, the
-queued samples could consume a lot of memory, especially when dealing with
-raw video frames. It's possible to control the behaviour of the queue with
-the "drop" and "max-buffers" properties.
-
-If an EOS event was received before any buffers or the timeout expires,
-this function returns %NULL. Use gst_app_sink_is_eos () to check
-for the EOS condition.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="444">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.</doc>
- <type name="Gst.Sample"/>
- </return-value>
- <parameters>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="426">the maximum amount of time to wait for a sample</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="AppSinkCallbacks"
- c:type="GstAppSinkCallbacks"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.h"
- line="48">A set of callbacks that can be installed on the appsink with
-gst_app_sink_set_callbacks().</doc>
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="73"/>
- <field name="eos">
- <callback name="eos">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="67"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="appsink" transfer-ownership="none">
- <type name="AppSink" c:type="GstAppSink*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="new_preroll">
- <callback name="new_preroll">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="68"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="appsink" transfer-ownership="none">
- <type name="AppSink" c:type="GstAppSink*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="new_sample">
- <callback name="new_sample">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="69"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="appsink" transfer-ownership="none">
- <type name="AppSink" c:type="GstAppSink*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AppSinkClass"
- c:type="GstAppSinkClass"
- glib:is-gtype-struct-for="AppSink">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="103"/>
- <field name="basesink_class">
- <type name="GstBase.BaseSinkClass" c:type="GstBaseSinkClass"/>
- </field>
- <field name="eos">
- <callback name="eos">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="91"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="appsink" transfer-ownership="none">
- <type name="AppSink" c:type="GstAppSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="new_preroll">
- <callback name="new_preroll">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="92"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="appsink" transfer-ownership="none">
- <type name="AppSink" c:type="GstAppSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="new_sample">
- <callback name="new_sample">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="93"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="appsink" transfer-ownership="none">
- <type name="AppSink" c:type="GstAppSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="pull_preroll">
- <callback name="pull_preroll">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="96"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1502">a #GstSample or NULL when the appsink is stopped or EOS.
- Call gst_sample_unref() after usage.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1481">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="pull_sample">
- <callback name="pull_sample">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="97"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1527">a #GstSample or NULL when the appsink is stopped or EOS.
- Call gst_sample_unref() after usage.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1513">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="try_pull_preroll">
- <callback name="try_pull_preroll">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="98"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1561">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.
- Call gst_sample_unref() after usage.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1538">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1539">the maximum amount of time to wait for the preroll sample</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="try_pull_sample">
- <callback name="try_pull_sample">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="99"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1657">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires.
-Call gst_sample_unref() after usage.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <parameter name="appsink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1641">a #GstAppSink</doc>
- <type name="AppSink" c:type="GstAppSink*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsink.c"
- line="1642">the maximum amount of time to wait for a sample</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="2">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AppSinkPrivate" c:type="GstAppSinkPrivate" disguised="1">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="44"/>
- </record>
- <class name="AppSrc"
- c:symbol-prefix="app_src"
- c:type="GstAppSrc"
- parent="GstBase.BaseSrc"
- glib:type-name="GstAppSrc"
- glib:get-type="gst_app_src_get_type"
- glib:type-struct="AppSrcClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="20">The appsrc element can be used by applications to insert data into a
-GStreamer pipeline. Unlike most GStreamer elements, appsrc provides
-external API functions.
-
-appsrc can be used by linking with the libgstapp library to access the
-methods directly or by using the appsrc action signals.
-
-Before operating appsrc, the caps property must be set to fixed caps
-describing the format of the data that will be pushed with appsrc. An
-exception to this is when pushing buffers with unknown caps, in which case no
-caps should be set. This is typically true of file-like sources that push raw
-byte buffers. If you don't want to explicitly set the caps, you can use
-gst_app_src_push_sample. This method gets the caps associated with the
-sample and sets them on the appsrc replacing any previously set caps (if
-different from sample's caps).
-
-The main way of handing data to the appsrc element is by calling the
-gst_app_src_push_buffer() method or by emitting the push-buffer action signal.
-This will put the buffer onto a queue from which appsrc will read from in its
-streaming thread. It is important to note that data transport will not happen
-from the thread that performed the push-buffer call.
-
-The "max-bytes" property controls how much data can be queued in appsrc
-before appsrc considers the queue full. A filled internal queue will always
-signal the "enough-data" signal, which signals the application that it should
-stop pushing data into appsrc. The "block" property will cause appsrc to
-block the push-buffer method until free data becomes available again.
-
-When the internal queue is running out of data, the "need-data" signal is
-emitted, which signals the application that it should start pushing more data
-into appsrc.
-
-In addition to the "need-data" and "enough-data" signals, appsrc can emit the
-"seek-data" signal when the "stream-mode" property is set to "seekable" or
-"random-access". The signal argument will contain the new desired position in
-the stream expressed in the unit set with the "format" property. After
-receiving the seek-data signal, the application should push-buffers from the
-new position.
-
-These signals allow the application to operate the appsrc in two different
-ways:
-
-The push mode, in which the application repeatedly calls the push-buffer/push-sample
-method with a new buffer/sample. Optionally, the queue size in the appsrc
-can be controlled with the enough-data and need-data signals by respectively
-stopping/starting the push-buffer/push-sample calls. This is a typical
-mode of operation for the stream-type "stream" and "seekable". Use this
-mode when implementing various network protocols or hardware devices.
-
-The pull mode, in which the need-data signal triggers the next push-buffer call.
-This mode is typically used in the "random-access" stream-type. Use this
-mode for file access or other randomly accessible sources. In this mode, a
-buffer of exactly the amount of bytes given by the need-data signal should be
-pushed into appsrc.
-
-In all modes, the size property on appsrc should contain the total stream
-size in bytes. Setting this property is mandatory in the random-access mode.
-For the stream and seekable modes, setting this property is optional but
-recommended.
-
-When the application has finished pushing data into appsrc, it should call
-gst_app_src_end_of_stream() or emit the end-of-stream action signal. After
-this call, no more buffers can be pushed into appsrc until a flushing seek
-occurs or the state of the appsrc has gone through READY.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="119"/>
- <implements name="Gst.URIHandler"/>
- <virtual-method name="end_of_stream" invoker="end_of_stream">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2181">Indicates to the appsrc element that the last buffer queued in the
-element is the last buffer of the stream.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="113"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2188">#GST_FLOW_OK when the EOS was successfully queued.
-#GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2183">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="enough_data">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="108"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="need_data">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="107"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="length" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="push_buffer" invoker="push_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2081">Adds a buffer to the queue of buffers that the appsrc element will
-push to its source pad. This function takes ownership of the buffer.
-
-When the block property is TRUE, this function can block until free
-space becomes available in the queue.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2092">#GST_FLOW_OK when the buffer was successfully queued.
-#GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
-#GST_FLOW_EOS when EOS occurred.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2083">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2084">a #GstBuffer to push</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="push_buffer_list"
- invoker="push_buffer_list"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2102">Adds a buffer list to the queue of buffers and buffer lists that the
-appsrc element will push to its source pad. This function takes ownership
-of @buffer_list.
-
-When the block property is TRUE, this function can block until free
-space becomes available in the queue.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="115"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2114">#GST_FLOW_OK when the buffer list was successfully queued.
-#GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
-#GST_FLOW_EOS when EOS occurred.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2104">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="buffer_list" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2105">a #GstBufferList to push</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="push_sample" invoker="push_sample" version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2126">Extract a buffer from the provided sample and adds it to the queue of
-buffers that the appsrc element will push to its source pad. Any
-previous caps that were set on appsrc will be replaced by the caps
-associated with the sample if not equal.
-
-This function does not take ownership of the
-sample so the sample needs to be unreffed after calling this function.
-
-When the block property is TRUE, this function can block until free
-space becomes available in the queue.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="114"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2143">#GST_FLOW_OK when the buffer was successfully queued.
-#GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
-#GST_FLOW_EOS when EOS occurred.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2128">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2129">a #GstSample from which buffer and caps may be
-extracted</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="seek_data">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="109"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="end_of_stream" c:identifier="gst_app_src_end_of_stream">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2181">Indicates to the appsrc element that the last buffer queued in the
-element is the last buffer of the stream.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="176"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2188">#GST_FLOW_OK when the EOS was successfully queued.
-#GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2183">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_caps" c:identifier="gst_app_src_get_caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1470">Get the configured caps on @appsrc.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="128"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1476">the #GstCaps produced by the source. gst_caps_unref() after usage.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1472">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_current_level_bytes"
- c:identifier="gst_app_src_get_current_level_bytes"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1707">Get the number of currently queued bytes inside @appsrc.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="155"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1713">The number of currently queued bytes.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1709">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_duration"
- c:identifier="gst_app_src_get_duration"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1571">Get the duration of the stream in nanoseconds. A value of GST_CLOCK_TIME_NONE means that the duration is
-not known.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="140"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1578">the duration of the stream previously set with gst_app_src_set_duration();</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1573">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_emit_signals"
- c:identifier="gst_app_src_get_emit_signals">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1824">Check if appsrc will emit the "new-preroll" and "new-buffer" signals.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="167"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1830">%TRUE if @appsrc is emitting the "new-preroll" and "new-buffer"
-signals.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1826">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_latency" c:identifier="gst_app_src_get_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1776">Retrieve the min and max latencies in @min and @max respectively.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="161"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1778">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="min"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1779">the min latency</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="max"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1780">the max latency</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_max_bytes" c:identifier="gst_app_src_get_max_bytes">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1681">Get the maximum amount of bytes that can be queued in @appsrc.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="152"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1687">The maximum amount of bytes that can be queued.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1683">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_size" c:identifier="gst_app_src_get_size">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1518">Get the size of the stream in bytes. A value of -1 means that the size is
-not known.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="134"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1525">the size of the stream previously set with gst_app_src_set_size();</doc>
- <type name="gint64" c:type="gint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1520">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_type"
- c:identifier="gst_app_src_get_stream_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1626">Get the stream type. Control the stream type of @appsrc
-with gst_app_src_set_stream_type().</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="146"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1633">the stream type.</doc>
- <type name="AppStreamType" c:type="GstAppStreamType"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1628">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="push_buffer" c:identifier="gst_app_src_push_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2081">Adds a buffer to the queue of buffers that the appsrc element will
-push to its source pad. This function takes ownership of the buffer.
-
-When the block property is TRUE, this function can block until free
-space becomes available in the queue.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="170"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2092">#GST_FLOW_OK when the buffer was successfully queued.
-#GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
-#GST_FLOW_EOS when EOS occurred.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2083">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2084">a #GstBuffer to push</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="push_buffer_list"
- c:identifier="gst_app_src_push_buffer_list"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2102">Adds a buffer list to the queue of buffers and buffer lists that the
-appsrc element will push to its source pad. This function takes ownership
-of @buffer_list.
-
-When the block property is TRUE, this function can block until free
-space becomes available in the queue.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="173"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2114">#GST_FLOW_OK when the buffer list was successfully queued.
-#GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
-#GST_FLOW_EOS when EOS occurred.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2104">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="buffer_list" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2105">a #GstBufferList to push</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </method>
- <method name="push_sample"
- c:identifier="gst_app_src_push_sample"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2126">Extract a buffer from the provided sample and adds it to the queue of
-buffers that the appsrc element will push to its source pad. Any
-previous caps that were set on appsrc will be replaced by the caps
-associated with the sample if not equal.
-
-This function does not take ownership of the
-sample so the sample needs to be unreffed after calling this function.
-
-When the block property is TRUE, this function can block until free
-space becomes available in the queue.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="179"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2143">#GST_FLOW_OK when the buffer was successfully queued.
-#GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
-#GST_FLOW_EOS when EOS occurred.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2128">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2129">a #GstSample from which buffer and caps may be
-extracted</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_callbacks"
- c:identifier="gst_app_src_set_callbacks"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2222">Set callbacks which will be executed when data is needed, enough data has
-been collected or when a seek should be performed.
-This is an alternative to using the signals, it has lower overhead and is thus
-less expensive, but also less flexible.
-
-If callbacks are installed, no signals will be emitted for performance
-reasons.
-
-Before 1.16.3 it was not possible to change the callbacks in a thread-safe
-way.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="182"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2224">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="callbacks" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2225">the callbacks</doc>
- <type name="AppSrcCallbacks" c:type="GstAppSrcCallbacks*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2226">a user_data argument for the callbacks</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2227">a destroy notify function</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_caps" c:identifier="gst_app_src_set_caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1420">Set the capabilities on the appsrc element. This function takes
-a copy of the caps structure. After calling this method, the source will
-only produce caps that match @caps. @caps must be fixed and the caps on the
-buffers must match the caps or left NULL.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="125"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1422">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1423">caps to set</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_duration"
- c:identifier="gst_app_src_set_duration"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1545">Set the duration of the stream in nanoseconds. A value of GST_CLOCK_TIME_NONE means that the duration is
-not known.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="137"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1547">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1548">the duration to set</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_emit_signals"
- c:identifier="gst_app_src_set_emit_signals">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1801">Make appsrc emit the "new-preroll" and "new-buffer" signals. This option is
-by default disabled because signal emission is expensive and unneeded when
-the application prefers to operate in pull mode.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="164"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1803">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="emit" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1804">the new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_latency" c:identifier="gst_app_src_set_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1761">Configure the @min and @max latency in @src. If @min is set to -1, the
-default latency calculations for pseudo-live sources will be used.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="158"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1763">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="min" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1764">the min latency</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="max" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1765">the max latency</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_max_bytes" c:identifier="gst_app_src_set_max_bytes">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1653">Set the maximum amount of bytes that can be queued in @appsrc.
-After the maximum amount of bytes are queued, @appsrc will emit the
-"enough-data" signal.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="149"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1655">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="max" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1656">the maximum number of bytes to queue</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_size" c:identifier="gst_app_src_set_size">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1495">Set the size of the stream in bytes. A value of -1 means that the size is
-not known.</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="131"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1497">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1498">the size to set</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_stream_type"
- c:identifier="gst_app_src_set_stream_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1601">Set the stream type on @appsrc. For seekable streams, the "seek" signal must
-be connected to.
-
-A stream_type stream</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="143"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1603">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="1604">the new state</doc>
- <type name="AppStreamType" c:type="GstAppStreamType"/>
- </parameter>
- </parameters>
- </method>
- <property name="block" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="350">When max-bytes are queued and after the enough-data signal has been emitted,
-block any further push-buffer calls until the amount of queued bytes drops
-below the max-bytes limit.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="caps" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="296">The GstCaps that will negotiated downstream and will be put
-on outgoing buffers.</doc>
- <type name="Gst.Caps"/>
- </property>
- <property name="current-level-bytes"
- version="1.2"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="420">The number of currently queued bytes inside appsrc.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="duration"
- version="1.10"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="433">The total duration in nanoseconds of the data stream. If the total duration is known, it
-is recommended to configure it with this property.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="emit-signals" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="395">Make appsrc emit the "need-data", "enough-data" and "seek-data" signals.
-This option is by default enabled for backwards compatibility reasons but
-can disabled when needed because signal emission is expensive.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="format" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="306">The format to use for segment events. When the source is producing
-timestamped buffers this property should be set to GST_FORMAT_TIME.</doc>
- <type name="Gst.Format"/>
- </property>
- <property name="handle-segment-change"
- version="1.18"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="447">When enabled, appsrc will check GstSegment in GstSample which was
-pushed via gst_app_src_push_sample() or "push-sample" signal action.
-If a GstSegment is changed, corresponding segment event will be followed
-by next data flow.
-
-FIXME: currently only GST_FORMAT_TIME format is supported and therefore
-GstAppSrc::format should be time. However, possibly #GstAppSrc can support
-other formats.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="is-live" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="362">Instruct the source to behave like a live source. This includes that it
-will only push out buffers in the PLAYING state.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="max-bytes" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="338">The maximum amount of bytes that can be queued internally.
-After the maximum amount of bytes are queued, appsrc will emit the
-"enough-data" signal.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="max-latency" writable="1" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="min-latency" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="372">The minimum latency of the source. A value of -1 will use the default
-latency calculations of #GstBaseSrc.</doc>
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="min-percent" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="408">Make appsrc emit the "need-data" signal when the amount of bytes in the
-queue drops below this percentage of max-bytes.</doc>
- <type name="guint" c:type="guint"/>
- </property>
- <property name="size" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="316">The total size in bytes of the data stream. If the total size is known, it
-is recommended to configure it with this property.</doc>
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="stream-type" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="327">The type of stream that this source is producing. For seekable streams the
-application should connect to the seek-data signal.</doc>
- <type name="AppStreamType"/>
- </property>
- <field name="basesrc">
- <type name="GstBase.BaseSrc" c:type="GstBaseSrc"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AppSrcPrivate" c:type="GstAppSrcPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="end-of-stream" when="last" action="1">
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn"/>
- </return-value>
- </glib:signal>
- <glib:signal name="enough-data" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="need-data" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="push-buffer" when="last" action="1">
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="Gst.Buffer"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="push-buffer-list" when="last" action="1">
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="Gst.BufferList"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="push-sample" when="last" action="1">
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="Gst.Sample"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="seek-data" when="last">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="AppSrcCallbacks"
- c:type="GstAppSrcCallbacks"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.h"
- line="49">A set of callbacks that can be installed on the appsrc with
-gst_app_src_set_callbacks().</doc>
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="71"/>
- <field name="need_data">
- <callback name="need_data">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="65"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="enough_data">
- <callback name="enough_data">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="66"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="seek_data">
- <callback name="seek_data">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="67"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AppSrcClass"
- c:type="GstAppSrcClass"
- glib:is-gtype-struct-for="AppSrc">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="119"/>
- <field name="basesrc_class">
- <type name="GstBase.BaseSrcClass" c:type="GstBaseSrcClass"/>
- </field>
- <field name="need_data">
- <callback name="need_data">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="107"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="appsrc" transfer-ownership="none">
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="enough_data">
- <callback name="enough_data">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="108"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="appsrc" transfer-ownership="none">
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="seek_data">
- <callback name="seek_data">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="109"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="appsrc" transfer-ownership="none">
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="push_buffer">
- <callback name="push_buffer">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2092">#GST_FLOW_OK when the buffer was successfully queued.
-#GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
-#GST_FLOW_EOS when EOS occurred.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2083">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2084">a #GstBuffer to push</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="end_of_stream">
- <callback name="end_of_stream">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="113"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2188">#GST_FLOW_OK when the EOS was successfully queued.
-#GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2183">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="push_sample">
- <callback name="push_sample">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="114"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2143">#GST_FLOW_OK when the buffer was successfully queued.
-#GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
-#GST_FLOW_EOS when EOS occurred.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2128">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </parameter>
- <parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2129">a #GstSample from which buffer and caps may be
-extracted</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="push_buffer_list">
- <callback name="push_buffer_list">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="115"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2114">#GST_FLOW_OK when the buffer list was successfully queued.
-#GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
-#GST_FLOW_EOS when EOS occurred.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="appsrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2104">a #GstAppSrc</doc>
- <type name="AppSrc" c:type="GstAppSrc*"/>
- </parameter>
- <parameter name="buffer_list" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.c"
- line="2105">a #GstBufferList to push</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="2">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AppSrcPrivate" c:type="GstAppSrcPrivate" disguised="1">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="45"/>
- </record>
- <enumeration name="AppStreamType"
- glib:type-name="GstAppStreamType"
- glib:get-type="gst_app_stream_type_get_type"
- c:type="GstAppStreamType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.h"
- line="73">The stream type.</doc>
- <member name="stream"
- value="0"
- c:identifier="GST_APP_STREAM_TYPE_STREAM"
- glib:nick="stream">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.h"
- line="75">No seeking is supported in the stream, such as a
-live stream.</doc>
- </member>
- <member name="seekable"
- value="1"
- c:identifier="GST_APP_STREAM_TYPE_SEEKABLE"
- glib:nick="seekable">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.h"
- line="77">The stream is seekable but seeking might not
-be very fast, such as data from a webserver.</doc>
- </member>
- <member name="random_access"
- value="2"
- c:identifier="GST_APP_STREAM_TYPE_RANDOM_ACCESS"
- glib:nick="random-access">
- <doc xml:space="preserve"
- filename="gst-libs/gst/app/gstappsrc.h"
- line="79">The stream is seekable and seeking is fast,
-such as in a local file.</doc>
- </member>
- </enumeration>
- <function-macro name="IS_APP_SINK"
- c:identifier="GST_IS_APP_SINK"
- introspectable="0">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_APP_SINK_CLASS"
- c:identifier="GST_IS_APP_SINK_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/app/gstappsink.h" line="36"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_APP_SRC"
- c:identifier="GST_IS_APP_SRC"
- introspectable="0">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_APP_SRC_CLASS"
- c:identifier="GST_IS_APP_SRC_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/app/gstappsrc.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- </namespace>
-</repository>
diff --git a/girs/GstAudio-1.0.gir b/girs/GstAudio-1.0.gir
deleted file mode 100644
index 5ff07b769e..0000000000
--- a/girs/GstAudio-1.0.gir
+++ /dev/null
@@ -1,15495 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="GLib" version="2.0"/>
- <include name="GModule" version="2.0"/>
- <include name="GObject" version="2.0"/>
- <include name="Gst" version="1.0"/>
- <include name="GstBase" version="1.0"/>
- <package name="gstreamer-audio-1.0"/>
- <c:include name="gst/audio/audio.h"/>
- <namespace name="GstAudio"
- version="1.0"
- shared-library="libgstaudio-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <function-macro name="AUDIO_AGGREGATOR"
- c:identifier="GST_AUDIO_AGGREGATOR"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="163"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_AGGREGATOR_CLASS"
- c:identifier="GST_AUDIO_AGGREGATOR_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="164"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_AGGREGATOR_CONVERT_PAD"
- c:identifier="GST_AUDIO_AGGREGATOR_CONVERT_PAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="109"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_AGGREGATOR_CONVERT_PAD_CLASS"
- c:identifier="GST_AUDIO_AGGREGATOR_CONVERT_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="110"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_AGGREGATOR_CONVERT_PAD_GET_CLASS"
- c:identifier="GST_AUDIO_AGGREGATOR_CONVERT_PAD_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="111"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_AGGREGATOR_GET_CLASS"
- c:identifier="GST_AUDIO_AGGREGATOR_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="165"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_AGGREGATOR_PAD"
- c:identifier="GST_AUDIO_AGGREGATOR_PAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="46"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_AGGREGATOR_PAD_CLASS"
- c:identifier="GST_AUDIO_AGGREGATOR_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="47"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_AGGREGATOR_PAD_GET_CLASS"
- c:identifier="GST_AUDIO_AGGREGATOR_PAD_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="48"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BASE_SINK"
- c:identifier="GST_AUDIO_BASE_SINK"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="61"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BASE_SINK_CAST"
- c:identifier="GST_AUDIO_BASE_SINK_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="62"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BASE_SINK_CLASS"
- c:identifier="GST_AUDIO_BASE_SINK_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="63"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BASE_SINK_CLOCK"
- c:identifier="GST_AUDIO_BASE_SINK_CLOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="68">Get the #GstClock of @obj.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="74"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="70">a #GstAudioBaseSink</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BASE_SINK_GET_CLASS"
- c:identifier="GST_AUDIO_BASE_SINK_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="64"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BASE_SINK_PAD"
- c:identifier="GST_AUDIO_BASE_SINK_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="75">Get the sink #GstPad of @obj.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="81"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="77">a #GstAudioBaseSink</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BASE_SRC"
- c:identifier="GST_AUDIO_BASE_SRC"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BASE_SRC_CAST"
- c:identifier="GST_AUDIO_BASE_SRC_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="40"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BASE_SRC_CLASS"
- c:identifier="GST_AUDIO_BASE_SRC_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="41"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BASE_SRC_CLOCK"
- c:identifier="GST_AUDIO_BASE_SRC_CLOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="46">Get the #GstClock of @obj.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="52"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="48">a #GstAudioBaseSrc</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BASE_SRC_GET_CLASS"
- c:identifier="GST_AUDIO_BASE_SRC_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="42"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BASE_SRC_PAD"
- c:identifier="GST_AUDIO_BASE_SRC_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="53">Get the source #GstPad of @obj.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="59"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="55">a #GstAudioBaseSrc</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_BPF"
- c:identifier="GST_AUDIO_BUFFER_BPF"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="85"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_BPS"
- c:identifier="GST_AUDIO_BUFFER_BPS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="84"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_CHANNELS"
- c:identifier="GST_AUDIO_BUFFER_CHANNELS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="77"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_DEPTH"
- c:identifier="GST_AUDIO_BUFFER_DEPTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="82"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_FORMAT"
- c:identifier="GST_AUDIO_BUFFER_FORMAT"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="76"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_LAYOUT"
- c:identifier="GST_AUDIO_BUFFER_LAYOUT"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="78"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_N_PLANES"
- c:identifier="GST_AUDIO_BUFFER_N_PLANES"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="88"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_N_SAMPLES"
- c:identifier="GST_AUDIO_BUFFER_N_SAMPLES"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="87"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_PLANE_DATA"
- c:identifier="GST_AUDIO_BUFFER_PLANE_DATA"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="89"/>
- <parameters>
- <parameter name="b">
- </parameter>
- <parameter name="p">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_PLANE_SIZE"
- c:identifier="GST_AUDIO_BUFFER_PLANE_SIZE"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="92"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_RATE"
- c:identifier="GST_AUDIO_BUFFER_RATE"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="79"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_SAMPLE_STRIDE"
- c:identifier="GST_AUDIO_BUFFER_SAMPLE_STRIDE"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="83"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_BUFFER_WIDTH"
- c:identifier="GST_AUDIO_BUFFER_WIDTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="81"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_CAPS_MAKE"
- c:identifier="GST_AUDIO_CAPS_MAKE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="359">Generic caps string for audio, for use in pad templates.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="352"/>
- <parameters>
- <parameter name="format">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="361">string format that describes the sample layout, as string
- (e.g. "S16LE", "S8", etc.)</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_CD_SRC"
- c:identifier="GST_AUDIO_CD_SRC"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_CD_SRC_CLASS"
- c:identifier="GST_AUDIO_CD_SRC_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_CD_SRC_GET_CLASS"
- c:identifier="GST_AUDIO_CD_SRC_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="AUDIO_CHANNELS_RANGE"
- value="(int) [ 1, max ]"
- c:type="GST_AUDIO_CHANNELS_RANGE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="298">Maximum range of allowed channels, for use in template caps strings.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="303"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="AUDIO_CHANNEL_POSITION_MASK"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_MASK"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-channels.h"
- line="132"/>
- <parameters>
- <parameter name="pos">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_CLOCK"
- c:identifier="GST_AUDIO_CLOCK"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_CLOCK_CAST"
- c:identifier="GST_AUDIO_CLOCK_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="44"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_CLOCK_CLASS"
- c:identifier="GST_AUDIO_CLOCK_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="38"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="AUDIO_CONVERTER_OPT_DITHER_METHOD"
- value="GstAudioConverter.dither-method"
- c:type="GST_AUDIO_CONVERTER_OPT_DITHER_METHOD">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.h"
- line="49">#GstAudioDitherMethod, The dither method to use when
-changing bit depth.
-Default is #GST_AUDIO_DITHER_NONE.</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="56"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_CONVERTER_OPT_MIX_MATRIX"
- value="GstAudioConverter.mix-matrix"
- c:type="GST_AUDIO_CONVERTER_OPT_MIX_MATRIX">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.h"
- line="76">#GST_TYPE_LIST, The channel mapping matrix.
-
-The matrix coefficients must be between -1 and 1: the number of rows is equal
-to the number of output channels and the number of columns is equal to the
-number of input channels.
-
-## Example matrix generation code
-To generate the matrix using code:
-
-|[
-GValue v = G_VALUE_INIT;
-GValue v2 = G_VALUE_INIT;
-GValue v3 = G_VALUE_INIT;
-
-g_value_init (&amp;v2, GST_TYPE_ARRAY);
-g_value_init (&amp;v3, G_TYPE_DOUBLE);
-g_value_set_double (&amp;v3, 1);
-gst_value_array_append_value (&amp;v2, &amp;v3);
-g_value_unset (&amp;v3);
-[ Repeat for as many double as your input channels - unset and reinit v3 ]
-g_value_init (&amp;v, GST_TYPE_ARRAY);
-gst_value_array_append_value (&amp;v, &amp;v2);
-g_value_unset (&amp;v2);
-[ Repeat for as many v2's as your output channels - unset and reinit v2]
-g_object_set_property (G_OBJECT (audiomixmatrix), "matrix", &amp;v);
-g_value_unset (&amp;v);
-]|</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="107"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_CONVERTER_OPT_NOISE_SHAPING_METHOD"
- value="GstAudioConverter.noise-shaping-method"
- c:type="GST_AUDIO_CONVERTER_OPT_NOISE_SHAPING_METHOD">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.h"
- line="58">#GstAudioNoiseShapingMethod, The noise shaping method to use
-to mask noise from quantization errors.
-Default is #GST_AUDIO_NOISE_SHAPING_NONE.</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="65"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_CONVERTER_OPT_QUANTIZATION"
- value="GstAudioConverter.quantization"
- c:type="GST_AUDIO_CONVERTER_OPT_QUANTIZATION">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.h"
- line="67">#G_TYPE_UINT, The quantization amount. Components will be
-quantized to multiples of this value.
-Default is 1</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="74"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_CONVERTER_OPT_RESAMPLER_METHOD"
- value="GstAudioConverter.resampler-method"
- c:type="GST_AUDIO_CONVERTER_OPT_RESAMPLER_METHOD">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.h"
- line="40">#GstAudioResamplerMethod, The resampler method to use when
-changing sample rates.
-Default is #GST_AUDIO_RESAMPLER_METHOD_BLACKMAN_NUTTALL.</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="47"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="AUDIO_DECODER"
- c:identifier="GST_AUDIO_DECODER"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_DECODER_CAST"
- c:identifier="GST_AUDIO_DECODER_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="47"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_DECODER_CLASS"
- c:identifier="GST_AUDIO_DECODER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="39"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_DECODER_ERROR"
- c:identifier="GST_AUDIO_DECODER_ERROR"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="113">Utility function that audio decoder elements can use in case they encountered
-a data processing error that may be fatal for the current "data unit" but
-need not prevent subsequent decoding. Such errors are counted and if there
-are too many, as configured in the context's max_errors, the pipeline will
-post an error message and the application will be requested to stop further
-media processing. Otherwise, it is considered a "glitch" and only a warning
-is logged. In either case, @ret is set to the proper value to
-return to upstream/caller (indicating either GST_FLOW_ERROR or GST_FLOW_OK).</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="133"/>
- <parameters>
- <parameter name="el">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="115">the base audio decoder element that generates the error</doc>
- </parameter>
- <parameter name="weight">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="116">element defined weight of the error, added to error count</doc>
- </parameter>
- <parameter name="domain">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="117">like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)</doc>
- </parameter>
- <parameter name="code">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="118">error code defined for that domain (see #gstreamer-GstGError)</doc>
- </parameter>
- <parameter name="text">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="119">the message to display (format string and args enclosed in
- parentheses)</doc>
- </parameter>
- <parameter name="debug">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="121">debugging information for the message (format string and args
- enclosed in parentheses)</doc>
- </parameter>
- <parameter name="ret">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="123">variable to receive return value</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_DECODER_GET_CLASS"
- c:identifier="GST_AUDIO_DECODER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_DECODER_INPUT_SEGMENT"
- c:identifier="GST_AUDIO_DECODER_INPUT_SEGMENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="83">Gives the input segment of the element.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="88"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="85">audio decoder instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="AUDIO_DECODER_MAX_ERRORS"
- value="10"
- c:type="GST_AUDIO_DECODER_MAX_ERRORS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="145">Default maximum number of errors tolerated before signaling error.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="149"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="AUDIO_DECODER_OUTPUT_SEGMENT"
- c:identifier="GST_AUDIO_DECODER_OUTPUT_SEGMENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="91">Gives the output segment of the element.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="96"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="93">audio decoder instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="AUDIO_DECODER_SINK_NAME"
- value="sink"
- c:type="GST_AUDIO_DECODER_SINK_NAME">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="51">The name of the templates for the sink pad.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="55"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="AUDIO_DECODER_SINK_PAD"
- c:identifier="GST_AUDIO_DECODER_SINK_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="72">Gives the pointer to the sink #GstPad object of the element.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="77"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="74">base audio codec instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="AUDIO_DECODER_SRC_NAME"
- value="src"
- c:type="GST_AUDIO_DECODER_SRC_NAME">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="57">The name of the templates for the source pad.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="61"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="AUDIO_DECODER_SRC_PAD"
- c:identifier="GST_AUDIO_DECODER_SRC_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="64">Gives the pointer to the source #GstPad object of the element.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="69"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="66">base audio codec instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_DECODER_STREAM_LOCK"
- c:identifier="GST_AUDIO_DECODER_STREAM_LOCK"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="79"/>
- <parameters>
- <parameter name="dec">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_DECODER_STREAM_UNLOCK"
- c:identifier="GST_AUDIO_DECODER_STREAM_UNLOCK"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="80"/>
- <parameters>
- <parameter name="dec">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="AUDIO_DEF_CHANNELS"
- value="2"
- c:type="GST_AUDIO_DEF_CHANNELS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="378">Standard number of channels used in consumer audio.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="369"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="AUDIO_DEF_FORMAT"
- value="S16LE"
- c:type="GST_AUDIO_DEF_FORMAT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="384">Standard format used in consumer audio.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="375"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_DEF_RATE" value="44100" c:type="GST_AUDIO_DEF_RATE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="372">Standard sampling rate used in consumer audio.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="363"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="AUDIO_ENCODER"
- c:identifier="GST_AUDIO_ENCODER"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_ENCODER_CAST"
- c:identifier="GST_AUDIO_ENCODER_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_ENCODER_CLASS"
- c:identifier="GST_AUDIO_ENCODER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_ENCODER_GET_CLASS"
- c:identifier="GST_AUDIO_ENCODER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_ENCODER_INPUT_SEGMENT"
- c:identifier="GST_AUDIO_ENCODER_INPUT_SEGMENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="70">Gives the input segment of the element.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="76"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="72">base parse instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_ENCODER_OUTPUT_SEGMENT"
- c:identifier="GST_AUDIO_ENCODER_OUTPUT_SEGMENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="78">Gives the output segment of the element.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="84"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="80">base parse instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="AUDIO_ENCODER_SINK_NAME"
- value="sink"
- c:type="GST_AUDIO_ENCODER_SINK_NAME">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="41">the name of the templates for the sink pad</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="46"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="AUDIO_ENCODER_SINK_PAD"
- c:identifier="GST_AUDIO_ENCODER_SINK_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="62">Gives the pointer to the sink #GstPad object of the element.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="68"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="64">audio encoder instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="AUDIO_ENCODER_SRC_NAME"
- value="src"
- c:type="GST_AUDIO_ENCODER_SRC_NAME">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="47">the name of the templates for the source pad</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="52"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="AUDIO_ENCODER_SRC_PAD"
- c:identifier="GST_AUDIO_ENCODER_SRC_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="54">Gives the pointer to the source #GstPad object of the element.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="60"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="56">audio encoder instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_ENCODER_STREAM_LOCK"
- c:identifier="GST_AUDIO_ENCODER_STREAM_LOCK"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="86"/>
- <parameters>
- <parameter name="enc">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_ENCODER_STREAM_UNLOCK"
- c:identifier="GST_AUDIO_ENCODER_STREAM_UNLOCK"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="87"/>
- <parameters>
- <parameter name="enc">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FILTER"
- c:identifier="GST_AUDIO_FILTER"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FILTER_BPF"
- c:identifier="GST_AUDIO_FILTER_BPF"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="71"/>
- <parameters>
- <parameter name="filter">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FILTER_BPS"
- c:identifier="GST_AUDIO_FILTER_BPS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="72"/>
- <parameters>
- <parameter name="filter">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FILTER_CAST"
- c:identifier="GST_AUDIO_FILTER_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FILTER_CHANNELS"
- c:identifier="GST_AUDIO_FILTER_CHANNELS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="70"/>
- <parameters>
- <parameter name="filter">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FILTER_CLASS"
- c:identifier="GST_AUDIO_FILTER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="40"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FILTER_CLASS_CAST"
- c:identifier="GST_AUDIO_FILTER_CLASS_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="42"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FILTER_FORMAT"
- c:identifier="GST_AUDIO_FILTER_FORMAT"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="68"/>
- <parameters>
- <parameter name="filter">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FILTER_GET_CLASS"
- c:identifier="GST_AUDIO_FILTER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="44"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FILTER_INFO"
- c:identifier="GST_AUDIO_FILTER_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="66"/>
- <parameters>
- <parameter name="filter">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FILTER_RATE"
- c:identifier="GST_AUDIO_FILTER_RATE"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="69"/>
- <parameters>
- <parameter name="filter">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="AUDIO_FORMATS_ALL"
- value="{ F64BE, F64LE, F32BE, F32LE, S32BE, S32LE, U32BE, U32LE, S24_32BE, S24_32LE, U24_32BE, U24_32LE, S24BE, S24LE, U24BE, U24LE, S20BE, S20LE, U20BE, U20LE, S18BE, S18LE, U18BE, U18LE, S16BE, S16LE, U16BE, U16LE, S8, U8 }"
- c:type="GST_AUDIO_FORMATS_ALL">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="325">List of all audio formats, for use in template caps strings.
-
-Formats are sorted by decreasing "quality", using these criteria by priority:
- - depth
- - width
- - Float &gt; Signed &gt; Unsigned
- - native endianness preferred</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="337"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="AUDIO_FORMAT_INFO_DEPTH"
- c:identifier="GST_AUDIO_FORMAT_INFO_DEPTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="271"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FORMAT_INFO_ENDIANNESS"
- c:identifier="GST_AUDIO_FORMAT_INFO_ENDIANNESS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="267"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FORMAT_INFO_FLAGS"
- c:identifier="GST_AUDIO_FORMAT_INFO_FLAGS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="261"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FORMAT_INFO_FORMAT"
- c:identifier="GST_AUDIO_FORMAT_INFO_FORMAT"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="259"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FORMAT_INFO_IS_BIG_ENDIAN"
- c:identifier="GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="269"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FORMAT_INFO_IS_FLOAT"
- c:identifier="GST_AUDIO_FORMAT_INFO_IS_FLOAT"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="264"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FORMAT_INFO_IS_INTEGER"
- c:identifier="GST_AUDIO_FORMAT_INFO_IS_INTEGER"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="263"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN"
- c:identifier="GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="268"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FORMAT_INFO_IS_SIGNED"
- c:identifier="GST_AUDIO_FORMAT_INFO_IS_SIGNED"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="265"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FORMAT_INFO_NAME"
- c:identifier="GST_AUDIO_FORMAT_INFO_NAME"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="260"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_FORMAT_INFO_WIDTH"
- c:identifier="GST_AUDIO_FORMAT_INFO_WIDTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="270"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_BPF"
- c:identifier="GST_AUDIO_INFO_BPF"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="101"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_BPS"
- c:identifier="GST_AUDIO_INFO_BPS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="85"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_CHANNELS"
- c:identifier="GST_AUDIO_INFO_CHANNELS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="100"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_DEPTH"
- c:identifier="GST_AUDIO_INFO_DEPTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="84"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_ENDIANNESS"
- c:identifier="GST_AUDIO_INFO_ENDIANNESS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="91"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_FLAGS"
- c:identifier="GST_AUDIO_INFO_FLAGS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="95"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_FORMAT"
- c:identifier="GST_AUDIO_INFO_FORMAT"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="81"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_IS_BIG_ENDIAN"
- c:identifier="GST_AUDIO_INFO_IS_BIG_ENDIAN"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="93"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_IS_FLOAT"
- c:identifier="GST_AUDIO_INFO_IS_FLOAT"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="88"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_IS_INTEGER"
- c:identifier="GST_AUDIO_INFO_IS_INTEGER"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="87"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_IS_LITTLE_ENDIAN"
- c:identifier="GST_AUDIO_INFO_IS_LITTLE_ENDIAN"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="92"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_IS_SIGNED"
- c:identifier="GST_AUDIO_INFO_IS_SIGNED"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="89"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_IS_UNPOSITIONED"
- c:identifier="GST_AUDIO_INFO_IS_UNPOSITIONED"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="96"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_IS_VALID"
- c:identifier="GST_AUDIO_INFO_IS_VALID"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="79"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_LAYOUT"
- c:identifier="GST_AUDIO_INFO_LAYOUT"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="97"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_NAME"
- c:identifier="GST_AUDIO_INFO_NAME"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="82"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_POSITION"
- c:identifier="GST_AUDIO_INFO_POSITION"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="102"/>
- <parameters>
- <parameter name="info">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_RATE"
- c:identifier="GST_AUDIO_INFO_RATE"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="99"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_INFO_WIDTH"
- c:identifier="GST_AUDIO_INFO_WIDTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="83"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_NE"
- c:identifier="GST_AUDIO_NE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="305">Turns audio format string @s into the format string for native endianness.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="318"/>
- <parameters>
- <parameter name="s">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="307">format string without endianness marker</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_OE"
- c:identifier="GST_AUDIO_OE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="311">Turns audio format string @s into the format string for other endianness.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="319"/>
- <parameters>
- <parameter name="s">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="313">format string without endianness marker</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="AUDIO_RATE_RANGE"
- value="(int) [ 1, max ]"
- c:type="GST_AUDIO_RATE_RANGE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="292">Maximum range of allowed sample rates, for use in template caps strings.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="297"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_OPT_CUBIC_B"
- value="GstAudioResampler.cubic-b"
- c:type="GST_AUDIO_RESAMPLER_OPT_CUBIC_B">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="58">G_TYPE_DOUBLE, B parameter of the cubic filter.
-Values between 0.0 and 2.0 are accepted. 1.0 is the default.
-
-Below are some values of popular filters:
- B C
-Hermite 0.0 0.0
-Spline 1.0 0.0
-Catmull-Rom 0.0 1/2</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="70"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_OPT_CUBIC_C"
- value="GstAudioResampler.cubic-c"
- c:type="GST_AUDIO_RESAMPLER_OPT_CUBIC_C">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="71">G_TYPE_DOUBLE, C parameter of the cubic filter.
-Values between 0.0 and 2.0 are accepted. 0.0 is the default.
-
-See #GST_AUDIO_RESAMPLER_OPT_CUBIC_B for some more common values</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="79"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_OPT_CUTOFF"
- value="GstAudioResampler.cutoff"
- c:type="GST_AUDIO_RESAMPLER_OPT_CUTOFF">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="37">G_TYPE_DOUBLE, Cutoff parameter for the filter. 0.940 is the default.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="42"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_OPT_FILTER_INTERPOLATION"
- value="GstAudioResampler.filter-interpolation"
- c:type="GST_AUDIO_RESAMPLER_OPT_FILTER_INTERPOLATION">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="142">GST_TYPE_AUDIO_RESAMPLER_INTERPOLATION: how the filter coefficients should be
- interpolated.
-GST_AUDIO_RESAMPLER_FILTER_INTERPOLATION_CUBIC is default.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="149"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_OPT_FILTER_MODE"
- value="GstAudioResampler.filter-mode"
- c:type="GST_AUDIO_RESAMPLER_OPT_FILTER_MODE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="108">GST_TYPE_AUDIO_RESAMPLER_FILTER_MODE: how the filter tables should be
-constructed.
-GST_AUDIO_RESAMPLER_FILTER_MODE_AUTO is the default.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="115"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_OPT_FILTER_MODE_THRESHOLD"
- value="GstAudioResampler.filter-mode-threshold"
- c:type="GST_AUDIO_RESAMPLER_OPT_FILTER_MODE_THRESHOLD">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="116">G_TYPE_UINT: the amount of memory to use for full filter tables before
-switching to interpolated filter tables.
-1048576 is the default.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="123"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_OPT_FILTER_OVERSAMPLE"
- value="GstAudioResampler.filter-oversample"
- c:type="GST_AUDIO_RESAMPLER_OPT_FILTER_OVERSAMPLE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="150">G_TYPE_UINT, oversampling to use when interpolating filters
-8 is the default.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="156"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_OPT_MAX_PHASE_ERROR"
- value="GstAudioResampler.max-phase-error"
- c:type="GST_AUDIO_RESAMPLER_OPT_MAX_PHASE_ERROR">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="158">G_TYPE_DOUBLE: The maximum allowed phase error when switching sample
-rates.
-0.1 is the default.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="165"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_OPT_N_TAPS"
- value="GstAudioResampler.n-taps"
- c:type="GST_AUDIO_RESAMPLER_OPT_N_TAPS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="81">G_TYPE_INT: the number of taps to use for the filter.
-0 is the default and selects the taps automatically.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="87"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_OPT_STOP_ATTENUATION"
- value="GstAudioResampler.stop-attenutation"
- c:type="GST_AUDIO_RESAMPLER_OPT_STOP_ATTENUATION">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="43">G_TYPE_DOUBLE, stopband attenuation in decibels. The attenuation
-after the stopband for the kaiser window. 85 dB is the default.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="49"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_OPT_TRANSITION_BANDWIDTH"
- value="GstAudioResampler.transition-bandwidth"
- c:type="GST_AUDIO_RESAMPLER_OPT_TRANSITION_BANDWIDTH">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="50">G_TYPE_DOUBLE, transition bandwidth. The width of the
-transition band for the kaiser window. 0.087 is the default.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="56"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_QUALITY_DEFAULT"
- value="4"
- c:type="GST_AUDIO_RESAMPLER_QUALITY_DEFAULT">
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="215"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_QUALITY_MAX"
- value="10"
- c:type="GST_AUDIO_RESAMPLER_QUALITY_MAX">
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="214"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="AUDIO_RESAMPLER_QUALITY_MIN"
- value="0"
- c:type="GST_AUDIO_RESAMPLER_QUALITY_MIN">
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="213"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="AUDIO_RING_BUFFER"
- c:identifier="GST_AUDIO_RING_BUFFER"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_RING_BUFFER_BROADCAST"
- c:identifier="GST_AUDIO_RING_BUFFER_BROADCAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="162"/>
- <parameters>
- <parameter name="buf">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_RING_BUFFER_CAST"
- c:identifier="GST_AUDIO_RING_BUFFER_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_RING_BUFFER_CLASS"
- c:identifier="GST_AUDIO_RING_BUFFER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_RING_BUFFER_GET_CLASS"
- c:identifier="GST_AUDIO_RING_BUFFER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_RING_BUFFER_GET_COND"
- c:identifier="GST_AUDIO_RING_BUFFER_GET_COND"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="159"/>
- <parameters>
- <parameter name="buf">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_RING_BUFFER_SIGNAL"
- c:identifier="GST_AUDIO_RING_BUFFER_SIGNAL"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="161"/>
- <parameters>
- <parameter name="buf">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_RING_BUFFER_WAIT"
- c:identifier="GST_AUDIO_RING_BUFFER_WAIT"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="160"/>
- <parameters>
- <parameter name="buf">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_SINK"
- c:identifier="GST_AUDIO_SINK"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_SINK_CLASS"
- c:identifier="GST_AUDIO_SINK_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_SINK_GET_CLASS"
- c:identifier="GST_AUDIO_SINK_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_SRC"
- c:identifier="GST_AUDIO_SRC"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_SRC_CLASS"
- c:identifier="GST_AUDIO_SRC_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_SRC_GET_CLASS"
- c:identifier="GST_AUDIO_SRC_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <class name="AudioAggregator"
- c:symbol-prefix="audio_aggregator"
- c:type="GstAudioAggregator"
- version="1.14"
- parent="GstBase.Aggregator"
- abstract="1"
- glib:type-name="GstAudioAggregator"
- glib:get-type="gst_audio_aggregator_get_type"
- glib:type-struct="AudioAggregatorClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioaggregator.c"
- line="26">Subclasses must use (a subclass of) #GstAudioAggregatorPad for both
-their source and sink pads,
-gst_element_class_add_static_pad_template_with_gtype() is a convenient
-helper.
-
-#GstAudioAggregator can perform conversion on the data arriving
-on its sink pads, based on the format expected downstream: in order
-to enable that behaviour, the GType of the sink pads must either be
-a (subclass of) #GstAudioAggregatorConvertPad to use the default
-#GstAudioConverter implementation, or a subclass of #GstAudioAggregatorPad
-implementing #GstAudioAggregatorPadClass.convert_buffer.
-
-To allow for the output caps to change, the mechanism is the same as
-above, with the GType of the source pad.
-
-See #GstAudioMixer for an example.
-
-When conversion is enabled, #GstAudioAggregator will accept
-any type of raw audio caps and perform conversion
-on the data arriving on its sink pads, with whatever downstream
-expects as the target format.
-
-In case downstream caps are not fully fixated, it will use
-the first configured sink pad to finish fixating its source pad
-caps.
-
-A notable exception for now is the sample rate, sink pads must
-have the same sample rate as either the downstream requirement,
-or the first configured pad, or a combination of both (when
-downstream specifies a range or a set of acceptable rates).
-
-The #GstAggregator::samples-selected signal is provided with some
-additional information about the output buffer:
-- "offset" G_TYPE_UINT64 Offset in samples since segment start
- for the position that is next to be filled in the output buffer.
-- "frames" G_TYPE_UINT Number of frames per output buffer.
-
-In addition the gst_aggregator_peek_next_sample() function returns
-additional information in the info #GstStructure of the returned sample:
-- "output-offset" G_TYPE_UINT64 Sample offset in output segment relative to
- the output segment's start where the current position of this input
- buffer would be placed
-- "position" G_TYPE_UINT current position in the input buffer in samples
-- "size" G_TYPE_UINT size of the input buffer in samples</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="212"/>
- <virtual-method name="aggregate_one_buffer">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="206"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="aagg" transfer-ownership="none">
- <type name="AudioAggregator" c:type="GstAudioAggregator*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="AudioAggregatorPad" c:type="GstAudioAggregatorPad*"/>
- </parameter>
- <parameter name="inbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="in_offset" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="outbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="out_offset" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="num_frames" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="create_output_buffer">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="204"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="aagg" transfer-ownership="none">
- <type name="AudioAggregator" c:type="GstAudioAggregator*"/>
- </instance-parameter>
- <parameter name="num_frames" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="set_sink_caps"
- c:identifier="gst_audio_aggregator_set_sink_caps">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="222"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="aagg" transfer-ownership="none">
- <type name="AudioAggregator" c:type="GstAudioAggregator*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="AudioAggregatorPad" c:type="GstAudioAggregatorPad*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <property name="alignment-threshold"
- writable="1"
- transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="discont-wait" writable="1" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="output-buffer-duration"
- writable="1"
- transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="output-buffer-duration-fraction"
- version="1.18"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioaggregator.c"
- line="596">Output block size in nanoseconds, expressed as a fraction.</doc>
- <type name="Gst.Fraction"/>
- </property>
- <field name="parent">
- <type name="GstBase.Aggregator" c:type="GstAggregator"/>
- </field>
- <field name="current_caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="171">The caps set by the subclass</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioAggregatorPrivate"
- c:type="GstAudioAggregatorPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioAggregatorClass"
- c:type="GstAudioAggregatorClass"
- glib:is-gtype-struct-for="AudioAggregator"
- version="1.14">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="212"/>
- <field name="parent_class">
- <type name="GstBase.AggregatorClass" c:type="GstAggregatorClass"/>
- </field>
- <field name="create_output_buffer">
- <callback name="create_output_buffer">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="204"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="aagg" transfer-ownership="none">
- <type name="AudioAggregator" c:type="GstAudioAggregator*"/>
- </parameter>
- <parameter name="num_frames" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="aggregate_one_buffer">
- <callback name="aggregate_one_buffer">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="206"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="aagg" transfer-ownership="none">
- <type name="AudioAggregator" c:type="GstAudioAggregator*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="AudioAggregatorPad" c:type="GstAudioAggregatorPad*"/>
- </parameter>
- <parameter name="inbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="in_offset" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="outbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="out_offset" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="num_frames" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="AudioAggregatorConvertPad"
- c:symbol-prefix="audio_aggregator_convert_pad"
- c:type="GstAudioAggregatorConvertPad"
- version="1.14"
- parent="AudioAggregatorPad"
- glib:type-name="GstAudioAggregatorConvertPad"
- glib:get-type="gst_audio_aggregator_convert_pad_get_type"
- glib:type-struct="AudioAggregatorConvertPadClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="123">An implementation of GstPad that can be used with #GstAudioAggregator.
-
-See #GstAudioAggregator for more details.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="153"/>
- <property name="converter-config" writable="1" transfer-ownership="none">
- <type name="Gst.Structure"/>
- </property>
- <field name="parent" readable="0" private="1">
- <type name="AudioAggregatorPad" c:type="GstAudioAggregatorPad"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioAggregatorConvertPadPrivate"
- c:type="GstAudioAggregatorConvertPadPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioAggregatorConvertPadClass"
- c:type="GstAudioAggregatorConvertPadClass"
- glib:is-gtype-struct-for="AudioAggregatorConvertPad"
- version="1.14">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="153"/>
- <field name="parent_class">
- <type name="AudioAggregatorPadClass"
- c:type="GstAudioAggregatorPadClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AudioAggregatorConvertPadPrivate"
- c:type="GstAudioAggregatorConvertPadPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="121"/>
- </record>
- <class name="AudioAggregatorPad"
- c:symbol-prefix="audio_aggregator_pad"
- c:type="GstAudioAggregatorPad"
- version="1.14"
- parent="GstBase.AggregatorPad"
- glib:type-name="GstAudioAggregatorPad"
- glib:get-type="gst_audio_aggregator_pad_get_type"
- glib:type-struct="AudioAggregatorPadClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="60">The default implementation of GstPad used with #GstAudioAggregator</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="103"/>
- <virtual-method name="convert_buffer">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="94"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <type name="AudioAggregatorPad" c:type="GstAudioAggregatorPad*"/>
- </instance-parameter>
- <parameter name="in_info" transfer-ownership="none">
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </parameter>
- <parameter name="out_info" transfer-ownership="none">
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="update_conversion_info">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="99"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <type name="AudioAggregatorPad" c:type="GstAudioAggregatorPad*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <field name="parent">
- <type name="GstBase.AggregatorPad" c:type="GstAggregatorPad"/>
- </field>
- <field name="info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="62">The audio info for this pad set from the incoming caps</doc>
- <type name="AudioInfo" c:type="GstAudioInfo"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioAggregatorPadPrivate"
- c:type="GstAudioAggregatorPadPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioAggregatorPadClass"
- c:type="GstAudioAggregatorPadClass"
- glib:is-gtype-struct-for="AudioAggregatorPad"
- version="1.14">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="103"/>
- <field name="parent_class">
- <type name="GstBase.AggregatorPadClass"
- c:type="GstAggregatorPadClass"/>
- </field>
- <field name="convert_buffer">
- <callback name="convert_buffer">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="94"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <type name="AudioAggregatorPad" c:type="GstAudioAggregatorPad*"/>
- </parameter>
- <parameter name="in_info" transfer-ownership="none">
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </parameter>
- <parameter name="out_info" transfer-ownership="none">
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="update_conversion_info">
- <callback name="update_conversion_info">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="99"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <type name="AudioAggregatorPad" c:type="GstAudioAggregatorPad*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AudioAggregatorPadPrivate"
- c:type="GstAudioAggregatorPadPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="58"/>
- </record>
- <record name="AudioAggregatorPrivate"
- c:type="GstAudioAggregatorPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="37"/>
- </record>
- <class name="AudioBaseSink"
- c:symbol-prefix="audio_base_sink"
- c:type="GstAudioBaseSink"
- parent="GstBase.BaseSink"
- glib:type-name="GstAudioBaseSink"
- glib:get-type="gst_audio_base_sink_get_type"
- glib:type-struct="AudioBaseSinkClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="23">This is the base class for audio sinks. Subclasses need to implement the
-::create_ringbuffer vmethod. This base class will then take care of
-writing samples to the ringbuffer, synchronisation, clipping and flushing.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="221"/>
- <virtual-method name="create_ringbuffer" invoker="create_ringbuffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="2249">Create and return the #GstAudioRingBuffer for @sink. This function will
-call the ::create_ringbuffer vmethod and will set @sink as the parent of
-the returned buffer (see gst_object_set_parent()).</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="214"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="2257">The new ringbuffer of @sink.</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="2251">a #GstAudioBaseSink.</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="payload">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="217"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="create_ringbuffer"
- c:identifier="gst_audio_base_sink_create_ringbuffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="2249">Create and return the #GstAudioRingBuffer for @sink. This function will
-call the ::create_ringbuffer vmethod and will set @sink as the parent of
-the returned buffer (see gst_object_set_parent()).</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="228"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="2257">The new ringbuffer of @sink.</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="2251">a #GstAudioBaseSink.</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_alignment_threshold"
- c:identifier="gst_audio_base_sink_get_alignment_threshold">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="694">Get the current alignment threshold, in nanoseconds, used by @sink.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="254"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="700">The current alignment threshold used by @sink.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="696">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_discont_wait"
- c:identifier="gst_audio_base_sink_get_discont_wait">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="801">Get the current discont wait, in nanoseconds, used by @sink.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="261"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="807">The current discont wait used by @sink.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="803">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_drift_tolerance"
- c:identifier="gst_audio_base_sink_get_drift_tolerance">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="654">Get the current drift tolerance, in microseconds, used by @sink.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="247"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="660">The current drift tolerance used by @sink.</doc>
- <type name="gint64" c:type="gint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="656">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_provide_clock"
- c:identifier="gst_audio_base_sink_get_provide_clock">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="572">Queries whether @sink will provide a clock or not. See also
-gst_audio_base_sink_set_provide_clock.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="234"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="579">%TRUE if @sink will provide a clock.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="574">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_slave_method"
- c:identifier="gst_audio_base_sink_get_slave_method">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="613">Get the current slave method used by @sink.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="241"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="619">The current slave method used by @sink.</doc>
- <type name="AudioBaseSinkSlaveMethod"
- c:type="GstAudioBaseSinkSlaveMethod"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="615">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="report_device_failure"
- c:identifier="gst_audio_base_sink_report_device_failure"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="778">Informs this base class that the audio output device has failed for
-some reason, causing a discontinuity (for example, because the device
-recovered from the error, but lost all contents of its ring buffer).
-This function is typically called by derived classes, and is useful
-for the custom slave method.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="271"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="780">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_alignment_threshold"
- c:identifier="gst_audio_base_sink_set_alignment_threshold">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="676">Controls the sink's alignment threshold.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="250"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="678">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- <parameter name="alignment_threshold" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="679">the new alignment threshold in nanoseconds</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_custom_slaving_callback"
- c:identifier="gst_audio_base_sink_set_custom_slaving_callback"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="734">Sets the custom slaving callback. This callback will
-be invoked if the slave-method property is set to
-GST_AUDIO_BASE_SINK_SLAVE_CUSTOM and the audio sink
-receives and plays samples.
-
-Setting the callback to NULL causes the sink to
-behave as if the GST_AUDIO_BASE_SINK_SLAVE_NONE
-method were used.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="265"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="736">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- <parameter name="callback"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="737">a #GstAudioBaseSinkCustomSlavingCallback</doc>
- <type name="AudioBaseSinkCustomSlavingCallback"
- c:type="GstAudioBaseSinkCustomSlavingCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="738">user data passed to the callback</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="739">called when user_data becomes unused</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_discont_wait"
- c:identifier="gst_audio_base_sink_set_discont_wait">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="716">Controls how long the sink will wait before creating a discontinuity.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="257"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="718">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- <parameter name="discont_wait" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="719">the new discont wait in nanoseconds</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_drift_tolerance"
- c:identifier="gst_audio_base_sink_set_drift_tolerance">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="636">Controls the sink's drift tolerance.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="244"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="638">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- <parameter name="drift_tolerance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="639">the new drift tolerance in microseconds</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_provide_clock"
- c:identifier="gst_audio_base_sink_set_provide_clock">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="548">Controls whether @sink will provide a clock or not. If @provide is %TRUE,
-gst_element_provide_clock() will return a clock that reflects the datarate
-of @sink. If @provide is %FALSE, gst_element_provide_clock() will return
-NULL.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="231"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="550">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- <parameter name="provide" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="551">new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_slave_method"
- c:identifier="gst_audio_base_sink_set_slave_method">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="595">Controls how clock slaving will be performed in @sink.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="237"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="597">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </instance-parameter>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="598">the new slave method</doc>
- <type name="AudioBaseSinkSlaveMethod"
- c:type="GstAudioBaseSinkSlaveMethod"/>
- </parameter>
- </parameters>
- </method>
- <property name="alignment-threshold"
- writable="1"
- transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="buffer-time" writable="1" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="can-activate-pull"
- writable="1"
- transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="discont-wait" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="237">A window of time in nanoseconds to wait before creating a discontinuity as
-a result of breaching the drift-tolerance.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="drift-tolerance" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="214">Controls the amount of time in microseconds that clocks are allowed
-to drift before resynchronisation happens.</doc>
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="latency-time" writable="1" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="provide-clock" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="slave-method" writable="1" transfer-ownership="none">
- <type name="AudioBaseSinkSlaveMethod"/>
- </property>
- <field name="element">
- <type name="GstBase.BaseSink" c:type="GstBaseSink"/>
- </field>
- <field name="ringbuffer">
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </field>
- <field name="buffer_time">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="latency_time">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="next_sample">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="provided_clock">
- <type name="Gst.Clock" c:type="GstClock*"/>
- </field>
- <field name="eos_rendering">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioBaseSinkPrivate" c:type="GstAudioBaseSinkPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioBaseSinkClass"
- c:type="GstAudioBaseSinkClass"
- glib:is-gtype-struct-for="AudioBaseSink">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="198">#GstAudioBaseSink class. Override the vmethod to implement
-functionality.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="221"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="200">the parent class.</doc>
- <type name="GstBase.BaseSinkClass" c:type="GstBaseSinkClass"/>
- </field>
- <field name="create_ringbuffer">
- <callback name="create_ringbuffer">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="214"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="2257">The new ringbuffer of @sink.</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.c"
- line="2251">a #GstAudioBaseSink.</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="payload">
- <callback name="payload">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="217"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <callback name="AudioBaseSinkCustomSlavingCallback"
- c:type="GstAudioBaseSinkCustomSlavingCallback"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="130">This function is set with gst_audio_base_sink_set_custom_slaving_callback()
-and is called during playback. It receives the current time of external and
-internal clocks, which the callback can then use to apply any custom
-slaving/synchronization schemes.
-
-The external clock is the sink's element clock, the internal one is the
-internal audio clock. The internal audio clock's calibration is applied to
-the timestamps before they are passed to the callback. The difference between
-etime and itime is the skew; how much internal and external clock lie apart
-from each other. A skew of 0 means both clocks are perfectly in sync.
-itime &gt; etime means the external clock is going slower, while itime &lt; etime
-means it is going faster than the internal clock. etime and itime are always
-valid timestamps, except for when a discontinuity happens.
-
-requested_skew is an output value the callback can write to. It informs the
-sink of whether or not it should move the playout pointer, and if so, by how
-much. This pointer is only NULL if a discontinuity occurs; otherwise, it is
-safe to write to *requested_skew. The default skew is 0.
-
-The sink may experience discontinuities. If one happens, discont is TRUE,
-itime, etime are set to GST_CLOCK_TIME_NONE, and requested_skew is NULL.
-This makes it possible to reset custom clock slaving algorithms when a
-discontinuity happens.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="165"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="132">a #GstAudioBaseSink</doc>
- <type name="AudioBaseSink" c:type="GstAudioBaseSink*"/>
- </parameter>
- <parameter name="etime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="133">external clock time</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="itime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="134">internal clock time</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="requested_skew" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="135">skew amount requested by the callback</doc>
- <type name="Gst.ClockTimeDiff" c:type="GstClockTimeDiff*"/>
- </parameter>
- <parameter name="discont_reason" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="136">reason for discontinuity (if any)</doc>
- <type name="AudioBaseSinkDiscontReason"
- c:type="GstAudioBaseSinkDiscontReason"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="5">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="137">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <enumeration name="AudioBaseSinkDiscontReason"
- version="1.6"
- glib:type-name="GstAudioBaseSinkDiscontReason"
- glib:get-type="gst_audio_base_sink_discont_reason_get_type"
- c:type="GstAudioBaseSinkDiscontReason">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="106">Different possible reasons for discontinuities. This enum is useful for the custom
-slave method.</doc>
- <member name="no_discont"
- value="0"
- c:identifier="GST_AUDIO_BASE_SINK_DISCONT_REASON_NO_DISCONT"
- glib:nick="no-discont">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="108">No discontinuity occurred</doc>
- </member>
- <member name="new_caps"
- value="1"
- c:identifier="GST_AUDIO_BASE_SINK_DISCONT_REASON_NEW_CAPS"
- glib:nick="new-caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="109">New caps are set, causing renegotiotion</doc>
- </member>
- <member name="flush"
- value="2"
- c:identifier="GST_AUDIO_BASE_SINK_DISCONT_REASON_FLUSH"
- glib:nick="flush">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="110">Samples have been flushed</doc>
- </member>
- <member name="sync_latency"
- value="3"
- c:identifier="GST_AUDIO_BASE_SINK_DISCONT_REASON_SYNC_LATENCY"
- glib:nick="sync-latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="111">Sink was synchronized to the estimated latency (occurs during initialization)</doc>
- </member>
- <member name="alignment"
- value="4"
- c:identifier="GST_AUDIO_BASE_SINK_DISCONT_REASON_ALIGNMENT"
- glib:nick="alignment">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="112">Aligning buffers failed because the timestamps are too discontinuous</doc>
- </member>
- <member name="device_failure"
- value="5"
- c:identifier="GST_AUDIO_BASE_SINK_DISCONT_REASON_DEVICE_FAILURE"
- glib:nick="device-failure">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="113">Audio output device experienced and recovered from an error but introduced latency in the process (see also @gst_audio_base_sink_report_device_failure())</doc>
- </member>
- </enumeration>
- <record name="AudioBaseSinkPrivate"
- c:type="GstAudioBaseSinkPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="104"/>
- </record>
- <enumeration name="AudioBaseSinkSlaveMethod"
- glib:type-name="GstAudioBaseSinkSlaveMethod"
- glib:get-type="gst_audio_base_sink_slave_method_get_type"
- c:type="GstAudioBaseSinkSlaveMethod">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="83">Different possible clock slaving algorithms used when the internal audio
-clock is not selected as the pipeline master clock.</doc>
- <member name="resample"
- value="0"
- c:identifier="GST_AUDIO_BASE_SINK_SLAVE_RESAMPLE"
- glib:nick="resample">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="85">Resample to match the master clock</doc>
- </member>
- <member name="skew"
- value="1"
- c:identifier="GST_AUDIO_BASE_SINK_SLAVE_SKEW"
- glib:nick="skew">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="86">Adjust playout pointer when master clock
-drifts too much.</doc>
- </member>
- <member name="none"
- value="2"
- c:identifier="GST_AUDIO_BASE_SINK_SLAVE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="88">No adjustment is done.</doc>
- </member>
- <member name="custom"
- value="3"
- c:identifier="GST_AUDIO_BASE_SINK_SLAVE_CUSTOM"
- glib:nick="custom">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="89">Use custom clock slaving algorithm (Since: 1.6)</doc>
- </member>
- </enumeration>
- <class name="AudioBaseSrc"
- c:symbol-prefix="audio_base_src"
- c:type="GstAudioBaseSrc"
- parent="GstBase.PushSrc"
- glib:type-name="GstAudioBaseSrc"
- glib:get-type="gst_audio_base_src_get_type"
- glib:type-struct="AudioBaseSrcClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="23">This is the base class for audio sources. Subclasses need to implement the
-::create_ringbuffer vmethod. This base class will then take care of
-reading samples from the ringbuffer, synchronisation and flushing.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="133"/>
- <virtual-method name="create_ringbuffer" invoker="create_ringbuffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="1075">Create and return the #GstAudioRingBuffer 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()).</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="129"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="1083">The new ringbuffer of @src.</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="1077">a #GstAudioBaseSrc.</doc>
- <type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <method name="create_ringbuffer"
- c:identifier="gst_audio_base_src_create_ringbuffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="1075">Create and return the #GstAudioRingBuffer 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()).</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="140"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="1083">The new ringbuffer of @src.</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="1077">a #GstAudioBaseSrc.</doc>
- <type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_provide_clock"
- c:identifier="gst_audio_base_src_get_provide_clock">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="354">Queries whether @src will provide a clock or not. See also
-gst_audio_base_src_set_provide_clock.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="146"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="361">%TRUE if @src will provide a clock.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="356">a #GstAudioBaseSrc</doc>
- <type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_slave_method"
- c:identifier="gst_audio_base_src_get_slave_method">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="395">Get the current slave method used by @src.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="153"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="401">The current slave method used by @src.</doc>
- <type name="AudioBaseSrcSlaveMethod"
- c:type="GstAudioBaseSrcSlaveMethod"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="397">a #GstAudioBaseSrc</doc>
- <type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_provide_clock"
- c:identifier="gst_audio_base_src_set_provide_clock">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="332">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 NULL.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="143"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="334">a #GstAudioBaseSrc</doc>
- <type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
- </instance-parameter>
- <parameter name="provide" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="335">new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_slave_method"
- c:identifier="gst_audio_base_src_set_slave_method">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="377">Controls how clock slaving will be performed in @src.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="149"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="379">a #GstAudioBaseSrc</doc>
- <type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
- </instance-parameter>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="380">the new slave method</doc>
- <type name="AudioBaseSrcSlaveMethod"
- c:type="GstAudioBaseSrcSlaveMethod"/>
- </parameter>
- </parameters>
- </method>
- <property name="actual-buffer-time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="159">Actual configured size of audio buffer in microseconds.</doc>
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="actual-latency-time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="170">Actual configured audio latency in microseconds.</doc>
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="buffer-time" writable="1" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="latency-time" writable="1" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="provide-clock" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="slave-method" writable="1" transfer-ownership="none">
- <type name="AudioBaseSrcSlaveMethod"/>
- </property>
- <field name="element">
- <type name="GstBase.PushSrc" c:type="GstPushSrc"/>
- </field>
- <field name="ringbuffer">
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </field>
- <field name="buffer_time">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="latency_time">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="next_sample">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="clock">
- <type name="Gst.Clock" c:type="GstClock*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioBaseSrcPrivate" c:type="GstAudioBaseSrcPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioBaseSrcClass"
- c:type="GstAudioBaseSrcClass"
- glib:is-gtype-struct-for="AudioBaseSrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="117">#GstAudioBaseSrc class. Override the vmethod to implement
-functionality.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="133"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="119">the parent class.</doc>
- <type name="GstBase.PushSrcClass" c:type="GstPushSrcClass"/>
- </field>
- <field name="create_ringbuffer">
- <callback name="create_ringbuffer">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="129"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="1083">The new ringbuffer of @src.</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.c"
- line="1077">a #GstAudioBaseSrc.</doc>
- <type name="AudioBaseSrc" c:type="GstAudioBaseSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AudioBaseSrcPrivate"
- c:type="GstAudioBaseSrcPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="63"/>
- </record>
- <enumeration name="AudioBaseSrcSlaveMethod"
- glib:type-name="GstAudioBaseSrcSlaveMethod"
- glib:get-type="gst_audio_base_src_slave_method_get_type"
- c:type="GstAudioBaseSrcSlaveMethod">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="67">Different possible clock slaving algorithms when the internal audio clock was
-not selected as the pipeline clock.</doc>
- <member name="resample"
- value="0"
- c:identifier="GST_AUDIO_BASE_SRC_SLAVE_RESAMPLE"
- glib:nick="resample">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="69">Resample to match the master clock.</doc>
- </member>
- <member name="re_timestamp"
- value="1"
- c:identifier="GST_AUDIO_BASE_SRC_SLAVE_RE_TIMESTAMP"
- glib:nick="re-timestamp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="70">Retimestamp output buffers with master
-clock time.</doc>
- </member>
- <member name="skew"
- value="2"
- c:identifier="GST_AUDIO_BASE_SRC_SLAVE_SKEW"
- glib:nick="skew">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="72">Adjust capture pointer when master clock
-drifts too much.</doc>
- </member>
- <member name="none"
- value="3"
- c:identifier="GST_AUDIO_BASE_SRC_SLAVE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="74">No adjustment is done.</doc>
- </member>
- </enumeration>
- <record name="AudioBuffer" c:type="GstAudioBuffer" version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.h"
- line="30">A structure containing the result of an audio buffer map operation,
-which is executed with gst_audio_buffer_map(). For non-interleaved (planar)
-buffers, the beginning of each channel in the buffer has its own pointer in
-the @planes array. For interleaved buffers, the @planes array only contains
-one item, which is the pointer to the beginning of the buffer, and @n_planes
-equals 1.
-
-The different channels in @planes are always in the GStreamer channel order.</doc>
- <source-position filename="gst-libs/gst/audio/audio-buffer.h" line="65"/>
- <field name="info" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.h"
- line="32">a #GstAudioInfo describing the audio properties of this buffer</doc>
- <type name="AudioInfo" c:type="GstAudioInfo"/>
- </field>
- <field name="n_samples" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.h"
- line="33">the size of the buffer in samples</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="n_planes" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.h"
- line="34">the number of planes available</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="planes" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.h"
- line="35">an array of @n_planes pointers pointing to the start of each
- plane in the mapped buffer</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </field>
- <field name="buffer" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.h"
- line="37">the mapped buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="map_infos" readable="0" private="1">
- <type name="Gst.MapInfo" c:type="GstMapInfo*"/>
- </field>
- <field name="priv_planes_arr" readable="0" private="1">
- <array zero-terminated="0" fixed-size="8">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="priv_map_infos_arr" readable="0" private="1">
- <array zero-terminated="0" fixed-size="8">
- <type name="Gst.MapInfo" c:type="GstMapInfo"/>
- </array>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="map" c:identifier="gst_audio_buffer_map" version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.c"
- line="56">Maps an audio @gstbuffer so that it can be read or written and stores the
-result of the map operation in @buffer.
-
-This is especially useful when the @gstbuffer is in non-interleaved (planar)
-layout, in which case this function will use the information in the
-@gstbuffer's attached #GstAudioMeta in order to map each channel in a
-separate "plane" in #GstAudioBuffer. If a #GstAudioMeta is not attached
-on the @gstbuffer, then it must be in interleaved layout.
-
-If a #GstAudioMeta is attached, then the #GstAudioInfo on the meta is checked
-against @info. Normally, they should be equal, but in case they are not,
-a g_critical will be printed and the #GstAudioInfo from the meta will be
-used.
-
-In non-interleaved buffers, it is possible to have each channel on a separate
-#GstMemory. In this case, each memory will be mapped separately to avoid
-copying their contents in a larger memory area. Do note though that it is
-not supported to have a single channel spanning over two or more different
-#GstMemory objects. Although the map operation will likely succeed in this
-case, it will be highly sub-optimal and it is recommended to merge all the
-memories in the buffer before calling this function.
-
-Note: The actual #GstBuffer is not ref'ed, but it is required to stay valid
-as long as it's mapped.</doc>
- <source-position filename="gst-libs/gst/audio/audio-buffer.h"
- line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.c"
- line="88">%TRUE if the map operation succeeded or %FALSE on failure</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.c"
- line="58">pointer to a #GstAudioBuffer</doc>
- <type name="AudioBuffer" c:type="GstAudioBuffer*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.c"
- line="59">the audio properties of the buffer</doc>
- <type name="AudioInfo" c:type="const GstAudioInfo*"/>
- </parameter>
- <parameter name="gstbuffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.c"
- line="60">the #GstBuffer to be mapped</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.c"
- line="61">the access mode for the memory</doc>
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="unmap"
- c:identifier="gst_audio_buffer_unmap"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.c"
- line="41">Unmaps an audio buffer that was previously mapped with
-gst_audio_buffer_map().</doc>
- <source-position filename="gst-libs/gst/audio/audio-buffer.h"
- line="73"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-buffer.c"
- line="43">the #GstAudioBuffer to unmap</doc>
- <type name="AudioBuffer" c:type="GstAudioBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="clip" c:identifier="gst_audio_buffer_clip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="58">Clip the buffer to the given %GstSegment.
-
-After calling this function the caller does not own a reference to
-@buffer anymore.</doc>
- <source-position filename="gst-libs/gst/audio/audio.h" line="96"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="72">%NULL if the buffer is completely outside the configured segment,
-otherwise the clipped buffer is returned.
-
-If the buffer has no timestamp, it is assumed to be inside the segment and
-is not clipped</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="60">The buffer to clip.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="61">Segment in %GST_FORMAT_TIME or %GST_FORMAT_DEFAULT to which
- the buffer should be clipped.</doc>
- <type name="Gst.Segment" c:type="const GstSegment*"/>
- </parameter>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="63">sample rate.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="bpf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="64">size of one audio frame in bytes. This is the size of one sample *
-number of channels.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="reorder_channels"
- c:identifier="gst_audio_buffer_reorder_channels">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="278">Reorders @buffer from the channel positions @from to the channel
-positions @to. @from and @to must contain the same number of
-positions and the same positions, only in a different order.
-@buffer must be writable.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channels.h"
- line="135"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="291">%TRUE if the reordering was possible.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="280">The buffer to reorder.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="281">The %GstAudioFormat of the buffer.</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="282">The number of channels.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="from" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="283">The channel positions in the buffer.</doc>
- <array length="2"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- <parameter name="to" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="284">The channel positions to convert to.</doc>
- <array length="2"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="truncate"
- c:identifier="gst_audio_buffer_truncate"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="247">Truncate the buffer to finally have @samples number of samples, removing
-the necessary amount of samples from the end and @trim number of samples
-from the beginning.
-
-After calling this function the caller does not own a reference to
-@buffer anymore.</doc>
- <source-position filename="gst-libs/gst/audio/audio.h" line="101"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="264">the truncated buffer or %NULL if the arguments
- were invalid</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="249">The buffer to truncate.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="bpf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="250">size of one audio frame in bytes. This is the size of one sample *
-number of channels.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="trim" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="252">the number of samples to remove from the beginning of the buffer</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="253">the final number of samples that should exist in this buffer or -1
-to use all the remaining samples if you are only removing samples from the
-beginning.</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <class name="AudioCdSrc"
- c:symbol-prefix="audio_cd_src"
- c:type="GstAudioCdSrc"
- parent="GstBase.PushSrc"
- glib:type-name="GstAudioCdSrc"
- glib:get-type="gst_audio_cd_src_get_type"
- glib:type-struct="AudioCdSrcClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.c"
- line="37">Provides a base class for CD digital audio (CDDA) sources, which handles
-things like seeking, querying, discid calculation, tags, and buffer
-timestamping.
-
-## Using GstAudioCdSrc-based elements in applications
-
-GstAudioCdSrc registers two #GstFormat&lt;!-- --&gt;s of its own, namely
-the "track" format and the "sector" format. Applications will usually
-only find the "track" format interesting. You can retrieve that #GstFormat
-for use in seek events or queries with gst_format_get_by_nick("track").
-
-In order to query the number of tracks, for example, an application would
-set the CDDA source element to READY or PAUSED state and then query the
-the number of tracks via gst_element_query_duration() using the track
-format acquired above. Applications can query the currently playing track
-in the same way.
-
-Alternatively, applications may retrieve the currently playing track and
-the total number of tracks from the taglist that will posted on the bus
-whenever the CD is opened or the currently playing track changes. The
-taglist will contain GST_TAG_TRACK_NUMBER and GST_TAG_TRACK_COUNT tags.
-
-Applications playing back CD audio using playbin and cdda://n URIs should
-issue a seek command in track format to change between tracks, rather than
-setting a new cdda://n+1 URI on playbin (as setting a new URI on playbin
-involves closing and re-opening the CD device, which is much much slower).
-
-## Tags and meta-information
-
-CDDA sources will automatically emit a number of tags, details about which
-can be found in the libgsttag documentation. Those tags are:
-#GST_TAG_CDDA_CDDB_DISCID, #GST_TAG_CDDA_CDDB_DISCID_FULL,
-#GST_TAG_CDDA_MUSICBRAINZ_DISCID, #GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL,
-among others.
-
-## Tracks and Table of Contents (TOC)
-
-Applications will be informed of the available tracks via a TOC message
-on the pipeline's #GstBus. The #GstToc will contain a #GstTocEntry for
-each track, with information about each track. The duration for each
-track can be retrieved via the #GST_TAG_DURATION tag from each entry's
-tag list, or calculated via gst_toc_entry_get_start_stop_times().
-The track entries in the TOC will be sorted by track number.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="132"/>
- <implements name="Gst.URIHandler"/>
- <virtual-method name="close">
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="116"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="open">
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="115"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
- </instance-parameter>
- <parameter name="device" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="read_sector">
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="119"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
- </instance-parameter>
- <parameter name="sector" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add_track" c:identifier="gst_audio_cd_src_add_track">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.c"
- line="1072">CDDA sources use this function from their start vfunc to announce the
-available data and audio tracks to the base source class. The caller
-should allocate @track on the stack, the base source will do a shallow
-copy of the structure (and take ownership of the taglist if there is one).</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="138"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.c"
- line="1082">FALSE on error, otherwise TRUE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.c"
- line="1074">a #GstAudioCdSrc</doc>
- <type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
- </instance-parameter>
- <parameter name="track" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.c"
- line="1075">address of #GstAudioCdSrcTrack to add</doc>
- <type name="AudioCdSrcTrack" c:type="GstAudioCdSrcTrack*"/>
- </parameter>
- </parameters>
- </method>
- <property name="device" writable="1" transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="mode" writable="1" transfer-ownership="none">
- <type name="AudioCdSrcMode"/>
- </property>
- <property name="track" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <field name="pushsrc">
- <type name="GstBase.PushSrc" c:type="GstPushSrc"/>
- </field>
- <field name="tags">
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioCdSrcPrivate" c:type="GstAudioCdSrcPrivate*"/>
- </field>
- <field name="_gst_reserved1" readable="0" private="1">
- <array zero-terminated="0" fixed-size="2">
- <type name="guint" c:type="guint"/>
- </array>
- </field>
- <field name="_gst_reserved2" readable="0" private="1">
- <array zero-terminated="0" fixed-size="2">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioCdSrcClass"
- c:type="GstAudioCdSrcClass"
- glib:is-gtype-struct-for="AudioCdSrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="100">Audio CD source base class.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="132"/>
- <field name="pushsrc_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="102">the parent class</doc>
- <type name="GstBase.PushSrcClass" c:type="GstPushSrcClass"/>
- </field>
- <field name="open">
- <callback name="open">
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="115"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
- </parameter>
- <parameter name="device" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="close">
- <callback name="close">
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="116"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="read_sector">
- <callback name="read_sector">
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="119"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AudioCdSrc" c:type="GstAudioCdSrc*"/>
- </parameter>
- <parameter name="sector" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <enumeration name="AudioCdSrcMode"
- glib:type-name="GstAudioCdSrcMode"
- glib:get-type="gst_audio_cd_src_mode_get_type"
- c:type="GstAudioCdSrcMode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="44">Mode in which the CD audio source operates. Influences timestamping,
-EOS handling and seeking.</doc>
- <member name="normal"
- value="0"
- c:identifier="GST_AUDIO_CD_SRC_MODE_NORMAL"
- glib:nick="normal">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="46">each single track is a stream</doc>
- </member>
- <member name="continuous"
- value="1"
- c:identifier="GST_AUDIO_CD_SRC_MODE_CONTINUOUS"
- glib:nick="continuous">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="47">the entire disc is a single stream</doc>
- </member>
- </enumeration>
- <record name="AudioCdSrcPrivate"
- c:type="GstAudioCdSrcPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="42"/>
- </record>
- <record name="AudioCdSrcTrack" c:type="GstAudioCdSrcTrack">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="57">CD track abstraction to communicate TOC entries to the base class.
-
-This structure is only for use by sub-classed in connection with
-gst_audio_cd_src_add_track().
-
-Applications will be informed of the available tracks via a TOC message
-on the pipeline's #GstBus instead.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="84"/>
- <field name="is_audio" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="59">Whether this is an audio track</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="num" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="60">Track number in TOC (usually starts from 1, but not always)</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="start" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="61">The first sector of this track (LBA)</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="end" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="62">The last sector of this track (LBA)</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="tags" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="63">Track-specific tags (e.g. from cd-text information), or NULL</doc>
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </field>
- <field name="_gst_reserved1" readable="0" private="1">
- <array zero-terminated="0" fixed-size="2">
- <type name="guint" c:type="guint"/>
- </array>
- </field>
- <field name="_gst_reserved2" readable="0" private="1">
- <array zero-terminated="0" fixed-size="2">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AudioChannelMixer"
- c:type="GstAudioChannelMixer"
- disguised="1">
- <source-position filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="29"/>
- <method name="free" c:identifier="gst_audio_channel_mixer_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="76">Free memory allocated by @mix.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="65"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="mix" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="78">a #GstAudioChannelMixer</doc>
- <type name="AudioChannelMixer" c:type="GstAudioChannelMixer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_passthrough"
- c:identifier="gst_audio_channel_mixer_is_passthrough">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="1009">Check if @mix is in passthrough.
-
-Only N x N mix identity matrices are considered passthrough,
-this is determined by comparing the contents of the matrix
-with 0.0 and 1.0.
-
-As this is floating point comparisons, if the values have been
-generated, they should be rounded up or down by explicit
-assignment of 0.0 or 1.0 to values within a user-defined
-epsilon, this code doesn't make assumptions as to what may
-constitute an appropriate epsilon.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="72"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="1025">%TRUE is @mix is passthrough.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="mix" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="1011">a #GstAudioChannelMixer</doc>
- <type name="AudioChannelMixer" c:type="GstAudioChannelMixer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="samples" c:identifier="gst_audio_channel_mixer_samples">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="1052">In case the samples are interleaved, @in and @out must point to an
-array with a single element pointing to a block of interleaved samples.
-
-If non-interleaved samples are used, @in and @out must point to an
-array with pointers to memory blocks, one for each channel.
-
-Perform channel mixing on @in_data and write the result to @out_data.
-@in_data and @out_data need to be in @format and @layout.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="79"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="mix" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="1054">a #GstAudioChannelMixer</doc>
- <type name="AudioChannelMixer" c:type="GstAudioChannelMixer*"/>
- </instance-parameter>
- <parameter name="in"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="1055">input samples</doc>
- <type name="gpointer" c:type="const gpointer*"/>
- </parameter>
- <parameter name="out"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="1056">output samples</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="1057">number of samples</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <function name="new"
- c:identifier="gst_audio_channel_mixer_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="973">Create a new channel mixer object for the given parameters.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="50"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="983">a new #GstAudioChannelMixer object, or %NULL if @format isn't supported.
- Free with gst_audio_channel_mixer_free() after usage.</doc>
- <type name="AudioChannelMixer" c:type="GstAudioChannelMixer*"/>
- </return-value>
- <parameters>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="975">#GstAudioChannelMixerFlags</doc>
- <type name="AudioChannelMixerFlags"
- c:type="GstAudioChannelMixerFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- <parameter name="in_channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="976">number of input channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="in_position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="977">positions of input channels</doc>
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition*"/>
- </parameter>
- <parameter name="out_channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="978">number of output channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="979">positions of output channels</doc>
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition*"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_with_matrix"
- c:identifier="gst_audio_channel_mixer_new_with_matrix"
- version="1.14"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="809">Create a new channel mixer object for the given parameters.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="58"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="820">a new #GstAudioChannelMixer object, or %NULL if @format isn't supported,
- @matrix is invalid, or @matrix is %NULL and @in_channels != @out_channels.
- Free with gst_audio_channel_mixer_free() after usage.</doc>
- <type name="AudioChannelMixer" c:type="GstAudioChannelMixer*"/>
- </return-value>
- <parameters>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="811">#GstAudioChannelMixerFlags</doc>
- <type name="AudioChannelMixerFlags"
- c:type="GstAudioChannelMixerFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- <parameter name="in_channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="812">number of input channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="813">number of output channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="matrix"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="814">channel conversion matrix, m[@in_channels][@out_channels].
- If identity matrix, passthrough applies. If %NULL, a (potentially truncated)
- identity matrix is generated.</doc>
- <type name="gfloat" c:type="gfloat**"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <bitfield name="AudioChannelMixerFlags"
- glib:type-name="GstAudioChannelMixerFlags"
- glib:get-type="gst_audio_channel_mixer_flags_get_type"
- c:type="GstAudioChannelMixerFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="31">Flags passed to gst_audio_channel_mixer_new()</doc>
- <member name="none"
- value="0"
- c:identifier="GST_AUDIO_CHANNEL_MIXER_FLAGS_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="33">no flag</doc>
- </member>
- <member name="non_interleaved_in"
- value="1"
- c:identifier="GST_AUDIO_CHANNEL_MIXER_FLAGS_NON_INTERLEAVED_IN"
- glib:nick="non-interleaved-in">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="34">input channels are not interleaved</doc>
- </member>
- <member name="non_interleaved_out"
- value="2"
- c:identifier="GST_AUDIO_CHANNEL_MIXER_FLAGS_NON_INTERLEAVED_OUT"
- glib:nick="non-interleaved-out">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="35">output channels are not interleaved</doc>
- </member>
- <member name="unpositioned_in"
- value="4"
- c:identifier="GST_AUDIO_CHANNEL_MIXER_FLAGS_UNPOSITIONED_IN"
- glib:nick="unpositioned-in">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="36">input channels are explicitly unpositioned</doc>
- </member>
- <member name="unpositioned_out"
- value="8"
- c:identifier="GST_AUDIO_CHANNEL_MIXER_FLAGS_UNPOSITIONED_OUT"
- glib:nick="unpositioned-out">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="37">output channels are explicitly unpositioned</doc>
- </member>
- </bitfield>
- <enumeration name="AudioChannelPosition"
- glib:type-name="GstAudioChannelPosition"
- glib:get-type="gst_audio_channel_position_get_type"
- c:type="GstAudioChannelPosition">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="31">Audio channel positions.
-
-These are the channels defined in SMPTE 2036-2-2008
-Table 1 for 22.2 audio systems with the Surround and Wide channels from
-DTS Coherent Acoustics (v.1.3.1) and 10.2 and 7.1 layouts. In the caps the
-actual channel layout is expressed with a channel count and a channel mask,
-which describes the existing channels. The positions in the bit mask correspond
-to the enum values.
-For negotiation it is allowed to have more bits set in the channel mask than
-the number of channels to specify the allowed channel positions but this is
-not allowed in negotiated caps. It is not allowed in any situation other
-than the one mentioned below to have less bits set in the channel mask than
-the number of channels.
-
-@GST_AUDIO_CHANNEL_POSITION_MONO can only be used with a single mono channel that
-has no direction information and would be mixed into all directional channels.
-This is expressed in caps by having a single channel and no channel mask.
-
-@GST_AUDIO_CHANNEL_POSITION_NONE can only be used if all channels have this position.
-This is expressed in caps by having a channel mask with no bits set.
-
-As another special case it is allowed to have two channels without a channel mask.
-This implicitly means that this is a stereo stream with a front left and front right
-channel.</doc>
- <member name="none"
- value="-3"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="63">used for position-less channels, e.g.
- from a sound card that records 1024 channels; mutually exclusive with
- any other channel position</doc>
- </member>
- <member name="mono"
- value="-2"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_MONO"
- glib:nick="mono">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="33">Mono without direction;
- can only be used with 1 channel</doc>
- </member>
- <member name="invalid"
- value="-1"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="66">invalid position</doc>
- </member>
- <member name="front_left"
- value="0"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT"
- glib:nick="front-left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="35">Front left</doc>
- </member>
- <member name="front_right"
- value="1"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT"
- glib:nick="front-right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="36">Front right</doc>
- </member>
- <member name="front_center"
- value="2"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER"
- glib:nick="front-center">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="37">Front center</doc>
- </member>
- <member name="lfe1"
- value="3"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_LFE1"
- glib:nick="lfe1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="38">Low-frequency effects 1 (subwoofer)</doc>
- </member>
- <member name="rear_left"
- value="4"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_REAR_LEFT"
- glib:nick="rear-left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="39">Rear left</doc>
- </member>
- <member name="rear_right"
- value="5"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_REAR_RIGHT"
- glib:nick="rear-right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="40">Rear right</doc>
- </member>
- <member name="front_left_of_center"
- value="6"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER"
- glib:nick="front-left-of-center">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="41">Front left of center</doc>
- </member>
- <member name="front_right_of_center"
- value="7"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER"
- glib:nick="front-right-of-center">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="42">Front right of center</doc>
- </member>
- <member name="rear_center"
- value="8"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_REAR_CENTER"
- glib:nick="rear-center">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="43">Rear center</doc>
- </member>
- <member name="lfe2"
- value="9"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_LFE2"
- glib:nick="lfe2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="44">Low-frequency effects 2 (subwoofer)</doc>
- </member>
- <member name="side_left"
- value="10"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_SIDE_LEFT"
- glib:nick="side-left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="45">Side left</doc>
- </member>
- <member name="side_right"
- value="11"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_SIDE_RIGHT"
- glib:nick="side-right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="46">Side right</doc>
- </member>
- <member name="top_front_left"
- value="12"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_LEFT"
- glib:nick="top-front-left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="47">Top front left</doc>
- </member>
- <member name="top_front_right"
- value="13"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_RIGHT"
- glib:nick="top-front-right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="48">Top front right</doc>
- </member>
- <member name="top_front_center"
- value="14"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_CENTER"
- glib:nick="top-front-center">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="49">Top front center</doc>
- </member>
- <member name="top_center"
- value="15"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_CENTER"
- glib:nick="top-center">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="50">Top center</doc>
- </member>
- <member name="top_rear_left"
- value="16"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_REAR_LEFT"
- glib:nick="top-rear-left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="51">Top rear left</doc>
- </member>
- <member name="top_rear_right"
- value="17"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_REAR_RIGHT"
- glib:nick="top-rear-right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="52">Top rear right</doc>
- </member>
- <member name="top_side_left"
- value="18"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_SIDE_LEFT"
- glib:nick="top-side-left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="53">Top side right</doc>
- </member>
- <member name="top_side_right"
- value="19"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_SIDE_RIGHT"
- glib:nick="top-side-right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="54">Top rear right</doc>
- </member>
- <member name="top_rear_center"
- value="20"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_TOP_REAR_CENTER"
- glib:nick="top-rear-center">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="55">Top rear center</doc>
- </member>
- <member name="bottom_front_center"
- value="21"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_BOTTOM_FRONT_CENTER"
- glib:nick="bottom-front-center">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="56">Bottom front center</doc>
- </member>
- <member name="bottom_front_left"
- value="22"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_BOTTOM_FRONT_LEFT"
- glib:nick="bottom-front-left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="57">Bottom front left</doc>
- </member>
- <member name="bottom_front_right"
- value="23"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_BOTTOM_FRONT_RIGHT"
- glib:nick="bottom-front-right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="58">Bottom front right</doc>
- </member>
- <member name="wide_left"
- value="24"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_WIDE_LEFT"
- glib:nick="wide-left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="59">Wide left (between front left and side left)</doc>
- </member>
- <member name="wide_right"
- value="25"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_WIDE_RIGHT"
- glib:nick="wide-right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="60">Wide right (between front right and side right)</doc>
- </member>
- <member name="surround_left"
- value="26"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_SURROUND_LEFT"
- glib:nick="surround-left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="61">Surround left (between rear left and side left)</doc>
- </member>
- <member name="surround_right"
- value="27"
- c:identifier="GST_AUDIO_CHANNEL_POSITION_SURROUND_RIGHT"
- glib:nick="surround-right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.h"
- line="62">Surround right (between rear right and side right)</doc>
- </member>
- </enumeration>
- <record name="AudioClippingMeta"
- c:type="GstAudioClippingMeta"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="85">Extra buffer metadata describing how much audio has to be clipped from
-the start or end of a buffer. This is used for compressed formats, where
-the first frame usually has some additional samples due to encoder and
-decoder delays, and the last frame usually has some additional samples to
-be able to fill the complete last frame.
-
-This is used to ensure that decoded data in the end has the same amount of
-samples, and multiply decoded streams can be gaplessly concatenated.
-
-Note: If clipping of the start is done by adjusting the segment, this meta
-has to be dropped from buffers as otherwise clipping could happen twice.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="112"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="87">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="format" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="88">GstFormat of @start and @stop, GST_FORMAT_DEFAULT is samples</doc>
- <type name="Gst.Format" c:type="GstFormat"/>
- </field>
- <field name="start" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="89">Amount of audio to clip from start of buffer</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="end" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="90">Amount of to clip from end of buffer</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <function name="get_info"
- c:identifier="gst_audio_clipping_meta_get_info">
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="118"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <class name="AudioClock"
- c:symbol-prefix="audio_clock"
- c:type="GstAudioClock"
- parent="Gst.SystemClock"
- glib:type-name="GstAudioClock"
- glib:get-type="gst_audio_clock_get_type"
- glib:type-struct="AudioClockClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="23">#GstAudioClock makes it easy for elements to implement a #GstClock, they
-simply need to provide a function that returns the current clock time.
-
-This object is internally used to implement the clock in #GstAudioBaseSink.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="90"/>
- <constructor name="new" c:identifier="gst_audio_clock_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="89">Create a new #GstAudioClock instance. Whenever the clock time should be
-calculated it will call @func with @user_data. When @func returns
-#GST_CLOCK_TIME_NONE, the clock will return the last reported time.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="96"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="100">a new #GstAudioClock casted to a #GstClock.</doc>
- <type name="Gst.Clock" c:type="GstClock*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="91">the name of the clock</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="notified"
- closure="2"
- destroy="3">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="92">a function</doc>
- <type name="AudioClockGetTimeFunc"
- c:type="GstAudioClockGetTimeFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="93">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="destroy_notify"
- transfer-ownership="none"
- scope="async">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="94">#GDestroyNotify for @user_data</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="adjust" c:identifier="gst_audio_clock_adjust">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="207">Adjust @time with the internal offset of the audio clock.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="106"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="214">@time adjusted with the internal offset.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="209">a #GstAudioClock</doc>
- <type name="AudioClock" c:type="GstAudioClock*"/>
- </instance-parameter>
- <parameter name="time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="210">a #GstClockTime</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_time" c:identifier="gst_audio_clock_get_time">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="180">Report the time as returned by the #GstAudioClockGetTimeFunc without applying
-any offsets.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="103"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="187">the time as reported by the time function of the audio clock</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="182">a #GstAudioClock</doc>
- <type name="AudioClock" c:type="GstAudioClock*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="invalidate" c:identifier="gst_audio_clock_invalidate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="226">Invalidate the clock function. Call this function when the provided
-#GstAudioClockGetTimeFunc cannot be called anymore, for example, when the
-user_data becomes invalid.
-
-After calling this function, @clock will return the last returned time for
-the rest of its lifetime.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="109"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="228">a #GstAudioClock</doc>
- <type name="AudioClock" c:type="GstAudioClock*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reset" c:identifier="gst_audio_clock_reset">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="119">Inform @clock that future calls to #GstAudioClockGetTimeFunc will return values
-starting from @time. The clock will update an internal offset to make sure that
-future calls to internal_time will return an increasing result as required by
-the #GstClock object.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="100"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="121">a #GstAudioClock</doc>
- <type name="AudioClock" c:type="GstAudioClock*"/>
- </instance-parameter>
- <parameter name="time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.c"
- line="122">a #GstClockTime</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <field name="clock">
- <type name="Gst.SystemClock" c:type="GstSystemClock"/>
- </field>
- <field name="func">
- <type name="AudioClockGetTimeFunc" c:type="GstAudioClockGetTimeFunc"/>
- </field>
- <field name="user_data">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="destroy_notify">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="last_time" readable="0" private="1">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="time_offset" readable="0" private="1">
- <type name="Gst.ClockTimeDiff" c:type="GstClockTimeDiff"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioClockClass"
- c:type="GstAudioClockClass"
- glib:is-gtype-struct-for="AudioClock">
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="90"/>
- <field name="parent_class">
- <type name="Gst.SystemClockClass" c:type="GstSystemClockClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <callback name="AudioClockGetTimeFunc" c:type="GstAudioClockGetTimeFunc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.h"
- line="51">This function will be called whenever the current clock time needs to be
-calculated. If this function returns #GST_CLOCK_TIME_NONE, the last reported
-time will be returned by the clock.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="63"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.h"
- line="60">the current time or #GST_CLOCK_TIME_NONE if the previous time should
-be used.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.h"
- line="53">the #GstAudioClock</doc>
- <type name="Gst.Clock" c:type="GstClock*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioclock.h"
- line="54">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="AudioConverter"
- c:type="GstAudioConverter"
- version="1.8"
- glib:type-name="GstAudioConverter"
- glib:get-type="gst_audio_converter_get_type"
- c:symbol-prefix="audio_converter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="33">This object is used to convert audio samples from one format to another.
-The object can perform conversion of:
-
- * audio format with optional dithering and noise shaping
-
- * audio samplerate
-
- * audio channels and channel layout</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="38"/>
- <constructor name="new" c:identifier="gst_audio_converter_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1306">Create a new #GstAudioConverter that is able to convert between @in and @out
-audio formats.
-
-@config contains extra configuration options, see `GST_AUDIO_CONVERTER_OPT_*`
-parameters for details about the options and values.</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="126"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1319">a #GstAudioConverter or %NULL if conversion is not possible.</doc>
- <type name="AudioConverter" c:type="GstAudioConverter*"/>
- </return-value>
- <parameters>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1308">extra #GstAudioConverterFlags</doc>
- <type name="AudioConverterFlags" c:type="GstAudioConverterFlags"/>
- </parameter>
- <parameter name="in_info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1309">a source #GstAudioInfo</doc>
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </parameter>
- <parameter name="out_info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1310">a destination #GstAudioInfo</doc>
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </parameter>
- <parameter name="config"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1311">a #GstStructure with configuration options</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="convert"
- c:identifier="gst_audio_converter_convert"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1599">Convenience wrapper around gst_audio_converter_samples(), which will
-perform allocation of the output buffer based on the result from
-gst_audio_converter_get_out_frames().</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="173"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1613">%TRUE is the conversion could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1601">a #GstAudioConverter</doc>
- <type name="AudioConverter" c:type="GstAudioConverter*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1602">extra #GstAudioConverterFlags</doc>
- <type name="AudioConverterFlags" c:type="GstAudioConverterFlags"/>
- </parameter>
- <parameter name="in" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1603">input data</doc>
- <array length="2" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="in_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1604">size of @in</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="out"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1605">a pointer where
- the output data will be written</doc>
- <array length="4" zero-terminated="0" c:type="gpointer*">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="out_size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1607">a pointer where the size of @out will be written</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_audio_converter_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1447">Free a previously allocated @convert instance.</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="135"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1449">a #GstAudioConverter</doc>
- <type name="AudioConverter" c:type="GstAudioConverter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_config" c:identifier="gst_audio_converter_get_config">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="375">Get the current configuration of @convert.</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="146"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="383">
- a #GstStructure that remains valid for as long as @convert is valid
- or until gst_audio_converter_update_config() is called.</doc>
- <type name="Gst.Structure" c:type="const GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="377">a #GstAudioConverter</doc>
- <type name="AudioConverter" c:type="GstAudioConverter*"/>
- </instance-parameter>
- <parameter name="in_rate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="378">result input rate</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="out_rate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="379">result output rate</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_in_frames"
- c:identifier="gst_audio_converter_get_in_frames">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1501">Calculate how many input frames are currently needed by @convert to produce
-@out_frames of output frames.</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="154"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1509">the number of input frames</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1503">a #GstAudioConverter</doc>
- <type name="AudioConverter" c:type="GstAudioConverter*"/>
- </instance-parameter>
- <parameter name="out_frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1504">number of output frames</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_max_latency"
- c:identifier="gst_audio_converter_get_max_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1521">Get the maximum number of input frames that the converter would
-need before producing output.</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="158"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1528">the latency of @convert as expressed in the number of
-frames.</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1523">a #GstAudioConverter</doc>
- <type name="AudioConverter" c:type="GstAudioConverter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_out_frames"
- c:identifier="gst_audio_converter_get_out_frames">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1481">Calculate how many output frames can be produced when @in_frames input
-frames are given to @convert.</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="150"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1489">the number of output frames</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1483">a #GstAudioConverter</doc>
- <type name="AudioConverter" c:type="GstAudioConverter*"/>
- </instance-parameter>
- <parameter name="in_frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1484">number of input frames</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_passthrough"
- c:identifier="gst_audio_converter_is_passthrough"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1655">Returns whether the audio converter will operate in passthrough mode.
-The return value would be typically input to gst_base_transform_set_passthrough()</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="170"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1661">%TRUE when no conversion will actually occur.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <type name="AudioConverter" c:type="GstAudioConverter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reset" c:identifier="gst_audio_converter_reset">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1540">Reset @convert to the state it was when it was first created, clearing
-any history it might currently have.</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="138"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1542">a #GstAudioConverter</doc>
- <type name="AudioConverter" c:type="GstAudioConverter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="samples" c:identifier="gst_audio_converter_samples">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1556">Perform the conversion with @in_frames in @in to @out_frames in @out
-using @convert.
-
-In case the samples are interleaved, @in and @out must point to an
-array with a single element pointing to a block of interleaved samples.
-
-If non-interleaved samples are used, @in and @out must point to an
-array with pointers to memory blocks, one for each channel.
-
-@in may be %NULL, in which case @in_frames of silence samples are processed
-by the converter.
-
-This function always produces @out_frames of output and consumes @in_frames of
-input. Use gst_audio_converter_get_out_frames() and
-gst_audio_converter_get_in_frames() to make sure @in_frames and @out_frames
-are matching and @in and @out point to enough memory.</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="161"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1582">%TRUE is the conversion could be performed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1558">a #GstAudioConverter</doc>
- <type name="AudioConverter" c:type="GstAudioConverter*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1559">extra #GstAudioConverterFlags</doc>
- <type name="AudioConverterFlags" c:type="GstAudioConverterFlags"/>
- </parameter>
- <parameter name="in"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1560">input frames</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="in_frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1561">number of input frames</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="out"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1562">output frames</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="out_frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1563">number of output frames</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="supports_inplace"
- c:identifier="gst_audio_converter_supports_inplace"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1638">Returns whether the audio converter can perform the conversion in-place.
-The return value would be typically input to gst_base_transform_set_in_place()</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="167"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1645">%TRUE when the conversion can be done in place.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="1640">a #GstAudioConverter</doc>
- <type name="AudioConverter" c:type="GstAudioConverter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="update_config"
- c:identifier="gst_audio_converter_update_config">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="322">Set @in_rate, @out_rate and @config as extra configuration for @convert.
-
-@in_rate and @out_rate specify the new sample rates of input and output
-formats. A value of 0 leaves the sample rate unchanged.
-
-@config can be %NULL, in which case, the current configuration is not
-changed.
-
-If the parameters in @config can not be set exactly, this function returns
-%FALSE and will try to update as much state as possible. The new state can
-then be retrieved and refined with gst_audio_converter_get_config().
-
-Look at the `GST_AUDIO_CONVERTER_OPT_*` fields to check valid configuration
-option and values.</doc>
- <source-position filename="gst-libs/gst/audio/audio-converter.h"
- line="141"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="344">%TRUE when the new parameters could be set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="324">a #GstAudioConverter</doc>
- <type name="AudioConverter" c:type="GstAudioConverter*"/>
- </instance-parameter>
- <parameter name="in_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="325">input rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="326">output rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="config"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.c"
- line="327">a #GstStructure or %NULL</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <bitfield name="AudioConverterFlags"
- glib:type-name="GstAudioConverterFlags"
- glib:get-type="gst_audio_converter_flags_get_type"
- c:type="GstAudioConverterFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.h"
- line="109">Extra flags passed to gst_audio_converter_new() and gst_audio_converter_samples().</doc>
- <member name="none"
- value="0"
- c:identifier="GST_AUDIO_CONVERTER_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.h"
- line="111">no flag</doc>
- </member>
- <member name="in_writable"
- value="1"
- c:identifier="GST_AUDIO_CONVERTER_FLAG_IN_WRITABLE"
- glib:nick="in-writable">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.h"
- line="112">the input sample arrays are writable and can be
- used as temporary storage during conversion.</doc>
- </member>
- <member name="variable_rate"
- value="2"
- c:identifier="GST_AUDIO_CONVERTER_FLAG_VARIABLE_RATE"
- glib:nick="variable-rate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-converter.h"
- line="114">allow arbitrary rate updates with
- gst_audio_converter_update_config().</doc>
- </member>
- </bitfield>
- <class name="AudioDecoder"
- c:symbol-prefix="audio_decoder"
- c:type="GstAudioDecoder"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstAudioDecoder"
- glib:get-type="gst_audio_decoder_get_type"
- glib:type-struct="AudioDecoderClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="24">This base class is for audio decoders turning encoded data into
-raw audio samples.
-
-GstAudioDecoder and subclass should cooperate as follows.
-
-## Configuration
-
- * Initially, GstAudioDecoder calls @start when the decoder element
- is activated, which allows subclass to perform any global setup.
- Base class (context) parameters can already be set according to subclass
- capabilities (or possibly upon receive more information in subsequent
- @set_format).
- * GstAudioDecoder calls @set_format to inform subclass of the format
- of input audio data that it is about to receive.
- While unlikely, it might be called more than once, if changing input
- parameters require reconfiguration.
- * GstAudioDecoder calls @stop at end of all processing.
-
-As of configuration stage, and throughout processing, GstAudioDecoder
-provides various (context) parameters, e.g. describing the format of
-output audio data (valid when output caps have been set) or current parsing state.
-Conversely, subclass can and should configure context to inform
-base class of its expectation w.r.t. buffer handling.
-
-## Data processing
- * Base class gathers input data, and optionally allows subclass
- to parse this into subsequently manageable (as defined by subclass)
- chunks. Such chunks are subsequently referred to as 'frames',
- though they may or may not correspond to 1 (or more) audio format frame.
- * Input frame is provided to subclass' @handle_frame.
- * If codec processing results in decoded data, subclass should call
- @gst_audio_decoder_finish_frame to have decoded data pushed
- downstream.
- * Just prior to actually pushing a buffer downstream,
- it is passed to @pre_push. Subclass should either use this callback
- to arrange for additional downstream pushing or otherwise ensure such
- custom pushing occurs after at least a method call has finished since
- setting src pad caps.
- * During the parsing process GstAudioDecoderClass will handle both
- srcpad and sinkpad events. Sink events will be passed to subclass
- if @event callback has been provided.
-
-## Shutdown phase
-
- * GstAudioDecoder class calls @stop to inform the subclass that data
- parsing will be stopped.
-
-Subclass is responsible for providing pad template caps for
-source and sink pads. The pads need to be named "sink" and "src". It also
-needs to set the fixed caps on srcpad, when the format is ensured. This
-is typically when base class calls subclass' @set_format function, though
-it might be delayed until calling @gst_audio_decoder_finish_frame.
-
-In summary, above process should have subclass concentrating on
-codec data processing while leaving other matters to base class,
-such as most notably timestamp handling. While it may exert more control
-in this area (see e.g. @pre_push), it is very much not recommended.
-
-In particular, base class will try to arrange for perfect output timestamps
-as much as possible while tracking upstream timestamps.
-To this end, if deviation between the next ideal expected perfect timestamp
-and upstream exceeds #GstAudioDecoder:tolerance, then resync to upstream
-occurs (which would happen always if the tolerance mechanism is disabled).
-
-In non-live pipelines, baseclass can also (configurably) arrange for
-output buffer aggregation which may help to redue large(r) numbers of
-small(er) buffers being pushed and processed downstream. Note that this
-feature is only available if the buffer layout is interleaved. For planar
-buffers, the decoder implementation is fully responsible for the output
-buffer size.
-
-On the other hand, it should be noted that baseclass only provides limited
-seeking support (upon explicit subclass request), as full-fledged support
-should rather be left to upstream demuxer, parser or alike. This simple
-approach caters for seeking and duration reporting using estimated input
-bitrates.
-
-Things that subclass need to take care of:
-
- * Provide pad templates
- * Set source pad caps when appropriate
- * Set user-configurable properties to sane defaults for format and
- implementing codec at hand, and convey some subclass capabilities and
- expectations in context.
-
- * Accept data in @handle_frame and provide encoded results to
- @gst_audio_decoder_finish_frame. If it is prepared to perform
- PLC, it should also accept NULL data in @handle_frame and provide for
- data for indicated duration.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="315"/>
- <virtual-method name="close">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="294"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="decide_allocation">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="298"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="flush">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="282"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="hard" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="getcaps">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="307"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="handle_frame">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="279"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="negotiate" invoker="negotiate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="759">Negotiate with downstream elements to currently configured #GstAudioInfo.
-Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
-negotiate fails.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="296"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="767">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="761">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="open">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="292"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="parse">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="275"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="adapter" transfer-ownership="none">
- <type name="GstBase.Adapter" c:type="GstAdapter*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="pre_push">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="284"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="propose_allocation">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="300"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_format">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="272"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_event">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="287"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_query">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="303"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_event">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="289"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_query">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="305"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="268"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="270"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="transform_meta">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="310"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="outbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="meta" transfer-ownership="none">
- <type name="Gst.Meta" c:type="GstMeta*"/>
- </parameter>
- <parameter name="inbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="allocate_output_buffer"
- c:identifier="gst_audio_decoder_allocate_output_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3742">Helper function that allocates a buffer to hold an audio frame
-for @dec's current output format.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="344"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3750">allocated buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3744">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3745">size of the buffer</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="finish_frame"
- c:identifier="gst_audio_decoder_finish_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="1304">Collects decoded data and pushes it downstream.
-
-@buf may be NULL in which case the indicated number of frames
-are discarded and considered to have produced no output
-(e.g. lead-in or setup frames).
-Otherwise, source pad caps must be set when it is called with valid
-data in @buf.
-
-Note that a frame received in #GstAudioDecoderClass.handle_frame() may be
-invalidated by a call to this function.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="340"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="1321">a #GstFlowReturn that should be escalated to caller (of caller)</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="1306">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="buf"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="1307">decoded data</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="1308">number of decoded frames represented by decoded data</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="finish_subframe"
- c:identifier="gst_audio_decoder_finish_subframe"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="1270">Collects decoded data and pushes it downstream. This function may be called
-multiple times for a given input frame.
-
-@buf may be NULL in which case it is assumed that the current input frame is
-finished. This is equivalent to calling gst_audio_decoder_finish_subframe()
-with a NULL buffer and frames=1 after having pushed out all decoded audio
-subframes using this function.
-
-When called with valid data in @buf the source pad caps must have been set
-already.
-
-Note that a frame received in #GstAudioDecoderClass.handle_frame() may be
-invalidated by a call to this function.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="336"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="1289">a #GstFlowReturn that should be escalated to caller (of caller)</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="1272">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="buf"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="1273">decoded data</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_allocator"
- c:identifier="gst_audio_decoder_get_allocator">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3793">Lets #GstAudioDecoder sub-classes to know the memory @allocator
-used by the base class and its @params.
-
-Unref the @allocator after use it.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="433"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3795">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="allocator"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3796">the #GstAllocator
-used</doc>
- <type name="Gst.Allocator" c:type="GstAllocator**"/>
- </parameter>
- <parameter name="params"
- direction="out"
- caller-allocates="1"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3798">the
-#GstAllocationParams of @allocator</doc>
- <type name="Gst.AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_audio_info"
- c:identifier="gst_audio_decoder_get_audio_info">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="350"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3273">a #GstAudioInfo describing the input audio format</doc>
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3271">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_delay" c:identifier="gst_audio_decoder_get_delay">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="367"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3345">currently configured decoder delay</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3343">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_drainable"
- c:identifier="gst_audio_decoder_get_drainable">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3631">Queries decoder drain handling.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="423"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3637">TRUE if drainable handling is enabled.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3633">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_estimate_rate"
- c:identifier="gst_audio_decoder_get_estimate_rate">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="364"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3331">currently configured byte to time conversion setting</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3329">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_latency" c:identifier="gst_audio_decoder_get_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3413">Sets the variables pointed to by @min and @max to the currently configured
-latency.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="382"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3415">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="min"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3416">a pointer to storage to hold minimum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="max"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3417">a pointer to storage to hold maximum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_max_errors"
- c:identifier="gst_audio_decoder_get_max_errors">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="374"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3377">currently configured decoder tolerated error count.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3375">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_min_latency"
- c:identifier="gst_audio_decoder_get_min_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3542">Queries decoder's latency aggregation.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="409"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3548">aggregation latency.
-
-MT safe.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3544">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_needs_format"
- c:identifier="gst_audio_decoder_get_needs_format">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3679">Queries decoder required format handling.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="430"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3685">TRUE if required format handling is enabled.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3681">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_parse_state"
- c:identifier="gst_audio_decoder_get_parse_state">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3436">Return current parsing (sync and eos) state.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="387"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3438">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="sync"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3439">a pointer to a variable to hold the current sync state</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="eos"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3440">a pointer to a variable to hold the current eos state</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_plc" c:identifier="gst_audio_decoder_get_plc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3499">Queries decoder packet loss concealment handling.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="402"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3505">TRUE if packet loss concealment is enabled.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3501">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_plc_aware"
- c:identifier="gst_audio_decoder_get_plc_aware">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="357"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3302">currently configured plc handling</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3300">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tolerance"
- c:identifier="gst_audio_decoder_get_tolerance">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3585">Queries current audio jitter tolerance threshold.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="416"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3591">decoder audio jitter tolerance threshold.
-
-MT safe.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3587">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="merge_tags" c:identifier="gst_audio_decoder_merge_tags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3703">Sets the audio decoder tags and how they should be merged with any
-upstream stream tags. This will override any tags previously-set
-with gst_audio_decoder_merge_tags().
-
-Note that this is provided for convenience, and the subclass is
-not required to use this and can still do tag handling on its own.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="438"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3705">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="tags"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3706">a #GstTagList to merge, or NULL</doc>
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3707">the #GstTagMergeMode to use, usually #GST_TAG_MERGE_REPLACE</doc>
- <type name="Gst.TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="negotiate" c:identifier="gst_audio_decoder_negotiate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="759">Negotiate with downstream elements to currently configured #GstAudioInfo.
-Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
-negotiate fails.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="333"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="767">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="761">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="proxy_getcaps"
- c:identifier="gst_audio_decoder_proxy_getcaps"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="2761">Returns caps that express @caps (or sink template caps if @caps == NULL)
-restricted to rate/channels/... combinations supported by downstream
-elements.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="328"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="2771">a #GstCaps owned by caller</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="2763">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="2764">initial caps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="filter"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="2765">filter caps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_allocation_caps"
- c:identifier="gst_audio_decoder_set_allocation_caps"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3456">Sets a caps in allocation query which are different from the set
-pad's caps. Use this function before calling
-gst_audio_decoder_negotiate(). Setting to %NULL the allocation
-query will use the caps from the pad.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="392"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3458">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="allocation_caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3459">a #GstCaps or %NULL</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_drainable"
- c:identifier="gst_audio_decoder_set_drainable">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3609">Configures decoder drain handling. If drainable, subclass might
-be handed a NULL buffer to have it return any leftover decoded data.
-Otherwise, it is not considered so capable and will only ever be passed
-real data.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="419"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3611">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3612">new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_estimate_rate"
- c:identifier="gst_audio_decoder_set_estimate_rate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3312">Allows baseclass to perform byte to time estimated conversion.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="360"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3314">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3315">whether to enable byte to time conversion</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_latency" c:identifier="gst_audio_decoder_set_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3387">Sets decoder latency.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="377"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3389">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="min" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3390">minimum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="max" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3391">maximum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_max_errors"
- c:identifier="gst_audio_decoder_set_max_errors">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3355">Sets numbers of tolerated decoder errors, where a tolerated one is then only
-warned about, but more than tolerated will lead to fatal error. You can set
--1 for never returning fatal errors. Default is set to
-GST_AUDIO_DECODER_MAX_ERRORS.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="370"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3357">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3358">max tolerated errors</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_min_latency"
- c:identifier="gst_audio_decoder_set_min_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3523">Sets decoder minimum aggregation latency.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="405"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3525">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3526">new minimum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_needs_format"
- c:identifier="gst_audio_decoder_set_needs_format">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3655">Configures decoder format needs. If enabled, subclass needs to be
-negotiated with format caps before it can process any data. It will then
-never be handed any data before it has been configured.
-Otherwise, it might be handed data without having been configured and
-is then expected being able to do so either by default
-or based on the input data.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="426"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3657">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3658">new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_output_caps"
- c:identifier="gst_audio_decoder_set_output_caps"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="824">Configure output caps on the srcpad of @dec. Similar to
-gst_audio_decoder_set_output_format(), but allows subclasses to specify
-output caps that can't be expressed via #GstAudioInfo e.g. caps that have
-caps features.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="325"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="834">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="826">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="827">(fixed) #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_output_format"
- c:identifier="gst_audio_decoder_set_output_format">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="791">Configure output info on the srcpad of @dec.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="321"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="798">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="793">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="794">#GstAudioInfo</doc>
- <type name="AudioInfo" c:type="const GstAudioInfo*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_plc" c:identifier="gst_audio_decoder_set_plc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3477">Enable or disable decoder packet loss concealment, provided subclass
-and codec are capable and allow handling plc.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="398"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3479">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3480">new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_plc_aware"
- c:identifier="gst_audio_decoder_set_plc_aware">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3283">Indicates whether or not subclass handles packet loss concealment (plc).</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="353"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3285">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="plc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3286">new plc state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_tolerance"
- c:identifier="gst_audio_decoder_set_tolerance">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3566">Configures decoder audio jitter tolerance threshold.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="412"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3568">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="tolerance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3569">new tolerance</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_use_default_pad_acceptcaps"
- c:identifier="gst_audio_decoder_set_use_default_pad_acceptcaps"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3820">Lets #GstAudioDecoder sub-classes decide if they want the sink pad
-to use the default pad query handler to reply to accept-caps queries.
-
-By setting this to true it is possible to further customize the default
-handler with %GST_PAD_SET_ACCEPT_INTERSECT and
-%GST_PAD_SET_ACCEPT_TEMPLATE</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="442"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3822">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </instance-parameter>
- <parameter name="use" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="3823">if the default pad accept-caps query handling should be used</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <property name="max-errors"
- version="1.18"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="417">Maximum number of tolerated consecutive decode errors. See
-gst_audio_decoder_set_max_errors() for more details.</doc>
- <type name="gint" c:type="gint"/>
- </property>
- <property name="min-latency" writable="1" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="plc" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="tolerance" writable="1" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </property>
- <field name="element">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="sinkpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="srcpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="stream_lock">
- <type name="GLib.RecMutex" c:type="GRecMutex"/>
- </field>
- <field name="input_segment">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="output_segment">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioDecoderPrivate" c:type="GstAudioDecoderPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioDecoderClass"
- c:type="GstAudioDecoderClass"
- glib:is-gtype-struct-for="AudioDecoder">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="181">Subclasses can override any of the available virtual methods or not, as
-needed. At minimum @handle_frame (and likely @set_format) needs to be
-overridden.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="315"/>
- <field name="element_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="183">The parent class structure</doc>
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="start">
- <callback name="start">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="268"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="270"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_format">
- <callback name="set_format">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="272"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="parse">
- <callback name="parse">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="275"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="adapter" transfer-ownership="none">
- <type name="GstBase.Adapter" c:type="GstAdapter*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="handle_frame">
- <callback name="handle_frame">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="279"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="flush">
- <callback name="flush">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="282"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="hard" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="pre_push">
- <callback name="pre_push">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="284"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_event">
- <callback name="sink_event">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="287"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_event">
- <callback name="src_event">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="289"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="open">
- <callback name="open">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="292"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="close">
- <callback name="close">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="294"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="negotiate">
- <callback name="negotiate">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="296"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="767">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiodecoder.c"
- line="761">a #GstAudioDecoder</doc>
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="decide_allocation">
- <callback name="decide_allocation">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="298"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="propose_allocation">
- <callback name="propose_allocation">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="300"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_query">
- <callback name="sink_query">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="303"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_query">
- <callback name="src_query">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="305"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="getcaps">
- <callback name="getcaps">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="307"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="dec" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="transform_meta">
- <callback name="transform_meta">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="310"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioDecoder" c:type="GstAudioDecoder*"/>
- </parameter>
- <parameter name="outbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="meta" transfer-ownership="none">
- <type name="Gst.Meta" c:type="GstMeta*"/>
- </parameter>
- <parameter name="inbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="16">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AudioDecoderPrivate"
- c:type="GstAudioDecoderPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="102"/>
- </record>
- <enumeration name="AudioDitherMethod"
- glib:type-name="GstAudioDitherMethod"
- glib:get-type="gst_audio_dither_method_get_type"
- c:type="GstAudioDitherMethod">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="32">Set of available dithering methods.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_AUDIO_DITHER_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="34">No dithering</doc>
- </member>
- <member name="rpdf"
- value="1"
- c:identifier="GST_AUDIO_DITHER_RPDF"
- glib:nick="rpdf">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="35">Rectangular dithering</doc>
- </member>
- <member name="tpdf"
- value="2"
- c:identifier="GST_AUDIO_DITHER_TPDF"
- glib:nick="tpdf">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="36">Triangular dithering (default)</doc>
- </member>
- <member name="tpdf_hf"
- value="3"
- c:identifier="GST_AUDIO_DITHER_TPDF_HF"
- glib:nick="tpdf-hf">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="37">High frequency triangular dithering</doc>
- </member>
- </enumeration>
- <record name="AudioDownmixMeta" c:type="GstAudioDownmixMeta">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="32">Extra buffer metadata describing audio downmixing matrix. This metadata is
-attached to audio buffers and contains a matrix to downmix the buffer number
-of channels to @channels.
-
-@matrix is an two-dimensional array of @to_channels times @from_channels
-coefficients, i.e. the i-th output channels is constructed by multiplicating
-the input channels with the coefficients in @matrix[i] and taking the sum
-of the results.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h" line="57"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="34">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="from_position" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="35">the channel positions of the source</doc>
- <type name="AudioChannelPosition" c:type="GstAudioChannelPosition*"/>
- </field>
- <field name="to_position" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="36">the channel positions of the destination</doc>
- <type name="AudioChannelPosition" c:type="GstAudioChannelPosition*"/>
- </field>
- <field name="from_channels" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="37">the number of channels of the source</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="to_channels" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="38">the number of channels of the destination</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="matrix" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="39">the matrix coefficients.</doc>
- <type name="gfloat" c:type="gfloat**"/>
- </field>
- <function name="get_info" c:identifier="gst_audio_downmix_meta_get_info">
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="63"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <class name="AudioEncoder"
- c:symbol-prefix="audio_encoder"
- c:type="GstAudioEncoder"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstAudioEncoder"
- glib:get-type="gst_audio_encoder_get_type"
- glib:type-struct="AudioEncoderClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="22">This base class is for audio encoders turning raw audio samples into
-encoded audio data.
-
-GstAudioEncoder and subclass should cooperate as follows.
-
-## Configuration
-
- * Initially, GstAudioEncoder calls @start when the encoder element
- is activated, which allows subclass to perform any global setup.
-
- * GstAudioEncoder calls @set_format to inform subclass of the format
- of input audio data that it is about to receive. Subclass should
- setup for encoding and configure various base class parameters
- appropriately, notably those directing desired input data handling.
- While unlikely, it might be called more than once, if changing input
- parameters require reconfiguration.
-
- * GstAudioEncoder calls @stop at end of all processing.
-
-As of configuration stage, and throughout processing, GstAudioEncoder
-maintains various parameters that provide required context,
-e.g. describing the format of input audio data.
-Conversely, subclass can and should configure these context parameters
-to inform base class of its expectation w.r.t. buffer handling.
-
-## Data processing
-
- * Base class gathers input sample data (as directed by the context's
- frame_samples and frame_max) and provides this to subclass' @handle_frame.
- * If codec processing results in encoded data, subclass should call
- gst_audio_encoder_finish_frame() to have encoded data pushed
- downstream. Alternatively, it might also call
- gst_audio_encoder_finish_frame() (with a NULL buffer and some number of
- dropped samples) to indicate dropped (non-encoded) samples.
- * Just prior to actually pushing a buffer downstream,
- it is passed to @pre_push.
- * During the parsing process GstAudioEncoderClass will handle both
- srcpad and sinkpad events. Sink events will be passed to subclass
- if @event callback has been provided.
-
-## Shutdown phase
-
- * GstAudioEncoder class calls @stop to inform the subclass that data
- parsing will be stopped.
-
-Subclass is responsible for providing pad template caps for
-source and sink pads. The pads need to be named "sink" and "src". It also
-needs to set the fixed caps on srcpad, when the format is ensured. This
-is typically when base class calls subclass' @set_format function, though
-it might be delayed until calling @gst_audio_encoder_finish_frame.
-
-In summary, above process should have subclass concentrating on
-codec data processing while leaving other matters to base class,
-such as most notably timestamp handling. While it may exert more control
-in this area (see e.g. @pre_push), it is very much not recommended.
-
-In particular, base class will either favor tracking upstream timestamps
-(at the possible expense of jitter) or aim to arrange for a perfect stream of
-output timestamps, depending on #GstAudioEncoder:perfect-timestamp.
-However, in the latter case, the input may not be so perfect or ideal, which
-is handled as follows. An input timestamp is compared with the expected
-timestamp as dictated by input sample stream and if the deviation is less
-than #GstAudioEncoder:tolerance, the deviation is discarded.
-Otherwise, it is considered a discontuinity and subsequent output timestamp
-is resynced to the new position after performing configured discontinuity
-processing. In the non-perfect-timestamp case, an upstream variation
-exceeding tolerance only leads to marking DISCONT on subsequent outgoing
-(while timestamps are adjusted to upstream regardless of variation).
-While DISCONT is also marked in the perfect-timestamp case, this one
-optionally (see #GstAudioEncoder:hard-resync)
-performs some additional steps, such as clipping of (early) input samples
-or draining all currently remaining input data, depending on the direction
-of the discontuinity.
-
-If perfect timestamps are arranged, it is also possible to request baseclass
-(usually set by subclass) to provide additional buffer metadata (in OFFSET
-and OFFSET_END) fields according to granule defined semantics currently
-needed by oggmux. Specifically, OFFSET is set to granulepos (= sample count
-including buffer) and OFFSET_END to corresponding timestamp (as determined
-by same sample count and sample rate).
-
-Things that subclass need to take care of:
-
- * Provide pad templates
- * Set source pad caps when appropriate
- * Inform base class of buffer processing needs using context's
- frame_samples and frame_bytes.
- * Set user-configurable properties to sane defaults for format and
- implementing codec at hand, e.g. those controlling timestamp behaviour
- and discontinuity processing.
- * Accept data in @handle_frame and provide encoded results to
- gst_audio_encoder_finish_frame().</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="248"/>
- <implements name="Gst.Preset"/>
- <virtual-method name="close">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="227"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="decide_allocation">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="231"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="flush">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="212"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="getcaps">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="223"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="handle_frame">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="209"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="negotiate" invoker="negotiate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2819">Negotiate with downstream elements to currently configured #GstCaps.
-Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
-negotiate fails.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="229"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2827">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2821">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="open">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="225"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="pre_push">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="214"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="propose_allocation">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="233"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_format">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="206"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="none">
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_event">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="217"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_query">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="239"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_event">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="220"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_query">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="242"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="202"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="204"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="transform_meta">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="236"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="outbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="meta" transfer-ownership="none">
- <type name="Gst.Meta" c:type="GstMeta*"/>
- </parameter>
- <parameter name="inbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="allocate_output_buffer"
- c:identifier="gst_audio_encoder_allocate_output_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2897">Helper function that allocates a buffer to hold an encoded audio frame
-for @enc's current output format.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="271"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2905">allocated buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2899">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2900">size of the buffer</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="finish_frame"
- c:identifier="gst_audio_encoder_finish_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="732">Collects encoded data and pushes encoded data downstream.
-Source pad caps must be set when this is called.
-
-If @samples &lt; 0, then best estimate is all samples provided to encoder
-(subclass) so far. @buf may be NULL, in which case next number of @samples
-are considered discarded, e.g. as a result of discontinuous transmission,
-and a discontinuity is marked.
-
-Note that samples received in #GstAudioEncoderClass.handle_frame()
-may be invalidated by a call to this function.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="254"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="749">a #GstFlowReturn that should be escalated to caller (of caller)</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="734">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="buffer"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="735">encoded data</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="736">number of samples (per channel) represented by encoded data</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_allocator"
- c:identifier="gst_audio_encoder_get_allocator">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2948">Lets #GstAudioEncoder sub-classes to know the memory @allocator
-used by the base class and its @params.
-
-Unref the @allocator after use it.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="366"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2950">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="allocator"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2951">the #GstAllocator
-used</doc>
- <type name="Gst.Allocator" c:type="GstAllocator**"/>
- </parameter>
- <parameter name="params"
- direction="out"
- caller-allocates="1"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2953">the
-#GstAllocationParams of @allocator</doc>
- <type name="Gst.AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_audio_info"
- c:identifier="gst_audio_encoder_get_audio_info">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="277"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2153">a #GstAudioInfo describing the input audio format</doc>
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2151">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_drainable"
- c:identifier="gst_audio_encoder_get_drainable">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2647">Queries encoder drain handling.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="363"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2653">TRUE if drainable handling is enabled.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2649">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_frame_max"
- c:identifier="gst_audio_encoder_get_frame_max">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="292"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2261">currently configured maximum handled frames</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2259">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_frame_samples_max"
- c:identifier="gst_audio_encoder_get_frame_samples_max">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="286"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2227">currently maximum requested samples per frame</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2225">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_frame_samples_min"
- c:identifier="gst_audio_encoder_get_frame_samples_min">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="280"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2190">currently minimum requested samples per frame</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2188">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_hard_min"
- c:identifier="gst_audio_encoder_get_hard_min">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2601">Queries encoder hard minimum handling.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="356"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2607">TRUE if hard minimum handling is enabled.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2603">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_hard_resync"
- c:identifier="gst_audio_encoder_get_hard_resync">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="342"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_latency" c:identifier="gst_audio_encoder_get_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2333">Sets the variables pointed to by @min and @max to the currently configured
-latency.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="304"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2335">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="min"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2336">a pointer to storage to hold minimum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="max"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2337">a pointer to storage to hold maximum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_lookahead"
- c:identifier="gst_audio_encoder_get_lookahead">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="298"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2294">currently configured encoder lookahead</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2292">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_mark_granule"
- c:identifier="gst_audio_encoder_get_mark_granule">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2419">Queries if the encoder will handle granule marking.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="328"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2425">TRUE if granule marking is enabled.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2421">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_perfect_timestamp"
- c:identifier="gst_audio_encoder_get_perfect_timestamp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2465">Queries encoder perfect timestamp behaviour.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="335"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2471">TRUE if perfect timestamp setting enabled.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2467">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tolerance"
- c:identifier="gst_audio_encoder_get_tolerance">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2555">Queries current audio jitter tolerance threshold.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="349"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2561">encoder audio jitter tolerance threshold.
-
-MT safe.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2557">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="merge_tags" c:identifier="gst_audio_encoder_merge_tags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2671">Sets the audio encoder tags and how they should be merged with any
-upstream stream tags. This will override any tags previously-set
-with gst_audio_encoder_merge_tags().
-
-Note that this is provided for convenience, and the subclass is
-not required to use this and can still do tag handling on its own.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="371"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2673">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="tags"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2674">a #GstTagList to merge, or NULL to unset
- previously-set tags</doc>
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2676">the #GstTagMergeMode to use, usually #GST_TAG_MERGE_REPLACE</doc>
- <type name="Gst.TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="negotiate" c:identifier="gst_audio_encoder_negotiate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2819">Negotiate with downstream elements to currently configured #GstCaps.
-Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
-negotiate fails.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="268"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2827">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2821">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="proxy_getcaps"
- c:identifier="gst_audio_encoder_proxy_getcaps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="1497">Returns caps that express @caps (or sink template caps if @caps == NULL)
-restricted to channel/rate combinations supported by downstream elements
-(e.g. muxers).</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="259"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="1507">a #GstCaps owned by caller</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="1499">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="1500">initial caps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="filter"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="1501">filter caps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_allocation_caps"
- c:identifier="gst_audio_encoder_set_allocation_caps"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2377">Sets a caps in allocation query which are different from the set
-pad's caps. Use this function before calling
-gst_audio_encoder_negotiate(). Setting to %NULL the allocation
-query will use the caps from the pad.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="318"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2379">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="allocation_caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2380">a #GstCaps or %NULL</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_drainable"
- c:identifier="gst_audio_encoder_set_drainable">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2625">Configures encoder drain handling. If drainable, subclass might
-be handed a NULL buffer to have it return any leftover encoded data.
-Otherwise, it is not considered so capable and will only ever be passed
-real data.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="359"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2627">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2628">new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_frame_max"
- c:identifier="gst_audio_encoder_set_frame_max">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2237">Sets max number of frames accepted at once (assumed minimally 1).
-Requires @frame_samples_min and @frame_samples_max to be the equal.
-
-Note: This value will be reset to 0 every time before
-#GstAudioEncoderClass.set_format() is called.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="295"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2239">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2240">number of frames</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_frame_samples_max"
- c:identifier="gst_audio_encoder_set_frame_samples_max">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2200">Sets number of samples (per channel) subclass needs to be handed,
-at most or will be handed all available if 0.
-
-If an exact number of samples is required, gst_audio_encoder_set_frame_samples_min()
-must be called with the same number.
-
-Note: This value will be reset to 0 every time before
-#GstAudioEncoderClass.set_format() is called.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="289"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2202">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2203">number of samples per frame</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_frame_samples_min"
- c:identifier="gst_audio_encoder_set_frame_samples_min">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2163">Sets number of samples (per channel) subclass needs to be handed,
-at least or will be handed all available if 0.
-
-If an exact number of samples is required, gst_audio_encoder_set_frame_samples_max()
-must be called with the same number.
-
-Note: This value will be reset to 0 every time before
-#GstAudioEncoderClass.set_format() is called.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="283"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2165">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2166">number of samples per frame</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_hard_min"
- c:identifier="gst_audio_encoder_set_hard_min">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2579">Configures encoder hard minimum handling. If enabled, subclass
-will never be handed less samples than it configured, which otherwise
-might occur near end-of-data handling. Instead, the leftover samples
-will simply be discarded.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="352"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2581">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2582">new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_hard_resync"
- c:identifier="gst_audio_encoder_set_hard_resync">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="338"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_headers" c:identifier="gst_audio_encoder_set_headers">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2356">Set the codec headers to be sent downstream whenever requested.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="314"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2358">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="headers" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2359">a list of
- #GstBuffer containing the codec header</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Gst.Buffer"/>
- </type>
- </parameter>
- </parameters>
- </method>
- <method name="set_latency" c:identifier="gst_audio_encoder_set_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2304">Sets encoder latency.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="309"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2306">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="min" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2307">minimum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="max" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2308">maximum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_lookahead"
- c:identifier="gst_audio_encoder_set_lookahead">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2271">Sets encoder lookahead (in units of input rate samples)
-
-Note: This value will be reset to 0 every time before
-#GstAudioEncoderClass.set_format() is called.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="301"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2273">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2274">lookahead</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_mark_granule"
- c:identifier="gst_audio_encoder_set_mark_granule">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2398">Enable or disable encoder granule handling.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="324"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2400">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2401">new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_output_format"
- c:identifier="gst_audio_encoder_set_output_format">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2851">Configure output caps on the srcpad of @enc.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="264"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2858">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2853">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2854">#GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_perfect_timestamp"
- c:identifier="gst_audio_encoder_set_perfect_timestamp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2443">Enable or disable encoder perfect output timestamp preference.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="331"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2445">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2446">new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_tolerance"
- c:identifier="gst_audio_encoder_set_tolerance">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2534">Configures encoder audio jitter tolerance threshold.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="345"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2536">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </instance-parameter>
- <parameter name="tolerance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2537">new tolerance</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <property name="hard-resync" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="mark-granule" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="perfect-timestamp"
- writable="1"
- transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="tolerance" writable="1" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </property>
- <field name="element">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="sinkpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="srcpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="stream_lock">
- <type name="GLib.RecMutex" c:type="GRecMutex"/>
- </field>
- <field name="input_segment">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="output_segment">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioEncoderPrivate" c:type="GstAudioEncoderPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioEncoderClass"
- c:type="GstAudioEncoderClass"
- glib:is-gtype-struct-for="AudioEncoder">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="122">Subclasses can override any of the available virtual methods or not, as
-needed. At minimum @set_format and @handle_frame needs to be overridden.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="248"/>
- <field name="element_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="124">The parent class structure</doc>
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="start">
- <callback name="start">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="202"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="204"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_format">
- <callback name="set_format">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="206"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="handle_frame">
- <callback name="handle_frame">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="209"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="flush">
- <callback name="flush">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="212"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="pre_push">
- <callback name="pre_push">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="214"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_event">
- <callback name="sink_event">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="217"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_event">
- <callback name="src_event">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="220"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="getcaps">
- <callback name="getcaps">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="223"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="open">
- <callback name="open">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="225"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="close">
- <callback name="close">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="227"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="negotiate">
- <callback name="negotiate">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="229"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2827">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioencoder.c"
- line="2821">a #GstAudioEncoder</doc>
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="decide_allocation">
- <callback name="decide_allocation">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="231"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="propose_allocation">
- <callback name="propose_allocation">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="233"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="transform_meta">
- <callback name="transform_meta">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="236"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- <parameter name="outbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="meta" transfer-ownership="none">
- <type name="Gst.Meta" c:type="GstMeta*"/>
- </parameter>
- <parameter name="inbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_query">
- <callback name="sink_query">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="239"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_query">
- <callback name="src_query">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="242"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="AudioEncoder" c:type="GstAudioEncoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="17">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AudioEncoderPrivate"
- c:type="GstAudioEncoderPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="92"/>
- </record>
- <class name="AudioFilter"
- c:symbol-prefix="audio_filter"
- c:type="GstAudioFilter"
- parent="GstBase.BaseTransform"
- abstract="1"
- glib:type-name="GstAudioFilter"
- glib:get-type="gst_audio_filter_get_type"
- glib:type-struct="AudioFilterClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiofilter.c"
- line="22">#GstAudioFilter is a #GstBaseTransform&lt;!-- --&gt;-derived base class for simple audio
-filters, ie. those that output the same format that they get as input.
-
-#GstAudioFilter will parse the input format for you (with error checking)
-before calling your setup function. Also, elements deriving from
-#GstAudioFilter may use gst_audio_filter_class_add_pad_templates() from
-their class_init function to easily configure the set of caps/formats that
-the element is able to handle.
-
-Derived classes should override the #GstAudioFilterClass.setup() and
-#GstBaseTransformClass.transform_ip() and/or
-#GstBaseTransformClass.transform()
-virtual functions in their class_init function.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="93"/>
- <virtual-method name="setup">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="89"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <type name="AudioFilter" c:type="GstAudioFilter*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="none">
- <type name="AudioInfo" c:type="const GstAudioInfo*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <field name="basetransform">
- <type name="GstBase.BaseTransform" c:type="GstBaseTransform"/>
- </field>
- <field name="info">
- <type name="AudioInfo" c:type="GstAudioInfo"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioFilterClass"
- c:type="GstAudioFilterClass"
- glib:is-gtype-struct-for="AudioFilter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="75">In addition to the @setup virtual function, you should also override the
-GstBaseTransform::transform and/or GstBaseTransform::transform_ip virtual
-function.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="93"/>
- <field name="basetransformclass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="77">parent class</doc>
- <type name="GstBase.BaseTransformClass"
- c:type="GstBaseTransformClass"/>
- </field>
- <field name="setup">
- <callback name="setup">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="89"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="filter" transfer-ownership="none">
- <type name="AudioFilter" c:type="GstAudioFilter*"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <type name="AudioInfo" c:type="const GstAudioInfo*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="add_pad_templates"
- c:identifier="gst_audio_filter_class_add_pad_templates">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiofilter.c"
- line="211">Convenience function to add pad templates to this element class, with
-@allowed_caps as the caps that can be handled.
-
-This function is usually used from within a GObject class_init function.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="99"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="klass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiofilter.c"
- line="213">an #GstAudioFilterClass</doc>
- <type name="AudioFilterClass" c:type="GstAudioFilterClass*"/>
- </instance-parameter>
- <parameter name="allowed_caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiofilter.c"
- line="214">what formats the filter can handle, as #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <bitfield name="AudioFlags"
- glib:type-name="GstAudioFlags"
- glib:get-type="gst_audio_flags_get_type"
- c:type="GstAudioFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.h"
- line="33">Extra audio flags</doc>
- <member name="none"
- value="0"
- c:identifier="GST_AUDIO_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.h"
- line="35">no valid flag</doc>
- </member>
- <member name="unpositioned"
- value="1"
- c:identifier="GST_AUDIO_FLAG_UNPOSITIONED"
- glib:nick="unpositioned">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.h"
- line="36">the position array explicitly
- contains unpositioned channels.</doc>
- </member>
- </bitfield>
- <enumeration name="AudioFormat"
- glib:type-name="GstAudioFormat"
- glib:get-type="gst_audio_format_get_type"
- c:type="GstAudioFormat">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="39">Enum value describing the most common audio formats.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_AUDIO_FORMAT_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="41">unknown or unset audio format</doc>
- </member>
- <member name="encoded"
- value="1"
- c:identifier="GST_AUDIO_FORMAT_ENCODED"
- glib:nick="encoded">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="42">encoded audio format</doc>
- </member>
- <member name="s8"
- value="2"
- c:identifier="GST_AUDIO_FORMAT_S8"
- glib:nick="s8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="43">8 bits in 8 bits, signed</doc>
- </member>
- <member name="u8"
- value="3"
- c:identifier="GST_AUDIO_FORMAT_U8"
- glib:nick="u8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="44">8 bits in 8 bits, unsigned</doc>
- </member>
- <member name="s16le"
- value="4"
- c:identifier="GST_AUDIO_FORMAT_S16LE"
- glib:nick="s16le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="45">16 bits in 16 bits, signed, little endian</doc>
- </member>
- <member name="s16be"
- value="5"
- c:identifier="GST_AUDIO_FORMAT_S16BE"
- glib:nick="s16be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="46">16 bits in 16 bits, signed, big endian</doc>
- </member>
- <member name="u16le"
- value="6"
- c:identifier="GST_AUDIO_FORMAT_U16LE"
- glib:nick="u16le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="47">16 bits in 16 bits, unsigned, little endian</doc>
- </member>
- <member name="u16be"
- value="7"
- c:identifier="GST_AUDIO_FORMAT_U16BE"
- glib:nick="u16be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="48">16 bits in 16 bits, unsigned, big endian</doc>
- </member>
- <member name="s24_32le"
- value="8"
- c:identifier="GST_AUDIO_FORMAT_S24_32LE"
- glib:nick="s24-32le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="49">24 bits in 32 bits, signed, little endian</doc>
- </member>
- <member name="s24_32be"
- value="9"
- c:identifier="GST_AUDIO_FORMAT_S24_32BE"
- glib:nick="s24-32be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="50">24 bits in 32 bits, signed, big endian</doc>
- </member>
- <member name="u24_32le"
- value="10"
- c:identifier="GST_AUDIO_FORMAT_U24_32LE"
- glib:nick="u24-32le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="51">24 bits in 32 bits, unsigned, little endian</doc>
- </member>
- <member name="u24_32be"
- value="11"
- c:identifier="GST_AUDIO_FORMAT_U24_32BE"
- glib:nick="u24-32be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="52">24 bits in 32 bits, unsigned, big endian</doc>
- </member>
- <member name="s32le"
- value="12"
- c:identifier="GST_AUDIO_FORMAT_S32LE"
- glib:nick="s32le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="53">32 bits in 32 bits, signed, little endian</doc>
- </member>
- <member name="s32be"
- value="13"
- c:identifier="GST_AUDIO_FORMAT_S32BE"
- glib:nick="s32be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="54">32 bits in 32 bits, signed, big endian</doc>
- </member>
- <member name="u32le"
- value="14"
- c:identifier="GST_AUDIO_FORMAT_U32LE"
- glib:nick="u32le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="55">32 bits in 32 bits, unsigned, little endian</doc>
- </member>
- <member name="u32be"
- value="15"
- c:identifier="GST_AUDIO_FORMAT_U32BE"
- glib:nick="u32be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="56">32 bits in 32 bits, unsigned, big endian</doc>
- </member>
- <member name="s24le"
- value="16"
- c:identifier="GST_AUDIO_FORMAT_S24LE"
- glib:nick="s24le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="57">24 bits in 24 bits, signed, little endian</doc>
- </member>
- <member name="s24be"
- value="17"
- c:identifier="GST_AUDIO_FORMAT_S24BE"
- glib:nick="s24be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="58">24 bits in 24 bits, signed, big endian</doc>
- </member>
- <member name="u24le"
- value="18"
- c:identifier="GST_AUDIO_FORMAT_U24LE"
- glib:nick="u24le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="59">24 bits in 24 bits, unsigned, little endian</doc>
- </member>
- <member name="u24be"
- value="19"
- c:identifier="GST_AUDIO_FORMAT_U24BE"
- glib:nick="u24be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="60">24 bits in 24 bits, unsigned, big endian</doc>
- </member>
- <member name="s20le"
- value="20"
- c:identifier="GST_AUDIO_FORMAT_S20LE"
- glib:nick="s20le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="61">20 bits in 24 bits, signed, little endian</doc>
- </member>
- <member name="s20be"
- value="21"
- c:identifier="GST_AUDIO_FORMAT_S20BE"
- glib:nick="s20be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="62">20 bits in 24 bits, signed, big endian</doc>
- </member>
- <member name="u20le"
- value="22"
- c:identifier="GST_AUDIO_FORMAT_U20LE"
- glib:nick="u20le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="63">20 bits in 24 bits, unsigned, little endian</doc>
- </member>
- <member name="u20be"
- value="23"
- c:identifier="GST_AUDIO_FORMAT_U20BE"
- glib:nick="u20be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="64">20 bits in 24 bits, unsigned, big endian</doc>
- </member>
- <member name="s18le"
- value="24"
- c:identifier="GST_AUDIO_FORMAT_S18LE"
- glib:nick="s18le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="65">18 bits in 24 bits, signed, little endian</doc>
- </member>
- <member name="s18be"
- value="25"
- c:identifier="GST_AUDIO_FORMAT_S18BE"
- glib:nick="s18be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="66">18 bits in 24 bits, signed, big endian</doc>
- </member>
- <member name="u18le"
- value="26"
- c:identifier="GST_AUDIO_FORMAT_U18LE"
- glib:nick="u18le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="67">18 bits in 24 bits, unsigned, little endian</doc>
- </member>
- <member name="u18be"
- value="27"
- c:identifier="GST_AUDIO_FORMAT_U18BE"
- glib:nick="u18be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="68">18 bits in 24 bits, unsigned, big endian</doc>
- </member>
- <member name="f32le"
- value="28"
- c:identifier="GST_AUDIO_FORMAT_F32LE"
- glib:nick="f32le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="69">32-bit floating point samples, little endian</doc>
- </member>
- <member name="f32be"
- value="29"
- c:identifier="GST_AUDIO_FORMAT_F32BE"
- glib:nick="f32be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="70">32-bit floating point samples, big endian</doc>
- </member>
- <member name="f64le"
- value="30"
- c:identifier="GST_AUDIO_FORMAT_F64LE"
- glib:nick="f64le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="71">64-bit floating point samples, little endian</doc>
- </member>
- <member name="f64be"
- value="31"
- c:identifier="GST_AUDIO_FORMAT_F64BE"
- glib:nick="f64be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="72">64-bit floating point samples, big endian</doc>
- </member>
- <member name="s16"
- value="4"
- c:identifier="GST_AUDIO_FORMAT_S16"
- glib:nick="s16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="73">16 bits in 16 bits, signed, native endianness</doc>
- </member>
- <member name="u16"
- value="6"
- c:identifier="GST_AUDIO_FORMAT_U16"
- glib:nick="u16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="74">16 bits in 16 bits, unsigned, native endianness</doc>
- </member>
- <member name="s24_32"
- value="8"
- c:identifier="GST_AUDIO_FORMAT_S24_32"
- glib:nick="s24-32">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="75">24 bits in 32 bits, signed, native endianness</doc>
- </member>
- <member name="u24_32"
- value="10"
- c:identifier="GST_AUDIO_FORMAT_U24_32"
- glib:nick="u24-32">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="76">24 bits in 32 bits, unsigned, native endianness</doc>
- </member>
- <member name="s32"
- value="12"
- c:identifier="GST_AUDIO_FORMAT_S32"
- glib:nick="s32">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="77">32 bits in 32 bits, signed, native endianness</doc>
- </member>
- <member name="u32"
- value="14"
- c:identifier="GST_AUDIO_FORMAT_U32"
- glib:nick="u32">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="78">32 bits in 32 bits, unsigned, native endianness</doc>
- </member>
- <member name="s24"
- value="16"
- c:identifier="GST_AUDIO_FORMAT_S24"
- glib:nick="s24">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="79">24 bits in 24 bits, signed, native endianness</doc>
- </member>
- <member name="u24"
- value="18"
- c:identifier="GST_AUDIO_FORMAT_U24"
- glib:nick="u24">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="80">24 bits in 24 bits, unsigned, native endianness</doc>
- </member>
- <member name="s20"
- value="20"
- c:identifier="GST_AUDIO_FORMAT_S20"
- glib:nick="s20">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="81">20 bits in 24 bits, signed, native endianness</doc>
- </member>
- <member name="u20"
- value="22"
- c:identifier="GST_AUDIO_FORMAT_U20"
- glib:nick="u20">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="82">20 bits in 24 bits, unsigned, native endianness</doc>
- </member>
- <member name="s18"
- value="24"
- c:identifier="GST_AUDIO_FORMAT_S18"
- glib:nick="s18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="83">18 bits in 24 bits, signed, native endianness</doc>
- </member>
- <member name="u18"
- value="26"
- c:identifier="GST_AUDIO_FORMAT_U18"
- glib:nick="u18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="84">18 bits in 24 bits, unsigned, native endianness</doc>
- </member>
- <member name="f32"
- value="28"
- c:identifier="GST_AUDIO_FORMAT_F32"
- glib:nick="f32">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="85">32-bit floating point samples, native endianness</doc>
- </member>
- <member name="f64"
- value="30"
- c:identifier="GST_AUDIO_FORMAT_F64"
- glib:nick="f64">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="86">64-bit floating point samples, native endianness</doc>
- </member>
- <function name="build_integer"
- c:identifier="gst_audio_format_build_integer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="358">Construct a #GstAudioFormat with given parameters.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="275"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="367">a #GstAudioFormat or GST_AUDIO_FORMAT_UNKNOWN when no audio format
-exists with the given parameters.</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </return-value>
- <parameters>
- <parameter name="sign" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="360">signed or unsigned format</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="endianness" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="361">G_LITTLE_ENDIAN or G_BIG_ENDIAN</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="362">amount of bits used per sample</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="depth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="363">amount of used bits in @width</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="fill_silence"
- c:identifier="gst_audio_format_fill_silence">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="454">Fill @length bytes in @dest with silence samples for @info.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="289"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="456">a #GstAudioFormatInfo</doc>
- <type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
- </parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="457">a destination
- to fill</doc>
- <array length="2" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="459">the length to fill</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- <function name="from_string" c:identifier="gst_audio_format_from_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="404">Convert the @format string to its #GstAudioFormat.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="279"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="410">the #GstAudioFormat for @format or GST_AUDIO_FORMAT_UNKNOWN when the
-string is not a known format.</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="406">a format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_info" c:identifier="gst_audio_format_get_info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="438">Get the #GstAudioFormatInfo for @format</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="286"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="444">The #GstAudioFormatInfo for @format.</doc>
- <type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="440">a #GstAudioFormat</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_string" c:identifier="gst_audio_format_to_string">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="282"/>
- <return-value transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <bitfield name="AudioFormatFlags"
- glib:type-name="GstAudioFormatFlags"
- glib:get-type="gst_audio_format_flags_get_type"
- c:type="GstAudioFormatFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="151">The different audio flags that a format info can have.</doc>
- <member name="integer"
- value="1"
- c:identifier="GST_AUDIO_FORMAT_FLAG_INTEGER"
- glib:nick="integer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="153">integer samples</doc>
- </member>
- <member name="float"
- value="2"
- c:identifier="GST_AUDIO_FORMAT_FLAG_FLOAT"
- glib:nick="float">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="154">float samples</doc>
- </member>
- <member name="signed"
- value="4"
- c:identifier="GST_AUDIO_FORMAT_FLAG_SIGNED"
- glib:nick="signed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="155">signed samples</doc>
- </member>
- <member name="complex"
- value="16"
- c:identifier="GST_AUDIO_FORMAT_FLAG_COMPLEX"
- glib:nick="complex">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="156">complex layout</doc>
- </member>
- <member name="unpack"
- value="32"
- c:identifier="GST_AUDIO_FORMAT_FLAG_UNPACK"
- glib:nick="unpack">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="157">the format can be used in
-#GstAudioFormatUnpack and #GstAudioFormatPack functions</doc>
- </member>
- </bitfield>
- <record name="AudioFormatInfo" c:type="GstAudioFormatInfo">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="221">Information for an audio format.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="254"/>
- <field name="format" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="223">#GstAudioFormat</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </field>
- <field name="name" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="224">string representation of the format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="description" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="225">user readable description of the format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="226">#GstAudioFormatFlags</doc>
- <type name="AudioFormatFlags" c:type="GstAudioFormatFlags"/>
- </field>
- <field name="endianness" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="227">the endianness</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="width" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="228">amount of bits used for one sample</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="depth" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="229">amount of valid bits in @width</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="silence" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="230">@width/8 bytes with 1 silent sample</doc>
- <array zero-terminated="0" fixed-size="8">
- <type name="guint8" c:type="guint8"/>
- </array>
- </field>
- <field name="unpack_format" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="231">the format of the unpacked samples</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </field>
- <field name="unpack_func" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="232">function to unpack samples</doc>
- <type name="AudioFormatUnpack" c:type="GstAudioFormatUnpack"/>
- </field>
- <field name="pack_func" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="233">function to pack samples</doc>
- <type name="AudioFormatPack" c:type="GstAudioFormatPack"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <callback name="AudioFormatPack" c:type="GstAudioFormatPack">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="204">Packs @length samples from @src to the data array in format @info.
-The samples from source have each channel interleaved
-and will be packed into @data.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="217"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="206">a #GstAudioFormatInfo</doc>
- <type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="207">#GstAudioPackFlags</doc>
- <type name="AudioPackFlags" c:type="GstAudioPackFlags"/>
- </parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="208">a source array</doc>
- <array zero-terminated="0" c:type="gconstpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="209">pointer to the destination
- data</doc>
- <array zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="211">the amount of samples to pack.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="AudioFormatUnpack" c:type="GstAudioFormatUnpack">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="188">Unpacks @length samples from the given data of format @info.
-The samples will be unpacked into @dest which each channel
-interleaved. @dest should at least be big enough to hold @length *
-channels * size(unpack_format) bytes.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="201"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="190">a #GstAudioFormatInfo</doc>
- <type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="191">#GstAudioPackFlags</doc>
- <type name="AudioPackFlags" c:type="GstAudioPackFlags"/>
- </parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="192">a destination array</doc>
- <array zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="193">pointer to the audio data</doc>
- <array zero-terminated="0" c:type="gconstpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="194">the amount of samples to unpack.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </callback>
- <record name="AudioInfo"
- c:type="GstAudioInfo"
- glib:type-name="GstAudioInfo"
- glib:get-type="gst_audio_info_get_type"
- c:symbol-prefix="audio_info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.h"
- line="46">Information describing audio properties. This information can be filled
-in from GstCaps with gst_audio_info_from_caps().
-
-Use the provided macros to access the info in this structure.</doc>
- <source-position filename="gst-libs/gst/audio/audio-info.h" line="73"/>
- <field name="finfo" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.h"
- line="48">the format info of the audio</doc>
- <type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
- </field>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.h"
- line="49">additional audio flags</doc>
- <type name="AudioFlags" c:type="GstAudioFlags"/>
- </field>
- <field name="layout" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.h"
- line="50">audio layout</doc>
- <type name="AudioLayout" c:type="GstAudioLayout"/>
- </field>
- <field name="rate" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.h"
- line="51">the audio sample rate</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="channels" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.h"
- line="52">the number of channels</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="bpf" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.h"
- line="53">the number of bytes for one frame, this is the size of one
- sample * @channels</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="position" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.h"
- line="55">the positions for each channel</doc>
- <array zero-terminated="0" fixed-size="64">
- <type name="AudioChannelPosition" c:type="GstAudioChannelPosition"/>
- </array>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <constructor name="new" c:identifier="gst_audio_info_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="83">Allocate a new #GstAudioInfo that is also initialized with
-gst_audio_info_init().</doc>
- <source-position filename="gst-libs/gst/audio/audio-info.h"
- line="105"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="89">a new #GstAudioInfo. free with gst_audio_info_free().</doc>
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </return-value>
- </constructor>
- <method name="convert" c:identifier="gst_audio_info_convert">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="404">Converts among various #GstFormat types. This function handles
-GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For
-raw audio, GST_FORMAT_DEFAULT corresponds to audio frames. This
-function can be used to handle pad queries of the type GST_QUERY_CONVERT.</doc>
- <source-position filename="gst-libs/gst/audio/audio-info.h"
- line="128"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="417">TRUE if the conversion was successful.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="406">a #GstAudioInfo</doc>
- <type name="AudioInfo" c:type="const GstAudioInfo*"/>
- </instance-parameter>
- <parameter name="src_fmt" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="407">#GstFormat of the @src_val</doc>
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="src_val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="408">value to convert</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="dest_fmt" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="409">#GstFormat of the @dest_val</doc>
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="dest_val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="410">pointer to destination value</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_audio_info_copy">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="53">Copy a GstAudioInfo structure.</doc>
- <source-position filename="gst-libs/gst/audio/audio-info.h"
- line="111"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="59">a new #GstAudioInfo. free with gst_audio_info_free.</doc>
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="55">a #GstAudioInfo</doc>
- <type name="AudioInfo" c:type="const GstAudioInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_audio_info_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="67">Free a GstAudioInfo structure previously allocated with gst_audio_info_new()
-or gst_audio_info_copy().</doc>
- <source-position filename="gst-libs/gst/audio/audio-info.h"
- line="114"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="69">a #GstAudioInfo</doc>
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="from_caps" c:identifier="gst_audio_info_from_caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="182">Parse @caps and update @info.</doc>
- <source-position filename="gst-libs/gst/audio/audio-info.h"
- line="122"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="189">TRUE if @caps could be parsed</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="184">a #GstAudioInfo</doc>
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="185">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_audio_info_init">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="102">Initialize @info with default values.</doc>
- <source-position filename="gst-libs/gst/audio/audio-info.h"
- line="108"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="104">a #GstAudioInfo</doc>
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_equal"
- c:identifier="gst_audio_info_is_equal"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="497">Compares two #GstAudioInfo and returns whether they are equal or not</doc>
- <source-position filename="gst-libs/gst/audio/audio-info.h"
- line="133"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="504">%TRUE if @info and @other are equal, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="499">a #GstAudioInfo</doc>
- <type name="AudioInfo" c:type="const GstAudioInfo*"/>
- </instance-parameter>
- <parameter name="other" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="500">a #GstAudioInfo</doc>
- <type name="AudioInfo" c:type="const GstAudioInfo*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_format" c:identifier="gst_audio_info_set_format">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="118">Set the default info for the audio info of @format and @rate and @channels.
-
-Note: This initializes @info first, no values are preserved.</doc>
- <source-position filename="gst-libs/gst/audio/audio-info.h"
- line="117"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="120">a #GstAudioInfo</doc>
- <type name="AudioInfo" c:type="GstAudioInfo*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="121">the format</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="122">the samplerate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="123">the number of channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="position"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="124">the channel positions</doc>
- <array zero-terminated="0"
- c:type="const GstAudioChannelPosition*"
- fixed-size="64">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="to_caps" c:identifier="gst_audio_info_to_caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="323">Convert the values of @info into a #GstCaps.</doc>
- <source-position filename="gst-libs/gst/audio/audio-info.h"
- line="125"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="329">the new #GstCaps containing the
- info of @info.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-info.c"
- line="325">a #GstAudioInfo</doc>
- <type name="AudioInfo" c:type="const GstAudioInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <enumeration name="AudioLayout"
- glib:type-name="GstAudioLayout"
- glib:get-type="gst_audio_layout_get_type"
- c:type="GstAudioLayout">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="391">Layout of the audio samples for the different channels.</doc>
- <member name="interleaved"
- value="0"
- c:identifier="GST_AUDIO_LAYOUT_INTERLEAVED"
- glib:nick="interleaved">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="393">interleaved audio</doc>
- </member>
- <member name="non_interleaved"
- value="1"
- c:identifier="GST_AUDIO_LAYOUT_NON_INTERLEAVED"
- glib:nick="non-interleaved">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="394">non-interleaved audio</doc>
- </member>
- </enumeration>
- <record name="AudioMeta" c:type="GstAudioMeta" version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="20">#GstAudioDownmixMeta defines an audio downmix matrix to be send along with
-audio buffers. These functions in this module help to create and attach the
-meta as well as extracting it.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="185"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="136">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="info" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="137">the audio properties of the buffer</doc>
- <type name="AudioInfo" c:type="GstAudioInfo"/>
- </field>
- <field name="samples" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="138">the number of valid samples in the buffer</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="offsets" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.h"
- line="139">the offsets (in bytes) where each channel plane starts in the
- buffer or %NULL if the buffer has interleaved layout; if not %NULL, this
- is guaranteed to be an array of @info.channels elements</doc>
- <type name="gsize" c:type="gsize*"/>
- </field>
- <field name="priv_offsets_arr" readable="0" private="1">
- <array zero-terminated="0" fixed-size="8">
- <type name="gsize" c:type="gsize"/>
- </array>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <function name="get_info" c:identifier="gst_audio_meta_get_info">
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="191"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <enumeration name="AudioNoiseShapingMethod"
- glib:type-name="GstAudioNoiseShapingMethod"
- glib:get-type="gst_audio_noise_shaping_method_get_type"
- c:type="GstAudioNoiseShapingMethod">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="49">Set of available noise shaping methods</doc>
- <member name="none"
- value="0"
- c:identifier="GST_AUDIO_NOISE_SHAPING_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="51">No noise shaping (default)</doc>
- </member>
- <member name="error_feedback"
- value="1"
- c:identifier="GST_AUDIO_NOISE_SHAPING_ERROR_FEEDBACK"
- glib:nick="error-feedback">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="52">Error feedback</doc>
- </member>
- <member name="simple"
- value="2"
- c:identifier="GST_AUDIO_NOISE_SHAPING_SIMPLE"
- glib:nick="simple">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="53">Simple 2-pole noise shaping</doc>
- </member>
- <member name="medium"
- value="3"
- c:identifier="GST_AUDIO_NOISE_SHAPING_MEDIUM"
- glib:nick="medium">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="54">Medium 5-pole noise shaping</doc>
- </member>
- <member name="high"
- value="4"
- c:identifier="GST_AUDIO_NOISE_SHAPING_HIGH"
- glib:nick="high">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="55">High 8-pole noise shaping</doc>
- </member>
- </enumeration>
- <bitfield name="AudioPackFlags"
- glib:type-name="GstAudioPackFlags"
- glib:get-type="gst_audio_pack_flags_get_type"
- c:type="GstAudioPackFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="171">The different flags that can be used when packing and unpacking.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_AUDIO_PACK_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="173">No flag</doc>
- </member>
- <member name="truncate_range"
- value="1"
- c:identifier="GST_AUDIO_PACK_FLAG_TRUNCATE_RANGE"
- glib:nick="truncate-range">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.h"
- line="174">When the source has a smaller depth
- than the target format, set the least significant bits of the target
- to 0. This is likely slightly faster but less accurate. When this flag
- is not specified, the most significant bits of the source are duplicated
- in the least significant bits of the destination.</doc>
- </member>
- </bitfield>
- <record name="AudioQuantize" c:type="GstAudioQuantize" disguised="1">
- <source-position filename="gst-libs/gst/audio/audio-quantize.h"
- line="82"/>
- <method name="free" c:identifier="gst_audio_quantize_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="470">Free a #GstAudioQuantize.</doc>
- <source-position filename="gst-libs/gst/audio/audio-quantize.h"
- line="93"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="quant" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="472">a #GstAudioQuantize</doc>
- <type name="AudioQuantize" c:type="GstAudioQuantize*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reset" c:identifier="gst_audio_quantize_reset">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="489">Reset @quant to the state is was when created, clearing any
-history it might have.</doc>
- <source-position filename="gst-libs/gst/audio/audio-quantize.h"
- line="96"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="quant" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="491">a #GstAudioQuantize</doc>
- <type name="AudioQuantize" c:type="GstAudioQuantize*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="samples" c:identifier="gst_audio_quantize_samples">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="504">Perform quantization on @samples in @in and write the result to @out.
-
-In case the samples are interleaved, @in and @out must point to an
-array with a single element pointing to a block of interleaved samples.
-
-If non-interleaved samples are used, @in and @out must point to an
-array with pointers to memory blocks, one for each channel.
-
-@in and @out may point to the same memory location, in which case samples will be
-modified in-place.</doc>
- <source-position filename="gst-libs/gst/audio/audio-quantize.h"
- line="99"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="quant" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="506">a #GstAudioQuantize</doc>
- <type name="AudioQuantize" c:type="GstAudioQuantize*"/>
- </instance-parameter>
- <parameter name="in"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="507">input samples</doc>
- <type name="gpointer" c:type="const gpointer*"/>
- </parameter>
- <parameter name="out"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="508">output samples</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="509">number of samples</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <function name="new"
- c:identifier="gst_audio_quantize_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="413">Create a new quantizer object with the given parameters.
-
-Output samples will be quantized to a multiple of @quantizer. Better
-performance is achieved when @quantizer is a power of 2.
-
-Dithering and noise-shaping can be performed during quantization with
-the @dither and @ns parameters.</doc>
- <source-position filename="gst-libs/gst/audio/audio-quantize.h"
- line="85"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="430">a new #GstAudioQuantize. Free with gst_audio_quantize_free().</doc>
- <type name="AudioQuantize" c:type="GstAudioQuantize*"/>
- </return-value>
- <parameters>
- <parameter name="dither" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="415">a #GstAudioDitherMethod</doc>
- <type name="AudioDitherMethod" c:type="GstAudioDitherMethod"/>
- </parameter>
- <parameter name="ns" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="416">a #GstAudioNoiseShapingMethod</doc>
- <type name="AudioNoiseShapingMethod"
- c:type="GstAudioNoiseShapingMethod"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="417">#GstAudioQuantizeFlags</doc>
- <type name="AudioQuantizeFlags" c:type="GstAudioQuantizeFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="418">the #GstAudioFormat of the samples</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="419">the amount of channels in the samples</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="quantizer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="420">the quantizer to use</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <bitfield name="AudioQuantizeFlags"
- glib:type-name="GstAudioQuantizeFlags"
- glib:get-type="gst_audio_quantize_flags_get_type"
- c:type="GstAudioQuantizeFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="68">Extra flags that can be passed to gst_audio_quantize_new()</doc>
- <member name="none"
- value="0"
- c:identifier="GST_AUDIO_QUANTIZE_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="70">no flags</doc>
- </member>
- <member name="non_interleaved"
- value="1"
- c:identifier="GST_AUDIO_QUANTIZE_FLAG_NON_INTERLEAVED"
- glib:nick="non-interleaved">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.h"
- line="71">samples are non-interleaved</doc>
- </member>
- </bitfield>
- <record name="AudioResampler"
- c:type="GstAudioResampler"
- disguised="1"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="43">#GstAudioResampler is a structure which holds the information
-required to perform various kinds of resampling filtering.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="35"/>
- <method name="free" c:identifier="gst_audio_resampler_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1620">Free a previously allocated #GstAudioResampler @resampler.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="231"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="resampler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1622">a #GstAudioResampler</doc>
- <type name="AudioResampler" c:type="GstAudioResampler*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_in_frames"
- c:identifier="gst_audio_resampler_get_in_frames">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1680">Get the number of input frames that would currently be needed
-to produce @out_frames from @resampler.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="246"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1688">The number of input frames needed for producing
-@out_frames of data from @resampler.</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="resampler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1682">a #GstAudioResampler</doc>
- <type name="AudioResampler" c:type="GstAudioResampler*"/>
- </instance-parameter>
- <parameter name="out_frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1683">number of input frames</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_max_latency"
- c:identifier="gst_audio_resampler_get_max_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1707">Get the maximum number of input samples that the resampler would
-need before producing output.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="250"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1714">the latency of @resampler as expressed in the number of
-frames.</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="resampler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1709">a #GstAudioResampler</doc>
- <type name="AudioResampler" c:type="GstAudioResampler*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_out_frames"
- c:identifier="gst_audio_resampler_get_out_frames">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1641">Get the number of output frames that would be currently available when
-@in_frames are given to @resampler.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="242"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1649">The number of frames that would be available after giving
-@in_frames as input to @resampler.</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="resampler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1643">a #GstAudioResampler</doc>
- <type name="AudioResampler" c:type="GstAudioResampler*"/>
- </instance-parameter>
- <parameter name="in_frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1644">number of input frames</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="resample" c:identifier="gst_audio_resampler_resample">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1725">Perform resampling on @in_frames frames in @in and write @out_frames to @out.
-
-In case the samples are interleaved, @in and @out must point to an
-array with a single element pointing to a block of interleaved samples.
-
-If non-interleaved samples are used, @in and @out must point to an
-array with pointers to memory blocks, one for each channel.
-
-@in may be %NULL, in which case @in_frames of silence samples are pushed
-into the resampler.
-
-This function always produces @out_frames of output and consumes @in_frames of
-input. Use gst_audio_resampler_get_out_frames() and
-gst_audio_resampler_get_in_frames() to make sure @in_frames and @out_frames
-are matching and @in and @out point to enough memory.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="253"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="resampler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1727">a #GstAudioResampler</doc>
- <type name="AudioResampler" c:type="GstAudioResampler*"/>
- </instance-parameter>
- <parameter name="in"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1728">input samples</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="in_frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1729">number of input frames</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="out"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1730">output samples</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="out_frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1731">number of output frames</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="reset" c:identifier="gst_audio_resampler_reset">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1462">Reset @resampler to the state it was when it was first created, discarding
-all sample history.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="234"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="resampler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1464">a #GstAudioResampler</doc>
- <type name="AudioResampler" c:type="GstAudioResampler*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="update" c:identifier="gst_audio_resampler_update">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1490">Update the resampler parameters for @resampler. This function should
-not be called concurrently with any other function on @resampler.
-
-When @in_rate or @out_rate is 0, its value is unchanged.
-
-When @options is %NULL, the previously configured options are reused.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="237"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1504">%TRUE if the new parameters could be set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="resampler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1492">a #GstAudioResampler</doc>
- <type name="AudioResampler" c:type="GstAudioResampler*"/>
- </instance-parameter>
- <parameter name="in_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1493">new input rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1494">new output rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="options" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1495">new options or %NULL</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <function name="new" c:identifier="gst_audio_resampler_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1333">Make a new resampler.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="224"/>
- <return-value transfer-ownership="full" skip="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1345">The new #GstAudioResampler, or
-%NULL on failure.</doc>
- <type name="AudioResampler" c:type="GstAudioResampler*"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1335">a #GstAudioResamplerMethod</doc>
- <type name="AudioResamplerMethod"
- c:type="GstAudioResamplerMethod"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1336">#GstAudioResamplerFlags</doc>
- <type name="AudioResamplerFlags" c:type="GstAudioResamplerFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1337">the #GstAudioFormat</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1338">the number of channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="in_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1339">input rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1340">output rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="options" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1341">extra options</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </function>
- <function name="options_set_quality"
- c:identifier="gst_audio_resampler_options_set_quality">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1269">Set the parameters for resampling from @in_rate to @out_rate using @method
-for @quality in @options.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="218"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1271">a #GstAudioResamplerMethod</doc>
- <type name="AudioResamplerMethod"
- c:type="GstAudioResamplerMethod"/>
- </parameter>
- <parameter name="quality" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1272">the quality</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="in_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1273">the input rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1274">the output rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="options" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1275">a #GstStructure</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <enumeration name="AudioResamplerFilterInterpolation"
- version="1.10"
- glib:type-name="GstAudioResamplerFilterInterpolation"
- glib:get-type="gst_audio_resampler_filter_interpolation_get_type"
- c:type="GstAudioResamplerFilterInterpolation">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="125">The different filter interpolation methods.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_AUDIO_RESAMPLER_FILTER_INTERPOLATION_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="127">no interpolation</doc>
- </member>
- <member name="linear"
- value="1"
- c:identifier="GST_AUDIO_RESAMPLER_FILTER_INTERPOLATION_LINEAR"
- glib:nick="linear">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="128">linear interpolation of the
- filter coefficients.</doc>
- </member>
- <member name="cubic"
- value="2"
- c:identifier="GST_AUDIO_RESAMPLER_FILTER_INTERPOLATION_CUBIC"
- glib:nick="cubic">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="130">cubic interpolation of the
- filter coefficients.</doc>
- </member>
- </enumeration>
- <enumeration name="AudioResamplerFilterMode"
- version="1.10"
- glib:type-name="GstAudioResamplerFilterMode"
- glib:get-type="gst_audio_resampler_filter_mode_get_type"
- c:type="GstAudioResamplerFilterMode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="89">Select for the filter tables should be set up.</doc>
- <member name="interpolated"
- value="0"
- c:identifier="GST_AUDIO_RESAMPLER_FILTER_MODE_INTERPOLATED"
- glib:nick="interpolated">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="91">Use interpolated filter tables. This
- uses less memory but more CPU and is slightly less accurate but it allows for more
- efficient variable rate resampling with gst_audio_resampler_update().</doc>
- </member>
- <member name="full"
- value="1"
- c:identifier="GST_AUDIO_RESAMPLER_FILTER_MODE_FULL"
- glib:nick="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="94">Use full filter table. This uses more memory
- but less CPU.</doc>
- </member>
- <member name="auto"
- value="2"
- c:identifier="GST_AUDIO_RESAMPLER_FILTER_MODE_AUTO"
- glib:nick="auto">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="96">Automatically choose between interpolated
- and full filter tables.</doc>
- </member>
- </enumeration>
- <bitfield name="AudioResamplerFlags"
- version="1.10"
- glib:type-name="GstAudioResamplerFlags"
- glib:get-type="gst_audio_resampler_flags_get_type"
- c:type="GstAudioResamplerFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="189">Different resampler flags.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_AUDIO_RESAMPLER_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="191">no flags</doc>
- </member>
- <member name="non_interleaved_in"
- value="1"
- c:identifier="GST_AUDIO_RESAMPLER_FLAG_NON_INTERLEAVED_IN"
- glib:nick="non-interleaved-in">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="192">input samples are non-interleaved.
- an array of blocks of samples, one for each channel, should be passed to the
- resample function.</doc>
- </member>
- <member name="non_interleaved_out"
- value="2"
- c:identifier="GST_AUDIO_RESAMPLER_FLAG_NON_INTERLEAVED_OUT"
- glib:nick="non-interleaved-out">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="195">output samples are non-interleaved.
- an array of blocks of samples, one for each channel, should be passed to the
- resample function.</doc>
- </member>
- <member name="variable_rate"
- value="4"
- c:identifier="GST_AUDIO_RESAMPLER_FLAG_VARIABLE_RATE"
- glib:nick="variable-rate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="198">optimize for dynamic updates of the sample
- rates with gst_audio_resampler_update(). This will select an interpolating filter
- when #GST_AUDIO_RESAMPLER_FILTER_MODE_AUTO is configured.</doc>
- </member>
- </bitfield>
- <enumeration name="AudioResamplerMethod"
- version="1.10"
- glib:type-name="GstAudioResamplerMethod"
- glib:get-type="gst_audio_resampler_method_get_type"
- c:type="GstAudioResamplerMethod">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="167">Different subsampling and upsampling methods</doc>
- <member name="nearest"
- value="0"
- c:identifier="GST_AUDIO_RESAMPLER_METHOD_NEAREST"
- glib:nick="nearest">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="169">Duplicates the samples when
- upsampling and drops when downsampling</doc>
- </member>
- <member name="linear"
- value="1"
- c:identifier="GST_AUDIO_RESAMPLER_METHOD_LINEAR"
- glib:nick="linear">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="171">Uses linear interpolation to reconstruct
- missing samples and averaging to downsample</doc>
- </member>
- <member name="cubic"
- value="2"
- c:identifier="GST_AUDIO_RESAMPLER_METHOD_CUBIC"
- glib:nick="cubic">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="173">Uses cubic interpolation</doc>
- </member>
- <member name="blackman_nuttall"
- value="3"
- c:identifier="GST_AUDIO_RESAMPLER_METHOD_BLACKMAN_NUTTALL"
- glib:nick="blackman-nuttall">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="174">Uses Blackman-Nuttall windowed sinc interpolation</doc>
- </member>
- <member name="kaiser"
- value="4"
- c:identifier="GST_AUDIO_RESAMPLER_METHOD_KAISER"
- glib:nick="kaiser">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.h"
- line="175">Uses Kaiser windowed sinc interpolation</doc>
- </member>
- </enumeration>
- <class name="AudioRingBuffer"
- c:symbol-prefix="audio_ring_buffer"
- c:type="GstAudioRingBuffer"
- parent="Gst.Object"
- abstract="1"
- glib:type-name="GstAudioRingBuffer"
- glib:get-type="gst_audio_ring_buffer_get_type"
- glib:type-struct="AudioRingBufferClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="20">This object is the base class for audio ringbuffers used by the base
-audio source and sink classes.
-
-The ringbuffer abstracts a circular buffer of data. One reader and
-one writer can operate on the data from different threads in a lockfree
-manner. The base class is sufficiently flexible to be used as an
-abstraction for DMA based ringbuffers as well as a pure software
-implementations.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="271"/>
- <function name="debug_spec_buff"
- c:identifier="gst_audio_ring_buffer_debug_spec_buff">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="169">Print debug info about the buffer sized in @spec to the debug log.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="296"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="spec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="171">the spec to debug</doc>
- <type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
- </parameter>
- </parameters>
- </function>
- <function name="debug_spec_caps"
- c:identifier="gst_audio_ring_buffer_debug_spec_caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="139">Print debug info about the parsed caps in @spec to the debug log.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="293"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="spec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="141">the spec to debug</doc>
- <type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
- </parameter>
- </parameters>
- </function>
- <function name="parse_caps"
- c:identifier="gst_audio_ring_buffer_parse_caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="193">Parse @caps into @spec.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="290"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="200">TRUE if the caps could be parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="spec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="195">a spec</doc>
- <type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="196">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="acquire" invoker="acquire">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="588">Allocate the resources for the ringbuffer. This function fills
-in the data pointer of the ring buffer with a valid #GstBuffer
-to which samples can be written.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="249"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="597">TRUE if the device could be acquired, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="590">the #GstAudioRingBuffer to acquire</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="spec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="591">the specs of the buffer</doc>
- <type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="activate" invoker="activate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="805">Activate @buf to start or stop pulling data.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="261"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="814">TRUE if the device could be activated in the requested mode,
-FALSE on error.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="807">the #GstAudioRingBuffer to activate</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="808">the new mode</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="clear_all" invoker="clear_all">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1316">Clear all samples from the ringbuffer.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="267"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1318">the #GstAudioRingBuffer to clear</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="close_device" invoker="close_device">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="497">Close the audio device associated with the ring buffer. The ring buffer
-should already have been released via gst_audio_ring_buffer_release().</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="251"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="504">TRUE if the device could be closed, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="499">the #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="commit" invoker="commit">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1675">Commit @in_samples samples pointed to by @data to the ringbuffer @buf.
-
-@in_samples and @out_samples define the rate conversion to perform on the
-samples in @data. For negative rates, @out_samples must be negative and
-@in_samples positive.
-
-When @out_samples is positive, the first sample will be written at position @sample
-in the ringbuffer. When @out_samples is negative, the last sample will be written to
-@sample in reverse order.
-
-@out_samples does not need to be a multiple of the segment size of the ringbuffer
-although it is recommended for optimal performance.
-
-@accum will hold a temporary accumulator used in rate conversion and should be
-set to 0 when this function is first called. In case the commit operation is
-interrupted, one can resume the processing by passing the previously returned
-@accum value back to this function.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="263"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1704">The number of samples written to the ringbuffer or -1 on error. The
-number of samples written can be less than @out_samples when @buf was interrupted
-with a flush or stop.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1677">the #GstAudioRingBuffer to commit</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1678">the sample position of the data</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1679">the data to commit</doc>
- <array length="2" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="in_samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1680">the number of samples in the data to commit</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1681">the number of samples to write to the ringbuffer</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="accum"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1682">accumulator for rate conversion.</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="delay" invoker="delay">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1183">Get the number of samples queued in the audio device. This is
-usually less than the segment size but can be bigger when the
-implementation uses another internal buffer between the audio
-device.
-
-For playback ringbuffers this is the amount of samples transferred from the
-ringbuffer to the device but still not played.
-
-For capture ringbuffers this is the amount of samples in the device that are
-not yet transferred to the ringbuffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="258"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1198">The number of samples queued in the audio device.
-
-MT safe.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1185">the #GstAudioRingBuffer to query</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="open_device" invoker="open_device">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="436">Open the audio device associated with the ring buffer. Does not perform any
-setup on the device. You must open the device before acquiring the ring
-buffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="248"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="444">TRUE if the device could be opened, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="438">the #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="pause" invoker="pause">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1079">Pause processing samples from the ringbuffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="254"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1085">TRUE if the device could be paused, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1081">the #GstAudioRingBuffer to pause</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="release" invoker="release">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="703">Free the resources of the ringbuffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="250"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="709">TRUE if the device could be released, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="705">the #GstAudioRingBuffer to release</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="resume">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="255"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start" invoker="start">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="947">Start processing samples from the ringbuffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="253"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="953">TRUE if the device could be started, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="949">the #GstAudioRingBuffer to start</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop" invoker="stop">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1123">Stop processing samples from the ringbuffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="256"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1129">TRUE if the device could be stopped, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1125">the #GstAudioRingBuffer to stop</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <method name="acquire" c:identifier="gst_audio_ring_buffer_acquire">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="588">Allocate the resources for the ringbuffer. This function fills
-in the data pointer of the ring buffer with a valid #GstBuffer
-to which samples can be written.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="317"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="597">TRUE if the device could be acquired, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="590">the #GstAudioRingBuffer to acquire</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="spec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="591">the specs of the buffer</doc>
- <type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
- </parameter>
- </parameters>
- </method>
- <method name="activate" c:identifier="gst_audio_ring_buffer_activate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="805">Activate @buf to start or stop pulling data.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="333"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="814">TRUE if the device could be activated in the requested mode,
-FALSE on error.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="807">the #GstAudioRingBuffer to activate</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="808">the new mode</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="advance" c:identifier="gst_audio_ring_buffer_advance">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1921">Subclasses should call this function to notify the fact that
-@advance segments are now processed by the device.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="405"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1923">the #GstAudioRingBuffer to advance</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="advance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1924">the number of segments written</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="clear" c:identifier="gst_audio_ring_buffer_clear">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1950">Clear the given segment of the buffer with silence samples.
-This function is used by subclasses.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="402"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1952">the #GstAudioRingBuffer to clear</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1953">the segment to clear</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="clear_all" c:identifier="gst_audio_ring_buffer_clear_all">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1316">Clear all samples from the ringbuffer.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="371"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1318">the #GstAudioRingBuffer to clear</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="close_device"
- c:identifier="gst_audio_ring_buffer_close_device">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="497">Close the audio device associated with the ring buffer. The ring buffer
-should already have been released via gst_audio_ring_buffer_release().</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="309"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="504">TRUE if the device could be closed, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="499">the #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="commit" c:identifier="gst_audio_ring_buffer_commit">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1675">Commit @in_samples samples pointed to by @data to the ringbuffer @buf.
-
-@in_samples and @out_samples define the rate conversion to perform on the
-samples in @data. For negative rates, @out_samples must be negative and
-@in_samples positive.
-
-When @out_samples is positive, the first sample will be written at position @sample
-in the ringbuffer. When @out_samples is negative, the last sample will be written to
-@sample in reverse order.
-
-@out_samples does not need to be a multiple of the segment size of the ringbuffer
-although it is recommended for optimal performance.
-
-@accum will hold a temporary accumulator used in rate conversion and should be
-set to 0 when this function is first called. In case the commit operation is
-interrupted, one can resume the processing by passing the previously returned
-@accum value back to this function.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="376"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1704">The number of samples written to the ringbuffer or -1 on error. The
-number of samples written can be less than @out_samples when @buf was interrupted
-with a flush or stop.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1677">the #GstAudioRingBuffer to commit</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1678">the sample position of the data</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1679">the data to commit</doc>
- <array length="2" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="in_samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1680">the number of samples in the data to commit</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1681">the number of samples to write to the ringbuffer</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="accum"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1682">accumulator for rate conversion.</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="convert" c:identifier="gst_audio_ring_buffer_convert">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="352">Convert @src_val in @src_fmt to the equivalent value in @dest_fmt. The result
-will be put in @dest_val.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="299"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="363">TRUE if the conversion succeeded.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="354">the #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="src_fmt" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="355">the source format</doc>
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="src_val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="356">the source value</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="dest_fmt" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="357">the destination format</doc>
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="dest_val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="358">a location to store the converted value</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="delay" c:identifier="gst_audio_ring_buffer_delay">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1183">Get the number of samples queued in the audio device. This is
-usually less than the segment size but can be bigger when the
-implementation uses another internal buffer between the audio
-device.
-
-For playback ringbuffers this is the amount of samples transferred from the
-ringbuffer to the device but still not played.
-
-For capture ringbuffers this is the amount of samples in the device that are
-not yet transferred to the ringbuffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="360"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1198">The number of samples queued in the audio device.
-
-MT safe.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1185">the #GstAudioRingBuffer to query</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="device_is_open"
- c:identifier="gst_audio_ring_buffer_device_is_open">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="564">Checks the status of the device associated with the ring buffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="312"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="570">TRUE if the device was open, FALSE if it was closed.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="566">the #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_acquired"
- c:identifier="gst_audio_ring_buffer_is_acquired">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="781">Check if the ringbuffer is acquired and ready to use.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="323"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="787">TRUE if the ringbuffer is acquired, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="783">the #GstAudioRingBuffer to check</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_active" c:identifier="gst_audio_ring_buffer_is_active">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="873">Check if @buf is activated.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="336"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="881">TRUE if the device is active.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="875">the #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_flushing"
- c:identifier="gst_audio_ring_buffer_is_flushing">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="923">Check if @buf is flushing.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="344"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="931">TRUE if the device is flushing.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="925">the #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="may_start" c:identifier="gst_audio_ring_buffer_may_start">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1985">Tell the ringbuffer that it is allowed to start playback when
-the ringbuffer is filled with samples.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="408"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1987">the #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="allowed" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1988">the new value</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="open_device"
- c:identifier="gst_audio_ring_buffer_open_device">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="436">Open the audio device associated with the ring buffer. Does not perform any
-setup on the device. You must open the device before acquiring the ring
-buffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="306"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="444">TRUE if the device could be opened, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="438">the #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pause" c:identifier="gst_audio_ring_buffer_pause">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1079">Pause processing samples from the ringbuffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="352"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1085">TRUE if the device could be paused, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1081">the #GstAudioRingBuffer to pause</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="prepare_read"
- c:identifier="gst_audio_ring_buffer_prepare_read">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1866">Returns a pointer to memory where the data from segment @segment
-can be found. This function is mostly used by subclasses.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="398"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1877">FALSE if the buffer is not started.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1868">the #GstAudioRingBuffer to read from</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="segment"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1869">the segment to read</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="readptr"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1870">
- the pointer to the memory where samples can be read</doc>
- <array length="2" zero-terminated="0" c:type="guint8**">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </parameter>
- <parameter name="len"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1872">the number of bytes to read</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="read" c:identifier="gst_audio_ring_buffer_read">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1728">Read @len samples from the ringbuffer into the memory pointed
-to by @data.
-The first sample should be read from position @sample in
-the ringbuffer.
-
-@len should not be a multiple of the segment size of the ringbuffer
-although it is recommended.
-
-@timestamp will return the timestamp associated with the data returned.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="383"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1746">The number of samples read from the ringbuffer or -1 on
-error.
-
-MT safe.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1730">the #GstAudioRingBuffer to read from</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1731">the sample position of the data</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1732">where the data should be read</doc>
- <array length="2" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1733">the number of samples in data to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timestamp"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1734">where the timestamp is returned</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="release" c:identifier="gst_audio_ring_buffer_release">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="703">Free the resources of the ringbuffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="320"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="709">TRUE if the device could be released, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="705">the #GstAudioRingBuffer to release</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="samples_done"
- c:identifier="gst_audio_ring_buffer_samples_done">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1229">Get the number of samples that were processed by the ringbuffer
-since it was last started. This does not include the number of samples not
-yet processed (see gst_audio_ring_buffer_delay()).</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="363"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1237">The number of samples processed by the ringbuffer.
-
-MT safe.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1231">the #GstAudioRingBuffer to query</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_callback"
- c:identifier="gst_audio_ring_buffer_set_callback"
- shadowed-by="set_callback_full"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="380">Sets the given callback function on the buffer. This function
-will be called every time a segment has been written to a device.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="279"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="382">the #GstAudioRingBuffer to set the callback on</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="cb"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="383">the callback to set</doc>
- <type name="AudioRingBufferCallback"
- c:type="GstAudioRingBufferCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="384">user data passed to the callback</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_callback_full"
- c:identifier="gst_audio_ring_buffer_set_callback_full"
- shadows="set_callback"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="398">Sets the given callback function on the buffer. This function
-will be called every time a segment has been written to a device.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="284"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="400">the #GstAudioRingBuffer to set the callback on</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="cb"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="401">the callback to set</doc>
- <type name="AudioRingBufferCallback"
- c:type="GstAudioRingBufferCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="402">user data passed to the callback</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="403">function to be called when @user_data is no longer needed</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_channel_positions"
- c:identifier="gst_audio_ring_buffer_set_channel_positions">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="2021">Tell the ringbuffer about the device's channel positions. This must
-be called in when the ringbuffer is acquired.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="328"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="2023">the #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="2024">the device channel positions</doc>
- <array zero-terminated="0" c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="set_flushing"
- c:identifier="gst_audio_ring_buffer_set_flushing">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="898">Set the ringbuffer to flushing mode or normal mode.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="341"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="900">the #GstAudioRingBuffer to flush</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="flushing" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="901">the new mode</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_sample"
- c:identifier="gst_audio_ring_buffer_set_sample">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1258">Make sure that the next sample written to the device is
-accounted for as being the @sample sample written to the
-device. This value will be used in reporting the current
-sample position of the ringbuffer.
-
-This function will also clear the buffer with silence.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="366"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1260">the #GstAudioRingBuffer to use</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1261">the sample number to set</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_timestamp"
- c:identifier="gst_audio_ring_buffer_set_timestamp">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="389"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- <parameter name="readseg" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="start" c:identifier="gst_audio_ring_buffer_start">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="947">Start processing samples from the ringbuffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="349"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="953">TRUE if the device could be started, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="949">the #GstAudioRingBuffer to start</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="stop" c:identifier="gst_audio_ring_buffer_stop">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1123">Stop processing samples from the ringbuffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="355"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1129">TRUE if the device could be stopped, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1125">the #GstAudioRingBuffer to stop</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <field name="object">
- <type name="Gst.Object" c:type="GstObject"/>
- </field>
- <field name="cond">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="166">used to signal start/stop/pause/resume actions</doc>
- <type name="GLib.Cond" c:type="GCond"/>
- </field>
- <field name="open">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="167">boolean indicating that the ringbuffer is open</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="acquired">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="168">boolean indicating that the ringbuffer is acquired</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="memory">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="169">data in the ringbuffer</doc>
- <type name="guint8" c:type="guint8*"/>
- </field>
- <field name="size">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="170">size of data in the ringbuffer</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="timestamps" readable="0" private="1">
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </field>
- <field name="spec">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="171">format and layout of the ringbuffer data</doc>
- <type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec"/>
- </field>
- <field name="samples_per_seg">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="172">number of samples in one segment</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="empty_seg">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="173">pointer to memory holding one segment of silence samples</doc>
- <type name="guint8" c:type="guint8*"/>
- </field>
- <field name="state">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="174">state of the buffer</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="segdone">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="175">readpointer in the ringbuffer</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="segbase">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="176">segment corresponding to segment 0 (unused)</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="waiting">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="177">is a reader or writer waiting for a free segment</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="callback" readable="0" private="1">
- <type name="AudioRingBufferCallback"
- c:type="GstAudioRingBufferCallback"/>
- </field>
- <field name="cb_data" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="need_reorder" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="channel_reorder_map" readable="0" private="1">
- <array zero-terminated="0" fixed-size="64">
- <type name="gint" c:type="gint"/>
- </array>
- </field>
- <field name="flushing" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="may_start" readable="0" private="1">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="active" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="cb_data_notify" readable="0" private="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <callback name="AudioRingBufferCallback"
- c:type="GstAudioRingBufferCallback">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="44">This function is set with gst_audio_ring_buffer_set_callback() and is
-called to fill the memory at @data with @len bytes of samples.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="54"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="rbuf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="46">a #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="47">target to fill</doc>
- <array length="2" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="48">amount to fill</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="3">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="49">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="AudioRingBufferClass"
- c:type="GstAudioRingBufferClass"
- glib:is-gtype-struct-for="AudioRingBuffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="222">The vmethods that subclasses can override to implement the ringbuffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="271"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="224">parent class</doc>
- <type name="Gst.ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="open_device">
- <callback name="open_device">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="248"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="444">TRUE if the device could be opened, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="438">the #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="acquire">
- <callback name="acquire">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="249"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="597">TRUE if the device could be acquired, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="590">the #GstAudioRingBuffer to acquire</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- <parameter name="spec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="591">the specs of the buffer</doc>
- <type name="AudioRingBufferSpec"
- c:type="GstAudioRingBufferSpec*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="release">
- <callback name="release">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="250"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="709">TRUE if the device could be released, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="705">the #GstAudioRingBuffer to release</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="close_device">
- <callback name="close_device">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="251"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="504">TRUE if the device could be closed, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="499">the #GstAudioRingBuffer</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="start">
- <callback name="start">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="253"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="953">TRUE if the device could be started, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="949">the #GstAudioRingBuffer to start</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="pause">
- <callback name="pause">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="254"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1085">TRUE if the device could be paused, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1081">the #GstAudioRingBuffer to pause</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="resume">
- <callback name="resume">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="255"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="256"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1129">TRUE if the device could be stopped, FALSE on error.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1125">the #GstAudioRingBuffer to stop</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="delay">
- <callback name="delay">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="258"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1198">The number of samples queued in the audio device.
-
-MT safe.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1185">the #GstAudioRingBuffer to query</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="activate">
- <callback name="activate">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="261"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="814">TRUE if the device could be activated in the requested mode,
-FALSE on error.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="807">the #GstAudioRingBuffer to activate</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="808">the new mode</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="commit">
- <callback name="commit">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="263"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1704">The number of samples written to the ringbuffer or -1 on error. The
-number of samples written can be less than @out_samples when @buf was interrupted
-with a flush or stop.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1677">the #GstAudioRingBuffer to commit</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- <parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1678">the sample position of the data</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1679">the data to commit</doc>
- <array length="3" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="in_samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1680">the number of samples in the data to commit</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1681">the number of samples to write to the ringbuffer</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="accum"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1682">accumulator for rate conversion.</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="clear_all">
- <callback name="clear_all">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="267"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.c"
- line="1318">the #GstAudioRingBuffer to clear</doc>
- <type name="AudioRingBuffer" c:type="GstAudioRingBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <enumeration name="AudioRingBufferFormatType"
- glib:type-name="GstAudioRingBufferFormatType"
- glib:get-type="gst_audio_ring_buffer_format_type_get_type"
- c:type="GstAudioRingBufferFormatType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="74">The format of the samples in the ringbuffer.</doc>
- <member name="raw"
- value="0"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_RAW"
- glib:nick="raw">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="76">samples in linear or float</doc>
- </member>
- <member name="mu_law"
- value="1"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MU_LAW"
- glib:nick="mu-law">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="77">samples in mulaw</doc>
- </member>
- <member name="a_law"
- value="2"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_A_LAW"
- glib:nick="a-law">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="78">samples in alaw</doc>
- </member>
- <member name="ima_adpcm"
- value="3"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_IMA_ADPCM"
- glib:nick="ima-adpcm">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="79">samples in ima adpcm</doc>
- </member>
- <member name="mpeg"
- value="4"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG"
- glib:nick="mpeg">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="80">samples in mpeg audio (but not AAC) format</doc>
- </member>
- <member name="gsm"
- value="5"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_GSM"
- glib:nick="gsm">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="81">samples in gsm format</doc>
- </member>
- <member name="iec958"
- value="6"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_IEC958"
- glib:nick="iec958">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="82">samples in IEC958 frames (e.g. AC3)</doc>
- </member>
- <member name="ac3"
- value="7"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_AC3"
- glib:nick="ac3">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="83">samples in AC3 format</doc>
- </member>
- <member name="eac3"
- value="8"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_EAC3"
- glib:nick="eac3">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="84">samples in EAC3 format</doc>
- </member>
- <member name="dts"
- value="9"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_DTS"
- glib:nick="dts">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="85">samples in DTS format</doc>
- </member>
- <member name="mpeg2_aac"
- value="10"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG2_AAC"
- glib:nick="mpeg2-aac">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="86">samples in MPEG-2 AAC ADTS format</doc>
- </member>
- <member name="mpeg4_aac"
- value="11"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG4_AAC"
- glib:nick="mpeg4-aac">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="87">samples in MPEG-4 AAC ADTS format</doc>
- </member>
- <member name="mpeg2_aac_raw"
- value="12"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG2_AAC_RAW"
- glib:nick="mpeg2-aac-raw">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="88">samples in MPEG-2 AAC raw format (Since: 1.12)</doc>
- </member>
- <member name="mpeg4_aac_raw"
- value="13"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG4_AAC_RAW"
- glib:nick="mpeg4-aac-raw">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="89">samples in MPEG-4 AAC raw format (Since: 1.12)</doc>
- </member>
- <member name="flac"
- value="14"
- c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_FLAC"
- glib:nick="flac">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="90">samples in FLAC format (Since: 1.12)</doc>
- </member>
- </enumeration>
- <record name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="113">The structure containing the format specification of the ringbuffer.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="157"/>
- <field name="caps" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="115">The caps that generated the Spec.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </field>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="116">the sample type</doc>
- <type name="AudioRingBufferFormatType"
- c:type="GstAudioRingBufferFormatType"/>
- </field>
- <field name="info" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="117">the #GstAudioInfo</doc>
- <type name="AudioInfo" c:type="GstAudioInfo"/>
- </field>
- <field name="latency_time" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="118">the latency in microseconds</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="buffer_time" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="119">the total buffer size in microseconds</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="segsize" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="120">the size of one segment in bytes</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="segtotal" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="121">the total number of segments</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="seglatency" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="122">number of segments queued in the lower level device,
- defaults to segtotal</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <enumeration name="AudioRingBufferState"
- glib:type-name="GstAudioRingBufferState"
- glib:get-type="gst_audio_ring_buffer_state_get_type"
- c:type="GstAudioRingBufferState">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="56">The state of the ringbuffer.</doc>
- <member name="stopped"
- value="0"
- c:identifier="GST_AUDIO_RING_BUFFER_STATE_STOPPED"
- glib:nick="stopped">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="58">The ringbuffer is stopped</doc>
- </member>
- <member name="paused"
- value="1"
- c:identifier="GST_AUDIO_RING_BUFFER_STATE_PAUSED"
- glib:nick="paused">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="59">The ringbuffer is paused</doc>
- </member>
- <member name="started"
- value="2"
- c:identifier="GST_AUDIO_RING_BUFFER_STATE_STARTED"
- glib:nick="started">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="60">The ringbuffer is started</doc>
- </member>
- <member name="error"
- value="3"
- c:identifier="GST_AUDIO_RING_BUFFER_STATE_ERROR"
- glib:nick="error">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="61">The ringbuffer has encountered an
- error after it has been started, e.g. because the device was
- disconnected (Since: 1.2)</doc>
- </member>
- </enumeration>
- <class name="AudioSink"
- c:symbol-prefix="audio_sink"
- c:type="GstAudioSink"
- parent="AudioBaseSink"
- glib:type-name="GstAudioSink"
- glib:get-type="gst_audio_sink_get_type"
- glib:type-struct="AudioSinkClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiosink.c"
- line="23">This is the most simple base class for audio sinks that only requires
-subclasses to implement a set of simple functions:
-
-* `open()` :Open the device.
-
-* `prepare()` :Configure the device with the specified format.
-
-* `write()` :Write samples to the device.
-
-* `reset()` :Unblock writes and flush the device.
-
-* `delay()` :Get the number of samples written but not yet played
-by the device.
-
-* `unprepare()` :Undo operations done by prepare.
-
-* `close()` :Close the device.
-
-All scheduling of samples and timestamps is done in this base class
-together with #GstAudioBaseSink using a default implementation of a
-#GstAudioRingBuffer that uses threads.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="115"/>
- <virtual-method name="close">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="100"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="delay">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="104"/>
- <return-value transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="open">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="94"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="pause">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="108"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="prepare">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="96"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </instance-parameter>
- <parameter name="spec" transfer-ownership="none">
- <type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="reset">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="106"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="resume">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="110"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="112"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="unprepare">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="98"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="write">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="102"/>
- <return-value transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </instance-parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </virtual-method>
- <field name="element">
- <type name="AudioBaseSink" c:type="GstAudioBaseSink"/>
- </field>
- <field name="thread" readable="0" private="1">
- <type name="GLib.Thread" c:type="GThread*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioSinkClass"
- c:type="GstAudioSinkClass"
- glib:is-gtype-struct-for="AudioSink">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="115"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiosink.h"
- line="63">the parent class structure.</doc>
- <type name="AudioBaseSinkClass" c:type="GstAudioBaseSinkClass"/>
- </field>
- <field name="open">
- <callback name="open">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="94"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="prepare">
- <callback name="prepare">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="96"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </parameter>
- <parameter name="spec" transfer-ownership="none">
- <type name="AudioRingBufferSpec"
- c:type="GstAudioRingBufferSpec*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="unprepare">
- <callback name="unprepare">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="98"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="close">
- <callback name="close">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="100"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="write">
- <callback name="write">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="102"/>
- <return-value transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="delay">
- <callback name="delay">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="104"/>
- <return-value transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="reset">
- <callback name="reset">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="106"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="pause">
- <callback name="pause">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="108"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="resume">
- <callback name="resume">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="110"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="112"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="extension">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiosink.h"
- line="86">class extension structure. Since: 1.18</doc>
- <type name="AudioSinkClassExtension"
- c:type="GstAudioSinkClassExtension*"/>
- </field>
- </record>
- <record name="AudioSinkClassExtension" c:type="GstAudioSinkClassExtension">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="127"/>
- <field name="clear_all">
- <callback name="clear_all">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h"
- line="124"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="AudioSink" c:type="GstAudioSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- </record>
- <class name="AudioSrc"
- c:symbol-prefix="audio_src"
- c:type="GstAudioSrc"
- parent="AudioBaseSrc"
- glib:type-name="GstAudioSrc"
- glib:get-type="gst_audio_src_get_type"
- glib:type-struct="AudioSrcClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiosrc.c"
- line="23">This is the most simple base class for audio sources that only requires
-subclasses to implement a set of simple functions:
-
-* `open()` :Open the device.
-* `prepare()` :Configure the device with the specified format.
-* `read()` :Read samples from the device.
-* `reset()` :Unblock reads and flush the device.
-* `delay()` :Get the number of samples in the device but not yet read.
-* `unprepare()` :Undo operations done by prepare.
-* `close()` :Close the device.
-
-All scheduling of samples and timestamps is done in this base class
-together with #GstAudioBaseSrc using a default implementation of a
-#GstAudioRingBuffer that uses threads.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h" line="97"/>
- <virtual-method name="close">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="86"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="delay">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="91"/>
- <return-value transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="open">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="80"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="prepare">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="82"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </instance-parameter>
- <parameter name="spec" transfer-ownership="none">
- <type name="AudioRingBufferSpec" c:type="GstAudioRingBufferSpec*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="read">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="88"/>
- <return-value transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </instance-parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="reset">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="93"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="unprepare">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="84"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <field name="element">
- <type name="AudioBaseSrc" c:type="GstAudioBaseSrc"/>
- </field>
- <field name="thread" readable="0" private="1">
- <type name="GLib.Thread" c:type="GThread*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="AudioSrcClass"
- c:type="GstAudioSrcClass"
- glib:is-gtype-struct-for="AudioSrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="60">#GstAudioSrc class. Override the vmethod to implement
-functionality.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h" line="97"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="62">the parent class.</doc>
- <type name="AudioBaseSrcClass" c:type="GstAudioBaseSrcClass"/>
- </field>
- <field name="open">
- <callback name="open">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="80"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="prepare">
- <callback name="prepare">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="82"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </parameter>
- <parameter name="spec" transfer-ownership="none">
- <type name="AudioRingBufferSpec"
- c:type="GstAudioRingBufferSpec*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="unprepare">
- <callback name="unprepare">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="84"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="close">
- <callback name="close">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="86"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="read">
- <callback name="read">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="88"/>
- <return-value transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="delay">
- <callback name="delay">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="91"/>
- <return-value transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="reset">
- <callback name="reset">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h"
- line="93"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="AudioSrc" c:type="GstAudioSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AudioStreamAlign"
- c:type="GstAudioStreamAlign"
- version="1.14"
- glib:type-name="GstAudioStreamAlign"
- glib:get-type="gst_audio_stream_align_get_type"
- c:symbol-prefix="audio_stream_align">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="28">#GstAudioStreamAlign provides a helper object that helps tracking audio
-stream alignment and discontinuities, and detects discontinuities if
-possible.
-
-See gst_audio_stream_align_new() for a description of its parameters and
-gst_audio_stream_align_process() for the details of the processing.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="39"/>
- <constructor name="new"
- c:identifier="gst_audio_stream_align_new"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="60">Allocate a new #GstAudioStreamAlign with the given configuration. All
-processing happens according to sample rate @rate, until
-gst_audio_stream_align_set_rate() is called with a new @rate.
-A negative rate can be used for reverse playback.
-
-@alignment_threshold gives the tolerance in nanoseconds after which a
-timestamp difference is considered a discontinuity. Once detected,
-@discont_wait nanoseconds have to pass without going below the threshold
-again until the output buffer is marked as a discontinuity. These can later
-be re-configured with gst_audio_stream_align_set_alignment_threshold() and
-gst_audio_stream_align_set_discont_wait().</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="45"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="78">a new #GstAudioStreamAlign. free with gst_audio_stream_align_free().</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </return-value>
- <parameters>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="62">a sample rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="alignment_threshold" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="63">a alignment threshold in nanoseconds</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="discont_wait" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="64">discont wait in nanoseconds</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="copy"
- c:identifier="gst_audio_stream_align_copy"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="102">Copy a GstAudioStreamAlign structure.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="49"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="108">a new #GstAudioStreamAlign. free with gst_audio_stream_align_free.</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="104">a #GstAudioStreamAlign</doc>
- <type name="AudioStreamAlign" c:type="const GstAudioStreamAlign*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free"
- c:identifier="gst_audio_stream_align_free"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="125">Free a GstAudioStreamAlign structure previously allocated with gst_audio_stream_align_new()
-or gst_audio_stream_align_copy().</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="51"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="127">a #GstAudioStreamAlign</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_alignment_threshold"
- c:identifier="gst_audio_stream_align_get_alignment_threshold"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="200">Gets the currently configured alignment threshold.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="63"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="206">The currently configured alignment threshold</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="202">a #GstAudioStreamAlign</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_discont_wait"
- c:identifier="gst_audio_stream_align_get_discont_wait"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="236">Gets the currently configured discont wait.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="242">The currently configured discont wait</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="238">a #GstAudioStreamAlign</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_rate"
- c:identifier="gst_audio_stream_align_get_rate"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="164">Gets the currently configured sample rate.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="57"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="170">The currently configured sample rate</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="166">a #GstAudioStreamAlign</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_samples_since_discont"
- c:identifier="gst_audio_stream_align_get_samples_since_discont"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="290">Returns the number of samples that were processed since the last
-discontinuity was detected.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="79"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="297">The number of samples processed since the last discontinuity.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="292">a #GstAudioStreamAlign</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_timestamp_at_discont"
- c:identifier="gst_audio_stream_align_get_timestamp_at_discont"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="271">Timestamp that was passed when a discontinuity was detected, i.e. the first
-timestamp after the discontinuity.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="76"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="278">The last timestamp at when a discontinuity was detected</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="273">a #GstAudioStreamAlign</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="mark_discont"
- c:identifier="gst_audio_stream_align_mark_discont"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="254">Marks the next buffer as discontinuous and resets timestamp tracking.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="73"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="256">a #GstAudioStreamAlign</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="process"
- c:identifier="gst_audio_stream_align_process"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="309">Processes data with @timestamp and @n_samples, and returns the output
-timestamp, duration and sample position together with a boolean to signal
-whether a discontinuity was detected or not. All non-discontinuous data
-will have perfect timestamps and durations.
-
-A discontinuity is detected once the difference between the actual
-timestamp and the timestamp calculated from the sample count since the last
-discontinuity differs by more than the alignment threshold for a duration
-longer than discont wait.
-
-Note: In reverse playback, every buffer is considered discontinuous in the
-context of buffer flags because the last sample of the previous buffer is
-discontinuous with the first sample of the current one. However for this
-function they are only considered discontinuous in reverse playback if the
-first sample of the previous buffer is discontinuous with the last sample
-of the current one.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="82"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="336">%TRUE if a discontinuity was detected, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="311">a #GstAudioStreamAlign</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </instance-parameter>
- <parameter name="discont" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="312">if this data is considered to be discontinuous</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="313">a #GstClockTime of the start of the data</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="n_samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="314">number of samples to process</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="out_timestamp"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="315">output timestamp of the data</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="out_duration"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="316">output duration of the data</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="out_sample_position"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="317">output sample position of the start of the data</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_alignment_threshold"
- c:identifier="gst_audio_stream_align_set_alignment_threshold"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="182">Sets @alignment_treshold as new alignment threshold for the following processing.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="60"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="184">a #GstAudioStreamAlign</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </instance-parameter>
- <parameter name="alignment_threshold" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="185">a new alignment threshold</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_discont_wait"
- c:identifier="gst_audio_stream_align_set_discont_wait"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="218">Sets @alignment_treshold as new discont wait for the following processing.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="66"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="220">a #GstAudioStreamAlign</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </instance-parameter>
- <parameter name="discont_wait" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="221">a new discont wait</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_rate"
- c:identifier="gst_audio_stream_align_set_rate"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="141">Sets @rate as new sample rate for the following processing. If the sample
-rate differs this implicitly marks the next data as discontinuous.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiostreamalign.h"
- line="54"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="143">a #GstAudioStreamAlign</doc>
- <type name="AudioStreamAlign" c:type="GstAudioStreamAlign*"/>
- </instance-parameter>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiostreamalign.c"
- line="144">a new sample rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <function-macro name="CLOCK_TIME_TO_FRAMES"
- c:identifier="GST_CLOCK_TIME_TO_FRAMES"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.h"
- line="52">Calculate frames from @clocktime and sample @rate.</doc>
- <source-position filename="gst-libs/gst/audio/audio.h" line="59"/>
- <parameters>
- <parameter name="clocktime">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.h"
- line="54">clock time</doc>
- </parameter>
- <parameter name="rate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.h"
- line="55">sampling rate</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="FRAMES_TO_CLOCK_TIME"
- c:identifier="GST_FRAMES_TO_CLOCK_TIME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.h"
- line="42">Calculate clocktime from sample @frames and @rate.</doc>
- <source-position filename="gst-libs/gst/audio/audio.h" line="49"/>
- <parameters>
- <parameter name="frames">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.h"
- line="44">sample frames</doc>
- </parameter>
- <parameter name="rate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.h"
- line="45">sampling rate</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_AGGREGATOR"
- c:identifier="GST_IS_AUDIO_AGGREGATOR"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="166"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_AGGREGATOR_CLASS"
- c:identifier="GST_IS_AUDIO_AGGREGATOR_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="167"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_AGGREGATOR_CONVERT_PAD"
- c:identifier="GST_IS_AUDIO_AGGREGATOR_CONVERT_PAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="112"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_AGGREGATOR_CONVERT_PAD_CLASS"
- c:identifier="GST_IS_AUDIO_AGGREGATOR_CONVERT_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="113"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_AGGREGATOR_PAD"
- c:identifier="GST_IS_AUDIO_AGGREGATOR_PAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="49"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_AGGREGATOR_PAD_CLASS"
- c:identifier="GST_IS_AUDIO_AGGREGATOR_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioaggregator.h"
- line="50"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_BASE_SINK"
- c:identifier="GST_IS_AUDIO_BASE_SINK"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="65"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_BASE_SINK_CLASS"
- c:identifier="GST_IS_AUDIO_BASE_SINK_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesink.h"
- line="66"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_BASE_SRC"
- c:identifier="GST_IS_AUDIO_BASE_SRC"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="43"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_BASE_SRC_CLASS"
- c:identifier="GST_IS_AUDIO_BASE_SRC_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiobasesrc.h"
- line="44"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_CD_SRC"
- c:identifier="GST_IS_AUDIO_CD_SRC"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_CD_SRC_CLASS"
- c:identifier="GST_IS_AUDIO_CD_SRC_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiocdsrc.h"
- line="36"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_CLOCK"
- c:identifier="GST_IS_AUDIO_CLOCK"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="40"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_CLOCK_CLASS"
- c:identifier="GST_IS_AUDIO_CLOCK_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioclock.h"
- line="42"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_DECODER"
- c:identifier="GST_IS_AUDIO_DECODER"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="43"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_DECODER_CLASS"
- c:identifier="GST_IS_AUDIO_DECODER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiodecoder.h"
- line="45"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_ENCODER"
- c:identifier="GST_IS_AUDIO_ENCODER"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_ENCODER_CLASS"
- c:identifier="GST_IS_AUDIO_ENCODER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioencoder.h"
- line="38"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_FILTER"
- c:identifier="GST_IS_AUDIO_FILTER"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="46"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_FILTER_CLASS"
- c:identifier="GST_IS_AUDIO_FILTER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiofilter.h"
- line="48"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_RING_BUFFER"
- c:identifier="GST_IS_AUDIO_RING_BUFFER"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_RING_BUFFER_CLASS"
- c:identifier="GST_IS_AUDIO_RING_BUFFER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudioringbuffer.h"
- line="38"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_SINK"
- c:identifier="GST_IS_AUDIO_SINK"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h" line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_SINK_CLASS"
- c:identifier="GST_IS_AUDIO_SINK_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiosink.h" line="40"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_SRC"
- c:identifier="GST_IS_AUDIO_SRC"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h" line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AUDIO_SRC_CLASS"
- c:identifier="GST_IS_AUDIO_SRC_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiosrc.h" line="40"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="META_TAG_AUDIO_CHANNELS_STR"
- value="channels"
- c:type="GST_META_TAG_AUDIO_CHANNELS_STR"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.h"
- line="72">This metadata stays relevant as long as channels are unchanged.</doc>
- <source-position filename="gst-libs/gst/audio/audio.h" line="79"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_TAG_AUDIO_RATE_STR"
- value="rate"
- c:type="GST_META_TAG_AUDIO_RATE_STR"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.h"
- line="81">This metadata stays relevant as long as sample rate is unchanged.</doc>
- <source-position filename="gst-libs/gst/audio/audio.h" line="88"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_TAG_AUDIO_STR"
- value="audio"
- c:type="GST_META_TAG_AUDIO_STR"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.h"
- line="64">This metadata is relevant for audio streams.</doc>
- <source-position filename="gst-libs/gst/audio/audio.h" line="71"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="STREAM_VOLUME_GET_INTERFACE"
- c:identifier="GST_STREAM_VOLUME_GET_INTERFACE"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/streamvolume.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <interface name="StreamVolume"
- c:symbol-prefix="stream_volume"
- c:type="GstStreamVolume"
- glib:type-name="GstStreamVolume"
- glib:get-type="gst_stream_volume_get_type"
- glib:type-struct="StreamVolumeInterface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="20">This interface is implemented by elements that provide a stream volume. Examples for
-such elements are #volume and #playbin.
-
-Applications can use this interface to get or set the current stream volume. For this
-the "volume" #GObject property can be used or the helper functions gst_stream_volume_set_volume()
-and gst_stream_volume_get_volume(). This volume is always a linear factor, i.e. 0.0 is muted
-1.0 is 100%. For showing the volume in a GUI it might make sense to convert it to
-a different format by using gst_stream_volume_convert_volume(). Volume sliders should usually
-use a cubic volume.
-
-Separate from the volume the stream can also be muted by the "mute" #GObject property or
-gst_stream_volume_set_mute() and gst_stream_volume_get_mute().
-
-Elements that provide some kind of stream volume should implement the "volume" and
-"mute" #GObject properties and handle setting and getting of them properly.
-The volume property is defined to be a linear volume factor.</doc>
- <source-position filename="gst-libs/gst/audio/streamvolume.h" line="37"/>
- <function name="convert_volume"
- c:identifier="gst_stream_volume_convert_volume">
- <source-position filename="gst-libs/gst/audio/streamvolume.h"
- line="74"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="170">the converted volume</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <parameter name="from" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="166">#GstStreamVolumeFormat to convert from</doc>
- <type name="StreamVolumeFormat" c:type="GstStreamVolumeFormat"/>
- </parameter>
- <parameter name="to" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="167">#GstStreamVolumeFormat to convert to</doc>
- <type name="StreamVolumeFormat" c:type="GstStreamVolumeFormat"/>
- </parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="168">Volume in @from format that should be converted</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </function>
- <method name="get_mute" c:identifier="gst_stream_volume_get_mute">
- <source-position filename="gst-libs/gst/audio/streamvolume.h"
- line="71"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="138">Returns %TRUE if the stream is muted</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="volume" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="136">#GstStreamVolume that should be used</doc>
- <type name="StreamVolume" c:type="GstStreamVolume*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_volume" c:identifier="gst_stream_volume_get_volume">
- <source-position filename="gst-libs/gst/audio/streamvolume.h"
- line="63"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="97">The current stream volume as linear factor</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <instance-parameter name="volume" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="94">#GstStreamVolume that should be used</doc>
- <type name="StreamVolume" c:type="GstStreamVolume*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="95">#GstStreamVolumeFormat which should be returned</doc>
- <type name="StreamVolumeFormat" c:type="GstStreamVolumeFormat"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_mute" c:identifier="gst_stream_volume_set_mute">
- <source-position filename="gst-libs/gst/audio/streamvolume.h"
- line="67"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="volume" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="153">#GstStreamVolume that should be used</doc>
- <type name="StreamVolume" c:type="GstStreamVolume*"/>
- </instance-parameter>
- <parameter name="mute" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="154">Mute state that should be set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_volume" c:identifier="gst_stream_volume_set_volume">
- <source-position filename="gst-libs/gst/audio/streamvolume.h"
- line="58"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="volume" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="117">#GstStreamVolume that should be used</doc>
- <type name="StreamVolume" c:type="GstStreamVolume*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="118">#GstStreamVolumeFormat of @val</doc>
- <type name="StreamVolumeFormat" c:type="GstStreamVolumeFormat"/>
- </parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="119">Linear volume factor that should be set</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <property name="mute" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="volume" writable="1" transfer-ownership="none">
- <type name="gdouble" c:type="gdouble"/>
- </property>
- </interface>
- <enumeration name="StreamVolumeFormat" c:type="GstStreamVolumeFormat">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.h"
- line="39">Different representations of a stream volume. gst_stream_volume_convert_volume()
-allows to convert between the different representations.
-
-Formulas to convert from a linear to a cubic or dB volume are
-cbrt(val) and 20 * log10 (val).</doc>
- <source-position filename="gst-libs/gst/audio/streamvolume.h" line="55"/>
- <member name="linear"
- value="0"
- c:identifier="GST_STREAM_VOLUME_FORMAT_LINEAR">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.h"
- line="41">Linear scale factor, 1.0 = 100%</doc>
- </member>
- <member name="cubic"
- value="1"
- c:identifier="GST_STREAM_VOLUME_FORMAT_CUBIC">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.h"
- line="42">Cubic volume scale</doc>
- </member>
- <member name="db" value="2" c:identifier="GST_STREAM_VOLUME_FORMAT_DB">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.h"
- line="43">Logarithmic volume scale (dB, amplitude not power)</doc>
- </member>
- </enumeration>
- <record name="StreamVolumeInterface"
- c:type="GstStreamVolumeInterface"
- glib:is-gtype-struct-for="StreamVolume">
- <source-position filename="gst-libs/gst/audio/streamvolume.h" line="37"/>
- <field name="iface">
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- </record>
- <function name="audio_buffer_clip"
- c:identifier="gst_audio_buffer_clip"
- moved-to="AudioBuffer.clip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="58">Clip the buffer to the given %GstSegment.
-
-After calling this function the caller does not own a reference to
-@buffer anymore.</doc>
- <source-position filename="gst-libs/gst/audio/audio.h" line="96"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="72">%NULL if the buffer is completely outside the configured segment,
-otherwise the clipped buffer is returned.
-
-If the buffer has no timestamp, it is assumed to be inside the segment and
-is not clipped</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="60">The buffer to clip.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="61">Segment in %GST_FORMAT_TIME or %GST_FORMAT_DEFAULT to which
- the buffer should be clipped.</doc>
- <type name="Gst.Segment" c:type="const GstSegment*"/>
- </parameter>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="63">sample rate.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="bpf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="64">size of one audio frame in bytes. This is the size of one sample *
-number of channels.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_buffer_reorder_channels"
- c:identifier="gst_audio_buffer_reorder_channels"
- moved-to="AudioBuffer.reorder_channels">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="278">Reorders @buffer from the channel positions @from to the channel
-positions @to. @from and @to must contain the same number of
-positions and the same positions, only in a different order.
-@buffer must be writable.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channels.h"
- line="135"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="291">%TRUE if the reordering was possible.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="280">The buffer to reorder.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="281">The %GstAudioFormat of the buffer.</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="282">The number of channels.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="from" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="283">The channel positions in the buffer.</doc>
- <array length="2"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- <parameter name="to" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="284">The channel positions to convert to.</doc>
- <array length="2"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="audio_buffer_truncate"
- c:identifier="gst_audio_buffer_truncate"
- moved-to="AudioBuffer.truncate"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="247">Truncate the buffer to finally have @samples number of samples, removing
-the necessary amount of samples from the end and @trim number of samples
-from the beginning.
-
-After calling this function the caller does not own a reference to
-@buffer anymore.</doc>
- <source-position filename="gst-libs/gst/audio/audio.h" line="101"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="264">the truncated buffer or %NULL if the arguments
- were invalid</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="249">The buffer to truncate.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="bpf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="250">size of one audio frame in bytes. This is the size of one sample *
-number of channels.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="trim" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="252">the number of samples to remove from the beginning of the buffer</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="253">the final number of samples that should exist in this buffer or -1
-to use all the remaining samples if you are only removing samples from the
-beginning.</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_channel_get_fallback_mask"
- c:identifier="gst_audio_channel_get_fallback_mask"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="568">Get the fallback channel-mask for the given number of channels.
-
-This function returns a reasonable fallback channel-mask and should be
-called as a last resort when the specific channel map is unknown.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channels.h"
- line="172"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="577">a fallback channel-mask for @channels or 0 when there is no
-mask and mono.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="570">the number of channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_channel_mixer_new"
- c:identifier="gst_audio_channel_mixer_new"
- moved-to="AudioChannelMixer.new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="973">Create a new channel mixer object for the given parameters.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="50"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="983">a new #GstAudioChannelMixer object, or %NULL if @format isn't supported.
- Free with gst_audio_channel_mixer_free() after usage.</doc>
- <type name="AudioChannelMixer" c:type="GstAudioChannelMixer*"/>
- </return-value>
- <parameters>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="975">#GstAudioChannelMixerFlags</doc>
- <type name="AudioChannelMixerFlags"
- c:type="GstAudioChannelMixerFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- <parameter name="in_channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="976">number of input channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="in_position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="977">positions of input channels</doc>
- <type name="AudioChannelPosition" c:type="GstAudioChannelPosition*"/>
- </parameter>
- <parameter name="out_channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="978">number of output channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="979">positions of output channels</doc>
- <type name="AudioChannelPosition" c:type="GstAudioChannelPosition*"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_channel_mixer_new_with_matrix"
- c:identifier="gst_audio_channel_mixer_new_with_matrix"
- moved-to="AudioChannelMixer.new_with_matrix"
- version="1.14"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="809">Create a new channel mixer object for the given parameters.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channel-mixer.h"
- line="58"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="820">a new #GstAudioChannelMixer object, or %NULL if @format isn't supported,
- @matrix is invalid, or @matrix is %NULL and @in_channels != @out_channels.
- Free with gst_audio_channel_mixer_free() after usage.</doc>
- <type name="AudioChannelMixer" c:type="GstAudioChannelMixer*"/>
- </return-value>
- <parameters>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="811">#GstAudioChannelMixerFlags</doc>
- <type name="AudioChannelMixerFlags"
- c:type="GstAudioChannelMixerFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- <parameter name="in_channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="812">number of input channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="813">number of output channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="matrix"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channel-mixer.c"
- line="814">channel conversion matrix, m[@in_channels][@out_channels].
- If identity matrix, passthrough applies. If %NULL, a (potentially truncated)
- identity matrix is generated.</doc>
- <type name="gfloat" c:type="gfloat**"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_channel_positions_from_mask"
- c:identifier="gst_audio_channel_positions_from_mask">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="367">Convert the @channels present in @channel_mask to a @position array
-(which should have at least @channels entries ensured by caller).
-If @channel_mask is set to 0, it is considered as 'not present' for purpose
-of conversion.
-A partially valid @channel_mask with less bits set than the number
-of channels is considered valid.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channels.h"
- line="162"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="381">%TRUE if channel and channel mask are valid and could be converted</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="369">The number of channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="channel_mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="370">The input channel_mask</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="371">The
- %GstAudioChannelPosition&lt;!-- --&gt;s</doc>
- <array length="0"
- zero-terminated="0"
- c:type="GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="audio_channel_positions_to_mask"
- c:identifier="gst_audio_channel_positions_to_mask">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="345">Convert the @position array of @channels channels to a bitmask.
-
-If @force_order is %TRUE it additionally checks if the channels are
-in the order required by GStreamer.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channels.h"
- line="157"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="357">%TRUE if the channel positions are valid and could be converted.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="347">The %GstAudioChannelPositions</doc>
- <array length="1"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="348">The number of channels.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="force_order" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="349">Only consider the GStreamer channel order.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="channel_mask"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="350">the output channel mask</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_channel_positions_to_string"
- c:identifier="gst_audio_channel_positions_to_string"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="666">Converts @position to a human-readable string representation for
-debugging purposes.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channels.h"
- line="175"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="675">a newly allocated string representing
-@position</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="668">The %GstAudioChannelPositions
- to convert.</doc>
- <array length="1"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="670">The number of channels.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_channel_positions_to_valid_order"
- c:identifier="gst_audio_channel_positions_to_valid_order">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="491">Reorders the channel positions in @position from any order to
-the GStreamer channel order.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channels.h"
- line="149"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="500">%TRUE if the channel positions are valid and reordering
-was successful.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="493">The channel positions to
- reorder to.</doc>
- <array length="1"
- zero-terminated="0"
- c:type="GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="495">The number of channels.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_check_valid_channel_positions"
- c:identifier="gst_audio_check_valid_channel_positions">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="325">Checks if @position contains valid channel positions for
-@channels channels. If @force_order is %TRUE it additionally
-checks if the channels are in the order required by GStreamer.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channels.h"
- line="153"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="336">%TRUE if the channel positions are valid.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="327">The %GstAudioChannelPositions
- to check.</doc>
- <array length="1"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="329">The number of channels.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="force_order" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="330">Only consider the GStreamer channel order.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_clipping_meta_api_get_type"
- c:identifier="gst_audio_clipping_meta_api_get_type">
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="115"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="audio_clipping_meta_get_info"
- c:identifier="gst_audio_clipping_meta_get_info"
- moved-to="AudioClippingMeta.get_info">
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="118"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="audio_downmix_meta_api_get_type"
- c:identifier="gst_audio_downmix_meta_api_get_type">
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h" line="60"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="audio_downmix_meta_get_info"
- c:identifier="gst_audio_downmix_meta_get_info"
- moved-to="AudioDownmixMeta.get_info">
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h" line="63"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="audio_format_build_integer"
- c:identifier="gst_audio_format_build_integer"
- moved-to="AudioFormat.build_integer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="358">Construct a #GstAudioFormat with given parameters.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="275"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="367">a #GstAudioFormat or GST_AUDIO_FORMAT_UNKNOWN when no audio format
-exists with the given parameters.</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </return-value>
- <parameters>
- <parameter name="sign" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="360">signed or unsigned format</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="endianness" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="361">G_LITTLE_ENDIAN or G_BIG_ENDIAN</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="362">amount of bits used per sample</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="depth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="363">amount of used bits in @width</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_format_fill_silence"
- c:identifier="gst_audio_format_fill_silence"
- moved-to="AudioFormat.fill_silence">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="454">Fill @length bytes in @dest with silence samples for @info.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="289"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="456">a #GstAudioFormatInfo</doc>
- <type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
- </parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="457">a destination
- to fill</doc>
- <array length="2" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="459">the length to fill</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_format_from_string"
- c:identifier="gst_audio_format_from_string"
- moved-to="AudioFormat.from_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="404">Convert the @format string to its #GstAudioFormat.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="279"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="410">the #GstAudioFormat for @format or GST_AUDIO_FORMAT_UNKNOWN when the
-string is not a known format.</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="406">a format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_format_get_info"
- c:identifier="gst_audio_format_get_info"
- moved-to="AudioFormat.get_info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="438">Get the #GstAudioFormatInfo for @format</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="286"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="444">The #GstAudioFormatInfo for @format.</doc>
- <type name="AudioFormatInfo" c:type="const GstAudioFormatInfo*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="440">a #GstAudioFormat</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_format_info_get_type"
- c:identifier="gst_audio_format_info_get_type">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="257"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="audio_format_to_string"
- c:identifier="gst_audio_format_to_string"
- moved-to="AudioFormat.to_string">
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="282"/>
- <return-value transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_formats_raw"
- c:identifier="gst_audio_formats_raw"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="558">Return all the raw audio formats supported by GStreamer.</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="357"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="564">an array of #GstAudioFormat</doc>
- <array length="0" zero-terminated="0" c:type="const GstAudioFormat*">
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </array>
- </return-value>
- <parameters>
- <parameter name="len"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="560">the number of elements in the returned array</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_get_channel_reorder_map"
- c:identifier="gst_audio_get_channel_reorder_map">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="429">Returns a reorder map for @from to @to that can be used in
-custom channel reordering code, e.g. to convert from or to the
-GStreamer channel order. @from and @to must contain the same
-number of positions and the same positions, only in a
-different order.
-
-The resulting @reorder_map can be used for reordering by assigning
-channel i of the input to channel reorder_map[i] of the output.</doc>
- <source-position filename="gst-libs/gst/audio/audio-channels.h"
- line="166"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="445">%TRUE if the channel positions are valid and reordering
-is possible.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="431">The number of channels.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="from" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="432">The channel positions to reorder from.</doc>
- <array length="0"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- <parameter name="to" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="433">The channel positions to reorder to.</doc>
- <array length="0"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- <parameter name="reorder_map" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="434">Pointer to the reorder map.</doc>
- <array length="0" zero-terminated="0" c:type="gint*">
- <type name="gint" c:type="gint"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="audio_iec61937_frame_size"
- c:identifier="gst_audio_iec61937_frame_size">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioiec61937.c"
- line="65">Calculated the size of the buffer expected by gst_audio_iec61937_payload() for
-payloading type from @spec.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioiec61937.h"
- line="28"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioiec61937.c"
- line="72">the size or 0 if the given @type is not supported or cannot be
-payloaded.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="spec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioiec61937.c"
- line="67">the ringbufer spec</doc>
- <type name="AudioRingBufferSpec"
- c:type="const GstAudioRingBufferSpec*"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_iec61937_payload"
- c:identifier="gst_audio_iec61937_payload">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioiec61937.c"
- line="142">Payloads @src in the form specified by IEC 61937 for the type from @spec and
-stores the result in @dst. @src must contain exactly one frame of data and
-the frame is not checked for errors.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudioiec61937.h"
- line="31"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioiec61937.c"
- line="156">transfer-full: %TRUE if the payloading was successful, %FALSE
-otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioiec61937.c"
- line="144">a buffer containing the data to payload</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="src_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioiec61937.c"
- line="145">size of @src in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="dst" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioiec61937.c"
- line="146">the destination buffer to store the
- payloaded contents in. Should not overlap with @src</doc>
- <array length="3" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="dst_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioiec61937.c"
- line="148">size of @dst in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="spec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioiec61937.c"
- line="149">the ringbufer spec for @src</doc>
- <type name="AudioRingBufferSpec"
- c:type="const GstAudioRingBufferSpec*"/>
- </parameter>
- <parameter name="endianness" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioiec61937.c"
- line="150">the expected byte order of the payloaded data</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_make_raw_caps"
- c:identifier="gst_audio_make_raw_caps"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="582">Return a generic raw audio caps for formats defined in @formats.
-If @formats is %NULL returns a caps for all the supported raw audio formats,
-see gst_audio_formats_raw().</doc>
- <source-position filename="gst-libs/gst/audio/audio-format.h"
- line="404"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="592">an audio @GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="formats"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="584">an array of raw #GstAudioFormat, or %NULL</doc>
- <array length="1" zero-terminated="0" c:type="const GstAudioFormat*">
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="585">the size of @formats</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="layout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-format.c"
- line="586">the layout of audio samples</doc>
- <type name="AudioLayout" c:type="GstAudioLayout"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_meta_api_get_type"
- c:identifier="gst_audio_meta_api_get_type">
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="188"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="audio_meta_get_info"
- c:identifier="gst_audio_meta_get_info"
- moved-to="AudioMeta.get_info">
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="191"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="audio_quantize_new"
- c:identifier="gst_audio_quantize_new"
- moved-to="AudioQuantize.new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="413">Create a new quantizer object with the given parameters.
-
-Output samples will be quantized to a multiple of @quantizer. Better
-performance is achieved when @quantizer is a power of 2.
-
-Dithering and noise-shaping can be performed during quantization with
-the @dither and @ns parameters.</doc>
- <source-position filename="gst-libs/gst/audio/audio-quantize.h"
- line="85"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="430">a new #GstAudioQuantize. Free with gst_audio_quantize_free().</doc>
- <type name="AudioQuantize" c:type="GstAudioQuantize*"/>
- </return-value>
- <parameters>
- <parameter name="dither" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="415">a #GstAudioDitherMethod</doc>
- <type name="AudioDitherMethod" c:type="GstAudioDitherMethod"/>
- </parameter>
- <parameter name="ns" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="416">a #GstAudioNoiseShapingMethod</doc>
- <type name="AudioNoiseShapingMethod"
- c:type="GstAudioNoiseShapingMethod"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="417">#GstAudioQuantizeFlags</doc>
- <type name="AudioQuantizeFlags" c:type="GstAudioQuantizeFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="418">the #GstAudioFormat of the samples</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="419">the amount of channels in the samples</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="quantizer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-quantize.c"
- line="420">the quantizer to use</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_reorder_channels"
- c:identifier="gst_audio_reorder_channels">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="185">Reorders @data from the channel positions @from to the channel
-positions @to. @from and @to must contain the same number of
-positions and the same positions, only in a different order.
-
-Note: this function assumes the audio data is in interleaved layout</doc>
- <source-position filename="gst-libs/gst/audio/audio-channels.h"
- line="142"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="201">%TRUE if the reordering was possible.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="187">The pointer to
- the memory.</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="189">The size of the memory.</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="190">The %GstAudioFormat of the buffer.</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="191">The number of channels.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="from" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="192">The channel positions in the buffer.</doc>
- <array length="3"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- <parameter name="to" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="193">The channel positions to convert to.</doc>
- <array length="3"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="audio_resampler_new"
- c:identifier="gst_audio_resampler_new"
- moved-to="AudioResampler.new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1333">Make a new resampler.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="224"/>
- <return-value transfer-ownership="full" skip="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1345">The new #GstAudioResampler, or
-%NULL on failure.</doc>
- <type name="AudioResampler" c:type="GstAudioResampler*"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1335">a #GstAudioResamplerMethod</doc>
- <type name="AudioResamplerMethod" c:type="GstAudioResamplerMethod"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1336">#GstAudioResamplerFlags</doc>
- <type name="AudioResamplerFlags" c:type="GstAudioResamplerFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1337">the #GstAudioFormat</doc>
- <type name="AudioFormat" c:type="GstAudioFormat"/>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1338">the number of channels</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="in_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1339">input rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1340">output rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="options" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1341">extra options</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </function>
- <function name="audio_resampler_options_set_quality"
- c:identifier="gst_audio_resampler_options_set_quality"
- moved-to="AudioResampler.options_set_quality">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1269">Set the parameters for resampling from @in_rate to @out_rate using @method
-for @quality in @options.</doc>
- <source-position filename="gst-libs/gst/audio/audio-resampler.h"
- line="218"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1271">a #GstAudioResamplerMethod</doc>
- <type name="AudioResamplerMethod" c:type="GstAudioResamplerMethod"/>
- </parameter>
- <parameter name="quality" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1272">the quality</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="in_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1273">the input rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="out_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1274">the output rate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="options" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-resampler.c"
- line="1275">a #GstStructure</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_audio_clipping_meta"
- c:identifier="gst_buffer_add_audio_clipping_meta"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="248">Attaches #GstAudioClippingMeta metadata to @buffer with the given parameters.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="123"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="257">the #GstAudioClippingMeta on @buffer.</doc>
- <type name="AudioClippingMeta" c:type="GstAudioClippingMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="250">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="251">GstFormat of @start and @stop, GST_FORMAT_DEFAULT is samples</doc>
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="252">Amount of audio to clip from start of buffer</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="end" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="253">Amount of to clip from end of buffer</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_audio_downmix_meta"
- c:identifier="gst_buffer_add_audio_downmix_meta">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="116">Attaches #GstAudioDownmixMeta metadata to @buffer with the given parameters.
-
-@matrix is an two-dimensional array of @to_channels times @from_channels
-coefficients, i.e. the i-th output channels is constructed by multiplicating
-the input channels with the coefficients in @matrix[i] and taking the sum
-of the results.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h" line="72"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="134">the #GstAudioDownmixMeta on @buffer.</doc>
- <type name="AudioDownmixMeta" c:type="GstAudioDownmixMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="118">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="from_position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="119">the channel positions
- of the source</doc>
- <array length="2"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- <parameter name="from_channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="121">The number of channels of the source</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="to_position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="122">the channel positions of
- the destination</doc>
- <array length="4"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- <parameter name="to_channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="124">The number of channels of the destination</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="matrix" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="125">The matrix coefficients.</doc>
- <type name="gfloat" c:type="const gfloat**"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_audio_meta"
- c:identifier="gst_buffer_add_audio_meta"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="354">Allocates and attaches a #GstAudioMeta on @buffer, which must be writable
-for that purpose. The fields of the #GstAudioMeta are directly populated
-from the arguments of this function.
-
-When @info-&gt;layout is %GST_AUDIO_LAYOUT_NON_INTERLEAVED and @offsets is
-%NULL, the offsets are calculated with a formula that assumes the planes are
-tightly packed and in sequence:
-offsets[channel] = channel * @samples * sample_stride
-
-It is not allowed for channels to overlap in memory,
-i.e. for each i in [0, channels), the range
-[@offsets[i], @offsets[i] + @samples * sample_stride) must not overlap
-with any other such range. This function will assert if the parameters
-specified cause this restriction to be violated.
-
-It is, obviously, also not allowed to specify parameters that would cause
-out-of-bounds memory access on @buffer. This is also checked, which means
-that you must add enough memory on the @buffer before adding this meta.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="197"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="382">the #GstAudioMeta that was attached on the @buffer</doc>
- <type name="AudioMeta" c:type="GstAudioMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="356">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="357">the audio properties of the buffer</doc>
- <type name="AudioInfo" c:type="const GstAudioInfo*"/>
- </parameter>
- <parameter name="samples" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="358">the number of valid samples in the buffer</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="offsets"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="359">the offsets (in bytes) where each channel plane starts
- in the buffer or %NULL to calculate it (see below); must be %NULL also
- when @info-&gt;layout is %GST_AUDIO_LAYOUT_INTERLEAVED</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="buffer_get_audio_clipping_meta"
- c:identifier="gst_buffer_get_audio_clipping_meta"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="120"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_get_audio_downmix_meta"
- c:identifier="gst_buffer_get_audio_downmix_meta"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h" line="65"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function name="buffer_get_audio_downmix_meta_for_channels"
- c:identifier="gst_buffer_get_audio_downmix_meta_for_channels">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="84">Find the #GstAudioDownmixMeta on @buffer for the given destination
-channel positions.</doc>
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h" line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="94">the #GstAudioDownmixMeta on @buffer.</doc>
- <type name="AudioDownmixMeta" c:type="GstAudioDownmixMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="86">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="to_position" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="87">the channel positions of
- the destination</doc>
- <array length="2"
- zero-terminated="0"
- c:type="const GstAudioChannelPosition*">
- <type name="AudioChannelPosition"
- c:type="GstAudioChannelPosition"/>
- </array>
- </parameter>
- <parameter name="to_channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudiometa.c"
- line="89">The number of channels of the destination</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="buffer_get_audio_meta"
- c:identifier="gst_buffer_get_audio_meta"
- introspectable="0">
- <source-position filename="gst-libs/gst/audio/gstaudiometa.h"
- line="193"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <docsection name="gstaudio">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio.c"
- line="19">This library contains some helper functions for audio elements.</doc>
- </docsection>
- <docsection name="gstaudiochannels">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/audio-channels.c"
- line="19">This library contains some helper functions for multichannel audio.</doc>
- </docsection>
- <docsection name="gstaudioiec61937">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/gstaudioiec61937.c"
- line="22">This module contains some helper functions for encapsulating various
-audio formats in IEC 61937 headers and padding.</doc>
- </docsection>
- <function name="stream_volume_convert_volume"
- c:identifier="gst_stream_volume_convert_volume"
- moved-to="StreamVolume.convert_volume">
- <source-position filename="gst-libs/gst/audio/streamvolume.h" line="74"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="170">the converted volume</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <parameter name="from" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="166">#GstStreamVolumeFormat to convert from</doc>
- <type name="StreamVolumeFormat" c:type="GstStreamVolumeFormat"/>
- </parameter>
- <parameter name="to" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="167">#GstStreamVolumeFormat to convert to</doc>
- <type name="StreamVolumeFormat" c:type="GstStreamVolumeFormat"/>
- </parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/audio/streamvolume.c"
- line="168">Volume in @from format that should be converted</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </function>
- </namespace>
-</repository>
diff --git a/girs/GstBase-1.0.gir b/girs/GstBase-1.0.gir
deleted file mode 100644
index 0aad79a0b4..0000000000
--- a/girs/GstBase-1.0.gir
+++ /dev/null
@@ -1,18611 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="GLib" version="2.0"/>
- <include name="GModule" version="2.0"/>
- <include name="GObject" version="2.0"/>
- <include name="Gst" version="1.0"/>
- <package name="gstreamer-base-1.0"/>
- <c:include name="gst/base/base.h"/>
- <namespace name="GstBase"
- version="1.0"
- shared-library="libgstbase-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <function-macro name="ADAPTER"
- c:identifier="GST_ADAPTER"
- introspectable="0">
- <source-position filename="libs/gst/base/gstadapter.h" line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ADAPTER_CLASS"
- c:identifier="GST_ADAPTER_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstadapter.h" line="33"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ADAPTER_GET_CLASS"
- c:identifier="GST_ADAPTER_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstadapter.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AGGREGATOR"
- c:identifier="GST_AGGREGATOR"
- introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="129"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AGGREGATOR_CAST"
- c:identifier="GST_AGGREGATOR_CAST"
- introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="130"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AGGREGATOR_CLASS"
- c:identifier="GST_AGGREGATOR_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="131"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AGGREGATOR_GET_CLASS"
- c:identifier="GST_AGGREGATOR_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="132"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AGGREGATOR_PAD"
- c:identifier="GST_AGGREGATOR_PAD"
- introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="42"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AGGREGATOR_PAD_CAST"
- c:identifier="GST_AGGREGATOR_PAD_CAST"
- introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="43"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AGGREGATOR_PAD_CLASS"
- c:identifier="GST_AGGREGATOR_PAD_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="44"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AGGREGATOR_PAD_GET_CLASS"
- c:identifier="GST_AGGREGATOR_PAD_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="45"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AGGREGATOR_SRC_PAD"
- c:identifier="GST_AGGREGATOR_SRC_PAD"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.h"
- line="361">Convenience macro to access the source pad of #GstAggregator</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="369"/>
- <parameters>
- <parameter name="agg">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.h"
- line="363">a #GstAggregator</doc>
- </parameter>
- </parameters>
- </function-macro>
- <class name="Adapter"
- c:symbol-prefix="adapter"
- c:type="GstAdapter"
- parent="GObject.Object"
- glib:type-name="GstAdapter"
- glib:get-type="gst_adapter_get_type"
- glib:type-struct="AdapterClass">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="21">This class is for elements that receive buffers in an undesired size.
-While for example raw video contains one image per buffer, the same is not
-true for a lot of other formats, especially those that come directly from
-a file. So if you have undefined buffer sizes and require a specific size,
-this object is for you.
-
-An adapter is created with gst_adapter_new(). It can be freed again with
-g_object_unref().
-
-The theory of operation is like this: All buffers received are put
-into the adapter using gst_adapter_push() and the data is then read back
-in chunks of the desired size using gst_adapter_map()/gst_adapter_unmap()
-and/or gst_adapter_copy(). After the data has been processed, it is freed
-using gst_adapter_unmap().
-
-Other methods such as gst_adapter_take() and gst_adapter_take_buffer()
-combine gst_adapter_map() and gst_adapter_unmap() in one method and are
-potentially more convenient for some use cases.
-
-For example, a sink pad's chain function that needs to pass data to a library
-in 512-byte chunks could be implemented like this:
-|[&lt;!-- language="C" --&gt;
-static GstFlowReturn
-sink_pad_chain (GstPad *pad, GstObject *parent, GstBuffer *buffer)
-{
- MyElement *this;
- GstAdapter *adapter;
- GstFlowReturn ret = GST_FLOW_OK;
-
- this = MY_ELEMENT (parent);
-
- adapter = this-&gt;adapter;
-
- // put buffer into adapter
- gst_adapter_push (adapter, buffer);
-
- // while we can read out 512 bytes, process them
- while (gst_adapter_available (adapter) &gt;= 512 &amp;&amp; ret == GST_FLOW_OK) {
- const guint8 *data = gst_adapter_map (adapter, 512);
- // use flowreturn as an error value
- ret = my_library_foo (data);
- gst_adapter_unmap (adapter);
- gst_adapter_flush (adapter, 512);
- }
- return ret;
-}
-]|
-
-For another example, a simple element inside GStreamer that uses #GstAdapter
-is the libvisual element.
-
-An element using #GstAdapter in its sink pad chain function should ensure that
-when the FLUSH_STOP event is received, that any queued data is cleared using
-gst_adapter_clear(). Data should also be cleared or processed on EOS and
-when changing state from %GST_STATE_PAUSED to %GST_STATE_READY.
-
-Also check the GST_BUFFER_FLAG_DISCONT flag on the buffer. Some elements might
-need to clear the adapter after a discontinuity.
-
-The adapter will keep track of the timestamps of the buffers
-that were pushed. The last seen timestamp before the current position
-can be queried with gst_adapter_prev_pts(). This function can
-optionally return the number of bytes between the start of the buffer that
-carried the timestamp and the current adapter position. The distance is
-useful when dealing with, for example, raw audio samples because it allows
-you to calculate the timestamp of the current adapter position by using the
-last seen timestamp and the amount of bytes since. Additionally, the
-gst_adapter_prev_pts_at_offset() can be used to determine the last
-seen timestamp at a particular offset in the adapter.
-
-The adapter will also keep track of the offset of the buffers
-(#GST_BUFFER_OFFSET) that were pushed. The last seen offset before the
-current position can be queried with gst_adapter_prev_offset(). This function
-can optionally return the number of bytes between the start of the buffer
-that carried the offset and the current adapter position.
-
-Additionally the adapter also keeps track of the PTS, DTS and buffer offset
-at the last discontinuity, which can be retrieved with
-gst_adapter_pts_at_discont(), gst_adapter_dts_at_discont() and
-gst_adapter_offset_at_discont(). The number of bytes that were consumed
-since then can be queried with gst_adapter_distance_from_discont().
-
-A last thing to note is that while #GstAdapter is pretty optimized,
-merging buffers still might be an operation that requires a `malloc()` and
-`memcpy()` operation, and these operations are not the fastest. Because of
-this, some functions like gst_adapter_available_fast() are provided to help
-speed up such cases should you want to. To avoid repeated memory allocations,
-gst_adapter_copy() can be used to copy data into a (statically allocated)
-user provided buffer.
-
-#GstAdapter is not MT safe. All operations on an adapter must be serialized by
-the caller. This is not normally a problem, however, as the normal use case
-of #GstAdapter is inside one pad's chain function, in which case access is
-serialized via the pad's STREAM_LOCK.
-
-Note that gst_adapter_push() takes ownership of the buffer passed. Use
-gst_buffer_ref() before pushing it into the adapter if you still want to
-access the buffer later. The adapter will never modify the data in the
-buffer pushed in it.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="49"/>
- <constructor name="new" c:identifier="gst_adapter_new">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="237">Creates a new #GstAdapter. Free with g_object_unref().</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="55"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="242">a new #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </return-value>
- </constructor>
- <method name="available" c:identifier="gst_adapter_available">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1308">Gets the maximum amount of bytes available, that is it returns the maximum
-value that can be supplied to gst_adapter_map() without that function
-returning %NULL.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="106"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1316">number of bytes available in @adapter</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1310">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="available_fast" c:identifier="gst_adapter_available_fast">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1326">Gets the maximum number of bytes that are immediately available without
-requiring any expensive operations (like copying the data into a
-temporary buffer).</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="109"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1334">number of bytes that are available in @adapter without expensive
-operations</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1328">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="clear" c:identifier="gst_adapter_clear">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="250">Removes all buffers from @adapter.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="58"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="252">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="copy"
- c:identifier="gst_adapter_copy"
- shadowed-by="copy_bytes"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="578">Copies @size bytes of data starting at @offset out of the buffers
-contained in #GstAdapter into an array @dest provided by the caller.
-
-The array @dest should be large enough to contain @size bytes.
-The user should check that the adapter has (@offset + @size) bytes
-available before calling this function.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="70"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="580">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="581">
- the memory to copy into</doc>
- <array length="2" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="583">the bytes offset in the adapter to start from</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="584">the number of bytes to copy</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy_bytes"
- c:identifier="gst_adapter_copy_bytes"
- shadows="copy"
- version="1.4">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="603">Similar to gst_adapter_copy, but more suitable for language bindings. @size
-bytes of data starting at @offset will be copied out of the buffers contained
-in @adapter and into a new #GBytes structure which is returned. Depending on
-the value of the @size argument an empty #GBytes structure may be returned.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="73"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="614">A new #GBytes structure containing the copied data.</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="605">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="606">the bytes offset in the adapter to start from</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="607">the number of bytes to copy</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="distance_from_discont"
- c:identifier="gst_adapter_distance_from_discont"
- version="1.10">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1367">Get the distance in bytes since the last buffer with the
-%GST_BUFFER_FLAG_DISCONT flag.
-
-The distance will be reset to 0 for all buffers with
-%GST_BUFFER_FLAG_DISCONT on them, and then calculated for all other
-following buffers based on their size.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="136"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1380">The offset. Can be %GST_BUFFER_OFFSET_NONE.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1369">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="dts_at_discont"
- c:identifier="gst_adapter_dts_at_discont"
- version="1.10">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1426">Get the DTS that was on the last buffer with the GST_BUFFER_FLAG_DISCONT
-flag, or GST_CLOCK_TIME_NONE.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="130"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1435">The DTS at the last discont or GST_CLOCK_TIME_NONE.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1428">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="flush" c:identifier="gst_adapter_flush">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="687">Flushes the first @flush bytes in the @adapter. The caller must ensure that
-at least this many bytes are available.
-
-See also: gst_adapter_map(), gst_adapter_unmap()</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="76"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="689">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="flush" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="690">the number of bytes to flush</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_buffer"
- c:identifier="gst_adapter_get_buffer"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="942">Returns a #GstBuffer containing the first @nbytes of the @adapter, but
-does not flush them from the adapter. See gst_adapter_take_buffer()
-for details.
-
-Caller owns a reference to the returned buffer. gst_buffer_unref() after
-usage.
-
-Free-function: gst_buffer_unref</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="94"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="956">a #GstBuffer containing the first
- @nbytes of the adapter, or %NULL if @nbytes bytes are not available.
- gst_buffer_unref() when no longer needed.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="944">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="nbytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="945">the number of bytes to get</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_buffer_fast"
- c:identifier="gst_adapter_get_buffer_fast"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="789">Returns a #GstBuffer containing the first @nbytes of the @adapter, but
-does not flush them from the adapter. See gst_adapter_take_buffer_fast()
-for details.
-
-Caller owns a reference to the returned buffer. gst_buffer_unref() after
-usage.
-
-Free-function: gst_buffer_unref</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="100"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="803">a #GstBuffer containing the first
- @nbytes of the adapter, or %NULL if @nbytes bytes are not available.
- gst_buffer_unref() when no longer needed.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="791">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="nbytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="792">the number of bytes to get</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_buffer_list"
- c:identifier="gst_adapter_get_buffer_list"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1239">Returns a #GstBufferList of buffers containing the first @nbytes bytes of
-the @adapter but does not flush them from the adapter. See
-gst_adapter_take_buffer_list() for details.
-
-Caller owns the returned list. Call gst_buffer_list_unref() to free
-the list after usage.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="103"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1251">a #GstBufferList of buffers containing
- the first @nbytes of the adapter, or %NULL if @nbytes bytes are not
- available</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1241">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="nbytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1242">the number of bytes to get</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_list"
- c:identifier="gst_adapter_get_list"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1127">Returns a #GList of buffers containing the first @nbytes bytes of the
-@adapter, but does not flush them from the adapter. See
-gst_adapter_take_list() for details.
-
-Caller owns returned list and contained buffers. gst_buffer_unref() each
-buffer in the list before freeing the list after usage.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="97"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1139">a #GList of
- buffers containing the first @nbytes of the adapter, or %NULL if @nbytes
- bytes are not available</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Gst.Buffer"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1129">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="nbytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1130">the number of bytes to get</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="map" c:identifier="gst_adapter_map">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="461">Gets the first @size bytes stored in the @adapter. The returned pointer is
-valid until the next function is called on the adapter.
-
-Note that setting the returned pointer as the data of a #GstBuffer is
-incorrect for general-purpose plugins. The reason is that if a downstream
-element stores the buffer so that it has access to it outside of the bounds
-of its chain function, the buffer will have an invalid data pointer after
-your element flushes the bytes. In that case you should use
-gst_adapter_take(), which returns a freshly-allocated buffer that you can set
-as #GstBuffer memory or the potentially more performant
-gst_adapter_take_buffer().
-
-Returns %NULL if @size bytes are not available.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="64"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="480">
- a pointer to the first @size bytes of data, or %NULL</doc>
- <array length="0" zero-terminated="0" c:type="gconstpointer">
- <type name="guint8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="463">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="464">the number of bytes to map/peek</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="masked_scan_uint32"
- c:identifier="gst_adapter_masked_scan_uint32">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1742">Scan for pattern @pattern with applied mask @mask in the adapter data,
-starting from offset @offset.
-
-The bytes in @pattern and @mask are interpreted left-to-right, regardless
-of endianness. All four bytes of the pattern must be present in the
-adapter for it to match, even if the first or last bytes are masked out.
-
-It is an error to call this function without making sure that there is
-enough data (offset+size bytes) in the adapter.
-
-This function calls gst_adapter_masked_scan_uint32_peek() passing %NULL
-for value.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="139"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1764">offset of the first match, or -1 if no match was found.
-
-Example:
-|[
-// Assume the adapter contains 0x00 0x01 0x02 ... 0xfe 0xff
-
-gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 0, 256);
-// -&gt; returns 0
-gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 1, 255);
-// -&gt; returns -1
-gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x01020304, 1, 255);
-// -&gt; returns 1
-gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0001, 0, 256);
-// -&gt; returns -1
-gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0203, 0, 256);
-// -&gt; returns 0
-gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 256);
-// -&gt; returns 2
-gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 4);
-// -&gt; returns -1
-]|</doc>
- <type name="gssize" c:type="gssize"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1744">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1745">mask to apply to data before matching against @pattern</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="pattern" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1746">pattern to match (after mask is applied)</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1747">offset into the adapter data from which to start scanning, returns
- the last scanned position.</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1749">number of bytes to scan from offset</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="masked_scan_uint32_peek"
- c:identifier="gst_adapter_masked_scan_uint32_peek">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1628">Scan for pattern @pattern with applied mask @mask in the adapter data,
-starting from offset @offset. If a match is found, the value that matched
-is returned through @value, otherwise @value is left untouched.
-
-The bytes in @pattern and @mask are interpreted left-to-right, regardless
-of endianness. All four bytes of the pattern must be present in the
-adapter for it to match, even if the first or last bytes are masked out.
-
-It is an error to call this function without making sure that there is
-enough data (offset+size bytes) in the adapter.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="142"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1649">offset of the first match, or -1 if no match was found.</doc>
- <type name="gssize" c:type="gssize"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1630">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1631">mask to apply to data before matching against @pattern</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="pattern" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1632">pattern to match (after mask is applied)</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1633">offset into the adapter data from which to start scanning, returns
- the last scanned position.</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1635">number of bytes to scan from offset</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1636">pointer to uint32 to return matching data</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="offset_at_discont"
- c:identifier="gst_adapter_offset_at_discont"
- version="1.10">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1388">Get the offset that was on the last buffer with the GST_BUFFER_FLAG_DISCONT
-flag, or GST_BUFFER_OFFSET_NONE.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="133"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1397">The offset at the last discont or GST_BUFFER_OFFSET_NONE.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1390">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="prev_dts" c:identifier="gst_adapter_prev_dts">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1501">Get the dts that was before the current byte in the adapter. When
-@distance is given, the amount of bytes between the dts and the current
-position is returned.
-
-The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
-the adapter is first created or when it is cleared. This also means that before
-the first byte with a dts is removed from the adapter, the dts
-and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="115"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1515">The previously seen dts.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1503">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="distance"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1504">pointer to location for distance, or %NULL</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="prev_dts_at_offset"
- c:identifier="gst_adapter_prev_dts_at_offset"
- version="1.2">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1578">Get the dts that was before the byte at offset @offset in the adapter. When
-@distance is given, the amount of bytes between the dts and the current
-position is returned.
-
-The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
-the adapter is first created or when it is cleared. This also means that before
-the first byte with a dts is removed from the adapter, the dts
-and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="121"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1594">The previously seen dts at given offset.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1580">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1581">the offset in the adapter at which to get timestamp</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="distance"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1582">pointer to location for distance, or %NULL</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="prev_offset"
- c:identifier="gst_adapter_prev_offset"
- version="1.10">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1445">Get the offset that was before the current byte in the adapter. When
-@distance is given, the amount of bytes between the offset and the current
-position is returned.
-
-The offset is reset to GST_BUFFER_OFFSET_NONE and the distance is set to 0
-when the adapter is first created or when it is cleared. This also means that
-before the first byte with an offset is removed from the adapter, the offset
-and distance returned are GST_BUFFER_OFFSET_NONE and 0 respectively.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="124"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1461">The previous seen offset.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1447">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="distance"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1448">pointer to a location for distance, or %NULL</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="prev_pts" c:identifier="gst_adapter_prev_pts">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1474">Get the pts that was before the current byte in the adapter. When
-@distance is given, the amount of bytes between the pts and the current
-position is returned.
-
-The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
-the adapter is first created or when it is cleared. This also means that before
-the first byte with a pts is removed from the adapter, the pts
-and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1488">The previously seen pts.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1476">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="distance"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1477">pointer to location for distance, or %NULL</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="prev_pts_at_offset"
- c:identifier="gst_adapter_prev_pts_at_offset"
- version="1.2">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1528">Get the pts that was before the byte at offset @offset in the adapter. When
-@distance is given, the amount of bytes between the pts and the current
-position is returned.
-
-The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
-the adapter is first created or when it is cleared. This also means that before
-the first byte with a pts is removed from the adapter, the pts
-and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="118"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1544">The previously seen pts at given offset.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1530">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1531">the offset in the adapter at which to get timestamp</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="distance"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1532">pointer to location for distance, or %NULL</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="pts_at_discont"
- c:identifier="gst_adapter_pts_at_discont"
- version="1.10">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1407">Get the PTS that was on the last buffer with the GST_BUFFER_FLAG_DISCONT
-flag, or GST_CLOCK_TIME_NONE.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="127"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1416">The PTS at the last discont or GST_CLOCK_TIME_NONE.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1409">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="push" c:identifier="gst_adapter_push">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="369">Adds the data from @buf to the data stored inside @adapter and takes
-ownership of the buffer.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="61"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="371">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="buf" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="372">a #GstBuffer to add to queue in the adapter</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="take" c:identifier="gst_adapter_take">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="753">Returns a freshly allocated buffer containing the first @nbytes bytes of the
-@adapter. The returned bytes will be flushed from the adapter.
-
-Caller owns returned value. g_free after usage.
-
-Free-function: g_free</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="79"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="765">
- oven-fresh hot data, or %NULL if @nbytes bytes are not available</doc>
- <array length="0" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="755">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="nbytes"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="756">the number of bytes to take</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="take_buffer" c:identifier="gst_adapter_take_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1039">Returns a #GstBuffer containing the first @nbytes bytes of the
-@adapter. The returned bytes will be flushed from the adapter.
-This function is potentially more performant than
-gst_adapter_take() since it can reuse the memory in pushed buffers
-by subbuffering or merging. This function will always return a
-buffer with a single memory region.
-
-Note that no assumptions should be made as to whether certain buffer
-flags such as the DISCONT flag are set on the returned buffer, or not.
-The caller needs to explicitly set or unset flags that should be set or
-unset.
-
-Since 1.6 this will also copy over all GstMeta of the input buffers except
-for meta with the %GST_META_FLAG_POOLED flag or with the "memory" tag.
-
-Caller owns a reference to the returned buffer. gst_buffer_unref() after
-usage.
-
-Free-function: gst_buffer_unref</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="82"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1064">a #GstBuffer containing the first
- @nbytes of the adapter, or %NULL if @nbytes bytes are not available.
- gst_buffer_unref() when no longer needed.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1041">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="nbytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1042">the number of bytes to take</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="take_buffer_fast"
- c:identifier="gst_adapter_take_buffer_fast"
- version="1.2">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="865">Returns a #GstBuffer containing the first @nbytes of the @adapter.
-The returned bytes will be flushed from the adapter. This function
-is potentially more performant than gst_adapter_take_buffer() since
-it can reuse the memory in pushed buffers by subbuffering or
-merging. Unlike gst_adapter_take_buffer(), the returned buffer may
-be composed of multiple non-contiguous #GstMemory objects, no
-copies are made.
-
-Note that no assumptions should be made as to whether certain buffer
-flags such as the DISCONT flag are set on the returned buffer, or not.
-The caller needs to explicitly set or unset flags that should be set or
-unset.
-
-This will also copy over all GstMeta of the input buffers except
-for meta with the %GST_META_FLAG_POOLED flag or with the "memory" tag.
-
-This function can return buffer up to the return value of
-gst_adapter_available() without making copies if possible.
-
-Caller owns a reference to the returned buffer. gst_buffer_unref() after
-usage.
-
-Free-function: gst_buffer_unref</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="88"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="894">a #GstBuffer containing the first
- @nbytes of the adapter, or %NULL if @nbytes bytes are not available.
- gst_buffer_unref() when no longer needed.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="867">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="nbytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="868">the number of bytes to take</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="take_buffer_list"
- c:identifier="gst_adapter_take_buffer_list"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1185">Returns a #GstBufferList of buffers containing the first @nbytes bytes of
-the @adapter. The returned bytes will be flushed from the adapter.
-When the caller can deal with individual buffers, this function is more
-performant because no memory should be copied.
-
-Caller owns the returned list. Call gst_buffer_list_unref() to free
-the list after usage.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="91"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1198">a #GstBufferList of buffers containing
- the first @nbytes of the adapter, or %NULL if @nbytes bytes are not
- available</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1187">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="nbytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1188">the number of bytes to take</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="take_list" c:identifier="gst_adapter_take_list">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1083">Returns a #GList of buffers containing the first @nbytes bytes of the
-@adapter. The returned bytes will be flushed from the adapter.
-When the caller can deal with individual buffers, this function is more
-performant because no memory should be copied.
-
-Caller owns returned list and contained buffers. gst_buffer_unref() each
-buffer in the list before freeing the list after usage.</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="85"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1096">a #GList of
- buffers containing the first @nbytes of the adapter, or %NULL if @nbytes
- bytes are not available</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Gst.Buffer"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1085">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- <parameter name="nbytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="1086">the number of bytes to take</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="unmap" c:identifier="gst_adapter_unmap">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="559">Releases the memory obtained with the last gst_adapter_map().</doc>
- <source-position filename="libs/gst/base/gstadapter.h" line="67"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="adapter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstadapter.c"
- line="561">a #GstAdapter</doc>
- <type name="Adapter" c:type="GstAdapter*"/>
- </instance-parameter>
- </parameters>
- </method>
- </class>
- <record name="AdapterClass"
- c:type="GstAdapterClass"
- disguised="1"
- glib:is-gtype-struct-for="Adapter">
- <source-position filename="libs/gst/base/gstadapter.h" line="49"/>
- </record>
- <class name="Aggregator"
- c:symbol-prefix="aggregator"
- c:type="GstAggregator"
- version="1.14"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstAggregator"
- glib:get-type="gst_aggregator_get_type"
- glib:type-struct="AggregatorClass">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="22">Manages a set of pads with the purpose of aggregating their buffers.
-Control is given to the subclass when all pads have data.
-
- * Base class for mixers and muxers. Subclasses should at least implement
- the #GstAggregatorClass.aggregate() virtual method.
-
- * Installs a #GstPadChainFunction, a #GstPadEventFullFunction and a
- #GstPadQueryFunction to queue all serialized data packets per sink pad.
- Subclasses should not overwrite those, but instead implement
- #GstAggregatorClass.sink_event() and #GstAggregatorClass.sink_query() as
- needed.
-
- * When data is queued on all pads, the aggregate vmethod is called.
-
- * One can peek at the data on any given GstAggregatorPad with the
- gst_aggregator_pad_peek_buffer() method, and remove it from the pad
- with the gst_aggregator_pad_pop_buffer () method. When a buffer
- has been taken with pop_buffer (), a new buffer can be queued
- on that pad.
-
- * When gst_aggregator_pad_peek_buffer() or gst_aggregator_pad_has_buffer()
- are called, a reference is taken to the returned buffer, which stays
- valid until either:
-
- - gst_aggregator_pad_pop_buffer() is called, in which case the caller
- is guaranteed that the buffer they receive is the same as the peeked
- buffer.
- - gst_aggregator_pad_drop_buffer() is called, in which case the caller
- is guaranteed that the dropped buffer is the one that was peeked.
- - the subclass implementation of #GstAggregatorClass.aggregate returns.
-
- Subsequent calls to gst_aggregator_pad_peek_buffer() or
- gst_aggregator_pad_has_buffer() return / check the same buffer that was
- returned / checked, until one of the conditions listed above is met.
-
- Subclasses are only allowed to call these methods from the aggregate
- thread.
-
- * If the subclass wishes to push a buffer downstream in its aggregate
- implementation, it should do so through the
- gst_aggregator_finish_buffer() method. This method will take care
- of sending and ordering mandatory events such as stream start, caps
- and segment. Buffer lists can also be pushed out with
- gst_aggregator_finish_buffer_list().
-
- * Same goes for EOS events, which should not be pushed directly by the
- subclass, it should instead return GST_FLOW_EOS in its aggregate
- implementation.
-
- * Note that the aggregator logic regarding gap event handling is to turn
- these into gap buffers with matching PTS and duration. It will also
- flag these buffers with GST_BUFFER_FLAG_GAP and GST_BUFFER_FLAG_DROPPABLE
- to ease their identification and subsequent processing.
-
- * Subclasses must use (a subclass of) #GstAggregatorPad for both their
- sink and source pads.
- See gst_element_class_add_static_pad_template_with_gtype().
-
-This class used to live in gst-plugins-bad and was moved to core.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="355"/>
- <virtual-method name="aggregate">
- <source-position filename="libs/gst/base/gstaggregator.h" line="291"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="clip">
- <source-position filename="libs/gst/base/gstaggregator.h" line="264"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="aggregator_pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="create_new_pad" introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="300"/>
- <return-value>
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="templ" transfer-ownership="none">
- <type name="Gst.PadTemplate" c:type="GstPadTemplate*"/>
- </parameter>
- <parameter name="req_name" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="decide_allocation">
- <source-position filename="libs/gst/base/gstaggregator.h" line="316"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="finish_buffer" invoker="finish_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="677">This method will push the provided output buffer downstream. If needed,
-mandatory events such as stream-start, caps, and segment events will be
-sent before pushing the buffer.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="268"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="679">The #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="680">the #GstBuffer to push.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="finish_buffer_list"
- invoker="finish_buffer_list"
- version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="716">This method will push the provided output buffer list downstream. If needed,
-mandatory events such as stream-start, caps, and segment events will be
-sent before pushing the buffer.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="341"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="718">The #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="bufferlist" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="719">the #GstBufferList to push.</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="fixate_src_caps">
- <source-position filename="libs/gst/base/gstaggregator.h" line="312"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="flush">
- <source-position filename="libs/gst/base/gstaggregator.h" line="262"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_next_time">
- <source-position filename="libs/gst/base/gstaggregator.h" line="298"/>
- <return-value transfer-ownership="none">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="negotiate" invoker="negotiate" version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="1279">Negotiates src pad caps with downstream elements.
-Unmarks GST_PAD_FLAG_NEED_RECONFIGURE in any case. But marks it again
-if #GstAggregatorClass.negotiate() fails.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="323"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="1287">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="1281">a #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="negotiated_src_caps">
- <source-position filename="libs/gst/base/gstaggregator.h" line="314"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="peek_next_sample"
- invoker="peek_next_sample"
- version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="319">Use this function to determine what input buffers will be aggregated
-to produce the next output buffer. This should only be called from
-a #GstAggregator::samples-selected handler, and can be used to precisely
-control aggregating parameters for a given set of input samples.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="350"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="327">The sample that is about to be aggregated. It may hold a #GstBuffer
- or a #GstBufferList. The contents of its info structure is subclass-dependent,
- and documented on a subclass basis. The buffers held by the sample are
- not writable.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="aggregator_pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="propose_allocation">
- <source-position filename="libs/gst/base/gstaggregator.h" line="318"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="decide_query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_event">
- <source-position filename="libs/gst/base/gstaggregator.h" line="272"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="aggregator_pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_event_pre_queue">
- <source-position filename="libs/gst/base/gstaggregator.h" line="325"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="aggregator_pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_query">
- <source-position filename="libs/gst/base/gstaggregator.h" line="276"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="aggregator_pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_query_pre_queue">
- <source-position filename="libs/gst/base/gstaggregator.h" line="329"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="aggregator_pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_activate">
- <source-position filename="libs/gst/base/gstaggregator.h" line="287"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="mode" transfer-ownership="none">
- <type name="Gst.PadMode" c:type="GstPadMode"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_event">
- <source-position filename="libs/gst/base/gstaggregator.h" line="281"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_query">
- <source-position filename="libs/gst/base/gstaggregator.h" line="284"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start">
- <source-position filename="libs/gst/base/gstaggregator.h" line="296"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop">
- <source-position filename="libs/gst/base/gstaggregator.h" line="294"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="update_src_caps">
- <source-position filename="libs/gst/base/gstaggregator.h" line="309"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="ret"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <type name="Gst.Caps" c:type="GstCaps**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="finish_buffer" c:identifier="gst_aggregator_finish_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="677">This method will push the provided output buffer downstream. If needed,
-mandatory events such as stream-start, caps, and segment events will be
-sent before pushing the buffer.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="376"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="679">The #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="680">the #GstBuffer to push.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="finish_buffer_list"
- c:identifier="gst_aggregator_finish_buffer_list"
- version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="716">This method will push the provided output buffer list downstream. If needed,
-mandatory events such as stream-start, caps, and segment events will be
-sent before pushing the buffer.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="380"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggregator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="718">The #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="bufferlist" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="719">the #GstBufferList to push.</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_allocator" c:identifier="gst_aggregator_get_allocator">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3628">Lets #GstAggregator sub-classes get the memory @allocator
-acquired by the base class and its @params.
-
-Unref the @allocator after use it.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="405"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3630">a #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="allocator"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3631">the #GstAllocator
-used</doc>
- <type name="Gst.Allocator" c:type="GstAllocator**"/>
- </parameter>
- <parameter name="params"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3633">the
-#GstAllocationParams of @allocator</doc>
- <type name="Gst.AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_buffer_pool"
- c:identifier="gst_aggregator_get_buffer_pool">
- <source-position filename="libs/gst/base/gstaggregator.h" line="402"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3609">the instance of the #GstBufferPool used
-by @trans; free it after use it</doc>
- <type name="Gst.BufferPool" c:type="GstBufferPool*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3607">a #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_latency" c:identifier="gst_aggregator_get_latency">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="2139">Retrieves the latency values reported by @self in response to the latency
-query, or %GST_CLOCK_TIME_NONE if there is not live source connected and the element
-will not wait for the clock.
-
-Typically only called by subclasses.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="399"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="2149">The latency or %GST_CLOCK_TIME_NONE if the element does not sync</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="2141">a #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="negotiate"
- c:identifier="gst_aggregator_negotiate"
- version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="1279">Negotiates src pad caps with downstream elements.
-Unmarks GST_PAD_FLAG_NEED_RECONFIGURE in any case. But marks it again
-if #GstAggregatorClass.negotiate() fails.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="388"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="1287">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="1281">a #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="peek_next_sample"
- c:identifier="gst_aggregator_peek_next_sample"
- version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="319">Use this function to determine what input buffers will be aggregated
-to produce the next output buffer. This should only be called from
-a #GstAggregator::samples-selected handler, and can be used to precisely
-control aggregating parameters for a given set of input samples.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="417"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="327">The sample that is about to be aggregated. It may hold a #GstBuffer
- or a #GstBufferList. The contents of its info structure is subclass-dependent,
- and documented on a subclass basis. The buffers held by the sample are
- not writable.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="selected_samples"
- c:identifier="gst_aggregator_selected_samples"
- version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3722">Subclasses should call this when they have prepared the
-buffers they will aggregate for each of their sink pads, but
-before using any of the properties of the pads that govern
-*how* aggregation should be performed, for example z-index
-for video aggregators.
-
-If gst_aggregator_update_segment() is used by the subclass,
-it MUST be called before gst_aggregator_selected_samples().
-
-This function MUST only be called from the #GstAggregatorClass::aggregate()
-function.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="421"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="pts" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3724">The presentation timestamp of the next output buffer</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="dts" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3725">The decoding timestamp of the next output buffer</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3726">The duration of the next output buffer</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="info"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3727">a #GstStructure containing additional information</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_latency" c:identifier="gst_aggregator_set_latency">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3565">Lets #GstAggregator sub-classes tell the baseclass what their internal
-latency is. Will also post a LATENCY message on the bus so the pipeline
-can reconfigure its global latency.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="391"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3567">a #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="min_latency" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3568">minimum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="max_latency" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3569">maximum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_src_caps" c:identifier="gst_aggregator_set_src_caps">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="642">Sets the caps to be used on the src pad.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="384"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="644">The #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="645">The #GstCaps to set on the src pad.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="simple_get_next_time"
- c:identifier="gst_aggregator_simple_get_next_time"
- version="1.16">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3655">This is a simple #GstAggregatorClass.get_next_time() implementation that
-just looks at the #GstSegment on the srcpad of the aggregator and bases
-the next time on the running time there.
-
-This is the desired behaviour in most cases where you have a live source
-and you have a dead line based aggregator subclass.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="410"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3666">The running time based on the position</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3657">A #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="update_segment"
- c:identifier="gst_aggregator_update_segment"
- version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3692">Subclasses should use this to update the segment on their
-source pad, instead of directly pushing new segment events
-downstream.
-
-Subclasses MUST call this before gst_aggregator_selected_samples(),
-if it is used at all.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="413"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </instance-parameter>
- <parameter name="segment" transfer-ownership="none">
- <type name="Gst.Segment" c:type="const GstSegment*"/>
- </parameter>
- </parameters>
- </method>
- <property name="emit-signals"
- version="1.18"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="2782">Enables the emission of signals such as #GstAggregator::samples-selected</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="latency" writable="1" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="min-upstream-latency"
- version="1.16"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="2748">Force minimum upstream latency (in nanoseconds). When sources with a
-higher latency are expected to be plugged in dynamically after the
-aggregator has started playing, this allows overriding the minimum
-latency reported by the initial source(s). This is only taken into
-account when larger than the actually reported minimum latency.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="start-time" writable="1" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="start-time-selection"
- writable="1"
- transfer-ownership="none">
- <type name="AggregatorStartTimeSelection"/>
- </property>
- <field name="parent">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="srcpad">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.h"
- line="140">the aggregator's source pad</doc>
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AggregatorPrivate" c:type="GstAggregatorPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="samples-selected" when="first" version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="2794">Signals that the #GstAggregator subclass has selected the next set
-of input samples it will aggregate. Handlers may call
-gst_aggregator_peek_next_sample() at that point.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="2797">The #GstSegment the next output buffer is part of</doc>
- <type name="Gst.Segment"/>
- </parameter>
- <parameter name="pts" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="2798">The presentation timestamp of the next output buffer</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="dts" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="2799">The decoding timestamp of the next output buffer</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="2800">The duration of the next output buffer</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="info"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="2801">a #GstStructure containing additional information</doc>
- <type name="Gst.Structure"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="AggregatorClass"
- c:type="GstAggregatorClass"
- glib:is-gtype-struct-for="Aggregator"
- version="1.14">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.h"
- line="159">The aggregator base class will handle in a thread-safe way all manners of
-concurrent flushes, seeks, pad additions and removals, leaving to the
-subclass the responsibility of clipping buffers, and aggregating buffers in
-the way the implementor sees fit.
-
-It will also take care of event ordering (stream-start, segment, eos).
-
-Basically, a simple implementation will override @aggregate, and call
-_finish_buffer from inside that function.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="355"/>
- <field name="parent_class">
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="flush">
- <callback name="flush">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="262"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="clip">
- <callback name="clip">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="264"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="aggregator_pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="finish_buffer">
- <callback name="finish_buffer">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="268"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="679">The #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="680">the #GstBuffer to push.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_event">
- <callback name="sink_event">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="272"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="aggregator_pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_query">
- <callback name="sink_query">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="276"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="aggregator_pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_event">
- <callback name="src_event">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="281"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_query">
- <callback name="src_query">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="284"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_activate">
- <callback name="src_activate">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="287"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <type name="Gst.PadMode" c:type="GstPadMode"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="aggregate">
- <callback name="aggregate">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="291"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="294"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="start">
- <callback name="start">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="296"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_next_time">
- <callback name="get_next_time">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="298"/>
- <return-value transfer-ownership="none">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="create_new_pad" introspectable="0">
- <callback name="create_new_pad" introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="300"/>
- <return-value>
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="templ" transfer-ownership="none">
- <type name="Gst.PadTemplate" c:type="GstPadTemplate*"/>
- </parameter>
- <parameter name="req_name" transfer-ownership="none">
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="update_src_caps">
- <callback name="update_src_caps">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="309"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="ret"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <type name="Gst.Caps" c:type="GstCaps**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="fixate_src_caps">
- <callback name="fixate_src_caps">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="312"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="negotiated_src_caps">
- <callback name="negotiated_src_caps">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="314"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="decide_allocation">
- <callback name="decide_allocation">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="316"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="propose_allocation">
- <callback name="propose_allocation">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="318"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="decide_query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="negotiate">
- <callback name="negotiate">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="323"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="1287">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="1281">a #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_event_pre_queue">
- <callback name="sink_event_pre_queue">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="325"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="aggregator_pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_query_pre_queue">
- <callback name="sink_query_pre_queue">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="329"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="aggregator_pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="finish_buffer_list">
- <callback name="finish_buffer_list">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="341"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="718">The #GstAggregator</doc>
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="bufferlist" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="719">the #GstBufferList to push.</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="peek_next_sample">
- <callback name="peek_next_sample">
- <source-position filename="libs/gst/base/gstaggregator.h"
- line="350"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="327">The sample that is about to be aggregated. It may hold a #GstBuffer
- or a #GstBufferList. The contents of its info structure is subclass-dependent,
- and documented on a subclass basis. The buffers held by the sample are
- not writable.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="aggregator_pad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="15">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="AggregatorPad"
- c:symbol-prefix="aggregator_pad"
- c:type="GstAggregatorPad"
- version="1.14"
- parent="Gst.Pad"
- glib:type-name="GstAggregatorPad"
- glib:get-type="gst_aggregator_pad_get_type"
- glib:type-struct="AggregatorPadClass">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="92">Pads managed by a #GstAggregator subclass.
-
-This class used to live in gst-plugins-bad and was moved to core.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="100"/>
- <virtual-method name="flush">
- <source-position filename="libs/gst/base/gstaggregator.h" line="95"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggpad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </instance-parameter>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="skip_buffer">
- <source-position filename="libs/gst/base/gstaggregator.h" line="96"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="aggpad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </instance-parameter>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="drop_buffer" c:identifier="gst_aggregator_pad_drop_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3419">Drop the buffer currently queued in @pad.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="116"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3425">TRUE if there was a buffer queued in @pad, or FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3421">the pad where to drop any pending buffer</doc>
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_buffer"
- c:identifier="gst_aggregator_pad_has_buffer"
- version="1.14.1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3478">This checks if a pad has a buffer available that will be returned by
-a call to gst_aggregator_pad_peek_buffer() or
-gst_aggregator_pad_pop_buffer().</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="119"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3486">%TRUE if the pad has a buffer available as the next thing.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3480">the pad to check the buffer on</doc>
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_eos" c:identifier="gst_aggregator_pad_is_eos">
- <source-position filename="libs/gst/base/gstaggregator.h" line="122"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3514">%TRUE if the pad is EOS, otherwise %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3512">an aggregator pad</doc>
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="peek_buffer" c:identifier="gst_aggregator_pad_peek_buffer">
- <source-position filename="libs/gst/base/gstaggregator.h" line="113"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3445">A reference to the buffer in @pad or
-NULL if no buffer was queued. You should unref the buffer after
-usage.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3443">the pad to get buffer from</doc>
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pop_buffer" c:identifier="gst_aggregator_pad_pop_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3361">Steal the ref to the buffer currently queued in @pad.</doc>
- <source-position filename="libs/gst/base/gstaggregator.h" line="110"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3367">The buffer in @pad or NULL if no buffer was
- queued. You should unref the buffer after usage.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3363">the pad to get buffer from</doc>
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <property name="emit-signals"
- version="1.16"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.c"
- line="3272">Enables the emission of signals such as #GstAggregatorPad::buffer-consumed</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="parent">
- <type name="Gst.Pad" c:type="GstPad"/>
- </field>
- <field name="segment">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.h"
- line="59">last segment received.</doc>
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AggregatorPadPrivate" c:type="GstAggregatorPadPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="buffer-consumed" when="first">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="Gst.Buffer"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="AggregatorPadClass"
- c:type="GstAggregatorPadClass"
- glib:is-gtype-struct-for="AggregatorPad"
- version="1.14">
- <source-position filename="libs/gst/base/gstaggregator.h" line="100"/>
- <field name="parent_class">
- <type name="Gst.PadClass" c:type="GstPadClass"/>
- </field>
- <field name="flush">
- <callback name="flush">
- <source-position filename="libs/gst/base/gstaggregator.h" line="95"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="aggpad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="skip_buffer">
- <callback name="skip_buffer">
- <source-position filename="libs/gst/base/gstaggregator.h" line="96"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="aggpad" transfer-ownership="none">
- <type name="AggregatorPad" c:type="GstAggregatorPad*"/>
- </parameter>
- <parameter name="aggregator" transfer-ownership="none">
- <type name="Aggregator" c:type="GstAggregator*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="AggregatorPadPrivate"
- c:type="GstAggregatorPadPrivate"
- disguised="1">
- <source-position filename="libs/gst/base/gstaggregator.h" line="55"/>
- </record>
- <record name="AggregatorPrivate"
- c:type="GstAggregatorPrivate"
- disguised="1">
- <source-position filename="libs/gst/base/gstaggregator.h" line="34"/>
- </record>
- <enumeration name="AggregatorStartTimeSelection"
- version="1.18"
- glib:type-name="GstAggregatorStartTimeSelection"
- glib:get-type="gst_aggregator_start_time_selection_get_type"
- c:type="GstAggregatorStartTimeSelection">
- <member name="zero"
- value="0"
- c:identifier="GST_AGGREGATOR_START_TIME_SELECTION_ZERO"
- glib:nick="zero">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.h"
- line="429">Start at running time 0.</doc>
- </member>
- <member name="first"
- value="1"
- c:identifier="GST_AGGREGATOR_START_TIME_SELECTION_FIRST"
- glib:nick="first">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.h"
- line="430">Start at the running time of
-the first buffer that is received.</doc>
- </member>
- <member name="set"
- value="2"
- c:identifier="GST_AGGREGATOR_START_TIME_SELECTION_SET"
- glib:nick="set">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstaggregator.h"
- line="432">Start at the running time
-selected by the `start-time` property.</doc>
- </member>
- </enumeration>
- <function-macro name="BASE_PARSE"
- c:identifier="GST_BASE_PARSE"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_PARSE_CAST"
- c:identifier="GST_BASE_PARSE_CAST"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_PARSE_CLASS"
- c:identifier="GST_BASE_PARSE_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="32"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_PARSE_DRAINING"
- c:identifier="GST_BASE_PARSE_DRAINING"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="76">Obtains current drain status (ie. whether EOS has been received and
-the parser is now processing the frames at the end of the stream)</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="83"/>
- <parameters>
- <parameter name="parse">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="78">base parse instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="BASE_PARSE_FLAG_DRAINING"
- value="2"
- c:type="GST_BASE_PARSE_FLAG_DRAINING">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="66"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="BASE_PARSE_FLAG_LOST_SYNC"
- value="1"
- c:type="GST_BASE_PARSE_FLAG_LOST_SYNC">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="65"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="BASE_PARSE_GET_CLASS"
- c:identifier="GST_BASE_PARSE_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_PARSE_LOST_SYNC"
- c:identifier="GST_BASE_PARSE_LOST_SYNC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="68">Obtains current sync status.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="74"/>
- <parameters>
- <parameter name="parse">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="70">base parse instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_PARSE_SINK_PAD"
- c:identifier="GST_BASE_PARSE_SINK_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="46">Gives the pointer to the sink #GstPad object of the element.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="52"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="48">base parse instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_PARSE_SRC_PAD"
- c:identifier="GST_BASE_PARSE_SRC_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="38">Gives the pointer to the source #GstPad object of the element.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="44"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="40">base parse instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK"
- c:identifier="GST_BASE_SINK"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_CAST"
- c:identifier="GST_BASE_SINK_CAST"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_CLASS"
- c:identifier="GST_BASE_SINK_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_GET_CLASS"
- c:identifier="GST_BASE_SINK_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_GET_PREROLL_COND"
- c:identifier="GST_BASE_SINK_GET_PREROLL_COND"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="53"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_GET_PREROLL_LOCK"
- c:identifier="GST_BASE_SINK_GET_PREROLL_LOCK"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="48"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_PAD"
- c:identifier="GST_BASE_SINK_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.h"
- line="40">Gives the pointer to the #GstPad object of the element.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="46"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.h"
- line="42">base sink instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_PREROLL_BROADCAST"
- c:identifier="GST_BASE_SINK_PREROLL_BROADCAST"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="59"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_PREROLL_LOCK"
- c:identifier="GST_BASE_SINK_PREROLL_LOCK"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="49"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_PREROLL_SIGNAL"
- c:identifier="GST_BASE_SINK_PREROLL_SIGNAL"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="58"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_PREROLL_TRYLOCK"
- c:identifier="GST_BASE_SINK_PREROLL_TRYLOCK"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="50"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_PREROLL_UNLOCK"
- c:identifier="GST_BASE_SINK_PREROLL_UNLOCK"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="51"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_PREROLL_WAIT"
- c:identifier="GST_BASE_SINK_PREROLL_WAIT"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="54"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SINK_PREROLL_WAIT_UNTIL"
- c:identifier="GST_BASE_SINK_PREROLL_WAIT_UNTIL"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="56"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- <parameter name="end_time">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SRC"
- c:identifier="GST_BASE_SRC"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SRC_CAST"
- c:identifier="GST_BASE_SRC_CAST"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SRC_CLASS"
- c:identifier="GST_BASE_SRC_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SRC_GET_CLASS"
- c:identifier="GST_BASE_SRC_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SRC_IS_STARTED"
- c:identifier="GST_BASE_SRC_IS_STARTED"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="56"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SRC_IS_STARTING"
- c:identifier="GST_BASE_SRC_IS_STARTING"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="55"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_SRC_PAD"
- c:identifier="GST_BASE_SRC_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.h"
- line="62">Gives the pointer to the #GstPad object of the element.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="68"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.h"
- line="64">base source instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_TRANSFORM"
- c:identifier="GST_BASE_TRANSFORM"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasetransform.h" line="30"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_TRANSFORM_CAST"
- c:identifier="GST_BASE_TRANSFORM_CAST"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasetransform.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_TRANSFORM_CLASS"
- c:identifier="GST_BASE_TRANSFORM_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasetransform.h" line="31"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BASE_TRANSFORM_GET_CLASS"
- c:identifier="GST_BASE_TRANSFORM_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasetransform.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="BASE_TRANSFORM_SINK_NAME"
- value="sink"
- c:type="GST_BASE_TRANSFORM_SINK_NAME">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.h"
- line="37">The name of the templates for the sink pad.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h" line="42"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="BASE_TRANSFORM_SINK_PAD"
- c:identifier="GST_BASE_TRANSFORM_SINK_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.h"
- line="58">Gives the pointer to the sink #GstPad object of the element.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h" line="64"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.h"
- line="60">base transform instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="BASE_TRANSFORM_SRC_NAME"
- value="src"
- c:type="GST_BASE_TRANSFORM_SRC_NAME">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.h"
- line="43">The name of the templates for the source pad.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h" line="48"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="BASE_TRANSFORM_SRC_PAD"
- c:identifier="GST_BASE_TRANSFORM_SRC_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.h"
- line="50">Gives the pointer to the source #GstPad object of the element.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h" line="56"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.h"
- line="52">base transform instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BIT_READER"
- c:identifier="GST_BIT_READER"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbitreader.h" line="31"/>
- <parameters>
- <parameter name="reader">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BIT_READER_INIT"
- c:identifier="GST_BIT_READER_INIT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.h"
- line="105">A #GstBitReader must be initialized with this macro, before it can be
-used. This macro can used be to initialize a variable, but it cannot
-be assigned to a variable. In that case you have to use
-gst_bit_reader_init().</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="115"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.h"
- line="107">Data from which the #GstBitReader should read</doc>
- </parameter>
- <parameter name="size">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.h"
- line="108">Size of @data in bytes</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BIT_WRITER"
- c:identifier="GST_BIT_WRITER"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbitwriter.h" line="35"/>
- <parameters>
- <parameter name="writer">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BIT_WRITER_BIT_SIZE"
- c:identifier="GST_BIT_WRITER_BIT_SIZE"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbitwriter.h" line="34"/>
- <parameters>
- <parameter name="writer">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BIT_WRITER_DATA"
- c:identifier="GST_BIT_WRITER_DATA"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbitwriter.h" line="33"/>
- <parameters>
- <parameter name="writer">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BYTE_READER"
- c:identifier="GST_BYTE_READER"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbytereader.h" line="30"/>
- <parameters>
- <parameter name="reader">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BYTE_READER_INIT"
- c:identifier="GST_BYTE_READER_INIT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.h"
- line="274">A #GstByteReader must be initialized with this macro, before it can be
-used. This macro can used be to initialize a variable, but it cannot
-be assigned to a variable. In that case you have to use
-gst_byte_reader_init().</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="284"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.h"
- line="276">Data from which the #GstByteReader should read</doc>
- </parameter>
- <parameter name="size">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.h"
- line="277">Size of @data in bytes</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="BYTE_WRITER"
- c:identifier="GST_BYTE_WRITER"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbytewriter.h" line="31"/>
- <parameters>
- <parameter name="writer">
- </parameter>
- </parameters>
- </function-macro>
- <class name="BaseParse"
- c:symbol-prefix="base_parse"
- c:type="GstBaseParse"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstBaseParse"
- glib:get-type="gst_base_parse_get_type"
- glib:type-struct="BaseParseClass">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="24">This base class is for parser elements that process data and splits it
-into separate audio/video/whatever frames.
-
-It provides for:
-
- * provides one sink pad and one source pad
- * handles state changes
- * can operate in pull mode or push mode
- * handles seeking in both modes
- * handles events (SEGMENT/EOS/FLUSH)
- * handles queries (POSITION/DURATION/SEEKING/FORMAT/CONVERT)
- * handles flushing
-
-The purpose of this base class is to provide the basic functionality of
-a parser and share a lot of rather complex code.
-
-# Description of the parsing mechanism:
-
-## Set-up phase
-
- * #GstBaseParse calls #GstBaseParseClass.start() to inform subclass
- that data processing is about to start now.
-
- * #GstBaseParse class calls #GstBaseParseClass.set_sink_caps() to
- inform the subclass about incoming sinkpad caps. Subclass could
- already set the srcpad caps accordingly, but this might be delayed
- until calling gst_base_parse_finish_frame() with a non-queued frame.
-
- * At least at this point subclass needs to tell the #GstBaseParse class
- how big data chunks it wants to receive (minimum frame size ). It can
- do this with gst_base_parse_set_min_frame_size().
-
- * #GstBaseParse class sets up appropriate data passing mode (pull/push)
- and starts to process the data.
-
-## Parsing phase
-
- * #GstBaseParse gathers at least min_frame_size bytes of data either
- by pulling it from upstream or collecting buffers in an internal
- #GstAdapter.
-
- * A buffer of (at least) min_frame_size bytes is passed to subclass
- with #GstBaseParseClass.handle_frame(). Subclass checks the contents
- and can optionally return #GST_FLOW_OK along with an amount of data
- to be skipped to find a valid frame (which will result in a
- subsequent DISCONT). If, otherwise, the buffer does not hold a
- complete frame, #GstBaseParseClass.handle_frame() can merely return
- and will be called again when additional data is available. In push
- mode this amounts to an additional input buffer (thus minimal
- additional latency), in pull mode this amounts to some arbitrary
- reasonable buffer size increase.
-
- Of course, gst_base_parse_set_min_frame_size() could also be used if
- a very specific known amount of additional data is required. If,
- however, the buffer holds a complete valid frame, it can pass the
- size of this frame to gst_base_parse_finish_frame().
-
- If acting as a converter, it can also merely indicate consumed input
- data while simultaneously providing custom output data. Note that
- baseclass performs some processing (such as tracking overall consumed
- data rate versus duration) for each finished frame, but other state
- is only updated upon each call to #GstBaseParseClass.handle_frame()
- (such as tracking upstream input timestamp).
-
- Subclass is also responsible for setting the buffer metadata
- (e.g. buffer timestamp and duration, or keyframe if applicable).
- (although the latter can also be done by #GstBaseParse if it is
- appropriately configured, see below). Frame is provided with
- timestamp derived from upstream (as much as generally possible),
- duration obtained from configuration (see below), and offset
- if meaningful (in pull mode).
-
- Note that #GstBaseParseClass.handle_frame() might receive any small
- amount of input data when leftover data is being drained (e.g. at
- EOS).
-
- * As part of finish frame processing, just prior to actually pushing
- the buffer in question, it is passed to
- #GstBaseParseClass.pre_push_frame() which gives subclass yet one last
- chance to examine buffer metadata, or to send some custom (tag)
- events, or to perform custom (segment) filtering.
-
- * During the parsing process #GstBaseParseClass will handle both srcpad
- and sinkpad events. They will be passed to subclass if
- #GstBaseParseClass.sink_event() or #GstBaseParseClass.src_event()
- implementations have been provided.
-
-## Shutdown phase
-
-* #GstBaseParse class calls #GstBaseParseClass.stop() to inform the
- subclass that data parsing will be stopped.
-
-Subclass is responsible for providing pad template caps for source and
-sink pads. The pads need to be named "sink" and "src". It also needs to
-set the fixed caps on srcpad, when the format is ensured (e.g. when
-base class calls subclass' #GstBaseParseClass.set_sink_caps() function).
-
-This base class uses %GST_FORMAT_DEFAULT as a meaning of frames. So,
-subclass conversion routine needs to know that conversion from
-%GST_FORMAT_TIME to %GST_FORMAT_DEFAULT must return the
-frame number that can be found from the given byte position.
-
-#GstBaseParse uses subclasses conversion methods also for seeking (or
-otherwise uses its own default one, see also below).
-
-Subclass @start and @stop functions will be called to inform the beginning
-and end of data processing.
-
-Things that subclass need to take care of:
-
-* Provide pad templates
-* Fixate the source pad caps when appropriate
-* Inform base class how big data chunks should be retrieved. This is
- done with gst_base_parse_set_min_frame_size() function.
-* Examine data chunks passed to subclass with
- #GstBaseParseClass.handle_frame() and pass proper frame(s) to
- gst_base_parse_finish_frame(), and setting src pad caps and timestamps
- on frame.
-* Provide conversion functions
-* Update the duration information with gst_base_parse_set_duration()
-* Optionally passthrough using gst_base_parse_set_passthrough()
-* Configure various baseparse parameters using
- gst_base_parse_set_average_bitrate(), gst_base_parse_set_syncable()
- and gst_base_parse_set_frame_rate().
-
-* In particular, if subclass is unable to determine a duration, but
- parsing (or specs) yields a frames per seconds rate, then this can be
- provided to #GstBaseParse to enable it to cater for buffer time
- metadata (which will be taken from upstream as much as
- possible). Internally keeping track of frame durations and respective
- sizes that have been pushed provides #GstBaseParse with an estimated
- bitrate. A default #GstBaseParseClass.convert() (used if not
- overridden) will then use these rates to perform obvious conversions.
- These rates are also used to update (estimated) duration at regular
- frame intervals.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="278"/>
- <virtual-method name="convert">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="252"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="src_format" transfer-ownership="none">
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="src_value" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="dest_format" transfer-ownership="none">
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="dest_value" transfer-ownership="none">
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="detect">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="267"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_sink_caps">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="264"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="handle_frame">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="245"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="BaseParseFrame" c:type="GstBaseParseFrame*"/>
- </parameter>
- <parameter name="skipsize" transfer-ownership="none">
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="pre_push_frame">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="249"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="BaseParseFrame" c:type="GstBaseParseFrame*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_sink_caps">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="242"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_event">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="258"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_query">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="270"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_event">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="261"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_query">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="273"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="238"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="240"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <method name="add_index_entry"
- c:identifier="gst_base_parse_add_index_entry">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1973">Adds an entry to the index associating @offset to @ts. It is recommended
-to only add keyframe entries. @force allows to bypass checks, such as
-whether the stream is (upstream) seekable, another entry is already "close"
-to the new entry, etc.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="351"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1986">#gboolean indicating whether entry was added</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1975">#GstBaseParse.</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1976">offset of entry</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="ts" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1977">timestamp associated with offset</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1978">whether entry refers to keyframe</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="force" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1979">add entry disregarding sanity checks</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="convert_default"
- c:identifier="gst_base_parse_convert_default">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1735">Default implementation of #GstBaseParseClass.convert().</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="345"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1745">%TRUE if conversion was successful.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1737">#GstBaseParse.</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="src_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1738">#GstFormat describing the source format.</doc>
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="src_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1739">Source value to be converted.</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="dest_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1740">#GstFormat defining the converted format.</doc>
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="dest_value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="1741">Pointer where the conversion result will be put.</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="drain" c:identifier="gst_base_parse_drain" version="1.12">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="2754">Drains the adapter until it is empty. It decreases the min_frame_size to
-match the current adapter size and calls chain method until the adapter
-is emptied or chain returns with error.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="320"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="2756">a #GstBaseParse</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="finish_frame" c:identifier="gst_base_parse_finish_frame">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="2658">Collects parsed data and pushes this downstream.
-Source pad caps must be set when this is called.
-
-If @frame's out_buffer is set, that will be used as subsequent frame data.
-Otherwise, @size samples will be taken from the input and used for output,
-and the output's metadata (timestamps etc) will be taken as (optionally)
-set by the subclass on @frame's (input) buffer (which is otherwise
-ignored for any but the above purpose/information).
-
-Note that the latter buffer is invalidated by this call, whereas the
-caller retains ownership of @frame.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="302"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="2676">a #GstFlowReturn that should be escalated to caller (of caller)</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="2660">a #GstBaseParse</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="2661">a #GstBaseParseFrame</doc>
- <type name="BaseParseFrame" c:type="GstBaseParseFrame*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="2662">consumed input data represented by frame</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="merge_tags"
- c:identifier="gst_base_parse_merge_tags"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4988">Sets the parser subclass's tags and how they should be merged with any
-upstream stream tags. This will override any tags previously-set
-with gst_base_parse_merge_tags().
-
-Note that this is provided for convenience, and the subclass is
-not required to use this and can still do tag handling on its own.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="360"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4990">a #GstBaseParse</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="tags"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4991">a #GstTagList to merge, or NULL to unset
- previously-set tags</doc>
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4993">the #GstTagMergeMode to use, usually #GST_TAG_MERGE_REPLACE</doc>
- <type name="Gst.TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="push_frame" c:identifier="gst_base_parse_push_frame">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="2444">Pushes the frame's buffer downstream, sends any pending events and
-does some timestamp and segment handling. Takes ownership of
-frame's buffer, though caller retains ownership of @frame.
-
-This must be called with sinkpad STREAM_LOCK held.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="299"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="2455">#GstFlowReturn</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="2446">#GstBaseParse.</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="2447">a #GstBaseParseFrame</doc>
- <type name="BaseParseFrame" c:type="GstBaseParseFrame*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_average_bitrate"
- c:identifier="gst_base_parse_set_average_bitrate">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3878">Optionally sets the average bitrate detected in media (if non-zero),
-e.g. based on metadata, as it will be posted to the application.
-
-By default, announced average bitrate is estimated. The average bitrate
-is used to estimate the total duration of the stream and to estimate
-a seek position, if there's no index and the format is syncable
-(see gst_base_parse_set_syncable()).</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="311"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3880">#GstBaseParse.</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="bitrate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3881">average bitrate in bits/second</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_duration" c:identifier="gst_base_parse_set_duration">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3827">Sets the duration of the currently playing media. Subclass can use this
-when it is able to determine duration and/or notices a change in the media
-duration. Alternatively, if @interval is non-zero (default), then stream
-duration is determined based on estimated bitrate, and updated every @interval
-frames.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="306"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3829">#GstBaseParse.</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="fmt" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3830">#GstFormat.</doc>
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3831">duration value.</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3832">how often to update the duration estimate based on bitrate, or 0.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_frame_rate"
- c:identifier="gst_base_parse_set_frame_rate">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3916">If frames per second is configured, parser can take care of buffer duration
-and timestamping. When performing segment clipping, or seeking to a specific
-location, a corresponding decoder might need an initial @lead_in and a
-following @lead_out number of frames to ensure the desired segment is
-entirely filled upon decoding.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="335"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3918">the #GstBaseParse to set</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="fps_num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3919">frames per second (numerator).</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="fps_den" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3920">frames per second (denominator).</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="lead_in" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3921">frames needed before a segment for subsequent decode</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="lead_out" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3922">frames needed after a segment</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_has_timing_info"
- c:identifier="gst_base_parse_set_has_timing_info">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3973">Set if frames carry timing information which the subclass can (generally)
-parse and provide. In particular, intrinsic (rather than estimated) time
-can be obtained following a seek.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="317"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3975">a #GstBaseParse</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="has_timing" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3976">whether frames carry timing information</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_infer_ts" c:identifier="gst_base_parse_set_infer_ts">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4044">By default, the base class might try to infer PTS from DTS and vice
-versa. While this is generally correct for audio data, it may not
-be otherwise. Sub-classes implementing such formats should disable
-timestamp inferring.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="332"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4046">a #GstBaseParse</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="infer_ts" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4047">%TRUE if parser should infer DTS/PTS from each other</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_latency" c:identifier="gst_base_parse_set_latency">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4061">Sets the minimum and maximum (which may likely be equal) latency introduced
-by the parsing process. If there is such a latency, which depends on the
-particular parsing of the format, it typically corresponds to 1 frame duration.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="341"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4063">a #GstBaseParse</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="min_latency" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4064">minimum parse latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="max_latency" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4065">maximum parse latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_min_frame_size"
- c:identifier="gst_base_parse_set_min_frame_size">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3898">Subclass can use this function to tell the base class that it needs to
-be given buffers of at least @min_size bytes.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="314"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3900">#GstBaseParse.</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="min_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3901">Minimum size in bytes of the data that this base class should
- give to subclass.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_passthrough"
- c:identifier="gst_base_parse_set_passthrough">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4005">Set if the nature of the format or configuration does not allow (much)
-parsing, and the parser should operate in passthrough mode (which only
-applies when operating in push mode). That is, incoming buffers are
-pushed through unmodified, i.e. no #GstBaseParseClass.handle_frame()
-will be invoked, but #GstBaseParseClass.pre_push_frame() will still be
-invoked, so subclass can perform as much or as little is appropriate for
-passthrough semantics in #GstBaseParseClass.pre_push_frame().</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="326"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4007">a #GstBaseParse</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="passthrough" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4008">%TRUE if parser should run in passthrough mode</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_pts_interpolation"
- c:identifier="gst_base_parse_set_pts_interpolation">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4025">By default, the base class will guess PTS timestamps using a simple
-interpolation (previous timestamp + duration), which is incorrect for
-data streams with reordering, where PTS can go backward. Sub-classes
-implementing such formats should disable PTS interpolation.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="329"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4027">a #GstBaseParse</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="pts_interpolate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4028">%TRUE if parser should interpolate PTS timestamps</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_syncable" c:identifier="gst_base_parse_set_syncable">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3989">Set if frame starts can be identified. This is set by default and
-determines whether seeking based on bitrate averages
-is possible for a format/stream.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="323"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3991">a #GstBaseParse</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="syncable" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="3992">set if frame starts can be identified</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_ts_at_offset"
- c:identifier="gst_base_parse_set_ts_at_offset"
- version="1.2">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4948">This function should only be called from a @handle_frame implementation.
-
-#GstBaseParse creates initial timestamps for frames by using the last
-timestamp seen in the stream before the frame starts. In certain
-cases, the correct timestamps will occur in the stream after the
-start of the frame, but before the start of the actual picture data.
-This function can be used to set the timestamps based on the offset
-into the frame data that the picture starts.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="357"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parse" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4950">a #GstBaseParse</doc>
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="4951">offset into current buffer</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <property name="disable-passthrough"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="551">If set to %TRUE, baseparse will unconditionally force parsing of the
-incoming data. This can be required in the rare cases where the incoming
-side-data (caps, pts, dts, ...) is not trusted by the user and wants to
-force validation and parsing of the incoming data.
-If set to %FALSE, decision of whether to parse the data or not is up to
-the implementation (standard behaviour).</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="element">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="156">the parent element.</doc>
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="sinkpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="srcpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="flags">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="segment">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="BaseParsePrivate" c:type="GstBaseParsePrivate*"/>
- </field>
- </class>
- <record name="BaseParseClass"
- c:type="GstBaseParseClass"
- glib:is-gtype-struct-for="BaseParse">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="179">Subclasses can override any of the available virtual methods or not, as
-needed. At minimum @handle_frame needs to be overridden.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="278"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="181">the parent class</doc>
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="start">
- <callback name="start">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="238"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="240"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_sink_caps">
- <callback name="set_sink_caps">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="242"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="handle_frame">
- <callback name="handle_frame">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="245"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="BaseParseFrame" c:type="GstBaseParseFrame*"/>
- </parameter>
- <parameter name="skipsize" transfer-ownership="none">
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="pre_push_frame">
- <callback name="pre_push_frame">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="249"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="BaseParseFrame" c:type="GstBaseParseFrame*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="convert">
- <callback name="convert">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="252"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </parameter>
- <parameter name="src_format" transfer-ownership="none">
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="src_value" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="dest_format" transfer-ownership="none">
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="dest_value" transfer-ownership="none">
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_event">
- <callback name="sink_event">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="258"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_event">
- <callback name="src_event">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="261"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_sink_caps">
- <callback name="get_sink_caps">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="264"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="detect">
- <callback name="detect">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="267"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_query">
- <callback name="sink_query">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="270"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_query">
- <callback name="src_query">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="273"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="parse" transfer-ownership="none">
- <type name="BaseParse" c:type="GstBaseParse*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="18">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="BaseParseFrame"
- c:type="GstBaseParseFrame"
- glib:type-name="GstBaseParseFrame"
- glib:get-type="gst_base_parse_frame_get_type"
- c:symbol-prefix="base_parse_frame">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="115">Frame (context) data passed to each frame parsing virtual methods. In
-addition to providing the data to be checked for a valid frame or an already
-identified frame, it conveys additional metadata or control information
-from and to the subclass w.r.t. the particular frame in question (rather
-than global parameters). Some of these may apply to each parsing stage, others
-only to some a particular one. These parameters are effectively zeroed at start
-of each frame's processing, i.e. parsing virtual method invocation sequence.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="148"/>
- <field name="buffer" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="117">input data to be parsed for frames.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="out_buffer" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="118">output data.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="125">a combination of input and output #GstBaseParseFrameFlags that
- convey additional context to subclass or allow subclass to tune
- subsequent #GstBaseParse actions.</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="offset" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="119">media specific offset of input frame
- Note that a converter may have a different one on the frame's buffer.</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="overhead" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="121">subclass can set this to indicates the metadata overhead
- for the given frame, which is then used to enable more accurate bitrate
- computations. If this is -1, it is assumed that this frame should be
- skipped in bitrate calculation.</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="size" readable="0" private="1">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="_gst_reserved_i" readable="0" private="1">
- <array zero-terminated="0" fixed-size="2">
- <type name="guint" c:type="guint"/>
- </array>
- </field>
- <field name="_gst_reserved_p" readable="0" private="1">
- <array zero-terminated="0" fixed-size="2">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="_private_flags" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <constructor name="new" c:identifier="gst_base_parse_frame_new">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="748">Allocates a new #GstBaseParseFrame. This function is mainly for bindings,
-elements written in C should usually allocate the frame on the stack and
-then use gst_base_parse_frame_init() to initialise it.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="287"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="760">a newly-allocated #GstBaseParseFrame. Free with
- gst_base_parse_frame_free() when no longer needed.</doc>
- <type name="BaseParseFrame" c:type="GstBaseParseFrame*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="750">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="751">the flags</doc>
- <type name="BaseParseFrameFlags" c:type="GstBaseParseFrameFlags"/>
- </parameter>
- <parameter name="overhead" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="752">number of bytes in this frame which should be counted as
- metadata overhead, ie. not used to calculate the average bitrate.
- Set to -1 to mark the entire frame as metadata. If in doubt, set to 0.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="copy"
- c:identifier="gst_base_parse_frame_copy"
- version="1.12.1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="679">Copies a #GstBaseParseFrame.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="294"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="685">A copy of @frame</doc>
- <type name="BaseParseFrame" c:type="GstBaseParseFrame*"/>
- </return-value>
- <parameters>
- <instance-parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="681">a #GstBaseParseFrame</doc>
- <type name="BaseParseFrame" c:type="GstBaseParseFrame*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_base_parse_frame_free">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="703">Frees the provided @frame.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="296"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="705">A #GstBaseParseFrame</doc>
- <type name="BaseParseFrame" c:type="GstBaseParseFrame*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_base_parse_frame_init">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="730">Sets a #GstBaseParseFrame to initial state. Currently this means
-all public fields are zero-ed and a private flag is set to make
-sure gst_base_parse_frame_free() only frees the contents but not
-the actual frame. Use this function to initialise a #GstBaseParseFrame
-allocated on the stack.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="291"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.c"
- line="732">#GstBaseParseFrame.</doc>
- <type name="BaseParseFrame" c:type="GstBaseParseFrame*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <bitfield name="BaseParseFrameFlags" c:type="GstBaseParseFrameFlags">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="85">Flags to be used in a #GstBaseParseFrame.</doc>
- <source-position filename="libs/gst/base/gstbaseparse.h" line="113"/>
- <member name="none"
- value="0"
- c:identifier="GST_BASE_PARSE_FRAME_FLAG_NONE">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="87">no flag</doc>
- </member>
- <member name="new_frame"
- value="1"
- c:identifier="GST_BASE_PARSE_FRAME_FLAG_NEW_FRAME">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="88">set by baseclass if current frame
- is passed for processing to the subclass for the first time
- (and not set on subsequent calls with same data).</doc>
- </member>
- <member name="no_frame"
- value="2"
- c:identifier="GST_BASE_PARSE_FRAME_FLAG_NO_FRAME">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="91">set to indicate this buffer should not be
- counted as frame, e.g. if this frame is dependent on a previous one.
- As it is not counted as a frame, bitrate increases but frame to time
- conversions are maintained.</doc>
- </member>
- <member name="clip"
- value="4"
- c:identifier="GST_BASE_PARSE_FRAME_FLAG_CLIP">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="95">@pre_push_frame can set this to indicate
- that regular segment clipping can still be performed (as opposed to
- any custom one having been done).</doc>
- </member>
- <member name="drop"
- value="8"
- c:identifier="GST_BASE_PARSE_FRAME_FLAG_DROP">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="98">indicates to @finish_frame that the
- the frame should be dropped (and might be handled internally by subclass)</doc>
- </member>
- <member name="queue"
- value="16"
- c:identifier="GST_BASE_PARSE_FRAME_FLAG_QUEUE">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbaseparse.h"
- line="100">indicates to @finish_frame that the
- the frame should be queued for now and processed fully later
- when the first non-queued frame is finished</doc>
- </member>
- </bitfield>
- <record name="BaseParsePrivate" c:type="GstBaseParsePrivate" disguised="1">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="152"/>
- </record>
- <class name="BaseSink"
- c:symbol-prefix="base_sink"
- c:type="GstBaseSink"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstBaseSink"
- glib:get-type="gst_base_sink_get_type"
- glib:type-struct="BaseSinkClass">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="22">#GstBaseSink is the base class for sink elements in GStreamer, such as
-xvimagesink or filesink. It is a layer on top of #GstElement that provides a
-simplified interface to plugin writers. #GstBaseSink handles many details
-for you, for example: preroll, clock synchronization, state changes,
-activation in push or pull mode, and queries.
-
-In most cases, when writing sink elements, there is no need to implement
-class methods from #GstElement or to set functions on pads, because the
-#GstBaseSink infrastructure should be sufficient.
-
-#GstBaseSink provides support for exactly one sink pad, which should be
-named "sink". A sink implementation (subclass of #GstBaseSink) should
-install a pad template in its class_init function, like so:
-|[&lt;!-- language="C" --&gt;
-static void
-my_element_class_init (GstMyElementClass *klass)
-{
- GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
-
- // sinktemplate should be a #GstStaticPadTemplate with direction
- // %GST_PAD_SINK and name "sink"
- gst_element_class_add_static_pad_template (gstelement_class, &amp;amp;sinktemplate);
-
- gst_element_class_set_static_metadata (gstelement_class,
- "Sink name",
- "Sink",
- "My Sink element",
- "The author &lt;my.sink@my.email&gt;");
-}
-]|
-
-#GstBaseSink will handle the prerolling correctly. This means that it will
-return %GST_STATE_CHANGE_ASYNC from a state change to PAUSED until the first
-buffer arrives in this element. The base class will call the
-#GstBaseSinkClass.preroll() vmethod with this preroll buffer and will then
-commit the state change to the next asynchronously pending state.
-
-When the element is set to PLAYING, #GstBaseSink will synchronise on the
-clock using the times returned from #GstBaseSinkClass.get_times(). If this
-function returns %GST_CLOCK_TIME_NONE for the start time, no synchronisation
-will be done. Synchronisation can be disabled entirely by setting the object
-#GstBaseSink:sync property to %FALSE.
-
-After synchronisation the virtual method #GstBaseSinkClass.render() will be
-called. Subclasses should minimally implement this method.
-
-Subclasses that synchronise on the clock in the #GstBaseSinkClass.render()
-method are supported as well. These classes typically receive a buffer in
-the render method and can then potentially block on the clock while
-rendering. A typical example is an audiosink.
-These subclasses can use gst_base_sink_wait_preroll() to perform the
-blocking wait.
-
-Upon receiving the EOS event in the PLAYING state, #GstBaseSink will wait
-for the clock to reach the time indicated by the stop time of the last
-#GstBaseSinkClass.get_times() call before posting an EOS message. When the
-element receives EOS in PAUSED, preroll completes, the event is queued and an
-EOS message is posted when going to PLAYING.
-
-#GstBaseSink will internally use the %GST_EVENT_SEGMENT events to schedule
-synchronisation and clipping of buffers. Buffers that fall completely outside
-of the current segment are dropped. Buffers that fall partially in the
-segment are rendered (and prerolled). Subclasses should do any subbuffer
-clipping themselves when needed.
-
-#GstBaseSink will by default report the current playback position in
-%GST_FORMAT_TIME based on the current clock time and segment information.
-If no clock has been set on the element, the query will be forwarded
-upstream.
-
-The #GstBaseSinkClass.set_caps() function will be called when the subclass
-should configure itself to process a specific media type.
-
-The #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() virtual methods
-will be called when resources should be allocated. Any
-#GstBaseSinkClass.preroll(), #GstBaseSinkClass.render() and
-#GstBaseSinkClass.set_caps() function will be called between the
-#GstBaseSinkClass.start() and #GstBaseSinkClass.stop() calls.
-
-The #GstBaseSinkClass.event() virtual method will be called when an event is
-received by #GstBaseSink. Normally this method should only be overridden by
-very specific elements (such as file sinks) which need to handle the
-newsegment event specially.
-
-The #GstBaseSinkClass.unlock() method is called when the elements should
-unblock any blocking operations they perform in the
-#GstBaseSinkClass.render() method. This is mostly useful when the
-#GstBaseSinkClass.render() method performs a blocking write on a file
-descriptor, for example.
-
-The #GstBaseSink:max-lateness property affects how the sink deals with
-buffers that arrive too late in the sink. A buffer arrives too late in the
-sink when the presentation time (as a combination of the last segment, buffer
-timestamp and element base_time) plus the duration is before the current
-time of the clock.
-If the frame is later than max-lateness, the sink will drop the buffer
-without calling the render method.
-This feature is disabled if sync is disabled, the
-#GstBaseSinkClass.get_times() method does not return a valid start time or
-max-lateness is set to -1 (the default).
-Subclasses can use gst_base_sink_set_max_lateness() to configure the
-max-lateness value.
-
-The #GstBaseSink:qos property will enable the quality-of-service features of
-the basesink which gather statistics about the real-time performance of the
-clock synchronisation. For each buffer received in the sink, statistics are
-gathered and a QOS event is sent upstream with these numbers. This
-information can then be used by upstream elements to reduce their processing
-rate, for example.
-
-The #GstBaseSink:async property can be used to instruct the sink to never
-perform an ASYNC state change. This feature is mostly usable when dealing
-with non-synchronized streams or sparse streams.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="208"/>
- <virtual-method name="activate_pull">
- <source-position filename="libs/gst/base/gstbasesink.h" line="167"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="active" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="event">
- <source-position filename="libs/gst/base/gstbasesink.h" line="192"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="fixate">
- <source-position filename="libs/gst/base/gstbasesink.h" line="165"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_caps">
- <source-position filename="libs/gst/base/gstbasesink.h" line="160"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_times">
- <source-position filename="libs/gst/base/gstbasesink.h" line="170"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="end" transfer-ownership="none">
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="prepare">
- <source-position filename="libs/gst/base/gstbasesink.h" line="197"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="prepare_list">
- <source-position filename="libs/gst/base/gstbasesink.h" line="198"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="buffer_list" transfer-ownership="none">
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="preroll">
- <source-position filename="libs/gst/base/gstbasesink.h" line="201"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="propose_allocation">
- <source-position filename="libs/gst/base/gstbasesink.h" line="174"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="query">
- <source-position filename="libs/gst/base/gstbasesink.h" line="189"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="render">
- <source-position filename="libs/gst/base/gstbasesink.h" line="202"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="render_list">
- <source-position filename="libs/gst/base/gstbasesink.h" line="204"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="buffer_list" transfer-ownership="none">
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_caps">
- <source-position filename="libs/gst/base/gstbasesink.h" line="162"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start">
- <source-position filename="libs/gst/base/gstbasesink.h" line="177"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop">
- <source-position filename="libs/gst/base/gstbasesink.h" line="178"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="unlock">
- <source-position filename="libs/gst/base/gstbasesink.h" line="182"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="unlock_stop">
- <source-position filename="libs/gst/base/gstbasesink.h" line="186"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="wait_event">
- <source-position filename="libs/gst/base/gstbasesink.h" line="194"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="do_preroll" c:identifier="gst_base_sink_do_preroll">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2450">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.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="214"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2462">%GST_FLOW_OK if the preroll completed and processing can
-continue. Any other return value should be returned from the render vmethod.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2452">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="obj" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2453">the mini object that caused the preroll</doc>
- <type name="Gst.MiniObject" c:type="GstMiniObject*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_blocksize" c:identifier="gst_base_sink_get_blocksize">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1388">Get the number of bytes that the sink will pull when it is operating in pull
-mode.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="300"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1395">the number of bytes @sink will pull in pull mode.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1390">a #GstBaseSink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_drop_out_of_segment"
- c:identifier="gst_base_sink_get_drop_out_of_segment"
- version="1.12">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="810">Checks if @sink is currently configured to drop buffers which are outside
-the current segment</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="233"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="817">%TRUE if the sink is configured to drop buffers outside the
-current segment.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="812">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_last_sample"
- c:identifier="gst_base_sink_get_last_sample">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1003">Get the last sample 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 sample can be used to determine the type of the buffer.
-
-Free-function: gst_sample_unref</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="270"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1014">a #GstSample. gst_sample_unref() after
- usage. This function returns %NULL when no buffer has arrived in the
- sink yet or when the sink is not in PAUSED or PLAYING.</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1005">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_latency" c:identifier="gst_base_sink_get_latency">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1162">Get the currently configured latency.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="284"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1168">The configured latency.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1164">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_max_bitrate"
- c:identifier="gst_base_sink_get_max_bitrate"
- version="1.2">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1475">Get the maximum amount of bits per second that the sink will render.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="316"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1481">the maximum number of bits per second @sink will render.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1477">a #GstBaseSink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_max_lateness"
- c:identifier="gst_base_sink_get_max_lateness">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="856">Gets the max lateness value. See gst_base_sink_set_max_lateness() for
-more details.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="241"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="863">The maximum time in nanoseconds that a buffer can be late
-before it is dropped and not rendered. A value of -1 means an
-unlimited time.</doc>
- <type name="gint64" c:type="gint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="858">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_processing_deadline"
- c:identifier="gst_base_sink_get_processing_deadline"
- version="1.16">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1534">Get the processing deadline of @sink. see
-gst_base_sink_set_processing_deadline() for more information about
-the processing deadline.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="323"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1542">the processing deadline</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1536">a #GstBaseSink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_render_delay"
- c:identifier="gst_base_sink_get_render_delay">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1345">Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
-information about the render delay.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="292"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1352">the render delay of @sink.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1347">a #GstBaseSink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stats"
- c:identifier="gst_base_sink_get_stats"
- version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="5877">Return various #GstBaseSink statistics. This function returns a #GstStructure
-with name `application/x-gst-base-sink-stats` with the following fields:
-
-- "average-rate" G_TYPE_DOUBLE average frame rate
-- "dropped" G_TYPE_UINT64 Number of dropped frames
-- "rendered" G_TYPE_UINT64 Number of rendered frames</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="333"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="5888">pointer to #GstStructure</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="5879">#GstBaseSink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_sync" c:identifier="gst_base_sink_get_sync">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="766">Checks if @sink is currently configured to synchronize against the
-clock.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="225"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="773">%TRUE if the sink is configured to synchronize against the clock.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="768">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_throttle_time"
- c:identifier="gst_base_sink_get_throttle_time">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1432">Get the time that will be inserted between frames to control the
-maximum buffers per second.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="308"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1439">the number of nanoseconds @sink will put between frames.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1434">a #GstBaseSink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_ts_offset" c:identifier="gst_base_sink_get_ts_offset">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="981">Get the synchronisation offset of @sink.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="265"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="987">The synchronisation offset.</doc>
- <type name="Gst.ClockTimeDiff" c:type="GstClockTimeDiff"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="983">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_async_enabled"
- c:identifier="gst_base_sink_is_async_enabled">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="938">Checks if @sink is currently configured to perform asynchronous state
-changes to PAUSED.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="257"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="945">%TRUE if the sink is configured to perform asynchronous state
-changes.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="940">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_last_sample_enabled"
- c:identifier="gst_base_sink_is_last_sample_enabled">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1145">Checks if @sink is currently configured to store the last received sample in
-the last-sample property.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="276"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1152">%TRUE if the sink is configured to store the last received sample.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1147">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_qos_enabled"
- c:identifier="gst_base_sink_is_qos_enabled">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="896">Checks if @sink is currently configured to send Quality-of-Service events
-upstream.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="249"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="903">%TRUE if the sink is configured to perform Quality-of-Service.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="898">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="query_latency" c:identifier="gst_base_sink_query_latency">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1182">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
-@min_latency to a strictly positive value.
-
-This function is mostly used by subclasses.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="281"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1201">%TRUE if the query succeeded.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1184">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="live"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1185">if the sink is live</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="upstream_live"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1186">if an upstream element is live</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="min_latency"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1187">the min latency of the upstream elements</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="max_latency"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1188">the max latency of the upstream elements</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_async_enabled"
- c:identifier="gst_base_sink_set_async_enabled">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="917">Configures @sink to perform all state changes asynchronously. When async is
-disabled, the sink will immediately go to PAUSED instead of waiting for a
-preroll buffer. This feature is useful if the sink does not synchronize
-against the clock or when it is dealing with sparse streams.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="254"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="919">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="920">the new async value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_blocksize" c:identifier="gst_base_sink_set_blocksize">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1368">Set the number of bytes that the sink will pull when it is operating in pull
-mode.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="297"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1370">a #GstBaseSink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="blocksize" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1371">the blocksize in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_drop_out_of_segment"
- c:identifier="gst_base_sink_set_drop_out_of_segment"
- version="1.12">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="789">Configure @sink to drop buffers which are outside the current segment</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="230"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="791">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="drop_out_of_segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="792">drop buffers outside the segment</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_last_sample_enabled"
- c:identifier="gst_base_sink_set_last_sample_enabled">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1122">Configures @sink to store the last received sample in the last-sample
-property.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="273"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1124">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1125">the new enable-last-sample value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_max_bitrate"
- c:identifier="gst_base_sink_set_max_bitrate"
- version="1.2">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1455">Set the maximum amount of bits per second that the sink will render.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="313"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1457">a #GstBaseSink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="max_bitrate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1458">the max_bitrate in bits per second</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_max_lateness"
- c:identifier="gst_base_sink_set_max_lateness">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="836">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.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="238"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="838">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="max_lateness" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="839">the new max lateness value.</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_processing_deadline"
- c:identifier="gst_base_sink_set_processing_deadline"
- version="1.16">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1499">Maximum amount of time (in nanoseconds) that the pipeline can take
-for processing the buffer. This is added to the latency of live
-pipelines.
-
-This function is usually called by subclasses.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="320"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1501">a #GstBaseSink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="processing_deadline" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1502">the new processing deadline in nanoseconds.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_qos_enabled"
- c:identifier="gst_base_sink_set_qos_enabled">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="881">Configures @sink to send Quality-of-Service events upstream.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="246"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="883">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="884">the new qos value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_render_delay"
- c:identifier="gst_base_sink_set_render_delay">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1309">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.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="289"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1311">a #GstBaseSink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="delay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1312">the new delay</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_sync" c:identifier="gst_base_sink_set_sync">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="745">Configures @sink to synchronize on the clock or not. When
-@sync is %FALSE, incoming samples will be played as fast as
-possible. If @sync is %TRUE, the timestamps of the incoming
-buffers will be used to schedule the exact render time of its
-contents.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="222"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="747">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="sync" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="748">the new sync value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_throttle_time"
- c:identifier="gst_base_sink_set_throttle_time">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1412">Set the time that will be inserted between rendered buffers. This
-can be used to control the maximum buffers per second that the sink
-will render.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="305"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1414">a #GstBaseSink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="throttle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="1415">the throttle time in nanoseconds</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_ts_offset" c:identifier="gst_base_sink_set_ts_offset">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="960">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.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="262"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="962">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="963">the new offset</doc>
- <type name="Gst.ClockTimeDiff" c:type="GstClockTimeDiff"/>
- </parameter>
- </parameters>
- </method>
- <method name="wait" c:identifier="gst_base_sink_wait">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2552">This function will wait for preroll to complete and will then block until @time
-is reached. It is usually called by subclasses that use their own internal
-synchronisation but want to let some synchronization (like 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 or when handling buffers in
-::render).
-
-The @time argument should be the running_time of when the timeout should happen
-and will be adjusted with any latency and offset configured in the sink.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="329"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2570">#GstFlowReturn</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2554">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2555">the running_time to be reached</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="jitter"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2556">the jitter to be filled with time diff, or %NULL</doc>
- <type name="Gst.ClockTimeDiff" c:type="GstClockTimeDiff*"/>
- </parameter>
- </parameters>
- </method>
- <method name="wait_clock" c:identifier="gst_base_sink_wait_clock">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2294">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 synchronisation 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.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="326"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2316">#GstClockReturn</doc>
- <type name="Gst.ClockReturn" c:type="GstClockReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2296">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- <parameter name="time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2297">the running_time to be reached</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="jitter"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2298">the jitter to be filled with time diff, or %NULL</doc>
- <type name="Gst.ClockTimeDiff" c:type="GstClockTimeDiff*"/>
- </parameter>
- </parameters>
- </method>
- <method name="wait_preroll" c:identifier="gst_base_sink_wait_preroll">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2394">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.
-
-If the #GstBaseSinkClass.render() method can block on something else than
-the clock, it must also be ready to unblock immediately on
-the #GstBaseSinkClass.unlock() method and cause the
-#GstBaseSinkClass.render() method to immediately call this function.
-In this case, the subclass must be prepared to continue rendering where it
-left off if this function returns %GST_FLOW_OK.
-
-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_FLUSHING).
-
-This function should only be called with the PREROLL_LOCK held, like in the
-render function.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="217"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2417">%GST_FLOW_OK if the preroll completed and processing can
-continue. Any other return value should be returned from the render vmethod.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="sink" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="2396">the sink</doc>
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </instance-parameter>
- </parameters>
- </method>
- <property name="async" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="467">If set to %TRUE, the basesink will perform asynchronous state changes.
-When set to %FALSE, the sink will not signal the parent when it prerolls.
-Use this option when dealing with sparse streams or when synchronisation is
-not required.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="blocksize" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="515">The amount of bytes to pull when operating in pull mode.</doc>
- <type name="guint" c:type="guint"/>
- </property>
- <property name="enable-last-sample"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="491">Enable the last-sample property. If %FALSE, basesink doesn't keep a
-reference to the last buffer arrived and the last-sample property is always
-set to %NULL. This can be useful if you need buffers to be released as soon
-as possible, eg. if you're using a buffer pool.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="last-sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="504">The last buffer that arrived in the sink and was used for preroll or for
-rendering. This property can be used to generate thumbnails. This property
-can be %NULL when the sink has not yet received a buffer.</doc>
- <type name="Gst.Sample"/>
- </property>
- <property name="max-bitrate"
- version="1.2"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="548">Control the maximum amount of bits that will be rendered per second.
-Setting this property to a value bigger than 0 will make the sink delay
-rendering of the buffers when it would exceed to max-bitrate.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="max-lateness" writable="1" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="processing-deadline"
- version="1.16"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="562">Maximum amount of time (in nanoseconds) that the pipeline can take
-for processing the buffer. This is added to the latency of live
-pipelines.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="qos" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="render-delay" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="525">The additional delay between synchronisation and actual rendering of the
-media. This property will add additional latency to the device in order to
-make other sinks compensate for the delay.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="stats" version="1.18" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="578">Various #GstBaseSink statistics. This property returns a #GstStructure
-with name `application/x-gst-base-sink-stats` with the following fields:
-
-- "average-rate" G_TYPE_DOUBLE average frame rate
-- "dropped" G_TYPE_UINT64 Number of dropped frames
-- "rendered" G_TYPE_UINT64 Number of rendered frames</doc>
- <type name="Gst.Structure"/>
- </property>
- <property name="sync" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="throttle-time" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="536">The time to insert between buffers. This property can be used to control
-the maximum amount of buffers per second to render. Setting this property
-to a value bigger than 0 will make the sink create THROTTLE QoS events.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="ts-offset" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.c"
- line="479">Controls the final synchronisation, a negative value will render the buffer
-earlier while a positive value delays playback. This property can be
-used to fix synchronisation in bad files.</doc>
- <type name="gint64" c:type="gint64"/>
- </property>
- <field name="element">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="sinkpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="pad_mode">
- <type name="Gst.PadMode" c:type="GstPadMode"/>
- </field>
- <field name="offset">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="can_activate_pull">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="can_activate_push">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="preroll_lock">
- <type name="GLib.Mutex" c:type="GMutex"/>
- </field>
- <field name="preroll_cond">
- <type name="GLib.Cond" c:type="GCond"/>
- </field>
- <field name="eos">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="need_preroll">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="have_preroll">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="playing_async">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="have_newsegment">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="segment">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="clock_id" readable="0" private="1">
- <type name="Gst.ClockID" c:type="GstClockID"/>
- </field>
- <field name="sync" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="flushing" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="running" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="max_lateness" readable="0" private="1">
- <type name="gint64" c:type="gint64"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="BaseSinkPrivate" c:type="GstBaseSinkPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="BaseSinkClass"
- c:type="GstBaseSinkClass"
- glib:is-gtype-struct-for="BaseSink">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.h"
- line="108">Subclasses can override any of the available virtual methods or not, as
-needed. At the minimum, the @render method should be overridden to
-output/present buffers.</doc>
- <source-position filename="libs/gst/base/gstbasesink.h" line="208"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesink.h"
- line="110">Element parent class</doc>
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="get_caps">
- <callback name="get_caps">
- <source-position filename="libs/gst/base/gstbasesink.h" line="160"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_caps">
- <callback name="set_caps">
- <source-position filename="libs/gst/base/gstbasesink.h" line="162"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="fixate">
- <callback name="fixate">
- <source-position filename="libs/gst/base/gstbasesink.h" line="165"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="activate_pull">
- <callback name="activate_pull">
- <source-position filename="libs/gst/base/gstbasesink.h" line="167"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_times">
- <callback name="get_times">
- <source-position filename="libs/gst/base/gstbasesink.h" line="170"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="start" transfer-ownership="none">
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="end" transfer-ownership="none">
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="propose_allocation">
- <callback name="propose_allocation">
- <source-position filename="libs/gst/base/gstbasesink.h" line="174"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="start">
- <callback name="start">
- <source-position filename="libs/gst/base/gstbasesink.h" line="177"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="libs/gst/base/gstbasesink.h" line="178"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="unlock">
- <callback name="unlock">
- <source-position filename="libs/gst/base/gstbasesink.h" line="182"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="unlock_stop">
- <callback name="unlock_stop">
- <source-position filename="libs/gst/base/gstbasesink.h" line="186"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="query">
- <callback name="query">
- <source-position filename="libs/gst/base/gstbasesink.h" line="189"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="event">
- <callback name="event">
- <source-position filename="libs/gst/base/gstbasesink.h" line="192"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="wait_event">
- <callback name="wait_event">
- <source-position filename="libs/gst/base/gstbasesink.h" line="194"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="prepare">
- <callback name="prepare">
- <source-position filename="libs/gst/base/gstbasesink.h" line="197"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="prepare_list">
- <callback name="prepare_list">
- <source-position filename="libs/gst/base/gstbasesink.h" line="198"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="buffer_list" transfer-ownership="none">
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="preroll">
- <callback name="preroll">
- <source-position filename="libs/gst/base/gstbasesink.h" line="201"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="render">
- <callback name="render">
- <source-position filename="libs/gst/base/gstbasesink.h" line="202"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="render_list">
- <callback name="render_list">
- <source-position filename="libs/gst/base/gstbasesink.h" line="204"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="sink" transfer-ownership="none">
- <type name="BaseSink" c:type="GstBaseSink*"/>
- </parameter>
- <parameter name="buffer_list" transfer-ownership="none">
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="BaseSinkPrivate" c:type="GstBaseSinkPrivate" disguised="1">
- <source-position filename="libs/gst/base/gstbasesink.h" line="63"/>
- </record>
- <class name="BaseSrc"
- c:symbol-prefix="base_src"
- c:type="GstBaseSrc"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstBaseSrc"
- glib:get-type="gst_base_src_get_type"
- glib:type-struct="BaseSrcClass">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="23">This is a generic base class for source elements. The following
-types of sources are supported:
-
- * random access sources like files
- * seekable sources
- * live sources
-
-The source can be configured to operate in any #GstFormat with the
-gst_base_src_set_format() method. The currently set format determines
-the format of the internal #GstSegment and any %GST_EVENT_SEGMENT
-events. The default format for #GstBaseSrc is %GST_FORMAT_BYTES.
-
-#GstBaseSrc always supports push mode scheduling. If the following
-conditions are met, it also supports pull mode scheduling:
-
- * The format is set to %GST_FORMAT_BYTES (default).
- * #GstBaseSrcClass.is_seekable() returns %TRUE.
-
-If all the conditions are met for operating in pull mode, #GstBaseSrc is
-automatically seekable in push mode as well. The following conditions must
-be met to make the element seekable in push mode when the format is not
-%GST_FORMAT_BYTES:
-
-* #GstBaseSrcClass.is_seekable() returns %TRUE.
-* #GstBaseSrcClass.query() can convert all supported seek formats to the
- internal format as set with gst_base_src_set_format().
-* #GstBaseSrcClass.do_seek() is implemented, performs the seek and returns
- %TRUE.
-
-When the element does not meet the requirements to operate in pull mode, the
-offset and length in the #GstBaseSrcClass.create() method should be ignored.
-It is recommended to subclass #GstPushSrc instead, in this situation. If the
-element can operate in pull mode but only with specific offsets and
-lengths, it is allowed to generate an error when the wrong values are passed
-to the #GstBaseSrcClass.create() function.
-
-#GstBaseSrc has support for live sources. Live sources are sources that when
-paused discard data, such as audio or video capture devices. A typical live
-source also produces data at a fixed rate and thus provides a clock to publish
-this rate.
-Use gst_base_src_set_live() to activate the live source mode.
-
-A live source does not produce data in the PAUSED state. This means that the
-#GstBaseSrcClass.create() method will not be called in PAUSED but only in
-PLAYING. To signal the pipeline that the element will not produce data, the
-return value from the READY to PAUSED state will be
-%GST_STATE_CHANGE_NO_PREROLL.
-
-A typical live source will timestamp the buffers it creates with the
-current running time of the pipeline. This is one reason why a live source
-can only produce data in the PLAYING state, when the clock is actually
-distributed and running.
-
-Live sources that synchronize and block on the clock (an audio source, for
-example) can use gst_base_src_wait_playing() when the
-#GstBaseSrcClass.create() function was interrupted by a state change to
-PAUSED.
-
-The #GstBaseSrcClass.get_times() method can be used to implement pseudo-live
-sources. It only makes sense to implement the #GstBaseSrcClass.get_times()
-function if the source is a live source. The #GstBaseSrcClass.get_times()
-function should return timestamps starting from 0, as if it were a non-live
-source. The base class will make sure that the timestamps are transformed
-into the current running_time. The base source will then wait for the
-calculated running_time before pushing out the buffer.
-
-For live sources, the base class will by default report a latency of 0.
-For pseudo live sources, the base class will by default measure the difference
-between the first buffer timestamp and the start time of get_times and will
-report this value as the latency.
-Subclasses should override the query function when this behaviour is not
-acceptable.
-
-There is only support in #GstBaseSrc for exactly one source pad, which
-should be named "src". A source implementation (subclass of #GstBaseSrc)
-should install a pad template in its class_init function, like so:
-|[&lt;!-- language="C" --&gt;
-static void
-my_element_class_init (GstMyElementClass *klass)
-{
- GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
- // srctemplate should be a #GstStaticPadTemplate with direction
- // %GST_PAD_SRC and name "src"
- gst_element_class_add_static_pad_template (gstelement_class, &amp;amp;srctemplate);
-
- gst_element_class_set_static_metadata (gstelement_class,
- "Source name",
- "Source",
- "My Source element",
- "The author &lt;my.sink@my.email&gt;");
-}
-]|
-
-## Controlled shutdown of live sources in applications
-
-Applications that record from a live source may want to stop recording
-in a controlled way, so that the recording is stopped, but the data
-already in the pipeline is processed to the end (remember that many live
-sources would go on recording forever otherwise). For that to happen the
-application needs to make the source stop recording and send an EOS
-event down the pipeline. The application would then wait for an
-EOS message posted on the pipeline's bus to know when all data has
-been processed and the pipeline can safely be stopped.
-
-An application may send an EOS event to a source element to make it
-perform the EOS logic (send EOS event downstream or post a
-%GST_MESSAGE_SEGMENT_DONE on the bus). This can typically be done
-with the gst_element_send_event() function on the element or its parent bin.
-
-After the EOS has been sent to the element, the application should wait for
-an EOS message to be posted on the pipeline's bus. Once this EOS message is
-received, it may safely shut down the entire pipeline.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="254"/>
- <virtual-method name="alloc">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="246"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="create">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.h"
- line="235">Ask the subclass to create a buffer with @offset and @size, the default
-implementation will call alloc and fill.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="242"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="buf"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="decide_allocation">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="192"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="do_seek">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="221"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="segment" transfer-ownership="none">
- <type name="Gst.Segment" c:type="GstSegment*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="event">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="233"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="fill">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="249"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="fixate">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="187"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_caps">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.h"
- line="177">Called to get the caps to report.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="183"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="filter"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_size">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="211"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_times">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.h"
- line="198">Given @buffer, return @start and @end time when it should be pushed
-out. The base class will sync on the clock using these times.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="206"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="start"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="end"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="is_seekable">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="214"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="negotiate" invoker="negotiate" version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3459">Negotiates src pad caps with downstream elements.
-Unmarks GST_PAD_FLAG_NEED_RECONFIGURE in any case. But marks it again
-if #GstBaseSrcClass.negotiate() fails.
-
-Do not call this in the #GstBaseSrcClass.fill() vmethod. Call this in
-#GstBaseSrcClass.create() or in #GstBaseSrcClass.alloc(), _before_ any
-buffer is allocated.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="185"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3471">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3461">base source instance</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="prepare_seek_segment">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="218"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="seek" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="segment" transfer-ownership="none">
- <type name="Gst.Segment" c:type="GstSegment*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="query">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="230"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_caps" invoker="set_caps">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="981">Set new caps on the basesrc source pad.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="189"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="988">%TRUE if the caps could be set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="983">a #GstBaseSrc</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="984">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="195"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="196"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="unlock">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="225"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="unlock_stop">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="227"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <method name="get_allocator" c:identifier="gst_base_src_get_allocator">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="4075">Lets #GstBaseSrc sub-classes to know the memory @allocator
-used by the base class and its @params.
-
-Unref the @allocator after usage.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="322"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="4077">a #GstBaseSrc</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="allocator"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="4078">the #GstAllocator
-used</doc>
- <type name="Gst.Allocator" c:type="GstAllocator**"/>
- </parameter>
- <parameter name="params"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="4080">the #GstAllocationParams of @allocator</doc>
- <type name="Gst.AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_blocksize" c:identifier="gst_base_src_get_blocksize">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="785">Get the number of bytes that @src will push out with each buffer.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="300"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="791">the number of bytes pushed with each buffer.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="787">the source</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_buffer_pool"
- c:identifier="gst_base_src_get_buffer_pool">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="319"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="4057">the instance of the #GstBufferPool used
-by the src; unref it after usage.</doc>
- <type name="Gst.BufferPool" c:type="GstBufferPool*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="4055">a #GstBaseSrc</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_do_timestamp"
- c:identifier="gst_base_src_get_do_timestamp">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="829">Query if @src timestamps outgoing buffers based on the current running_time.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="306"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="835">%TRUE if the base class will automatically timestamp outgoing buffers.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="831">the source</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_async" c:identifier="gst_base_src_is_async">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="695">Get the current async behaviour of @src. See also gst_base_src_set_async().</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="281"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="701">%TRUE if @src is operating in async mode.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="697">base source instance</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_live" c:identifier="gst_base_src_is_live">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="586">Check if an element is in live mode.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="266"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="592">%TRUE if element is in live mode.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="588">base source instance</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="negotiate"
- c:identifier="gst_base_src_negotiate"
- version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3459">Negotiates src pad caps with downstream elements.
-Unmarks GST_PAD_FLAG_NEED_RECONFIGURE in any case. But marks it again
-if #GstBaseSrcClass.negotiate() fails.
-
-Do not call this in the #GstBaseSrcClass.fill() vmethod. Call this in
-#GstBaseSrcClass.create() or in #GstBaseSrcClass.alloc(), _before_ any
-buffer is allocated.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="284"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3471">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3461">base source instance</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="new_seamless_segment"
- c:identifier="gst_base_src_new_seamless_segment"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="851">Prepare a new seamless segment for emission downstream. This function must
-only be called by derived sub-classes, and only from the #GstBaseSrcClass::create function,
-as the stream-lock needs to be held.
-
-The format for the new segment will be the current format of the source, as
-configured with gst_base_src_set_format()</doc>
- <doc-deprecated xml:space="preserve">Use gst_base_src_new_segment()</doc-deprecated>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="309"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="865">%TRUE if preparation of the seamless segment succeeded.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="853">The source</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="854">The new start value for the segment</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="stop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="855">Stop value for the new segment</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="856">The new time value for the start of the new segment</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="new_segment"
- c:identifier="gst_base_src_new_segment"
- version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="901">Prepare a new segment for emission downstream. This function must
-only be called by derived sub-classes, and only from the #GstBaseSrcClass::create function,
-as the stream-lock needs to be held.
-
-The format for the @segment must be identical with the current format
-of the source, as configured with gst_base_src_set_format().
-
-The format of @src must not be %GST_FORMAT_UNDEFINED and the format
-should be configured via gst_base_src_set_format() before calling this method.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="312"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="916">%TRUE if preparation of new segment succeeded.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="903">a #GstBaseSrc</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="904">a pointer to a #GstSegment</doc>
- <type name="Gst.Segment" c:type="const GstSegment*"/>
- </parameter>
- </parameters>
- </method>
- <method name="query_latency" c:identifier="gst_base_src_query_latency">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="718">Query the source for the latency parameters. @live will be %TRUE when @src is
-configured as a live source. @min_latency and @max_latency will be set
-to the difference between the running time and the timestamp of the first
-buffer.
-
-This function is mostly used by subclasses.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="293"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="732">%TRUE if the query succeeded.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="720">the source</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="live"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="721">if the source is live</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="min_latency"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="722">the min latency of the source</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="max_latency"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="723">the max latency of the source</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_async" c:identifier="gst_base_src_set_async">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="675">Configure async behaviour in @src, no state change will block. The open,
-close, start, stop, play and pause virtual methods will be executed in a
-different thread and are thus allowed to perform blocking operations. Any
-blocking operation should be unblocked with the unlock vmethod.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="278"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="677">base source instance</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="async" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="678">new async mode</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_automatic_eos"
- c:identifier="gst_base_src_set_automatic_eos"
- version="1.4">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="649">If @automatic_eos is %TRUE, @src will automatically go EOS if a buffer
-after the total size is returned. By default this is %TRUE but sources
-that can't return an authoritative size and only know that they're EOS
-when trying to read more should set this to %FALSE.
-
-When @src operates in %GST_FORMAT_TIME, #GstBaseSrc will send an EOS
-when a buffer outside of the currently configured segment is pushed if
-@automatic_eos is %TRUE. Since 1.16, if @automatic_eos is %FALSE an
-EOS will be pushed only when the #GstBaseSrcClass.create() implementation
-returns %GST_FLOW_EOS.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="275"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="651">base source instance</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="automatic_eos" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="652">automatic eos</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_blocksize" c:identifier="gst_base_src_set_blocksize">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="767">Set the number of bytes that @src will push out with each buffer. When
-@blocksize is set to -1, a default length will be used.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="297"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="769">the source</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="blocksize" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="770">the new blocksize in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_caps" c:identifier="gst_base_src_set_caps">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="981">Set new caps on the basesrc source pad.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="316"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="988">%TRUE if the caps could be set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="983">a #GstBaseSrc</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="984">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_do_timestamp"
- c:identifier="gst_base_src_set_do_timestamp">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="808">Configure @src to automatically timestamp outgoing buffers based on the
-current running_time of the pipeline. This property is mostly useful for live
-sources.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="303"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="810">the source</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="811">enable or disable timestamping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_dynamic_size"
- c:identifier="gst_base_src_set_dynamic_size">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="632">If not @dynamic, size is only updated when needed, such as when trying to
-read past current tracked size. Otherwise, size is checked for upon each
-read.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="272"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="634">base source instance</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="dynamic" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="635">new dynamic size mode</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_format" c:identifier="gst_base_src_set_format">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="608">Sets the default format of the source. This will be the format used
-for sending SEGMENT events and for performing seeks.
-
-If a format of GST_FORMAT_BYTES is set, the element will be able to
-operate in pull mode if the #GstBaseSrcClass.is_seekable() returns %TRUE.
-
-This function must only be called in states &lt; %GST_STATE_PAUSED.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="269"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="610">base source instance</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="611">the format to use</doc>
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_live" c:identifier="gst_base_src_set_live">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="562">If the element listens to a live source, @live should
-be set to %TRUE.
-
-A live source will not produce data in the PAUSED state and
-will therefore not be able to participate in the PREROLL phase
-of a pipeline. To signal this fact to the application and the
-pipeline, the state change return value of the live source will
-be GST_STATE_CHANGE_NO_PREROLL.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="263"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="564">base source instance</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="live" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="565">new live-mode</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="start_complete" c:identifier="gst_base_src_start_complete">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3563">Complete an asynchronous start operation. When the subclass overrides the
-start method, it should call gst_base_src_start_complete() when the start
-operation completes either from the same thread or from an asynchronous
-helper thread.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="287"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="basesrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3565">base source instance</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="ret" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3566">a #GstFlowReturn</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </parameter>
- </parameters>
- </method>
- <method name="start_wait" c:identifier="gst_base_src_start_wait">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3703">Wait until the start operation completes.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="290"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3709">a #GstFlowReturn.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="basesrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3705">base source instance</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="submit_buffer_list"
- c:identifier="gst_base_src_submit_buffer_list"
- version="1.14">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="4103">Subclasses can call this from their create virtual method implementation
-to submit a buffer list to be pushed out later. This is useful in
-cases where the create function wants to produce multiple buffers to be
-pushed out in one go in form of a #GstBufferList, which can reduce overhead
-drastically, especially for packetised inputs (for data streams where
-the packetisation/chunking is not important it is usually more efficient
-to return larger buffers instead).
-
-Subclasses that use this function from their create function must return
-%GST_FLOW_OK and no buffer from their create virtual method implementation.
-If a buffer is returned after a buffer list has also been submitted via this
-function the behaviour is undefined.
-
-Subclasses must only call this function once per create function call and
-subclasses must only call this function when the source operates in push
-mode.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="327"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="4105">a #GstBaseSrc</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- <parameter name="buffer_list" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="4106">a #GstBufferList</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </method>
- <method name="wait_playing" c:identifier="gst_base_src_wait_playing">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="532">If the #GstBaseSrcClass.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.
-
-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_FLUSHING).</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="260"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="545">%GST_FLOW_OK if @src is PLAYING and processing can
-continue. Any other return value should be returned from the create vmethod.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="534">the src</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </instance-parameter>
- </parameters>
- </method>
- <property name="blocksize" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="do-timestamp" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="num-buffers" writable="1" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <property name="typefind" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="element">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="srcpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="live_lock">
- <type name="GLib.Mutex" c:type="GMutex"/>
- </field>
- <field name="live_cond">
- <type name="GLib.Cond" c:type="GCond"/>
- </field>
- <field name="is_live">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="live_running">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="blocksize">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="can_activate_push">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="random_access">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="clock_id">
- <type name="Gst.ClockID" c:type="GstClockID"/>
- </field>
- <field name="segment">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="need_newsegment">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="num_buffers">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="num_buffers_left">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="typefind">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="running">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="pending_seek">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </field>
- <field name="priv">
- <type name="BaseSrcPrivate" c:type="GstBaseSrcPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="BaseSrcClass"
- c:type="GstBaseSrcClass"
- glib:is-gtype-struct-for="BaseSrc">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.h"
- line="117">Subclasses can override any of the available virtual methods or not, as
-needed. At the minimum, the @create method should be overridden to produce
-buffers.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="254"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.h"
- line="119">Element parent class</doc>
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="get_caps">
- <callback name="get_caps">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="183"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="filter"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="negotiate">
- <callback name="negotiate">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="185"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3471">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="3461">base source instance</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="fixate">
- <callback name="fixate">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="187"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_caps">
- <callback name="set_caps">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="189"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="988">%TRUE if the caps could be set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="983">a #GstBaseSrc</doc>
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.c"
- line="984">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="decide_allocation">
- <callback name="decide_allocation">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="192"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="start">
- <callback name="start">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="195"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="196"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_times">
- <callback name="get_times">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="206"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="start"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="end"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_size">
- <callback name="get_size">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="211"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="is_seekable">
- <callback name="is_seekable">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="214"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="prepare_seek_segment">
- <callback name="prepare_seek_segment">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="218"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="seek" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="segment" transfer-ownership="none">
- <type name="Gst.Segment" c:type="GstSegment*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="do_seek">
- <callback name="do_seek">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="221"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="segment" transfer-ownership="none">
- <type name="Gst.Segment" c:type="GstSegment*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="unlock">
- <callback name="unlock">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="225"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="unlock_stop">
- <callback name="unlock_stop">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="227"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="query">
- <callback name="query">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="230"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="event">
- <callback name="event">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="233"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="create">
- <callback name="create">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="242"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="buf"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="alloc">
- <callback name="alloc">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="246"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="fill">
- <callback name="fill">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="249"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="BaseSrc" c:type="GstBaseSrc*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <bitfield name="BaseSrcFlags" c:type="GstBaseSrcFlags">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.h"
- line="40">The #GstElement flags that a basesrc element may have.</doc>
- <source-position filename="libs/gst/base/gstbasesrc.h" line="53"/>
- <member name="starting"
- value="16384"
- c:identifier="GST_BASE_SRC_FLAG_STARTING">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.h"
- line="42">has source is starting</doc>
- </member>
- <member name="started"
- value="32768"
- c:identifier="GST_BASE_SRC_FLAG_STARTED">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.h"
- line="43">has source been started</doc>
- </member>
- <member name="last"
- value="1048576"
- c:identifier="GST_BASE_SRC_FLAG_LAST">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasesrc.h"
- line="44">offset to define more flags</doc>
- </member>
- </bitfield>
- <record name="BaseSrcPrivate" c:type="GstBaseSrcPrivate" disguised="1">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="60"/>
- </record>
- <class name="BaseTransform"
- c:symbol-prefix="base_transform"
- c:type="GstBaseTransform"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstBaseTransform"
- glib:get-type="gst_base_transform_get_type"
- glib:type-struct="BaseTransformClass">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="24">This base class is for filter elements that process data. Elements
-that are suitable for implementation using #GstBaseTransform are ones
-where the size and caps of the output is known entirely from the input
-caps and buffer sizes. These include elements that directly transform
-one buffer into another, modify the contents of a buffer in-place, as
-well as elements that collate multiple input buffers into one output buffer,
-or that expand one input buffer into multiple output buffers. See below
-for more concrete use cases.
-
-It provides for:
-
-* one sinkpad and one srcpad
-* Possible formats on sink and source pad implemented
- with custom transform_caps function. By default uses
- same format on sink and source.
-
-* Handles state changes
-* Does flushing
-* Push mode
-* Pull mode if the sub-class transform can operate on arbitrary data
-
-# Use Cases
-
-## Passthrough mode
-
- * Element has no interest in modifying the buffer. It may want to inspect it,
- in which case the element should have a transform_ip function. If there
- is no transform_ip function in passthrough mode, the buffer is pushed
- intact.
-
- * The #GstBaseTransformClass.passthrough_on_same_caps variable
- will automatically set/unset passthrough based on whether the
- element negotiates the same caps on both pads.
-
- * #GstBaseTransformClass.passthrough_on_same_caps on an element that
- doesn't implement a transform_caps function is useful for elements that
- only inspect data (such as level)
-
- * Example elements
-
- * Level
- * Videoscale, audioconvert, videoconvert, audioresample in certain modes.
-
-## Modifications in-place - input buffer and output buffer are the same thing.
-
-* The element must implement a transform_ip function.
-* Output buffer size must &lt;= input buffer size
-* If the always_in_place flag is set, non-writable buffers will be copied
- and passed to the transform_ip function, otherwise a new buffer will be
- created and the transform function called.
-
-* Incoming writable buffers will be passed to the transform_ip function
- immediately.
-* only implementing transform_ip and not transform implies always_in_place = %TRUE
-
- * Example elements:
- * Volume
- * Audioconvert in certain modes (signed/unsigned conversion)
- * videoconvert in certain modes (endianness swapping)
-
-## Modifications only to the caps/metadata of a buffer
-
-* The element does not require writable data, but non-writable buffers
- should be subbuffered so that the meta-information can be replaced.
-
-* Elements wishing to operate in this mode should replace the
- prepare_output_buffer method to create subbuffers of the input buffer
- and set always_in_place to %TRUE
-
-* Example elements
- * Capsfilter when setting caps on outgoing buffers that have
- none.
- * identity when it is going to re-timestamp buffers by
- datarate.
-
-## Normal mode
- * always_in_place flag is not set, or there is no transform_ip function
- * Element will receive an input buffer and output buffer to operate on.
- * Output buffer is allocated by calling the prepare_output_buffer function.
- * Example elements:
- * Videoscale, videoconvert, audioconvert when doing
- scaling/conversions
-
-## Special output buffer allocations
- * Elements which need to do special allocation of their output buffers
- beyond allocating output buffers via the negotiated allocator or
- buffer pool should implement the prepare_output_buffer method.
-
- * Example elements:
- * efence
-
-# Sub-class settable flags on GstBaseTransform
-
-* passthrough
-
- * Implies that in the current configuration, the sub-class is not interested in modifying the buffers.
- * Elements which are always in passthrough mode whenever the same caps has been negotiated on both pads can set the class variable passthrough_on_same_caps to have this behaviour automatically.
-
-* always_in_place
- * Determines whether a non-writable buffer will be copied before passing
- to the transform_ip function.
-
- * Implied %TRUE if no transform function is implemented.
- * Implied %FALSE if ONLY transform function is implemented.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h" line="302"/>
- <virtual-method name="accept_caps">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="232"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="direction" transfer-ownership="none">
- <type name="Gst.PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="before_transform">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="285"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="copy_metadata">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="280"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="input" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="outbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="decide_allocation">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="240"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="filter_meta">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="241"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="api" transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="params" transfer-ownership="none">
- <type name="Gst.Structure" c:type="const GstStructure*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="fixate_caps">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="229"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="direction" transfer-ownership="none">
- <type name="Gst.PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="othercaps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="generate_output">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="298"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="outbuf"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_unit_size">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="261"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="prepare_output_buffer">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="276"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="input" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="outbuf"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="propose_allocation">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="245"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="decide_query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="query">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="236"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="direction" transfer-ownership="none">
- <type name="Gst.PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_caps">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="234"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="incaps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="outcaps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_event">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="269"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_event">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="270"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="265"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="266"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="submit_input_buffer">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="292"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="is_discont" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="input" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="transform">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="288"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="inbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="outbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="transform_caps">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="226"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="direction" transfer-ownership="none">
- <type name="Gst.PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="transform_ip">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="290"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="transform_meta">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="282"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="outbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="meta" transfer-ownership="none">
- <type name="Gst.Meta" c:type="GstMeta*"/>
- </parameter>
- <parameter name="inbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="transform_size">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="252"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="direction" transfer-ownership="none">
- <type name="Gst.PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="othercaps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="othersize"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="get_allocator"
- c:identifier="gst_base_transform_get_allocator">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2864">Lets #GstBaseTransform sub-classes know the memory @allocator
-used by the base class and its @params.
-
-Unref the @allocator after use.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="340"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2866">a #GstBaseTransform</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="allocator"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2867">the #GstAllocator
-used</doc>
- <type name="Gst.Allocator" c:type="GstAllocator**"/>
- </parameter>
- <parameter name="params"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2869">the #GstAllocationParams of @allocator</doc>
- <type name="Gst.AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_buffer_pool"
- c:identifier="gst_base_transform_get_buffer_pool">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="337"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2850">the instance of the #GstBufferPool used
-by @trans; free it after use</doc>
- <type name="Gst.BufferPool" c:type="GstBufferPool*"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2848">a #GstBaseTransform</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_in_place" c:identifier="gst_base_transform_is_in_place">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2656">See if @trans is configured as a in_place transform.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="317"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2662">%TRUE if the transform is configured in in_place mode.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2658">the #GstBaseTransform to query</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_passthrough"
- c:identifier="gst_base_transform_is_passthrough">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2592">See if @trans is configured as a passthrough transform.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="311"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2598">%TRUE if the transform is configured in passthrough mode.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2594">the #GstBaseTransform to query</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_qos_enabled"
- c:identifier="gst_base_transform_is_qos_enabled">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2731">Queries if the transform will handle QoS.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="328"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2737">%TRUE if QoS is enabled.
-
-MT safe.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2733">a #GstBaseTransform</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reconfigure"
- c:identifier="gst_base_transform_reconfigure"
- version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="1447">Negotiates src pad caps with downstream elements if the source pad is
-marked as needing reconfiguring. Unmarks GST_PAD_FLAG_NEED_RECONFIGURE in
-any case. But marks it again if negotiation fails.
-
-Do not call this in the #GstBaseTransformClass.transform() or
-#GstBaseTransformClass.transform_ip() vmethod. Call this in
-#GstBaseTransformClass.submit_input_buffer(),
-#GstBaseTransformClass.prepare_output_buffer() or in
-#GstBaseTransformClass.generate_output() _before_ any output buffer is
-allocated.
-
-It will be default be called when handling an ALLOCATION query or at the
-very beginning of the default #GstBaseTransformClass.submit_input_buffer()
-implementation.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="354"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="1466">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="1449">the #GstBaseTransform to set</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reconfigure_sink"
- c:identifier="gst_base_transform_reconfigure_sink">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2811">Instructs @trans to request renegotiation upstream. This function is
-typically called after properties on the transform were set that
-influence the input format.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="344"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2813">a #GstBaseTransform</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reconfigure_src"
- c:identifier="gst_base_transform_reconfigure_src">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2830">Instructs @trans to renegotiate a new downstream transform on the next
-buffer. This function is typically called after properties on the transform
-were set that influence the output format.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="347"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2832">a #GstBaseTransform</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_gap_aware"
- c:identifier="gst_base_transform_set_gap_aware">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2755">If @gap_aware is %FALSE (the default), output buffers will have the
-%GST_BUFFER_FLAG_GAP flag unset.
-
-If set to %TRUE, the element must handle output buffers with this flag set
-correctly, i.e. it can assume that the buffer contains neutral data but must
-unset the flag if the output is no neutral data.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="331"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2757">a #GstBaseTransform</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="gap_aware" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2758">New state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_in_place"
- c:identifier="gst_base_transform_set_in_place">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2616">Determines whether a non-writable buffer will be copied before passing
-to the transform_ip function.
-
- * Always %TRUE if no transform function is implemented.
- * Always %FALSE if ONLY transform function is implemented.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="314"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2618">the #GstBaseTransform to modify</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="in_place" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2619">Boolean value indicating that we would like to operate
-on in_place buffers.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_passthrough"
- c:identifier="gst_base_transform_set_passthrough">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2556">Set passthrough mode for this filter by default. This is mostly
-useful for filters that do not care about negotiation.
-
-Always %TRUE for filters which don't implement either a transform
-or transform_ip or generate_output method.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="308"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2558">the #GstBaseTransform to set</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="passthrough" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2559">boolean indicating passthrough mode.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_prefer_passthrough"
- c:identifier="gst_base_transform_set_prefer_passthrough"
- version="1.0.1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2780">If @prefer_passthrough is %TRUE (the default), @trans will check and
-prefer passthrough caps from the list of caps returned by the
-transform_caps vmethod.
-
-If set to %FALSE, the element must order the caps returned from the
-transform_caps function in such a way that the preferred format is
-first in the list. This can be interesting for transforms that can do
-passthrough transforms but prefer to do something else, like a
-capsfilter.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="334"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2782">a #GstBaseTransform</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="prefer_passthrough" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2783">New state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_qos_enabled"
- c:identifier="gst_base_transform_set_qos_enabled">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2710">Enable or disable QoS handling in the transform.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="325"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2712">a #GstBaseTransform</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2713">new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="update_qos" c:identifier="gst_base_transform_update_qos">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2680">Set the QoS parameters in the transform. This function is called internally
-when a QOS event is received but subclasses can provide custom information
-when needed.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="320"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2682">a #GstBaseTransform</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="proportion" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2683">the proportion</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="diff" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2684">the diff against the clock</doc>
- <type name="Gst.ClockTimeDiff" c:type="GstClockTimeDiff"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2685">the timestamp of the buffer generating the QoS expressed in
-running_time.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="update_src_caps"
- c:identifier="gst_base_transform_update_src_caps"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2890">Updates the srcpad caps and sends the caps downstream. This function
-can be used by subclasses when they have already negotiated their caps
-but found a change in them (or computed new information). This way,
-they can notify downstream about that change without losing any
-buffer.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="350"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2902">%TRUE if the caps could be sent downstream %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2892">a #GstBaseTransform</doc>
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </instance-parameter>
- <parameter name="updated_caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.c"
- line="2893">An updated version of the srcpad caps to be pushed
-downstream</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <property name="qos" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="element">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="sinkpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="srcpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="have_segment">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="segment">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="queued_buf">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="BaseTransformPrivate" c:type="GstBaseTransformPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="19">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="BaseTransformClass"
- c:type="GstBaseTransformClass"
- glib:is-gtype-struct-for="BaseTransform">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.h"
- line="104">Subclasses can override any of the available virtual methods or not, as
-needed. At minimum either @transform or @transform_ip need to be overridden.
-If the element can overwrite the input data with the results (data is of the
-same type and quantity) it should provide @transform_ip.</doc>
- <source-position filename="libs/gst/base/gstbasetransform.h" line="302"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.h"
- line="106">Element parent class</doc>
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="passthrough_on_same_caps">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.h"
- line="107">If set to %TRUE, passthrough mode will be
- automatically enabled if the caps are the same.
- Set to %FALSE by default.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="transform_ip_on_passthrough">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbasetransform.h"
- line="110">If set to %TRUE, @transform_ip will be called in
- passthrough mode. The passed buffer might not be
- writable. When %FALSE, neither @transform nor
- @transform_ip will be called in passthrough mode.
- Set to %TRUE by default.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="transform_caps">
- <callback name="transform_caps">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="226"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="direction" transfer-ownership="none">
- <type name="Gst.PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="fixate_caps">
- <callback name="fixate_caps">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="229"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="direction" transfer-ownership="none">
- <type name="Gst.PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="othercaps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="accept_caps">
- <callback name="accept_caps">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="232"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="direction" transfer-ownership="none">
- <type name="Gst.PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_caps">
- <callback name="set_caps">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="234"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="incaps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="outcaps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="query">
- <callback name="query">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="236"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="direction" transfer-ownership="none">
- <type name="Gst.PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="decide_allocation">
- <callback name="decide_allocation">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="240"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="filter_meta">
- <callback name="filter_meta">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="241"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="api" transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </parameter>
- <parameter name="params" transfer-ownership="none">
- <type name="Gst.Structure" c:type="const GstStructure*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="propose_allocation">
- <callback name="propose_allocation">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="245"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="decide_query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="transform_size">
- <callback name="transform_size">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="252"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="direction" transfer-ownership="none">
- <type name="Gst.PadDirection" c:type="GstPadDirection"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="othercaps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="othersize"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_unit_size">
- <callback name="get_unit_size">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="261"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="start">
- <callback name="start">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="265"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="266"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_event">
- <callback name="sink_event">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="269"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_event">
- <callback name="src_event">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="270"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="prepare_output_buffer">
- <callback name="prepare_output_buffer">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="276"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="input" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="outbuf"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="copy_metadata">
- <callback name="copy_metadata">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="280"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="input" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="outbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="transform_meta">
- <callback name="transform_meta">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="282"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="outbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="meta" transfer-ownership="none">
- <type name="Gst.Meta" c:type="GstMeta*"/>
- </parameter>
- <parameter name="inbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="before_transform">
- <callback name="before_transform">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="285"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="transform">
- <callback name="transform">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="288"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="inbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="outbuf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="transform_ip">
- <callback name="transform_ip">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="290"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="submit_input_buffer">
- <callback name="submit_input_buffer">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="292"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="is_discont" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="input" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="generate_output">
- <callback name="generate_output">
- <source-position filename="libs/gst/base/gstbasetransform.h"
- line="298"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="BaseTransform" c:type="GstBaseTransform*"/>
- </parameter>
- <parameter name="outbuf"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="18">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="BaseTransformPrivate"
- c:type="GstBaseTransformPrivate"
- disguised="1">
- <source-position filename="libs/gst/base/gstbasetransform.h" line="76"/>
- </record>
- <record name="BitReader" c:type="GstBitReader">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="30">#GstBitReader provides a bit reader that can read any number of bits
-from a memory buffer. It provides functions for reading any number of bits
-into 8, 16, 32 and 64 bit variables.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="52"/>
- <field name="data" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.h"
- line="35">Data from which the bit reader will
- read</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.h"
- line="37">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="byte" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.h"
- line="38">Current byte position</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="bit" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.h"
- line="39">Bit position in the current byte</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="free" c:identifier="gst_bit_reader_free">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="74">Frees a #GstBitReader instance, which was previously allocated by
-gst_bit_reader_new().</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="58"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="76">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="GstBitReader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_bits_uint16"
- c:identifier="gst_bit_reader_get_bits_uint16">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="214">Read @nbits bits into @val and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="85"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="222">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="216">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="GstBitReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="217">Pointer to a #guint16 to store the result</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="218">number of bits to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_bits_uint32"
- c:identifier="gst_bit_reader_get_bits_uint32">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="225">Read @nbits bits into @val and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="88"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="233">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="227">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="GstBitReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="228">Pointer to a #guint32 to store the result</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="229">number of bits to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_bits_uint64"
- c:identifier="gst_bit_reader_get_bits_uint64">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="236">Read @nbits bits into @val and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="91"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="244">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="238">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="GstBitReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="239">Pointer to a #guint64 to store the result</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="240">number of bits to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_bits_uint8"
- c:identifier="gst_bit_reader_get_bits_uint8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="203">Read @nbits bits into @val and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="82"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="211">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="205">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="GstBitReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="206">Pointer to a #guint8 to store the result</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="207">number of bits to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pos" c:identifier="gst_bit_reader_get_pos">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="132">Returns the current position of a #GstBitReader instance in bits.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="138">The current position of @reader in bits.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="134">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="const GstBitReader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_remaining" c:identifier="gst_bit_reader_get_remaining">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="146">Returns the remaining number of bits of a #GstBitReader instance.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="70"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="152">The remaining number of bits of @reader instance.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="148">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="const GstBitReader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_size" c:identifier="gst_bit_reader_get_size">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="160">Returns the total number of bits of a #GstBitReader instance.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="73"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="166">The total number of bits of @reader instance.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="162">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="const GstBitReader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_bit_reader_init">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="89">Initializes a #GstBitReader instance to read from @data. This function
-can be called on already initialized instances.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="61"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="91">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="GstBitReader*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="92">data from which the bit reader should read</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="93">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_bits_uint16"
- c:identifier="gst_bit_reader_peek_bits_uint16">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="258">Read @nbits bits into @val but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="97"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="266">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="260">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="const GstBitReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="261">Pointer to a #guint16 to store the result</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="262">number of bits to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_bits_uint32"
- c:identifier="gst_bit_reader_peek_bits_uint32">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="269">Read @nbits bits into @val but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="100"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="277">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="271">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="const GstBitReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="272">Pointer to a #guint32 to store the result</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="273">number of bits to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_bits_uint64"
- c:identifier="gst_bit_reader_peek_bits_uint64">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="280">Read @nbits bits into @val but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="103"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="288">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="282">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="const GstBitReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="283">Pointer to a #guint64 to store the result</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="284">number of bits to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_bits_uint8"
- c:identifier="gst_bit_reader_peek_bits_uint8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="247">Read @nbits bits into @val but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="94"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="255">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="249">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="const GstBitReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="250">Pointer to a #guint8 to store the result</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="251">number of bits to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_pos" c:identifier="gst_bit_reader_set_pos">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="108">Sets the new position of a #GstBitReader instance to @pos in bits.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="64"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="115">%TRUE if the position could be set successfully, %FALSE
-otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="110">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="GstBitReader*"/>
- </instance-parameter>
- <parameter name="pos" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="111">The new position in bits</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="skip" c:identifier="gst_bit_reader_skip">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="174">Skips @nbits bits of the #GstBitReader instance.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="76"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="181">%TRUE if @nbits bits could be skipped, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="176">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="GstBitReader*"/>
- </instance-parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="177">the number of bits to skip</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="skip_to_byte" c:identifier="gst_bit_reader_skip_to_byte">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="189">Skips until the next byte.</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="79"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="195">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="191">a #GstBitReader instance</doc>
- <type name="BitReader" c:type="GstBitReader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="new"
- c:identifier="gst_bit_reader_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="51">Create a new #GstBitReader instance, which will read from @data.
-
-Free-function: gst_bit_reader_free</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="55"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="61">a new #GstBitReader instance</doc>
- <type name="BitReader" c:type="GstBitReader*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="53">Data from which the #GstBitReader
- should read</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="55">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <record name="BitWriter" c:type="GstBitWriter" version="1.16">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="30">#GstBitWriter provides a bit writer that can write any number of
-bits into a memory buffer. It provides functions for writing any
-number of bits into 8, 16, 32 and 64 bit variables.</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="58"/>
- <field name="data" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.h"
- line="41">Allocated @data for bit writer to write</doc>
- <type name="guint8" c:type="guint8*"/>
- </field>
- <field name="bit_size" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.h"
- line="42">Size of written @data in bits</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="bit_capacity" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="auto_grow" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="owned" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="align_bytes" c:identifier="gst_bit_writer_align_bytes">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="430">Write trailing bit to align last byte of @data. @trailing_bit can
-only be 1 or 0.</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="132"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="438">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="432">a #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- <parameter name="trailing_bit" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="433">trailing bits of last byte, 0 or 1</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_bit_writer_free">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="246">Frees @bitwriter and the allocated data inside.</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="71"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="248">#GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free_and_get_buffer"
- c:identifier="gst_bit_writer_free_and_get_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="286">Frees @bitwriter without destroying the internal data, which is
-returned as #GstBuffer.
-
-Free-function: gst_buffer_unref</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="77"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="295">a new allocated #GstBuffer wrapping the
- data inside. gst_buffer_unref() after usage.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="288">#GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free_and_get_data"
- c:identifier="gst_bit_writer_free_and_get_data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="261">Frees @bitwriter without destroying the internal data, which is
-returned.
-
-Free-function: g_free</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="74"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="270">the current data. g_free() after
- usage.</doc>
- <array zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="263">#GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_data" c:identifier="gst_bit_writer_get_data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="325">Get written data pointer</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="103"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="331">data pointer</doc>
- <type name="guint8" c:type="guint8*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="327">a #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="const GstBitWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_remaining" c:identifier="gst_bit_writer_get_remaining">
- <source-position filename="libs/gst/base/gstbitwriter.h" line="109"/>
- <return-value transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <type name="BitWriter" c:type="const GstBitWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_size" c:identifier="gst_bit_writer_get_size">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="311">Get size of written @data</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="100"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="317">size of bits written in @data</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="313">a #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="const GstBitWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init"
- c:identifier="gst_bit_writer_init"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="103">Initializes @bitwriter to an empty instance.</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="80"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="105">#GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init_with_data"
- c:identifier="gst_bit_writer_init_with_data"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="141">Initializes @bitwriter with the given memory area @data. IF
-@initialized is %TRUE it is possible to read @size bits from the
-#GstBitWriter from the beginning.</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="87"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="143">#GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="144">Memory area for writing</doc>
- <array length="1" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="145">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="initialized" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="146">If %TRUE the complete data can be read from the beginning</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="init_with_size"
- c:identifier="gst_bit_writer_init_with_size"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="119">Initializes a #GstBitWriter instance and allocates the given data
-@size.</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="83"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="121">#GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="122">the size on bytes to allocate for data</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="fixed" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="123">If %TRUE the data can't be reallocated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_bits_uint16"
- c:identifier="gst_bit_writer_put_bits_uint16">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="365">Write @nbits bits of @value to #GstBitWriter.</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="116"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="373">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="367">a #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="368">value of #guint16 to write</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="369">number of bits to write</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_bits_uint32"
- c:identifier="gst_bit_writer_put_bits_uint32">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="376">Write @nbits bits of @value to #GstBitWriter.</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="120"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="384">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="378">a #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="379">value of #guint32 to write</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="380">number of bits to write</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_bits_uint64"
- c:identifier="gst_bit_writer_put_bits_uint64">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="387">Write @nbits bits of @value to #GstBitWriter.</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="124"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="395">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="389">a #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="390">value of #guint64 to write</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="391">number of bits to write</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_bits_uint8"
- c:identifier="gst_bit_writer_put_bits_uint8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="354">Write @nbits bits of @value to #GstBitWriter.</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="362">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="356">a #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="357">value of #guint8 to write</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="nbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="358">number of bits to write</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_bytes" c:identifier="gst_bit_writer_put_bytes">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="413">Write @nbytes bytes of @data to #GstBitWriter.</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="128"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="421">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="415">a #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="416">pointer of data to write</doc>
- <type name="guint8" c:type="const guint8*"/>
- </parameter>
- <parameter name="nbytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="417">number of bytes to write</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="reset" c:identifier="gst_bit_writer_reset">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="167">Resets @bitwriter and frees the data if it's owned by @bitwriter.</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="91"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="169">#GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reset_and_get_buffer"
- c:identifier="gst_bit_writer_reset_and_get_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="209">Resets @bitwriter and returns the current data as #GstBuffer.
-
-Free-function: gst_buffer_unref</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="97"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="217">a new allocated #GstBuffer wrapping the
- current data. gst_buffer_unref() after usage.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="211">a #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reset_and_get_data"
- c:identifier="gst_bit_writer_reset_and_get_data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="183">Resets @bitwriter and returns the current data.
-
-Free-function: g_free</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="94"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="191">the current data. g_free() after
- usage.</doc>
- <array zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="185">a #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_pos" c:identifier="gst_bit_writer_set_pos">
- <source-position filename="libs/gst/base/gstbitwriter.h" line="106"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="bitwriter" transfer-ownership="none">
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </instance-parameter>
- <parameter name="pos" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <function name="new"
- c:identifier="gst_bit_writer_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="40">Creates a new, empty #GstBitWriter instance.
-
-Free-function: gst_bit_writer_free</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="61"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="47">a new, empty #GstByteWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </return-value>
- </function>
- <function name="new_with_data"
- c:identifier="gst_bit_writer_new_with_data"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="79">Creates a new #GstBitWriter instance with the given memory area. If
-@initialized is %TRUE it is possible to read @size bits from the
-#GstBitWriter from the beginning.
-
-Free-function: gst_bit_writer_free</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="67"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="91">a new #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="81">Memory area for writing</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="82">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="initialized" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="83">if %TRUE the complete data can be read from the beginning</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_with_size"
- c:identifier="gst_bit_writer_new_with_size"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="59">Creates a #GstBitWriter instance with the given initial data size.
-
-Free-function: gst_bit_writer_free</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="64"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="68">a new #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </return-value>
- <parameters>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="61">Initial size of data in bytes</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="fixed" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="62">If %TRUE the data can't be reallocated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <record name="ByteReader" c:type="GstByteReader">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="31">#GstByteReader provides a byte reader that can read different integer and
-floating point types from a memory buffer. It provides functions for reading
-signed/unsigned, little/big endian integers of 8, 16, 24, 32 and 64 bits
-and functions for reading little/big endian floating points numbers of
-32 and 64 bits. It also provides functions to read NUL-terminated strings
-in various character encodings.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="49"/>
- <field name="data" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.h"
- line="34">Data from which the bit reader will
- read</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.h"
- line="36">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="byte" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.h"
- line="37">Current byte position</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="dup_data" c:identifier="gst_byte_reader_dup_data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="843">Free-function: g_free
-
-Returns a newly-allocated copy of the current data
-position if at least @size bytes are left and
-updates the current position. Free with g_free() when no longer needed.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="216"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="856">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="845">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="846">Size in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="847">address of a
- #guint8 pointer variable in which to store the result</doc>
- <array length="0" zero-terminated="0" c:type="guint8**">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="dup_string_utf16"
- c:identifier="gst_byte_reader_dup_string_utf16">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1250">Free-function: g_free
-
-Returns a newly-allocated copy of the current data position if there is
-a NUL-terminated UTF-16 string in the data (this could be an empty string
-as well), and advances the current position.
-
-No input checking for valid UTF-16 is done. This function is endianness
-agnostic - you should not assume the UTF-16 characters are in host
-endianness.
-
-This function will fail if no NUL-terminator was found in in the data.
-
-Note: there is no peek or get variant of this function to ensure correct
-byte alignment of the UTF-16 string.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="231"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1271">%TRUE if a string could be read, %FALSE otherwise. The
- string put into @str must be freed with g_free() when no longer needed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1252">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="str"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1253">address of a
- #guint16 pointer variable in which to store the result</doc>
- <array c:type="guint16**">
- <type name="guint16" c:type="guint16*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="dup_string_utf32"
- c:identifier="gst_byte_reader_dup_string_utf32">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1276">Free-function: g_free
-
-Returns a newly-allocated copy of the current data position if there is
-a NUL-terminated UTF-32 string in the data (this could be an empty string
-as well), and advances the current position.
-
-No input checking for valid UTF-32 is done. This function is endianness
-agnostic - you should not assume the UTF-32 characters are in host
-endianness.
-
-This function will fail if no NUL-terminator was found in in the data.
-
-Note: there is no peek or get variant of this function to ensure correct
-byte alignment of the UTF-32 string.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="234"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1297">%TRUE if a string could be read, %FALSE otherwise. The
- string put into @str must be freed with g_free() when no longer needed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1278">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="str"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1279">address of a
- #guint32 pointer variable in which to store the result</doc>
- <array c:type="guint32**">
- <type name="guint32" c:type="guint32*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="dup_string_utf8"
- c:identifier="gst_byte_reader_dup_string_utf8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1230">Free-function: g_free
-
-FIXME:Reads (copies) a NUL-terminated string in the #GstByteReader instance,
-advancing the current position to the byte after the string. This will work
-for any NUL-terminated string with a character width of 8 bits, so ASCII,
-UTF-8, ISO-8859-N etc. No input checking for valid UTF-8 is done.
-
-This function will fail if no NUL-terminator was found in in the data.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="228"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1245">%TRUE if a string could be read into @str, %FALSE otherwise. The
- string put into @str must be freed with g_free() when no longer needed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1232">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="str"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1233">address of a
- #gchar pointer variable in which to store the result</doc>
- <array c:type="gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_byte_reader_free">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="109">Frees a #GstByteReader instance, which was previously allocated by
-gst_byte_reader_new().</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="55"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="111">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_data" c:identifier="gst_byte_reader_get_data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="803">Returns a constant pointer to the current data
-position if at least @size bytes are left and
-updates the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="219"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="814">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="805">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="806">Size in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="807">address of a
- #guint8 pointer variable in which to store the result</doc>
- <array length="0" zero-terminated="0" c:type="const guint8**">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="get_float32_be"
- c:identifier="gst_byte_reader_get_float32_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="730">Read a 32 bit big endian floating point value into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="195"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="738">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="732">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="733">Pointer to a #gfloat to store the result</doc>
- <type name="gfloat" c:type="gfloat*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_float32_le"
- c:identifier="gst_byte_reader_get_float32_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="708">Read a 32 bit little endian floating point value into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="192"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="716">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="710">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="711">Pointer to a #gfloat to store the result</doc>
- <type name="gfloat" c:type="gfloat*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_float64_be"
- c:identifier="gst_byte_reader_get_float64_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="774">Read a 64 bit big endian floating point value into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="201"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="782">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="776">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="777">Pointer to a #gdouble to store the result</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_float64_le"
- c:identifier="gst_byte_reader_get_float64_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="752">Read a 64 bit little endian floating point value into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="198"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="760">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="754">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="755">Pointer to a #gdouble to store the result</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int16_be" c:identifier="gst_byte_reader_get_int16_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="372">Read a signed 16 bit big endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="99"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="380">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="374">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="375">Pointer to a #gint16 to store the result</doc>
- <type name="gint16" c:type="gint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int16_le" c:identifier="gst_byte_reader_get_int16_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="328">Read a signed 16 bit little endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="93"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="336">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="330">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="331">Pointer to a #gint16 to store the result</doc>
- <type name="gint16" c:type="gint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int24_be" c:identifier="gst_byte_reader_get_int24_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="460">Read a signed 24 bit big endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="111"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="468">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="462">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="463">Pointer to a #gint32 to store the result</doc>
- <type name="gint32" c:type="gint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int24_le" c:identifier="gst_byte_reader_get_int24_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="416">Read a signed 24 bit little endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="105"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="424">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="418">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="419">Pointer to a #gint32 to store the result</doc>
- <type name="gint32" c:type="gint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int32_be" c:identifier="gst_byte_reader_get_int32_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="549">Read a signed 32 bit big endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="123"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="557">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="551">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="552">Pointer to a #gint32 to store the result</doc>
- <type name="gint32" c:type="gint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int32_le" c:identifier="gst_byte_reader_get_int32_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="505">Read a signed 32 bit little endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="117"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="513">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="507">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="508">Pointer to a #gint32 to store the result</doc>
- <type name="gint32" c:type="gint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int64_be" c:identifier="gst_byte_reader_get_int64_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="637">Read a signed 64 bit big endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="135"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="645">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="639">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="640">Pointer to a #gint64 to store the result</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int64_le" c:identifier="gst_byte_reader_get_int64_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="593">Read a signed 64 bit little endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="129"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="601">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="595">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="596">Pointer to a #gint64 to store the result</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_int8" c:identifier="gst_byte_reader_get_int8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="287">Read a signed 8 bit integer into @val and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="87"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="294">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="289">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="290">Pointer to a #gint8 to store the result</doc>
- <type name="gint8" c:type="gint8*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pos" c:identifier="gst_byte_reader_get_pos">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="217">Returns the current position of a #GstByteReader instance in bytes.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="72"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="223">The current position of @reader in bytes.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="219">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_remaining"
- c:identifier="gst_byte_reader_get_remaining">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="231">Returns the remaining number of bytes of a #GstByteReader instance.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="75"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="237">The remaining number of bytes of @reader instance.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="233">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_size" c:identifier="gst_byte_reader_get_size">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="245">Returns the total number of bytes of a #GstByteReader instance.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="78"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="251">The total number of bytes of @reader instance.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="247">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_string_utf8"
- c:identifier="gst_byte_reader_get_string_utf8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1174">Returns a constant pointer to the current data position if there is
-a NUL-terminated string in the data (this could be just a NUL terminator),
-advancing the current position to the byte after the string. This will work
-for any NUL-terminated string with a character width of 8 bits, so ASCII,
-UTF-8, ISO-8859-N etc.
-
-No input checking for valid UTF-8 is done.
-
-This function will fail if no NUL-terminator was found in in the data.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="255"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1190">%TRUE if a string could be found, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1176">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="str"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1177">address of a
- #gchar pointer variable in which to store the result</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="get_sub_reader"
- c:identifier="gst_byte_reader_get_sub_reader"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="169">Initializes a #GstByteReader sub-reader instance to contain @size bytes of
-data from the current position of @reader. This is useful to read chunked
-formats and make sure that one doesn't read beyond the size of the sub-chunk.
-
-Unlike gst_byte_reader_peek_sub_reader(), this function also modifies the
-position of @reader and moves it forward by @size bytes.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="65"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="182">FALSE on error or if @reader does not contain @size more bytes from
- the current position, and otherwise TRUE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="171">an existing and initialized #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="sub_reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="172">a #GstByteReader instance to initialize as sub-reader</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="173">size of @sub_reader in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint16_be"
- c:identifier="gst_byte_reader_get_uint16_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="361">Read an unsigned 16 bit big endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="96"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="369">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="363">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="364">Pointer to a #guint16 to store the result</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint16_le"
- c:identifier="gst_byte_reader_get_uint16_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="317">Read an unsigned 16 bit little endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="90"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="325">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="319">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="320">Pointer to a #guint16 to store the result</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint24_be"
- c:identifier="gst_byte_reader_get_uint24_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="449">Read an unsigned 24 bit big endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="457">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="451">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="452">Pointer to a #guint32 to store the result</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint24_le"
- c:identifier="gst_byte_reader_get_uint24_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="405">Read an unsigned 24 bit little endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="102"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="413">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="407">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="408">Pointer to a #guint32 to store the result</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint32_be"
- c:identifier="gst_byte_reader_get_uint32_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="538">Read an unsigned 32 bit big endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="120"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="546">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="540">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="541">Pointer to a #guint32 to store the result</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint32_le"
- c:identifier="gst_byte_reader_get_uint32_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="494">Read an unsigned 32 bit little endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="114"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="502">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="496">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="497">Pointer to a #guint32 to store the result</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint64_be"
- c:identifier="gst_byte_reader_get_uint64_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="626">Read an unsigned 64 bit big endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="132"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="634">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="628">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="629">Pointer to a #guint64 to store the result</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint64_le"
- c:identifier="gst_byte_reader_get_uint64_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="582">Read an unsigned 64 bit little endian integer into @val
-and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="126"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="590">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="584">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="585">Pointer to a #guint64 to store the result</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uint8" c:identifier="gst_byte_reader_get_uint8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="277">Read an unsigned 8 bit integer into @val and update the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="84"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="284">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="279">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="280">Pointer to a #guint8 to store the result</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_byte_reader_init">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="124">Initializes a #GstByteReader instance to read from @data. This function
-can be called on already initialized instances.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="58"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="126">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="127">data from which
- the #GstByteReader should read</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="129">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="masked_scan_uint32"
- c:identifier="gst_byte_reader_masked_scan_uint32">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="941">Scan for pattern @pattern with applied mask @mask in the byte reader data,
-starting from offset @offset relative to the current position.
-
-The bytes in @pattern and @mask are interpreted left-to-right, regardless
-of endianness. All four bytes of the pattern must be present in the
-byte reader data for it to match, even if the first or last bytes are masked
-out.
-
-It is an error to call this function without making sure that there is
-enough data (offset+size bytes) in the byte reader.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="261"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="961">offset of the first match, or -1 if no match was found.
-
-Example:
-|[
-// Assume the reader contains 0x00 0x01 0x02 ... 0xfe 0xff
-
-gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0x00010203, 0, 256);
-// -&gt; returns 0
-gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0x00010203, 1, 255);
-// -&gt; returns -1
-gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0x01020304, 1, 255);
-// -&gt; returns 1
-gst_byte_reader_masked_scan_uint32 (reader, 0xffff, 0x0001, 0, 256);
-// -&gt; returns -1
-gst_byte_reader_masked_scan_uint32 (reader, 0xffff, 0x0203, 0, 256);
-// -&gt; returns 0
-gst_byte_reader_masked_scan_uint32 (reader, 0xffff0000, 0x02030000, 0, 256);
-// -&gt; returns 2
-gst_byte_reader_masked_scan_uint32 (reader, 0xffff0000, 0x02030000, 0, 4);
-// -&gt; returns -1
-]|</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="943">a #GstByteReader</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="944">mask to apply to data before matching against @pattern</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="pattern" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="945">pattern to match (after mask is applied)</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="946">offset from which to start scanning, relative to the current
- position</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="948">number of bytes to scan from offset</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="masked_scan_uint32_peek"
- c:identifier="gst_byte_reader_masked_scan_uint32_peek"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="990">Scan for pattern @pattern with applied mask @mask in the byte reader data,
-starting from offset @offset relative to the current position.
-
-The bytes in @pattern and @mask are interpreted left-to-right, regardless
-of endianness. All four bytes of the pattern must be present in the
-byte reader data for it to match, even if the first or last bytes are masked
-out.
-
-It is an error to call this function without making sure that there is
-enough data (offset+size bytes) in the byte reader.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="267"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1011">offset of the first match, or -1 if no match was found.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="992">a #GstByteReader</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="993">mask to apply to data before matching against @pattern</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="pattern" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="994">pattern to match (after mask is applied)</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="995">offset from which to start scanning, relative to the current
- position</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="997">number of bytes to scan from offset</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="998">pointer to uint32 to return matching data</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_data" c:identifier="gst_byte_reader_peek_data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="823">Returns a constant pointer to the current data
-position if at least @size bytes are left and
-keeps the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="222"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="834">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="825">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="826">Size in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="827">address of a
- #guint8 pointer variable in which to store the result</doc>
- <array length="0" zero-terminated="0" c:type="const guint8**">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="peek_float32_be"
- c:identifier="gst_byte_reader_peek_float32_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="741">Read a 32 bit big endian floating point value into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="207"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="749">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="743">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="744">Pointer to a #gfloat to store the result</doc>
- <type name="gfloat" c:type="gfloat*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_float32_le"
- c:identifier="gst_byte_reader_peek_float32_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="719">Read a 32 bit little endian floating point value into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="204"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="727">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="721">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="722">Pointer to a #gfloat to store the result</doc>
- <type name="gfloat" c:type="gfloat*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_float64_be"
- c:identifier="gst_byte_reader_peek_float64_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="785">Read a 64 bit big endian floating point value into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="213"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="793">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="787">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="788">Pointer to a #gdouble to store the result</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_float64_le"
- c:identifier="gst_byte_reader_peek_float64_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="763">Read a 64 bit little endian floating point value into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="210"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="771">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="765">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="766">Pointer to a #gdouble to store the result</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_int16_be"
- c:identifier="gst_byte_reader_peek_int16_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="394">Read a signed 16 bit big endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="153"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="402">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="396">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="397">Pointer to a #gint16 to store the result</doc>
- <type name="gint16" c:type="gint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_int16_le"
- c:identifier="gst_byte_reader_peek_int16_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="350">Read a signed 16 bit little endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="147"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="358">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="352">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="353">Pointer to a #gint16 to store the result</doc>
- <type name="gint16" c:type="gint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_int24_be"
- c:identifier="gst_byte_reader_peek_int24_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="482">Read a signed 24 bit big endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="165"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="490">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="484">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="485">Pointer to a #gint32 to store the result</doc>
- <type name="gint32" c:type="gint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_int24_le"
- c:identifier="gst_byte_reader_peek_int24_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="438">Read a signed 24 bit little endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="159"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="446">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="440">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="441">Pointer to a #gint32 to store the result</doc>
- <type name="gint32" c:type="gint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_int32_be"
- c:identifier="gst_byte_reader_peek_int32_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="571">Read a signed 32 bit big endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="177"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="579">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="573">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="574">Pointer to a #gint32 to store the result</doc>
- <type name="gint32" c:type="gint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_int32_le"
- c:identifier="gst_byte_reader_peek_int32_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="527">Read a signed 32 bit little endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="171"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="535">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="529">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="530">Pointer to a #gint32 to store the result</doc>
- <type name="gint32" c:type="gint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_int64_be"
- c:identifier="gst_byte_reader_peek_int64_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="659">Read a signed 64 bit big endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="189"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="667">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="661">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="662">Pointer to a #gint64 to store the result</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_int64_le"
- c:identifier="gst_byte_reader_peek_int64_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="615">Read a signed 64 bit little endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="183"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="623">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="617">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="618">Pointer to a #gint64 to store the result</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_int8" c:identifier="gst_byte_reader_peek_int8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="307">Read a signed 8 bit integer into @val but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="141"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="314">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="309">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="310">Pointer to a #gint8 to store the result</doc>
- <type name="gint8" c:type="gint8*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_string_utf8"
- c:identifier="gst_byte_reader_peek_string_utf8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1141">Returns a constant pointer to the current data position if there is
-a NUL-terminated string in the data (this could be just a NUL terminator).
-The current position will be maintained. This will work for any
-NUL-terminated string with a character width of 8 bits, so ASCII,
-UTF-8, ISO-8859-N etc.
-
-No input checking for valid UTF-8 is done.
-
-This function will fail if no NUL-terminator was found in in the data.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="258"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1157">%TRUE if a string could be skipped, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1143">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="str"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1144">address of a
- #gchar pointer variable in which to store the result</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="peek_sub_reader"
- c:identifier="gst_byte_reader_peek_sub_reader"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="144">Initializes a #GstByteReader sub-reader instance to contain @size bytes of
-data from the current position of @reader. This is useful to read chunked
-formats and make sure that one doesn't read beyond the size of the sub-chunk.
-
-Unlike gst_byte_reader_get_sub_reader(), this function does not modify the
-current position of @reader.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="61"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="157">FALSE on error or if @reader does not contain @size more bytes from
- the current position, and otherwise TRUE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="146">an existing and initialized #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="sub_reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="147">a #GstByteReader instance to initialize as sub-reader</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="148">size of @sub_reader in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_uint16_be"
- c:identifier="gst_byte_reader_peek_uint16_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="383">Read an unsigned 16 bit big endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="150"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="391">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="385">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="386">Pointer to a #guint16 to store the result</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_uint16_le"
- c:identifier="gst_byte_reader_peek_uint16_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="339">Read an unsigned 16 bit little endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="144"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="347">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="341">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="342">Pointer to a #guint16 to store the result</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_uint24_be"
- c:identifier="gst_byte_reader_peek_uint24_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="471">Read an unsigned 24 bit big endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="162"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="479">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="473">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="474">Pointer to a #guint32 to store the result</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_uint24_le"
- c:identifier="gst_byte_reader_peek_uint24_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="427">Read an unsigned 24 bit little endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="156"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="435">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="429">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="430">Pointer to a #guint32 to store the result</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_uint32_be"
- c:identifier="gst_byte_reader_peek_uint32_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="560">Read an unsigned 32 bit big endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="174"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="568">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="562">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="563">Pointer to a #guint32 to store the result</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_uint32_le"
- c:identifier="gst_byte_reader_peek_uint32_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="516">Read an unsigned 32 bit little endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="168"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="524">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="518">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="519">Pointer to a #guint32 to store the result</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_uint64_be"
- c:identifier="gst_byte_reader_peek_uint64_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="648">Read an unsigned 64 bit big endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="186"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="656">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="650">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="651">Pointer to a #guint64 to store the result</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_uint64_le"
- c:identifier="gst_byte_reader_peek_uint64_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="604">Read an unsigned 64 bit little endian integer into @val
-but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="180"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="612">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="606">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="607">Pointer to a #guint64 to store the result</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_uint8" c:identifier="gst_byte_reader_peek_uint8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="297">Read an unsigned 8 bit integer into @val but keep the current position.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="138"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="304">%TRUE if successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="299">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="const GstByteReader*"/>
- </instance-parameter>
- <parameter name="val"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="300">Pointer to a #guint8 to store the result</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_pos" c:identifier="gst_byte_reader_set_pos">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="194">Sets the new position of a #GstByteReader instance to @pos in bytes.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="201">%TRUE if the position could be set successfully, %FALSE
-otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="196">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="pos" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="197">The new position in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="skip" c:identifier="gst_byte_reader_skip">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="262">Skips @nbytes bytes of the #GstByteReader instance.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="81"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="269">%TRUE if @nbytes bytes could be skipped, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="264">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- <parameter name="nbytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="265">the number of bytes to skip</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="skip_string_utf16"
- c:identifier="gst_byte_reader_skip_string_utf16">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1095">Skips a NUL-terminated UTF-16 string in the #GstByteReader instance,
-advancing the current position to the byte after the string.
-
-No input checking for valid UTF-16 is done.
-
-This function will fail if no NUL-terminator was found in in the data.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="243"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1106">%TRUE if a string could be skipped, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1097">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="skip_string_utf32"
- c:identifier="gst_byte_reader_skip_string_utf32">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1110">Skips a NUL-terminated UTF-32 string in the #GstByteReader instance,
-advancing the current position to the byte after the string.
-
-No input checking for valid UTF-32 is done.
-
-This function will fail if no NUL-terminator was found in in the data.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="246"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1121">%TRUE if a string could be skipped, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1112">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="skip_string_utf8"
- c:identifier="gst_byte_reader_skip_string_utf8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1080">Skips a NUL-terminated string in the #GstByteReader instance, advancing
-the current position to the byte after the string. This will work for
-any NUL-terminated string with a character width of 8 bits, so ASCII,
-UTF-8, ISO-8859-N etc. No input checking for valid UTF-8 is done.
-
-This function will fail if no NUL-terminator was found in in the data.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="240"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1091">%TRUE if a string could be skipped, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="reader" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1082">a #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="new"
- c:identifier="gst_byte_reader_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="86">Create a new #GstByteReader instance, which will read from @data.
-
-Free-function: gst_byte_reader_free</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="52"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="96">a new #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="88">data from which the
- #GstByteReader should read</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="90">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <record name="ByteWriter" c:type="GstByteWriter">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="28">#GstByteWriter provides a byte writer and reader that can write/read different
-integer and floating point types to/from a memory buffer. It provides functions
-for writing/reading signed/unsigned, little/big endian integers of 8, 16, 24,
-32 and 64 bits and functions for reading little/big endian floating points numbers of
-32 and 64 bits. It also provides functions to write/read NUL-terminated strings
-in various character encodings.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="52"/>
- <field name="parent" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.h"
- line="35">#GstByteReader parent</doc>
- <type name="ByteReader" c:type="GstByteReader"/>
- </field>
- <field name="alloc_size" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.h"
- line="36">Allocation size of the data</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="fixed" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.h"
- line="37">If %TRUE no reallocations are allowed</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="owned" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.h"
- line="38">If %FALSE no reallocations are allowed and copies of data are returned</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="ensure_free_space"
- c:identifier="gst_byte_writer_ensure_free_space">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="362">Checks if enough free space from the current write cursor is
-available and reallocates if necessary.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="134"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="370">%TRUE if at least @size bytes are still available</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="364">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="365">Number of bytes that should be available</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="fill" c:identifier="gst_byte_writer_fill">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="686">Writes @size bytes containing @value to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="206"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="694">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="688">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="689">Value to be written</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="690">Number of bytes to be written</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_byte_writer_free">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="278">Frees @writer and all memory allocated by it.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="73"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="280">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free_and_get_buffer"
- c:identifier="gst_byte_writer_free_and_get_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="317">Frees @writer and all memory allocated by it except
-the current data, which is returned as #GstBuffer.
-
-Free-function: gst_buffer_unref</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="79"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="326">the current data as buffer. gst_buffer_unref()
- after usage.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="319">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free_and_get_data"
- c:identifier="gst_byte_writer_free_and_get_data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="293">Frees @writer and all memory allocated by it except
-the current data, which is returned.
-
-Free-function: g_free</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="76"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="302">the current data. g_free() after usage.</doc>
- <type name="guint8" c:type="guint8*"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="295">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_remaining"
- c:identifier="gst_byte_writer_get_remaining">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="342">Returns the remaining size of data that can still be written. If
--1 is returned the remaining size is only limited by system resources.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="131"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="349">the remaining size of data that can still be written</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="344">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="const GstByteWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_byte_writer_init">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="138">Initializes @writer to an empty instance</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="64"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="140">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init_with_data"
- c:identifier="gst_byte_writer_init_with_data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="176">Initializes @writer with the given
-memory area. If @initialized is %TRUE it is possible to
-read @size bytes from the #GstByteWriter from the beginning.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="70"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="178">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="179">Memory area for writing</doc>
- <array length="1" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="180">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="initialized" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="181">If %TRUE the complete data can be read from the beginning</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="init_with_size"
- c:identifier="gst_byte_writer_init_with_size">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="154">Initializes @writer with the given initial data size.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="67"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="156">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="157">Initial size of data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="fixed" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="158">If %TRUE the data can't be reallocated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_buffer" c:identifier="gst_byte_writer_put_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="697">Writes @size bytes of @data to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="216"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="706">%TRUE if the data could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="699">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="700">source #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="701">offset to copy from</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="702">total size to copy. If -1, all data is copied</doc>
- <type name="gssize" c:type="gssize"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_data" c:identifier="gst_byte_writer_put_data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="676">Writes @size bytes of @data to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="203"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="684">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="678">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="679">Data to write</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="680">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_float32_be"
- c:identifier="gst_byte_writer_put_float32_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="613">Writes a big endian 32 bit float to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="191"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="620">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="615">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="616">Value to write</doc>
- <type name="gfloat" c:type="gfloat"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_float32_le"
- c:identifier="gst_byte_writer_put_float32_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="631">Writes a little endian 32 bit float to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="194"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="638">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="633">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="634">Value to write</doc>
- <type name="gfloat" c:type="gfloat"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_float64_be"
- c:identifier="gst_byte_writer_put_float64_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="622">Writes a big endian 64 bit float to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="197"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="629">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="624">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="625">Value to write</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_float64_le"
- c:identifier="gst_byte_writer_put_float64_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="640">Writes a little endian 64 bit float to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="200"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="647">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="642">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="643">Value to write</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_int16_be" c:identifier="gst_byte_writer_put_int16_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="541">Writes a signed big endian 16 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="149"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="548">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="543">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="544">Value to write</doc>
- <type name="gint16" c:type="gint16"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_int16_le" c:identifier="gst_byte_writer_put_int16_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="577">Writes a signed little endian 16 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="152"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="584">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="579">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="580">Value to write</doc>
- <type name="gint16" c:type="gint16"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_int24_be" c:identifier="gst_byte_writer_put_int24_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="550">Writes a signed big endian 24 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="161"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="557">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="552">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="553">Value to write</doc>
- <type name="gint32" c:type="gint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_int24_le" c:identifier="gst_byte_writer_put_int24_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="586">Writes a signed little endian 24 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="164"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="593">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="588">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="589">Value to write</doc>
- <type name="gint32" c:type="gint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_int32_be" c:identifier="gst_byte_writer_put_int32_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="559">Writes a signed big endian 32 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="173"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="566">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="561">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="562">Value to write</doc>
- <type name="gint32" c:type="gint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_int32_le" c:identifier="gst_byte_writer_put_int32_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="595">Writes a signed little endian 32 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="176"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="602">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="597">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="598">Value to write</doc>
- <type name="gint32" c:type="gint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_int64_be" c:identifier="gst_byte_writer_put_int64_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="568">Writes a signed big endian 64 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="185"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="575">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="570">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="571">Value to write</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_int64_le" c:identifier="gst_byte_writer_put_int64_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="604">Writes a signed little endian 64 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="188"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="611">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="606">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="607">Value to write</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_int8" c:identifier="gst_byte_writer_put_int8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="532">Writes a signed 8 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="140"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="539">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="534">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="535">Value to write</doc>
- <type name="gint8" c:type="gint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_string_utf16"
- c:identifier="gst_byte_writer_put_string_utf16">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="658">Writes a NUL-terminated UTF16 string to @writer (including the terminator).</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="212"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="665">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="660">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="661">UTF16 string to write</doc>
- <array c:type="const guint16*">
- <type name="guint16" c:type="guint16"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="put_string_utf32"
- c:identifier="gst_byte_writer_put_string_utf32">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="667">Writes a NUL-terminated UTF32 string to @writer (including the terminator).</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="215"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="674">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="669">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="670">UTF32 string to write</doc>
- <array c:type="const guint32*">
- <type name="guint32" c:type="guint32"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="put_string_utf8"
- c:identifier="gst_byte_writer_put_string_utf8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="649">Writes a NUL-terminated UTF8 string to @writer (including the terminator).</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="209"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="656">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="651">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="652">UTF8 string to write</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_uint16_be"
- c:identifier="gst_byte_writer_put_uint16_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="460">Writes a unsigned big endian 16 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="143"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="467">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="462">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="463">Value to write</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_uint16_le"
- c:identifier="gst_byte_writer_put_uint16_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="496">Writes a unsigned little endian 16 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="146"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="503">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="498">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="499">Value to write</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_uint24_be"
- c:identifier="gst_byte_writer_put_uint24_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="469">Writes a unsigned big endian 24 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="155"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="476">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="471">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="472">Value to write</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_uint24_le"
- c:identifier="gst_byte_writer_put_uint24_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="505">Writes a unsigned little endian 24 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="158"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="512">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="507">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="508">Value to write</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_uint32_be"
- c:identifier="gst_byte_writer_put_uint32_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="478">Writes a unsigned big endian 32 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="167"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="485">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="480">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="481">Value to write</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_uint32_le"
- c:identifier="gst_byte_writer_put_uint32_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="514">Writes a unsigned little endian 32 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="170"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="521">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="516">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="517">Value to write</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_uint64_be"
- c:identifier="gst_byte_writer_put_uint64_be">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="487">Writes a unsigned big endian 64 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="179"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="494">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="489">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="490">Value to write</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_uint64_le"
- c:identifier="gst_byte_writer_put_uint64_le">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="523">Writes a unsigned little endian 64 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="182"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="530">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="525">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="526">Value to write</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="put_uint8" c:identifier="gst_byte_writer_put_uint8">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="451">Writes a unsigned 8 bit integer to @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="137"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="458">%TRUE if the value could be written</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="453">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="454">Value to write</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="reset" c:identifier="gst_byte_writer_reset">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="202">Resets @writer and frees the data if it's
-owned by @writer.</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="82"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="204">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reset_and_get_buffer"
- c:identifier="gst_byte_writer_reset_and_get_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="246">Resets @writer and returns the current data as buffer.
-
-Free-function: gst_buffer_unref</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="88"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="254">the current data as buffer. gst_buffer_unref()
- after usage.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="248">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="reset_and_get_data"
- c:identifier="gst_byte_writer_reset_and_get_data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="219">Resets @writer and returns the current data.
-
-Free-function: g_free</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="85"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="227">the current data. g_free() after
-usage.</doc>
- <array zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="writer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="221">#GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="new"
- c:identifier="gst_byte_writer_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="67">Creates a new, empty #GstByteWriter instance
-
-Free-function: gst_byte_writer_free</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="55"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="74">a new, empty #GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </return-value>
- </function>
- <function name="new_with_data"
- c:identifier="gst_byte_writer_new_with_data"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="110">Creates a new #GstByteWriter instance with the given
-memory area. If @initialized is %TRUE it is possible to
-read @size bytes from the #GstByteWriter from the beginning.
-
-Free-function: gst_byte_writer_free</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="61"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="122">a new #GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="112">Memory area for writing</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="113">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="initialized" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="114">If %TRUE the complete data can be read from the beginning</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_with_size"
- c:identifier="gst_byte_writer_new_with_size"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="85">Creates a new #GstByteWriter instance with the given
-initial data size.
-
-Free-function: gst_byte_writer_free</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="58"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="95">a new #GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </return-value>
- <parameters>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="87">Initial size of data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="fixed" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="88">If %TRUE the data can't be reallocated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <function-macro name="COLLECT_PADS"
- c:identifier="GST_COLLECT_PADS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstcollectpads.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLLECT_PADS_CLASS"
- c:identifier="GST_COLLECT_PADS_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstcollectpads.h" line="33"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLLECT_PADS_DTS"
- c:identifier="GST_COLLECT_PADS_DTS"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="107">Returns the DTS that has been converted to running time when using
-gst_collect_pads_clip_running_time(). Unlike the value saved into
-the buffer, this value is of type gint64 and may be negative. This allow
-properly handling streams with frame reordering where the first DTS may
-be negative. If the initial DTS was not set, this value will be
-set to %G_MININT64.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="120"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="109">A #GstCollectData.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLLECT_PADS_DTS_IS_VALID"
- c:identifier="GST_COLLECT_PADS_DTS_IS_VALID"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="122">Check if running DTS value store is valid.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="130"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="124">A #GstCollectData.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLLECT_PADS_GET_CLASS"
- c:identifier="GST_COLLECT_PADS_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstcollectpads.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLLECT_PADS_GET_STREAM_LOCK"
- c:identifier="GST_COLLECT_PADS_GET_STREAM_LOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="291">Get the stream lock of @pads. The stream lock is used to coordinate and
-serialize execution among the various streams being collected, and in
-protecting the resources used to accomplish this.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="299"/>
- <parameters>
- <parameter name="pads">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="293">a #GstCollectPads</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLLECT_PADS_STATE"
- c:identifier="GST_COLLECT_PADS_STATE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="74">A flags word containing #GstCollectPadsStateFlags flags set
-on this collected pad.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="81"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="76">a #GstCollectData.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLLECT_PADS_STATE_IS_SET"
- c:identifier="GST_COLLECT_PADS_STATE_IS_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="82">Gives the status of a specific flag on a collected pad.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="89"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="84">a #GstCollectData.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="85">the #GstCollectPadsStateFlags to check.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLLECT_PADS_STATE_SET"
- c:identifier="GST_COLLECT_PADS_STATE_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="90">Sets a state flag on a collected pad.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="97"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="92">a #GstCollectData.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="93">the #GstCollectPadsStateFlags to set.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLLECT_PADS_STATE_UNSET"
- c:identifier="GST_COLLECT_PADS_STATE_UNSET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="98">Clears a state flag on a collected pad.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="105"/>
- <parameters>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="100">a #GstCollectData.</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="101">the #GstCollectPadsStateFlags to clear.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLLECT_PADS_STREAM_LOCK"
- c:identifier="GST_COLLECT_PADS_STREAM_LOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="300">Lock the stream lock of @pads.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="306"/>
- <parameters>
- <parameter name="pads">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="302">a #GstCollectPads</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLLECT_PADS_STREAM_UNLOCK"
- c:identifier="GST_COLLECT_PADS_STREAM_UNLOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="307">Unlock the stream lock of @pads.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="313"/>
- <parameters>
- <parameter name="pads">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="309">a #GstCollectPads</doc>
- </parameter>
- </parameters>
- </function-macro>
- <record name="CollectData" c:type="GstCollectData">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="132">Structure used by the collect_pads.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="168"/>
- <field name="collect" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="134">owner #GstCollectPads</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </field>
- <field name="pad" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="135">#GstPad managed by this data</doc>
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="buffer" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="136">currently queued buffer.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="pos" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="137">position in the buffer</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="segment" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="138">last segment received.</doc>
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="state" readable="0" private="1">
- <type name="CollectPadsStateFlags" c:type="GstCollectPadsStateFlags"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="CollectDataPrivate" c:type="GstCollectDataPrivate*"/>
- </field>
- <union name="ABI" c:type="ABI">
- <source-position filename="libs/gst/base/gstcollectpads.h" line="167"/>
- <record name="abi" c:type="abi">
- <source-position filename="libs/gst/base/gstcollectpads.h"
- line="165"/>
- <field name="dts" writable="1">
- <type name="gint64" c:type="gint64"/>
- </field>
- </record>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </union>
- </record>
- <callback name="CollectDataDestroyNotify"
- c:type="GstCollectDataDestroyNotify">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="44">A function that will be called when the #GstCollectData will be freed.
-It is passed the pointer to the structure and should free any custom
-memory and resources allocated for it.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="52"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="46">the #GstCollectData that will be freed</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="CollectDataPrivate"
- c:type="GstCollectDataPrivate"
- disguised="1">
- <source-position filename="libs/gst/base/gstcollectpads.h" line="39"/>
- </record>
- <class name="CollectPads"
- c:symbol-prefix="collect_pads"
- c:type="GstCollectPads"
- parent="Gst.Object"
- glib:type-name="GstCollectPads"
- glib:get-type="gst_collect_pads_get_type"
- glib:type-struct="CollectPadsClass">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="23">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.
-
- * Collectpads are created with gst_collect_pads_new(). A callback should then
- be installed with gst_collect_pads_set_function ().
-
- * Pads are added to the collection with gst_collect_pads_add_pad()/
- gst_collect_pads_remove_pad(). The pad has to be a sinkpad. When added,
- the chain, event and query functions of the pad are overridden. The
- element_private of the pad is used to store private information for the
- collectpads.
-
- * For each pad, data is queued in the _chain function or by
- performing a pull_range.
-
- * When data is queued on all pads in waiting mode, the callback function is called.
-
- * Data can be dequeued from the pad with the gst_collect_pads_pop() method.
- One can peek at the data with the gst_collect_pads_peek() function.
- These functions will return %NULL if the pad received an EOS event. When all
- pads return %NULL from a gst_collect_pads_peek(), the element can emit an EOS
- event itself.
-
- * Data can also be dequeued in byte units using the gst_collect_pads_available(),
- gst_collect_pads_read_buffer() and gst_collect_pads_flush() calls.
-
- * Elements should call gst_collect_pads_start() and gst_collect_pads_stop() in
- their state change functions to start and stop the processing of the collectpads.
- The gst_collect_pads_stop() call should be called before calling the parent
- element state change function in the PAUSED_TO_READY state change to ensure
- no pad is blocked and the element can finish streaming.
-
- * gst_collect_pads_set_waiting() sets a pad to waiting or non-waiting mode.
- CollectPads element is not waiting for data to be collected on non-waiting pads.
- Thus these pads may but need not have data when the callback is called.
- All pads are in waiting mode by default.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="341"/>
- <constructor name="new" c:identifier="gst_collect_pads_new">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="273">Create a new instance of #GstCollectPads.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="349"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="280">a new #GstCollectPads, or %NULL in case of an error.</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </return-value>
- </constructor>
- <method name="add_pad" c:identifier="gst_collect_pads_add_pad">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="585">Add a pad to the collection of collect pads. The pad has to be
-a sinkpad. The refcount of the pad is incremented. Use
-gst_collect_pads_remove_pad() to remove the pad from the collection
-again.
-
-You specify a size for the returned #GstCollectData structure
-so that you can use it to store additional information.
-
-You can also specify a #GstCollectDataDestroyNotify that will be called
-just before the #GstCollectData structure is freed. It is passed the
-pointer to the structure and should free any custom memory and resources
-allocated for it.
-
-Keeping a pad locked in waiting state is only relevant when using
-the default collection algorithm (providing the oldest buffer).
-It ensures a buffer must be available on this pad for a collection
-to take place. This is of typical use to a muxer element where
-non-subtitle streams should always be in waiting state,
-e.g. to assure that caps information is available on all these streams
-when initial headers have to be written.
-
-The pad will be automatically activated in push mode when @pads is
-started.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="385"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="620">a new #GstCollectData to identify the
- new pad. Or %NULL if wrong parameters are supplied.</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="587">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="588">the pad to add</doc>
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="589">the size of the returned #GstCollectData structure</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="destroy_notify"
- transfer-ownership="none"
- scope="async">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="590">function to be called before the returned
- #GstCollectData structure is freed</doc>
- <type name="CollectDataDestroyNotify"
- c:type="GstCollectDataDestroyNotify"/>
- </parameter>
- <parameter name="lock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="592">whether to lock this pad in usual waiting state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="available" c:identifier="gst_collect_pads_available">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1012">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.
-
-This function should be called with @pads STREAM_LOCK held, such as
-in the callback.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="413"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1025">The maximum number of bytes queued on all pads. This function
-returns 0 if a pad has no queued buffer.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1014">the collectpads to query</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="clip_running_time"
- c:identifier="gst_collect_pads_clip_running_time">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="472">Convenience clipping function that converts incoming buffer's timestamp
-to running time, or clips the buffer if outside configured segment.
-
-Since 1.6, this clipping function also sets the DTS parameter of the
-GstCollectData structure. This version of the running time DTS can be
-negative. G_MININT64 is used to indicate invalid value.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="434"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="474">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="cdata" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="475">collect data of corresponding pad</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="476">buffer being clipped</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="outbuf"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="477">output buffer with running time, or NULL if clipped</doc>
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="478">user data (unused)</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="event_default"
- c:identifier="gst_collect_pads_event_default">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1647">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.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="442"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1649">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1650">collect data of corresponding pad</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1651">event being processed</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="discard" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1652">process but do not send event downstream</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="flush" c:identifier="gst_collect_pads_flush">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1081">Flush @size bytes from the pad @data.
-
-This function should be called with @pads STREAM_LOCK held, such as
-in the callback.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="416"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1094">The number of bytes flushed This can be less than @size and
-is 0 if the pad was end-of-stream.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1083">the collectpads to query</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1084">the data to use</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1085">the number of bytes to flush</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek" c:identifier="gst_collect_pads_peek">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="930">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.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="405"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="941">The buffer in @data or %NULL if no
-buffer is queued. should unref the buffer after usage.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="932">the collectpads to peek</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="933">the data to use</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- </parameters>
- </method>
- <method name="pop" c:identifier="gst_collect_pads_pop">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="962">Pop the buffer currently queued in @data. This function
-should be called with the @pads STREAM_LOCK held, such as in the callback
-handler.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="408"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="973">The buffer in @data or %NULL if no
-buffer was queued. You should unref the buffer after usage.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="964">the collectpads to pop</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="965">the data to use</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- </parameters>
- </method>
- <method name="query_default"
- c:identifier="gst_collect_pads_query_default">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="2025">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.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="448"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="2027">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="2028">collect data of corresponding pad</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="2029">query being processed</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="discard" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="2030">process but do not send event downstream</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="read_buffer" c:identifier="gst_collect_pads_read_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1127">Get a subbuffer of @size bytes from the given pad @data.
-
-This function should be called with @pads STREAM_LOCK held, such as in the
-callback.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="419"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1140">A sub buffer. The size of the buffer can
-be less that requested. A return of %NULL signals that the pad is
-end-of-stream. Unref the buffer after use.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1129">the collectpads to query</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1130">the data to use</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1131">the number of bytes to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_pad" c:identifier="gst_collect_pads_remove_pad">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="683">Remove a pad from the collection of collect pads. This function will also
-free the #GstCollectData and all the resources that were allocated with
-gst_collect_pads_add_pad().
-
-The pad will be deactivated automatically when @pads is stopped.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="389"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="696">%TRUE if the pad could be removed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="685">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="686">the pad to remove</doc>
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_buffer_function"
- c:identifier="gst_collect_pads_set_buffer_function">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="304">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.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="358"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="306">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="307">the function to set</doc>
- <type name="CollectPadsBufferFunction"
- c:type="GstCollectPadsBufferFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="308">user data passed to the function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_clip_function"
- c:identifier="gst_collect_pads_set_clip_function">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="542">Install a clipping function that is called right after a buffer is received
-on a pad managed by @pads. See #GstCollectPadsClipFunction for more info.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="374"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="544">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="clipfunc"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="545">clip function to install</doc>
- <type name="CollectPadsClipFunction"
- c:type="GstCollectPadsClipFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="546">user data to pass to @clip_func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_compare_function"
- c:identifier="gst_collect_pads_set_compare_function">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="329">Set the timestamp comparison function.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="370"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="331">the pads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="332">the function to set</doc>
- <type name="CollectPadsCompareFunction"
- c:type="GstCollectPadsCompareFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="333">user data passed to the function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_event_function"
- c:identifier="gst_collect_pads_set_event_function">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="416">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.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="362"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="418">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="419">the function to set</doc>
- <type name="CollectPadsEventFunction"
- c:type="GstCollectPadsEventFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="420">user data passed to the function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_flush_function"
- c:identifier="gst_collect_pads_set_flush_function"
- version="1.4">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="562">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.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="378"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="564">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="565">flush function to install</doc>
- <type name="CollectPadsFlushFunction"
- c:type="GstCollectPadsFlushFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="566">user data to pass to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_flushing" c:identifier="gst_collect_pads_set_flushing">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="804">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.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="400"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="806">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="flushing" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="807">desired state of the pads</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_function" c:identifier="gst_collect_pads_set_function">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="356">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
-gst_collect_pads_set_buffer_function() callback.
-If this callback is set, the former will be unset.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="354"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="358">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="359">the function to set</doc>
- <type name="CollectPadsFunction" c:type="GstCollectPadsFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="360">user data passed to the function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_query_function"
- c:identifier="gst_collect_pads_set_query_function">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="444">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.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="366"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="446">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="447">the function to set</doc>
- <type name="CollectPadsQueryFunction"
- c:type="GstCollectPadsQueryFunction"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="448">user data passed to the function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_waiting" c:identifier="gst_collect_pads_set_waiting">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1196">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.
-
-This function should be called with @pads STREAM_LOCK held, such as
-in the callback.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="428"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1198">the collectpads</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1199">the data to use</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="waiting" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1200">boolean indicating whether this pad should operate
- in waiting or non-waiting mode</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="src_event_default"
- c:identifier="gst_collect_pads_src_event_default"
- version="1.4">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1909">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.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="445"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1911">the #GstCollectPads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1912">src #GstPad that received the event</doc>
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1913">event being processed</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </method>
- <method name="start" c:identifier="gst_collect_pads_start">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="831">Starts the processing of data in the collect_pads.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="394"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="833">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="stop" c:identifier="gst_collect_pads_stop">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="872">Stops the processing of data in the collect_pads. this function
-will also unblock any blocking operations.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="397"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="874">the collectpads to use</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="take_buffer" c:identifier="gst_collect_pads_take_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1166">Get a subbuffer of @size bytes from the given pad @data. Flushes the amount
-of read bytes.
-
-This function should be called with @pads STREAM_LOCK held, such as in the
-callback.
-
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="422"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1180">A sub buffer. The size of the buffer can
-be less that requested. A return of %NULL signals that the pad is
-end-of-stream. Unref the buffer after use.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1168">the collectpads to query</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1169">the data to use</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.c"
- line="1170">the number of bytes to read</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <field name="object">
- <type name="Gst.Object" c:type="GstObject"/>
- </field>
- <field name="data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="317">#GList of #GstCollectData managed
- by this #GstCollectPads.</doc>
- <type name="GLib.SList" c:type="GSList*">
- <type name="CollectData"/>
- </type>
- </field>
- <field name="stream_lock" readable="0" private="1">
- <type name="GLib.RecMutex" c:type="GRecMutex"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="CollectPadsPrivate" c:type="GstCollectPadsPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <callback name="CollectPadsBufferFunction"
- c:type="GstCollectPadsBufferFunction">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="181">A function that will be called when a (considered oldest) buffer can be muxed.
-If all pads have reached EOS, this function is called with %NULL @buffer
-and %NULL @data.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="194"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="192">%GST_FLOW_OK for success</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="183">the #GstCollectPads that triggered the callback</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="184">the #GstCollectData of pad that has received the buffer</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="185">the #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="3">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="186">user data passed to gst_collect_pads_set_buffer_function()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="CollectPadsClass"
- c:type="GstCollectPadsClass"
- glib:is-gtype-struct-for="CollectPads">
- <source-position filename="libs/gst/base/gstcollectpads.h" line="341"/>
- <field name="parent_class">
- <type name="Gst.ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <callback name="CollectPadsClipFunction"
- c:type="GstCollectPadsClipFunction">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="251">A function that will be called when @inbuffer is received on the pad managed
-by @data in the collectpad object @pads.
-
-The function should use the segment of @data and the negotiated media type on
-the pad to perform clipping of @inbuffer.
-
-This function takes ownership of @inbuffer and should output a buffer in
-@outbuffer or return %NULL in @outbuffer if the buffer should be dropped.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="270"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="268">a #GstFlowReturn that corresponds to the result of clipping.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="253">a #GstCollectPads</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="254">a #GstCollectData</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="inbuffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="255">the input #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="outbuffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="256">the output #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="4">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="257">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="CollectPadsCompareFunction"
- c:type="GstCollectPadsCompareFunction">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="197">A function for comparing two timestamps of buffers or newsegments collected on one pad.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="212"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="208">Integer less than zero when first timestamp is deemed older than the second one.
- Zero if the timestamps are deemed equally old.
- Integer greater than zero when second timestamp is deemed older than the first one.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="199">the #GstCollectPads that is comparing the timestamps</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </parameter>
- <parameter name="data1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="200">the first #GstCollectData</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="timestamp1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="201">the first timestamp</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="data2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="202">the second #GstCollectData</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="timestamp2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="203">the second timestamp</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="5">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="204">user data passed to gst_collect_pads_set_compare_function()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="CollectPadsEventFunction"
- c:type="GstCollectPadsEventFunction">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="217">A function that will be called while processing an event. It takes
-ownership of the event and is responsible for chaining up (to
-gst_collect_pads_event_default()) or dropping events (such typical cases
-being handled by the default handler).</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="231"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="229">%TRUE if the pad could handle the event</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="219">the #GstCollectPads that triggered the callback</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="220">the #GstPad that received an event</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="221">the #GstEvent received</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="3">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="222">user data passed to gst_collect_pads_set_event_function()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="CollectPadsFlushFunction"
- c:type="GstCollectPadsFlushFunction"
- version="1.4">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="275">A function that will be called while processing a flushing seek event.
-
-The function should flush any internal state of the element and the state of
-all the pads. It should clear only the state not directly managed by the
-@pads object. It is therefore not necessary to call
-gst_collect_pads_set_flushing nor gst_collect_pads_clear from this function.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="289"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="277">a #GstCollectPads</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="278">user data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="CollectPadsFunction" c:type="GstCollectPadsFunction">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="170">A function that will be called when all pads have received data.</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="179"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="177">%GST_FLOW_OK for success</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="172">the #GstCollectPads that triggered the callback</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="173">user data passed to gst_collect_pads_set_function()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="CollectPadsPrivate"
- c:type="GstCollectPadsPrivate"
- disguised="1">
- <source-position filename="libs/gst/base/gstcollectpads.h" line="41"/>
- </record>
- <callback name="CollectPadsQueryFunction"
- c:type="GstCollectPadsQueryFunction">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="235">A function that will be called while processing a query. It takes
-ownership of the query and is responsible for chaining up (to
-events downstream (with gst_pad_event_default()).</doc>
- <source-position filename="libs/gst/base/gstcollectpads.h" line="248"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="246">%TRUE if the pad could handle the event</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pads" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="237">the #GstCollectPads that triggered the callback</doc>
- <type name="CollectPads" c:type="GstCollectPads*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="238">the #GstPad that received an event</doc>
- <type name="CollectData" c:type="GstCollectData*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="239">the #GstEvent received</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="3">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="240">user data passed to gst_collect_pads_set_query_function()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <bitfield name="CollectPadsStateFlags" c:type="GstCollectPadsStateFlags">
- <source-position filename="libs/gst/base/gstcollectpads.h" line="72"/>
- <member name="eos" value="1" c:identifier="GST_COLLECT_PADS_STATE_EOS">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="56">Set if collectdata's pad is EOS.</doc>
- </member>
- <member name="flushing"
- value="2"
- c:identifier="GST_COLLECT_PADS_STATE_FLUSHING">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="57">Set if collectdata's pad is flushing.</doc>
- </member>
- <member name="new_segment"
- value="4"
- c:identifier="GST_COLLECT_PADS_STATE_NEW_SEGMENT">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="58">Set if collectdata's pad received a
- new_segment event.</doc>
- </member>
- <member name="waiting"
- value="8"
- c:identifier="GST_COLLECT_PADS_STATE_WAITING">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="60">Set if collectdata's pad must be waited
- for when collecting.</doc>
- </member>
- <member name="locked"
- value="16"
- c:identifier="GST_COLLECT_PADS_STATE_LOCKED">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstcollectpads.h"
- line="62">Set collectdata's pad WAITING state must
- not be changed.
-#GstCollectPadsStateFlags indicate private state of a collectdata('s pad).</doc>
- </member>
- </bitfield>
- <function-macro name="DATA_QUEUE"
- c:identifier="GST_DATA_QUEUE"
- introspectable="0">
- <source-position filename="libs/gst/base/gstdataqueue.h" line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DATA_QUEUE_CLASS"
- c:identifier="GST_DATA_QUEUE_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstdataqueue.h" line="33"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <class name="DataQueue"
- c:symbol-prefix="data_queue"
- c:type="GstDataQueue"
- parent="GObject.Object"
- glib:type-name="GstDataQueue"
- glib:get-type="gst_data_queue_get_type"
- glib:type-struct="DataQueueClass">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="22">#GstDataQueue is an object that handles threadsafe queueing of objects. It
-also provides size-related functionality. This object should be used for
-any #GstElement that wishes to provide some sort of queueing functionality.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="137"/>
- <constructor name="new"
- c:identifier="gst_data_queue_new"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="212">Creates a new #GstDataQueue. If @fullcallback or @emptycallback are supplied, then
-the #GstDataQueue will call the respective callback to signal full or empty condition.
-If the callbacks are NULL the #GstDataQueue will instead emit 'full' and 'empty'
-signals.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="143"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="226">a new #GstDataQueue.</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </return-value>
- <parameters>
- <parameter name="checkfull" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="214">the callback used to tell if the element considers the queue full
-or not.</doc>
- <type name="DataQueueCheckFullFunction"
- c:type="GstDataQueueCheckFullFunction"/>
- </parameter>
- <parameter name="fullcallback" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="216">the callback which will be called when the queue is considered full.</doc>
- <type name="DataQueueFullCallback"
- c:type="GstDataQueueFullCallback"/>
- </parameter>
- <parameter name="emptycallback"
- transfer-ownership="none"
- closure="3">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="217">the callback which will be called when the queue is considered empty.</doc>
- <type name="DataQueueEmptyCallback"
- c:type="GstDataQueueEmptyCallback"/>
- </parameter>
- <parameter name="checkdata"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="218">a #gpointer that will be passed to the @checkfull, @fullcallback,
- and @emptycallback callbacks.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </constructor>
- <virtual-method name="empty">
- <source-position filename="libs/gst/base/gstdataqueue.h" line="133"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="full">
- <source-position filename="libs/gst/base/gstdataqueue.h" line="134"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <method name="drop_head"
- c:identifier="gst_data_queue_drop_head"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="687">Pop and unref the head-most #GstMiniObject with the given #GType.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="166"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="694">%TRUE if an element was removed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="689">The #GstDataQueue to drop an item from.</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="690">The #GType of the item to drop.</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="flush"
- c:identifier="gst_data_queue_flush"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="316">Flushes all the contents of the @queue. Any call to #gst_data_queue_push and
-#gst_data_queue_pop will be released.
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="160"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="318">a #GstDataQueue.</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_level"
- c:identifier="gst_data_queue_get_level"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="759">Get the current level of the queue.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="175"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="761">The #GstDataQueue</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- <parameter name="level"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="762">the location to store the result</doc>
- <type name="DataQueueSize" c:type="GstDataQueueSize*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_empty"
- c:identifier="gst_data_queue_is_empty"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="335">Queries if there are any items in the @queue.
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="172"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="342">%TRUE if @queue is empty.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="337">a #GstDataQueue.</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_full"
- c:identifier="gst_data_queue_is_full"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="358">Queries if @queue is full. This check will be done using the
-#GstDataQueueCheckFullFunction registered with @queue.
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="169"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="366">%TRUE if @queue is full.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="360">a #GstDataQueue.</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="limits_changed"
- c:identifier="gst_data_queue_limits_changed"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="735">Inform the queue that the limits for the fullness check have changed and that
-any blocking gst_data_queue_push() should be unblocked to recheck the limits.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="178"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="737">The #GstDataQueue</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="peek"
- c:identifier="gst_data_queue_peek"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="632">Retrieves the first @item available on the @queue without removing it.
-If the queue is currently empty, the call will block until at least
-one item is available, OR the @queue is set to the flushing state.
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="157"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="642">%TRUE if an @item was successfully retrieved from the @queue.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="634">a #GstDataQueue.</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- <parameter name="item"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="635">pointer to store the returned #GstDataQueueItem.</doc>
- <type name="DataQueueItem" c:type="GstDataQueueItem**"/>
- </parameter>
- </parameters>
- </method>
- <method name="pop"
- c:identifier="gst_data_queue_pop"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="562">Retrieves the first @item available on the @queue. If the queue is currently
-empty, the call will block until at least one item is available, OR the
-@queue is set to the flushing state.
-MT safe.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="154"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="572">%TRUE if an @item was successfully retrieved from the @queue.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="564">a #GstDataQueue.</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- <parameter name="item"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="565">pointer to store the returned #GstDataQueueItem.</doc>
- <type name="DataQueueItem" c:type="GstDataQueueItem**"/>
- </parameter>
- </parameters>
- </method>
- <method name="push"
- c:identifier="gst_data_queue_push"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="478">Pushes a #GstDataQueueItem (or a structure that begins with the same fields)
-on the @queue. If the @queue is full, the call will block until space is
-available, OR the @queue is set to flushing state.
-MT safe.
-
-Note that this function has slightly different semantics than gst_pad_push()
-and gst_pad_push_event(): this function only takes ownership of @item and
-the #GstMiniObject contained in @item if the push was successful. If %FALSE
-is returned, the caller is responsible for freeing @item and its contents.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="148"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="493">%TRUE if the @item was successfully pushed on the @queue.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="480">a #GstDataQueue.</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- <parameter name="item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="481">a #GstDataQueueItem.</doc>
- <type name="DataQueueItem" c:type="GstDataQueueItem*"/>
- </parameter>
- </parameters>
- </method>
- <method name="push_force"
- c:identifier="gst_data_queue_push_force"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="430">Pushes a #GstDataQueueItem (or a structure that begins with the same fields)
-on the @queue. It ignores if the @queue is full or not and forces the @item
-to be pushed anyway.
-MT safe.
-
-Note that this function has slightly different semantics than gst_pad_push()
-and gst_pad_push_event(): this function only takes ownership of @item and
-the #GstMiniObject contained in @item if the push was successful. If %FALSE
-is returned, the caller is responsible for freeing @item and its contents.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="151"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="445">%TRUE if the @item was successfully pushed on the @queue.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="432">a #GstDataQueue.</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- <parameter name="item" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="433">a #GstDataQueueItem.</doc>
- <type name="DataQueueItem" c:type="GstDataQueueItem*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_flushing"
- c:identifier="gst_data_queue_set_flushing"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="382">Sets the queue to flushing state if @flushing is %TRUE. If set to flushing
-state, any incoming data on the @queue will be discarded. Any call currently
-blocking on #gst_data_queue_push or #gst_data_queue_pop will return straight
-away with a return value of %FALSE. While the @queue is in flushing state,
-all calls to those two functions will return %FALSE.
-
-MT Safe.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="163"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="384">a #GstDataQueue.</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </instance-parameter>
- <parameter name="flushing" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="385">a #gboolean stating if the queue will be flushing or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <property name="current-level-bytes" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="current-level-time" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="current-level-visible" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <field name="object">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="112">the parent structure</doc>
- <type name="GObject.Object" c:type="GObject"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="DataQueuePrivate" c:type="GstDataQueuePrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="empty" when="first" introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="147">Reports that the queue became empty (empty).
-A queue is empty if the total amount of visible items inside it (num-visible, time,
-size) is lower than the boundary values which can be set through the GObject
-properties.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="full" when="first" introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.c"
- line="161">Reports that the queue became full (full).
-A queue is full if the total amount of data inside it (num-visible, time,
-size) is higher than the boundary values which can be set through the GObject
-properties.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- </class>
- <callback name="DataQueueCheckFullFunction"
- c:type="GstDataQueueCheckFullFunction"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="91">The prototype of the function used to inform the queue that it should be
-considered as full.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="104"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="102">%TRUE if the queue should be considered full.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="queue" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="93">a #GstDataQueue.</doc>
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </parameter>
- <parameter name="visible" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="94">The number of visible items currently in the queue.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="bytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="95">The amount of bytes currently in the queue.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="96">The accumulated duration of the items currently in the queue.</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="checkdata"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="97">The #gpointer registered when the #GstDataQueue was created.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="DataQueueClass"
- c:type="GstDataQueueClass"
- glib:is-gtype-struct-for="DataQueue">
- <source-position filename="libs/gst/base/gstdataqueue.h" line="137"/>
- <field name="parent_class">
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </field>
- <field name="empty">
- <callback name="empty">
- <source-position filename="libs/gst/base/gstdataqueue.h" line="133"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="queue" transfer-ownership="none">
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="full">
- <callback name="full">
- <source-position filename="libs/gst/base/gstdataqueue.h" line="134"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="queue" transfer-ownership="none">
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <callback name="DataQueueEmptyCallback" c:type="GstDataQueueEmptyCallback">
- <source-position filename="libs/gst/base/gstdataqueue.h" line="108"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="queue" transfer-ownership="none">
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </parameter>
- <parameter name="checkdata"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="DataQueueFullCallback" c:type="GstDataQueueFullCallback">
- <source-position filename="libs/gst/base/gstdataqueue.h" line="107"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="queue" transfer-ownership="none">
- <type name="DataQueue" c:type="GstDataQueue*"/>
- </parameter>
- <parameter name="checkdata"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="DataQueueItem" c:type="GstDataQueueItem" introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="47">Structure used by #GstDataQueue. You can supply a different structure, as
-long as the top of the structure is identical to this structure.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="74"/>
- <field name="object" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="49">the #GstMiniObject to queue.</doc>
- <type name="Gst.MiniObject" c:type="GstMiniObject*"/>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="50">the size in bytes of the miniobject.</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="duration" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="51">the duration in #GstClockTime of the miniobject. Can not be
-%GST_CLOCK_TIME_NONE.</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="visible" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="53">%TRUE if @object should be considered as a visible object.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="destroy" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="54">The #GDestroyNotify function to use to free the #GstDataQueueItem.
-This function should also drop the reference to @object the owner of the
-#GstDataQueueItem is assumed to hold.</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="DataQueuePrivate" c:type="GstDataQueuePrivate" disguised="1">
- <source-position filename="libs/gst/base/gstdataqueue.h" line="45"/>
- </record>
- <record name="DataQueueSize" c:type="GstDataQueueSize" introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="76">Structure describing the size of a queue.</doc>
- <source-position filename="libs/gst/base/gstdataqueue.h" line="89"/>
- <field name="visible" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="78">number of buffers</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="bytes" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="79">number of bytes</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="time" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstdataqueue.h"
- line="80">amount of time</doc>
- <type name="guint64" c:type="guint64"/>
- </field>
- </record>
- <record name="FlowCombiner"
- c:type="GstFlowCombiner"
- version="1.4"
- glib:type-name="GstFlowCombiner"
- glib:get-type="gst_flow_combiner_get_type"
- c:symbol-prefix="flow_combiner">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="24">Utility struct to help handling #GstFlowReturn combination. Useful for
-#GstElement&lt;!-- --&gt;s that have multiple source pads and need to combine
-the different #GstFlowReturn for those pads.
-
-#GstFlowCombiner works by using the last #GstFlowReturn for all #GstPad
-it has in its list and computes the combined return value and provides
-it to the caller.
-
-To add a new pad to the #GstFlowCombiner use gst_flow_combiner_add_pad().
-The new #GstPad is stored with a default value of %GST_FLOW_OK.
-
-In case you want a #GstPad to be removed, use gst_flow_combiner_remove_pad().
-
-Please be aware that this struct isn't thread safe as its designed to be
- used by demuxers, those usually will have a single thread operating it.
-
-These functions will take refs on the passed #GstPad&lt;!-- --&gt;s.
-
-Aside from reducing the user's code size, the main advantage of using this
-helper struct is to follow the standard rules for #GstFlowReturn combination.
-These rules are:
-
-* %GST_FLOW_EOS: only if all returns are EOS too
-* %GST_FLOW_NOT_LINKED: only if all returns are NOT_LINKED too
-* %GST_FLOW_ERROR or below: if at least one returns an error return
-* %GST_FLOW_NOT_NEGOTIATED: if at least one returns a not-negotiated return
-* %GST_FLOW_FLUSHING: if at least one returns flushing
-* %GST_FLOW_OK: otherwise
-
-%GST_FLOW_ERROR or below, GST_FLOW_NOT_NEGOTIATED and GST_FLOW_FLUSHING are
-returned immediately from the gst_flow_combiner_update_flow() function.</doc>
- <source-position filename="libs/gst/base/gstflowcombiner.h" line="43"/>
- <constructor name="new"
- c:identifier="gst_flow_combiner_new"
- version="1.4">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="87">Creates a new #GstFlowCombiner, use gst_flow_combiner_free() to free it.</doc>
- <source-position filename="libs/gst/base/gstflowcombiner.h" line="46"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="92">A new #GstFlowCombiner</doc>
- <type name="FlowCombiner" c:type="GstFlowCombiner*"/>
- </return-value>
- </constructor>
- <method name="add_pad"
- c:identifier="gst_flow_combiner_add_pad"
- version="1.4">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="320">Adds a new #GstPad to the #GstFlowCombiner.</doc>
- <source-position filename="libs/gst/base/gstflowcombiner.h" line="64"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="combiner" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="322">the #GstFlowCombiner</doc>
- <type name="FlowCombiner" c:type="GstFlowCombiner*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="323">the #GstPad that is being added</doc>
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="clear"
- c:identifier="gst_flow_combiner_clear"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="168">Removes all pads from a #GstFlowCombiner and resets it to its initial state.</doc>
- <source-position filename="libs/gst/base/gstflowcombiner.h" line="70"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="combiner" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="170">the #GstFlowCombiner to clear</doc>
- <type name="FlowCombiner" c:type="GstFlowCombiner*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_flow_combiner_free" version="1.4">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="110">Frees a #GstFlowCombiner struct and all its internal data.</doc>
- <source-position filename="libs/gst/base/gstflowcombiner.h" line="55"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="combiner" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="112">the #GstFlowCombiner to free</doc>
- <type name="FlowCombiner" c:type="GstFlowCombiner*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_flow_combiner_ref" version="1.12.1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="124">Increments the reference count on the #GstFlowCombiner.</doc>
- <source-position filename="libs/gst/base/gstflowcombiner.h" line="49"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="130">the #GstFlowCombiner.</doc>
- <type name="FlowCombiner" c:type="GstFlowCombiner*"/>
- </return-value>
- <parameters>
- <instance-parameter name="combiner" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="126">the #GstFlowCombiner to add a reference to.</doc>
- <type name="FlowCombiner" c:type="GstFlowCombiner*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_pad"
- c:identifier="gst_flow_combiner_remove_pad"
- version="1.4">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="338">Removes a #GstPad from the #GstFlowCombiner.</doc>
- <source-position filename="libs/gst/base/gstflowcombiner.h" line="67"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="combiner" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="340">the #GstFlowCombiner</doc>
- <type name="FlowCombiner" c:type="GstFlowCombiner*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="341">the #GstPad to remove</doc>
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- </parameters>
- </method>
- <method name="reset"
- c:identifier="gst_flow_combiner_reset"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="190">Reset flow combiner and all pads to their initial state without removing pads.</doc>
- <source-position filename="libs/gst/base/gstflowcombiner.h" line="73"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="combiner" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="192">the #GstFlowCombiner to clear</doc>
- <type name="FlowCombiner" c:type="GstFlowCombiner*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unref"
- c:identifier="gst_flow_combiner_unref"
- version="1.12.1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="144">Decrements the reference count on the #GstFlowCombiner.</doc>
- <source-position filename="libs/gst/base/gstflowcombiner.h" line="52"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="combiner" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="146">the #GstFlowCombiner to unreference.</doc>
- <type name="FlowCombiner" c:type="GstFlowCombiner*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="update_flow"
- c:identifier="gst_flow_combiner_update_flow"
- version="1.4">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="253">Computes the combined flow return for the pads in it.
-
-The #GstFlowReturn parameter should be the last flow return update for a pad
-in this #GstFlowCombiner. It will use this value to be able to shortcut some
-combinations and avoid looking over all pads again. e.g. The last combined
-return is the same as the latest obtained #GstFlowReturn.</doc>
- <source-position filename="libs/gst/base/gstflowcombiner.h" line="58"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="265">The combined #GstFlowReturn</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="combiner" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="255">the #GstFlowCombiner</doc>
- <type name="FlowCombiner" c:type="GstFlowCombiner*"/>
- </instance-parameter>
- <parameter name="fret" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="256">the latest #GstFlowReturn received for a pad in this #GstFlowCombiner</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </parameter>
- </parameters>
- </method>
- <method name="update_pad_flow"
- c:identifier="gst_flow_combiner_update_pad_flow"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="292">Sets the provided pad's last flow return to provided value and computes
-the combined flow return for the pads in it.
-
-The #GstFlowReturn parameter should be the last flow return update for a pad
-in this #GstFlowCombiner. It will use this value to be able to shortcut some
-combinations and avoid looking over all pads again. e.g. The last combined
-return is the same as the latest obtained #GstFlowReturn.</doc>
- <source-position filename="libs/gst/base/gstflowcombiner.h" line="61"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="306">The combined #GstFlowReturn</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="combiner" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="294">the #GstFlowCombiner</doc>
- <type name="FlowCombiner" c:type="GstFlowCombiner*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="295">the #GstPad whose #GstFlowReturn to update</doc>
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="fret" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstflowcombiner.c"
- line="296">the latest #GstFlowReturn received for a pad in this #GstFlowCombiner</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <function-macro name="IS_ADAPTER"
- c:identifier="GST_IS_ADAPTER"
- introspectable="0">
- <source-position filename="libs/gst/base/gstadapter.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ADAPTER_CLASS"
- c:identifier="GST_IS_ADAPTER_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstadapter.h" line="39"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AGGREGATOR"
- c:identifier="GST_IS_AGGREGATOR"
- introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="133"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AGGREGATOR_CLASS"
- c:identifier="GST_IS_AGGREGATOR_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="134"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AGGREGATOR_PAD"
- c:identifier="GST_IS_AGGREGATOR_PAD"
- introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="46"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_AGGREGATOR_PAD_CLASS"
- c:identifier="GST_IS_AGGREGATOR_PAD_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstaggregator.h" line="47"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BASE_PARSE"
- c:identifier="GST_IS_BASE_PARSE"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BASE_PARSE_CLASS"
- c:identifier="GST_IS_BASE_PARSE_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbaseparse.h" line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BASE_SINK"
- c:identifier="GST_IS_BASE_SINK"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BASE_SINK_CLASS"
- c:identifier="GST_IS_BASE_SINK_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesink.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BASE_SRC"
- c:identifier="GST_IS_BASE_SRC"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BASE_SRC_CLASS"
- c:identifier="GST_IS_BASE_SRC_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasesrc.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BASE_TRANSFORM"
- c:identifier="GST_IS_BASE_TRANSFORM"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasetransform.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_BASE_TRANSFORM_CLASS"
- c:identifier="GST_IS_BASE_TRANSFORM_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbasetransform.h" line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_COLLECT_PADS"
- c:identifier="GST_IS_COLLECT_PADS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstcollectpads.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_COLLECT_PADS_CLASS"
- c:identifier="GST_IS_COLLECT_PADS_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstcollectpads.h" line="36"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DATA_QUEUE"
- c:identifier="GST_IS_DATA_QUEUE"
- introspectable="0">
- <source-position filename="libs/gst/base/gstdataqueue.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DATA_QUEUE_CLASS"
- c:identifier="GST_IS_DATA_QUEUE_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstdataqueue.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PUSH_SRC"
- c:identifier="GST_IS_PUSH_SRC"
- introspectable="0">
- <source-position filename="libs/gst/base/gstpushsrc.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PUSH_SRC_CLASS"
- c:identifier="GST_IS_PUSH_SRC_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstpushsrc.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PUSH_SRC"
- c:identifier="GST_PUSH_SRC"
- introspectable="0">
- <source-position filename="libs/gst/base/gstpushsrc.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PUSH_SRC_CLASS"
- c:identifier="GST_PUSH_SRC_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstpushsrc.h" line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PUSH_SRC_GET_CLASS"
- c:identifier="GST_PUSH_SRC_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/base/gstpushsrc.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <class name="PushSrc"
- c:symbol-prefix="push_src"
- c:type="GstPushSrc"
- parent="BaseSrc"
- glib:type-name="GstPushSrc"
- glib:get-type="gst_push_src_get_type"
- glib:type-struct="PushSrcClass">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstpushsrc.c"
- line="23">This class is mostly useful for elements that cannot do
-random access, or at least very slowly. The source usually
-prefers to push out a fixed size buffer.
-
-Subclasses usually operate in a format that is different from the
-default GST_FORMAT_BYTES format of #GstBaseSrc.
-
-Classes extending this base class will usually be scheduled
-in a push based mode. If the peer accepts to operate without
-offsets and within the limits of the allowed block size, this
-class can operate in getrange based mode automatically. To make
-this possible, the subclass should implement and override the
-SCHEDULING query.
-
-The subclass should extend the methods from the baseclass in
-addition to the ::create method.
-
-Seeking, flushing, scheduling and sync is all handled by this
-base class.</doc>
- <source-position filename="libs/gst/base/gstpushsrc.h" line="83"/>
- <virtual-method name="alloc">
- <source-position filename="libs/gst/base/gstpushsrc.h" line="77"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="PushSrc" c:type="GstPushSrc*"/>
- </instance-parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="create">
- <source-position filename="libs/gst/base/gstpushsrc.h" line="75"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="PushSrc" c:type="GstPushSrc*"/>
- </instance-parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="fill">
- <source-position filename="libs/gst/base/gstpushsrc.h" line="79"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <type name="PushSrc" c:type="GstPushSrc*"/>
- </instance-parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <field name="parent">
- <type name="BaseSrc" c:type="GstBaseSrc"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="PushSrcClass"
- c:type="GstPushSrcClass"
- glib:is-gtype-struct-for="PushSrc">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstpushsrc.h"
- line="54">Subclasses can override any of the available virtual methods or not, as
-needed. At the minimum, the @fill method should be overridden to produce
-buffers.</doc>
- <source-position filename="libs/gst/base/gstpushsrc.h" line="83"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstpushsrc.h"
- line="56">Element parent class</doc>
- <type name="BaseSrcClass" c:type="GstBaseSrcClass"/>
- </field>
- <field name="create">
- <callback name="create">
- <source-position filename="libs/gst/base/gstpushsrc.h" line="75"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="PushSrc" c:type="GstPushSrc*"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="alloc">
- <callback name="alloc">
- <source-position filename="libs/gst/base/gstpushsrc.h" line="77"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="PushSrc" c:type="GstPushSrc*"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="fill">
- <callback name="fill">
- <source-position filename="libs/gst/base/gstpushsrc.h" line="79"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <type name="PushSrc" c:type="GstPushSrc*"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="QueueArray"
- c:type="GstQueueArray"
- disguised="1"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="23">#GstQueueArray is an object that provides standard queue functionality
-based on an array instead of linked lists. This reduces the overhead
-caused by memory management by a large factor.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="34"/>
- <method name="clear"
- c:identifier="gst_queue_array_clear"
- version="1.16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="163">Clears queue @array and frees all memory associated to it.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="47"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="165">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="drop_element"
- c:identifier="gst_queue_array_drop_element"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="687">Drops the queue element at position @idx from queue @array.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="71"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="694">the dropped element</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="689">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="690">index to drop</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="drop_struct"
- c:identifier="gst_queue_array_drop_struct"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="569">Drops the queue element at position @idx from queue @array and copies the
-data of the element or structure that was removed into @p_struct if
-@p_struct is set (not NULL).</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="98"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="579">TRUE on success, or FALSE on error</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="571">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="572">index to drop</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="p_struct"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="573">address into which to store the data of the dropped structure, or NULL</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="find"
- c:identifier="gst_queue_array_find"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="709">Finds an element in the queue @array, either by comparing every element
-with @func or by looking up @data if no compare function @func is provided,
-and returning the index of the found element.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="74"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="719">Index of the found element or -1 if nothing was found.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="711">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="712">comparison function, or %NULL to find @data by value</doc>
- <type name="GLib.CompareFunc" c:type="GCompareFunc"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="713">data for comparison function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="free"
- c:identifier="gst_queue_array_free"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="105">Frees queue @array and all memory associated to it.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="40"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="107">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_length"
- c:identifier="gst_queue_array_get_length"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="757">Returns the length of the queue @array</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="78"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="763">the length of the queue @array.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="759">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_empty"
- c:identifier="gst_queue_array_is_empty"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="551">Checks if the queue @array is empty.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="68"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="557">%TRUE if the queue @array is empty</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="553">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="peek_head"
- c:identifier="gst_queue_array_peek_head"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="270">Returns the head of the queue @array and does not
-remove it from the queue.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="53"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="277">The head of the queue</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="272">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="peek_head_struct"
- c:identifier="gst_queue_array_peek_head_struct"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="247">Returns the head of the queue @array without removing it from the queue.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="92"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="253">pointer to element or struct, or NULL if @array was empty. The
- data pointed to by the returned pointer stays valid only as long as
- the queue array is not modified further!</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="249">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="peek_nth"
- c:identifier="gst_queue_array_peek_nth"
- version="1.16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="292">Returns the item at @idx in @array, but does not remove it from the queue.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="56"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="297">The item, or %NULL if @idx was out of bounds</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_nth_struct"
- c:identifier="gst_queue_array_peek_nth_struct"
- version="1.16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="312">Returns the item at @idx in @array, but does not remove it from the queue.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="95"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="317">The item, or %NULL if @idx was out of bounds</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="peek_tail"
- c:identifier="gst_queue_array_peek_tail"
- version="1.14"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="425">Returns the tail of the queue @array, but does not remove it from the queue.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="62"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="431">The tail of the queue</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="427">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="peek_tail_struct"
- c:identifier="gst_queue_array_peek_tail_struct"
- version="1.14"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="453">Returns the tail of the queue @array, but does not remove it from the queue.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="105"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="459">The tail of the queue</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="455">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pop_head"
- c:identifier="gst_queue_array_pop_head"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="219">Returns and head of the queue @array and removes
-it from the queue.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="50"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="226">The head of the queue</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="221">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pop_head_struct"
- c:identifier="gst_queue_array_pop_head_struct"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="189">Returns the head of the queue @array and removes it from the queue.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="89"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="195">pointer to element or struct, or NULL if @array was empty. The
- data pointed to by the returned pointer stays valid only as long as
- the queue array is not modified further!</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="191">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pop_tail"
- c:identifier="gst_queue_array_pop_tail"
- version="1.14"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="481">Returns the tail of the queue @array and removes
-it from the queue.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="59"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="488">The tail of the queue</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="483">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pop_tail_struct"
- c:identifier="gst_queue_array_pop_tail_struct"
- version="1.14"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="516">Returns the tail of the queue @array and removes
-it from the queue.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="102"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="523">The tail of the queue</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="518">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="push_tail"
- c:identifier="gst_queue_array_push_tail"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="401">Pushes @data to the tail of the queue @array.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="65"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="403">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="404">object to push</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="push_tail_struct"
- c:identifier="gst_queue_array_push_tail_struct">
- <source-position filename="libs/gst/base/gstqueuearray.h" line="86"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- <parameter name="p_struct"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_clear_func"
- c:identifier="gst_queue_array_set_clear_func"
- version="1.16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="122">Sets a function to clear an element of @array.
-
-The @clear_func will be called when an element in the array
-data segment is removed and when the array is freed and data
-segment is deallocated as well. @clear_func will be passed a
-pointer to the element to clear, rather than the element itself.
-
-Note that in contrast with other uses of #GDestroyNotify
-functions, @clear_func is expected to clear the contents of
-the array element it is given, but not free the element itself.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="43"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="array" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="124">a #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </instance-parameter>
- <parameter name="clear_func" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="125">a function to clear an element of @array</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <function name="new"
- c:identifier="gst_queue_array_new"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="84">Allocates a new #GstQueueArray object with an initial
-queue size of @initial_size.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="37"/>
- <return-value>
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="91">a new #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </return-value>
- <parameters>
- <parameter name="initial_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="86">Initial size of the new queue</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_for_struct"
- c:identifier="gst_queue_array_new_for_struct"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="53">Allocates a new #GstQueueArray object for elements (e.g. structures)
-of size @struct_size, with an initial queue size of @initial_size.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="83"/>
- <return-value>
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="61">a new #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </return-value>
- <parameters>
- <parameter name="struct_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="55">Size of each element (e.g. structure) in the array</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="initial_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="56">Initial size of the new queue</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <callback name="TypeFindHelperGetRangeFunction"
- c:type="GstTypeFindHelperGetRangeFunction">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.h"
- line="63">This function will be called by gst_type_find_helper_get_range() when
-typefinding functions request to peek at the data of a stream at certain
-offsets. If this function returns GST_FLOW_OK, the result buffer will be
-stored in @buffer. The contents of @buffer is invalid for any other
-return value.
-
-This function is supposed to behave exactly like a #GstPadGetRangeFunction.</doc>
- <source-position filename="libs/gst/base/gsttypefindhelper.h" line="81"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.h"
- line="79">GST_FLOW_OK for success</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="obj" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.h"
- line="65">a #GstObject that will handle the getrange request</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.h"
- line="66">the parent of @obj or %NULL</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.h"
- line="67">the offset of the range</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.h"
- line="68">the length of the range</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.h"
- line="69">a memory location to hold the result buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </callback>
- <function name="bit_reader_new"
- c:identifier="gst_bit_reader_new"
- moved-to="BitReader.new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="51">Create a new #GstBitReader instance, which will read from @data.
-
-Free-function: gst_bit_reader_free</doc>
- <source-position filename="libs/gst/base/gstbitreader.h" line="55"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="61">a new #GstBitReader instance</doc>
- <type name="BitReader" c:type="GstBitReader*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="53">Data from which the #GstBitReader
- should read</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitreader.c"
- line="55">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="bit_writer_new"
- c:identifier="gst_bit_writer_new"
- moved-to="BitWriter.new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="40">Creates a new, empty #GstBitWriter instance.
-
-Free-function: gst_bit_writer_free</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="61"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="47">a new, empty #GstByteWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </return-value>
- </function>
- <function name="bit_writer_new_with_data"
- c:identifier="gst_bit_writer_new_with_data"
- moved-to="BitWriter.new_with_data"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="79">Creates a new #GstBitWriter instance with the given memory area. If
-@initialized is %TRUE it is possible to read @size bits from the
-#GstBitWriter from the beginning.
-
-Free-function: gst_bit_writer_free</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="67"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="91">a new #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="81">Memory area for writing</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="82">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="initialized" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="83">if %TRUE the complete data can be read from the beginning</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="bit_writer_new_with_size"
- c:identifier="gst_bit_writer_new_with_size"
- moved-to="BitWriter.new_with_size"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="59">Creates a #GstBitWriter instance with the given initial data size.
-
-Free-function: gst_bit_writer_free</doc>
- <source-position filename="libs/gst/base/gstbitwriter.h" line="64"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="68">a new #GstBitWriter instance</doc>
- <type name="BitWriter" c:type="GstBitWriter*"/>
- </return-value>
- <parameters>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="61">Initial size of data in bytes</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="fixed" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbitwriter.c"
- line="62">If %TRUE the data can't be reallocated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="byte_reader_dup_string"
- c:identifier="gst_byte_reader_dup_string"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbytereader.h" line="224"/>
- <parameters>
- <parameter name="reader">
- </parameter>
- <parameter name="str">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="byte_reader_get_string"
- c:identifier="gst_byte_reader_get_string"
- introspectable="0">
- <source-position filename="libs/gst/base/gstbytereader.h" line="248"/>
- <parameters>
- <parameter name="reader">
- </parameter>
- <parameter name="str">
- </parameter>
- </parameters>
- </function-macro>
- <function name="byte_reader_new"
- c:identifier="gst_byte_reader_new"
- moved-to="ByteReader.new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="86">Create a new #GstByteReader instance, which will read from @data.
-
-Free-function: gst_byte_reader_free</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="52"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="96">a new #GstByteReader instance</doc>
- <type name="ByteReader" c:type="GstByteReader*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="88">data from which the
- #GstByteReader should read</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="90">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="byte_reader_peek_string"
- c:identifier="gst_byte_reader_peek_string"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1125">Returns a constant pointer to the current data position if there is
-a NUL-terminated string in the data (this could be just a NUL terminator).
-The current position will be maintained. This will work for any
-NUL-terminated string with a character width of 8 bits, so ASCII,
-UTF-8, ISO-8859-N etc.
-
-This function will fail if no NUL-terminator was found in in the data.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="251"/>
- <parameters>
- <parameter name="reader">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1127">a #GstByteReader instance</doc>
- </parameter>
- <parameter name="str">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1128">address of a
- #gchar pointer variable in which to store the result</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="byte_reader_skip_string"
- c:identifier="gst_byte_reader_skip_string"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1067">Skips a NUL-terminated string in the #GstByteReader instance, advancing
-the current position to the byte after the string. This will work for
-any NUL-terminated string with a character width of 8 bits, so ASCII,
-UTF-8, ISO-8859-N etc.
-
-This function will fail if no NUL-terminator was found in in the data.</doc>
- <source-position filename="libs/gst/base/gstbytereader.h" line="236"/>
- <parameters>
- <parameter name="reader">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytereader.c"
- line="1069">a #GstByteReader instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="byte_writer_new"
- c:identifier="gst_byte_writer_new"
- moved-to="ByteWriter.new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="67">Creates a new, empty #GstByteWriter instance
-
-Free-function: gst_byte_writer_free</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="55"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="74">a new, empty #GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </return-value>
- </function>
- <function name="byte_writer_new_with_data"
- c:identifier="gst_byte_writer_new_with_data"
- moved-to="ByteWriter.new_with_data"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="110">Creates a new #GstByteWriter instance with the given
-memory area. If @initialized is %TRUE it is possible to
-read @size bytes from the #GstByteWriter from the beginning.
-
-Free-function: gst_byte_writer_free</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="61"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="122">a new #GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="112">Memory area for writing</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="113">Size of @data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="initialized" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="114">If %TRUE the complete data can be read from the beginning</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="byte_writer_new_with_size"
- c:identifier="gst_byte_writer_new_with_size"
- moved-to="ByteWriter.new_with_size"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="85">Creates a new #GstByteWriter instance with the given
-initial data size.
-
-Free-function: gst_byte_writer_free</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="58"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="95">a new #GstByteWriter instance</doc>
- <type name="ByteWriter" c:type="GstByteWriter*"/>
- </return-value>
- <parameters>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="87">Initial size of data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="fixed" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.c"
- line="88">If %TRUE the data can't be reallocated</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="byte_writer_put_string"
- c:identifier="gst_byte_writer_put_string"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.h"
- line="218">Write a NUL-terminated string to @writer (including the terminator). The
-string is assumed to be in an 8-bit encoding (e.g. ASCII,UTF-8 or
-ISO-8859-1).</doc>
- <source-position filename="libs/gst/base/gstbytewriter.h" line="229"/>
- <parameters>
- <parameter name="writer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.h"
- line="220">#GstByteWriter instance</doc>
- </parameter>
- <parameter name="data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstbytewriter.h"
- line="221">Null terminated string</doc>
- </parameter>
- </parameters>
- </function-macro>
- <docsection name="gsttypefindhelper">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="24">Utility functions for elements doing typefinding:
-gst_type_find_helper() does typefinding in pull mode, while
-gst_type_find_helper_for_buffer() is useful for elements needing to do
-typefinding in push mode from a chain function.</doc>
- </docsection>
- <function name="queue_array_new"
- c:identifier="gst_queue_array_new"
- moved-to="QueueArray.new"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="84">Allocates a new #GstQueueArray object with an initial
-queue size of @initial_size.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="37"/>
- <return-value>
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="91">a new #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </return-value>
- <parameters>
- <parameter name="initial_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="86">Initial size of the new queue</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="queue_array_new_for_struct"
- c:identifier="gst_queue_array_new_for_struct"
- moved-to="QueueArray.new_for_struct"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="53">Allocates a new #GstQueueArray object for elements (e.g. structures)
-of size @struct_size, with an initial queue size of @initial_size.</doc>
- <source-position filename="libs/gst/base/gstqueuearray.h" line="83"/>
- <return-value>
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="61">a new #GstQueueArray object</doc>
- <type name="QueueArray" c:type="GstQueueArray*"/>
- </return-value>
- <parameters>
- <parameter name="struct_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="55">Size of each element (e.g. structure) in the array</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="initial_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gstqueuearray.c"
- line="56">Initial size of the new queue</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="type_find_helper" c:identifier="gst_type_find_helper">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="463">Tries to find what type of data is flowing from the given source #GstPad.
-
-Free-function: gst_caps_unref</doc>
- <source-position filename="libs/gst/base/gsttypefindhelper.h" line="33"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="472">the #GstCaps corresponding to the data
- stream. Returns %NULL if no #GstCaps matches the data stream.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="465">A source #GstPad</doc>
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="466">The length in bytes</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="type_find_helper_for_buffer"
- c:identifier="gst_type_find_helper_for_buffer">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="684">Tries to find what type of data is contained in the given #GstBuffer, the
-assumption being that the buffer represents the beginning of the stream or
-file.
-
-All available typefinders will be called on the data in order of rank. If
-a typefinding function returns a probability of %GST_TYPE_FIND_MAXIMUM,
-typefinding is stopped immediately and the found caps will be returned
-right away. Otherwise, all available typefind functions will the tried,
-and the caps with the highest probability will be returned, or %NULL if
-the content of the buffer could not be identified.
-
-Free-function: gst_caps_unref</doc>
- <source-position filename="libs/gst/base/gsttypefindhelper.h" line="49"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="704">the #GstCaps corresponding to the data,
- or %NULL if no type could be found. The caller should free the caps
- returned with gst_caps_unref().</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="obj"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="686">object doing the typefinding, or %NULL (used for logging)</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="687">a #GstBuffer with data to typefind</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="prob"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="688">location to store the probability of the found
- caps, or %NULL</doc>
- <type name="Gst.TypeFindProbability"
- c:type="GstTypeFindProbability*"/>
- </parameter>
- </parameters>
- </function>
- <function name="type_find_helper_for_buffer_with_extension"
- c:identifier="gst_type_find_helper_for_buffer_with_extension"
- version="1.16">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="715">Tries to find what type of data is contained in the given #GstBuffer, the
-assumption being that the buffer represents the beginning of the stream or
-file.
-
-All available typefinders will be called on the data in order of rank. If
-a typefinding function returns a probability of %GST_TYPE_FIND_MAXIMUM,
-typefinding is stopped immediately and the found caps will be returned
-right away. Otherwise, all available typefind functions will the tried,
-and the caps with the highest probability will be returned, or %NULL if
-the content of the buffer could not be identified.
-
-When @extension is not %NULL, this function will first try the typefind
-functions for the given extension, which might speed up the typefinding
-in many cases.
-
-Free-function: gst_caps_unref</doc>
- <source-position filename="libs/gst/base/gsttypefindhelper.h" line="54"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="740">the #GstCaps corresponding to the data,
- or %NULL if no type could be found. The caller should free the caps
- returned with gst_caps_unref().</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="obj"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="717">object doing the typefinding, or %NULL (used for logging)</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="718">a #GstBuffer with data to typefind</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="extension"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="719">extension of the media, or %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="prob"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="720">location to store the probability of the found
- caps, or %NULL</doc>
- <type name="Gst.TypeFindProbability"
- c:type="GstTypeFindProbability*"/>
- </parameter>
- </parameters>
- </function>
- <function name="type_find_helper_for_data"
- c:identifier="gst_type_find_helper_for_data">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="569">Tries to find what type of data is contained in the given @data, the
-assumption being that the data represents the beginning of the stream or
-file.
-
-All available typefinders will be called on the data in order of rank. If
-a typefinding function returns a probability of %GST_TYPE_FIND_MAXIMUM,
-typefinding is stopped immediately and the found caps will be returned
-right away. Otherwise, all available typefind functions will the tried,
-and the caps with the highest probability will be returned, or %NULL if
-the content of @data could not be identified.
-
-Free-function: gst_caps_unref</doc>
- <source-position filename="libs/gst/base/gsttypefindhelper.h" line="36"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="590">the #GstCaps corresponding to the data,
- or %NULL if no type could be found. The caller should free the caps
- returned with gst_caps_unref().</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="obj"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="571">object doing the typefinding, or %NULL (used for logging)</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="572">* a pointer with data to typefind</doc>
- <array length="2" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="573">the size of @data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="prob"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="574">location to store the probability of the found
- caps, or %NULL</doc>
- <type name="Gst.TypeFindProbability"
- c:type="GstTypeFindProbability*"/>
- </parameter>
- </parameters>
- </function>
- <function name="type_find_helper_for_data_with_extension"
- c:identifier="gst_type_find_helper_for_data_with_extension"
- version="1.16">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="602">Tries to find what type of data is contained in the given @data, the
-assumption being that the data represents the beginning of the stream or
-file.
-
-All available typefinders will be called on the data in order of rank. If
-a typefinding function returns a probability of %GST_TYPE_FIND_MAXIMUM,
-typefinding is stopped immediately and the found caps will be returned
-right away. Otherwise, all available typefind functions will the tried,
-and the caps with the highest probability will be returned, or %NULL if
-the content of @data could not be identified.
-
-When @extension is not %NULL, this function will first try the typefind
-functions for the given extension, which might speed up the typefinding
-in many cases.
-
-Free-function: gst_caps_unref</doc>
- <source-position filename="libs/gst/base/gsttypefindhelper.h" line="42"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="628">the #GstCaps corresponding to the data,
- or %NULL if no type could be found. The caller should free the caps
- returned with gst_caps_unref().</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="obj"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="604">object doing the typefinding, or %NULL (used for logging)</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="605">* a pointer with data to typefind</doc>
- <array length="2" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="606">the size of @data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="extension"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="607">extension of the media, or %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="prob"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="608">location to store the probability of the found
- caps, or %NULL</doc>
- <type name="Gst.TypeFindProbability"
- c:type="GstTypeFindProbability*"/>
- </parameter>
- </parameters>
- </function>
- <function name="type_find_helper_for_extension"
- c:identifier="gst_type_find_helper_for_extension">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="769">Tries to find the best #GstCaps associated with @extension.
-
-All available typefinders will be checked against the extension in order
-of rank. The caps of the first typefinder that can handle @extension will be
-returned.
-
-Free-function: gst_caps_unref</doc>
- <source-position filename="libs/gst/base/gsttypefindhelper.h" line="60"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="782">the #GstCaps corresponding to
- @extension, or %NULL if no type could be found. The caller should free
- the caps returned with gst_caps_unref().</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="obj"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="771">object doing the typefinding, or %NULL (used for logging)</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="extension" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="772">an extension</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="type_find_helper_get_range"
- c:identifier="gst_type_find_helper_get_range">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="303">Utility function to do pull-based typefinding. Unlike gst_type_find_helper()
-however, this function will use the specified function @func to obtain the
-data needed by the typefind functions, rather than operating on a given
-source pad. This is useful mostly for elements like tag demuxers which
-strip off data at the beginning and/or end of a file and want to typefind
-the stripped data stream before adding their own source pad (the specified
-callback can then call the upstream peer pad with offsets adjusted for the
-tag size, for example).
-
-When @extension is not %NULL, this function will first try the typefind
-functions for the given extension, which might speed up the typefinding
-in many cases.
-
-Free-function: gst_caps_unref</doc>
- <source-position filename="libs/gst/base/gsttypefindhelper.h" line="87"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="329">the #GstCaps corresponding to the data
- stream. Returns %NULL if no #GstCaps matches the data stream.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="obj" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="305">A #GstObject that will be passed as first argument to @func</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="306">the parent of @obj or %NULL</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="func" transfer-ownership="none" scope="call">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="307">A generic #GstTypeFindHelperGetRangeFunction that will
- be used to access data at random offsets when doing the typefinding</doc>
- <type name="TypeFindHelperGetRangeFunction"
- c:type="GstTypeFindHelperGetRangeFunction"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="309">The length in bytes</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="extension"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="310">extension of the media, or %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="prob"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="311">location to store the probability of the found
- caps, or %NULL</doc>
- <type name="Gst.TypeFindProbability"
- c:type="GstTypeFindProbability*"/>
- </parameter>
- </parameters>
- </function>
- <function name="type_find_helper_get_range_full"
- c:identifier="gst_type_find_helper_get_range_full"
- version="1.14.3">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="345">Utility function to do pull-based typefinding. Unlike gst_type_find_helper()
-however, this function will use the specified function @func to obtain the
-data needed by the typefind functions, rather than operating on a given
-source pad. This is useful mostly for elements like tag demuxers which
-strip off data at the beginning and/or end of a file and want to typefind
-the stripped data stream before adding their own source pad (the specified
-callback can then call the upstream peer pad with offsets adjusted for the
-tag size, for example).
-
-When @extension is not %NULL, this function will first try the typefind
-functions for the given extension, which might speed up the typefinding
-in many cases.</doc>
- <source-position filename="libs/gst/base/gsttypefindhelper.h" line="95"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="370">the last %GstFlowReturn from pulling a buffer or %GST_FLOW_OK if
- typefinding was successful.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="obj" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="347">A #GstObject that will be passed as first argument to @func</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="parent"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="348">the parent of @obj or %NULL</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="func" transfer-ownership="none" scope="call">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="349">A generic #GstTypeFindHelperGetRangeFunction that will
- be used to access data at random offsets when doing the typefinding</doc>
- <type name="TypeFindHelperGetRangeFunction"
- c:type="GstTypeFindHelperGetRangeFunction"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="351">The length in bytes</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="extension"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="352">extension of the media, or %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="caps"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="353">returned caps</doc>
- <type name="Gst.Caps" c:type="GstCaps**"/>
- </parameter>
- <parameter name="prob"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/base/gsttypefindhelper.c"
- line="354">location to store the probability of the found
- caps, or %NULL</doc>
- <type name="Gst.TypeFindProbability"
- c:type="GstTypeFindProbability*"/>
- </parameter>
- </parameters>
- </function>
- </namespace>
-</repository>
diff --git a/girs/GstController-1.0.gir b/girs/GstController-1.0.gir
deleted file mode 100644
index 47704d79dd..0000000000
--- a/girs/GstController-1.0.gir
+++ /dev/null
@@ -1,1604 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="GLib" version="2.0"/>
- <include name="GModule" version="2.0"/>
- <include name="GObject" version="2.0"/>
- <include name="Gst" version="1.0"/>
- <package name="gstreamer-controller-1.0"/>
- <c:include name="gst/controller/controller.h"/>
- <namespace name="GstController"
- version="1.0"
- shared-library="libgstcontroller-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <class name="ARGBControlBinding"
- c:symbol-prefix="argb_control_binding"
- c:type="GstARGBControlBinding"
- parent="Gst.ControlBinding"
- glib:type-name="GstARGBControlBinding"
- glib:get-type="gst_argb_control_binding_get_type"
- glib:type-struct="ARGBControlBindingClass">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstargbcontrolbinding.c"
- line="23">A value mapping object that attaches multiple control sources to a guint
-gobject properties representing a color. A control value of 0.0 will turn the
-color component off and a value of 1.0 will be the color level.</doc>
- <source-position filename="libs/gst/controller/gstargbcontrolbinding.h"
- line="87"/>
- <constructor name="new" c:identifier="gst_argb_control_binding_new">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstargbcontrolbinding.c"
- line="460">Create a new control-binding that attaches the given #GstControlSource to the
-#GObject property.</doc>
- <source-position filename="libs/gst/controller/gstargbcontrolbinding.h"
- line="95"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstargbcontrolbinding.c"
- line="472">the new #GstARGBControlBinding</doc>
- <type name="Gst.ControlBinding" c:type="GstControlBinding*"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstargbcontrolbinding.c"
- line="462">the object of the property</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstargbcontrolbinding.c"
- line="463">the property-name to attach the control source</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="cs_a" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstargbcontrolbinding.c"
- line="464">the control source for the alpha channel</doc>
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </parameter>
- <parameter name="cs_r" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstargbcontrolbinding.c"
- line="465">the control source for the red channel</doc>
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </parameter>
- <parameter name="cs_g" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstargbcontrolbinding.c"
- line="466">the control source for the green channel</doc>
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </parameter>
- <parameter name="cs_b" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstargbcontrolbinding.c"
- line="467">the control source for the blue channel</doc>
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </parameter>
- </parameters>
- </constructor>
- <property name="control-source-a"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="Gst.ControlSource"/>
- </property>
- <property name="control-source-b"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="Gst.ControlSource"/>
- </property>
- <property name="control-source-g"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="Gst.ControlSource"/>
- </property>
- <property name="control-source-r"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="Gst.ControlSource"/>
- </property>
- <field name="parent">
- <type name="Gst.ControlBinding" c:type="GstControlBinding"/>
- </field>
- <field name="cs_a" readable="0" private="1">
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </field>
- <field name="cs_r" readable="0" private="1">
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </field>
- <field name="cs_g" readable="0" private="1">
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </field>
- <field name="cs_b" readable="0" private="1">
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </field>
- <field name="cur_value" readable="0" private="1">
- <type name="GObject.Value" c:type="GValue"/>
- </field>
- <field name="last_value" readable="0" private="1">
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="ARGBControlBindingClass"
- c:type="GstARGBControlBindingClass"
- glib:is-gtype-struct-for="ARGBControlBinding">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstargbcontrolbinding.h"
- line="73">The class structure of #GstARGBControlBinding.</doc>
- <source-position filename="libs/gst/controller/gstargbcontrolbinding.h"
- line="87"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstargbcontrolbinding.h"
- line="75">Parent class</doc>
- <type name="Gst.ControlBindingClass" c:type="GstControlBindingClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <function-macro name="ARGB_CONTROL_BINDING"
- c:identifier="GST_ARGB_CONTROL_BINDING"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstargbcontrolbinding.h"
- line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ARGB_CONTROL_BINDING_CLASS"
- c:identifier="GST_ARGB_CONTROL_BINDING_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstargbcontrolbinding.h"
- line="39"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ARGB_CONTROL_BINDING_GET_CLASS"
- c:identifier="GST_ARGB_CONTROL_BINDING_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstargbcontrolbinding.h"
- line="45"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <record name="ControlPoint"
- c:type="GstControlPoint"
- glib:type-name="GstControlPoint"
- glib:get-type="gst_control_point_get_type"
- c:symbol-prefix="control_point">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="52">An internal structure for value+time and various temporary
-values used for interpolation. This "inherits" from
-GstTimedValue.</doc>
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="81"/>
- <field name="timestamp" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="54">timestamp of the value change</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="value" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="55">the new value</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <union name="cache" c:type="cache">
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="80"/>
- <record name="cubic" c:type="cubic">
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="75"/>
- <field name="h" writable="1">
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="z" writable="1">
- <type name="gdouble" c:type="gdouble"/>
- </field>
- </record>
- <record name="cubic_monotonic" c:type="cubic_monotonic">
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="78"/>
- <field name="c1s" writable="1">
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="c2s" writable="1">
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="c3s" writable="1">
- <type name="gdouble" c:type="gdouble"/>
- </field>
- </record>
- <field name="_gst_reserved" writable="1">
- <array zero-terminated="0" fixed-size="64">
- <type name="guint8" c:type="guint8"/>
- </array>
- </field>
- </union>
- <method name="copy" c:identifier="gst_control_point_copy">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="84">Copies a #GstControlPoint</doc>
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="154"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="90">A copy of @cp</doc>
- <type name="ControlPoint" c:type="GstControlPoint*"/>
- </return-value>
- <parameters>
- <instance-parameter name="cp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="86">The control point to copy</doc>
- <type name="ControlPoint" c:type="GstControlPoint*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_control_point_free">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="70">Frees all data allocated by a #GstControlPoint instance.</doc>
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="151"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="cp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="72">the object to free</doc>
- <type name="ControlPoint" c:type="GstControlPoint*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <function-macro name="DIRECT_CONTROL_BINDING"
- c:identifier="GST_DIRECT_CONTROL_BINDING"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DIRECT_CONTROL_BINDING_CLASS"
- c:identifier="GST_DIRECT_CONTROL_BINDING_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="38"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DIRECT_CONTROL_BINDING_GET_CLASS"
- c:identifier="GST_DIRECT_CONTROL_BINDING_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="44"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <class name="DirectControlBinding"
- c:symbol-prefix="direct_control_binding"
- c:type="GstDirectControlBinding"
- parent="Gst.ControlBinding"
- glib:type-name="GstDirectControlBinding"
- glib:get-type="gst_direct_control_binding_get_type"
- glib:type-struct="DirectControlBindingClass">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.c"
- line="22">A value mapping object that attaches control sources to gobject properties. It
-will map the control values directly to the target property range. If a
-non-absolute direct control binding is used, the value range [0.0 ... 1.0]
-is mapped to full target property range, and all values outside the range
-will be clipped. An absolute control binding will not do any value
-transformations.</doc>
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="111"/>
- <constructor name="new" c:identifier="gst_direct_control_binding_new">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.c"
- line="512">Create a new control-binding that attaches the #GstControlSource to the
-#GObject property. It will map the control source range [0.0 ... 1.0] to
-the full target property range, and clip all values outside this range.</doc>
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="119"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.c"
- line="522">the new #GstDirectControlBinding</doc>
- <type name="Gst.ControlBinding" c:type="GstControlBinding*"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.c"
- line="514">the object of the property</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.c"
- line="515">the property-name to attach the control source</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="cs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.c"
- line="516">the control source</doc>
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_absolute"
- c:identifier="gst_direct_control_binding_new_absolute"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.c"
- line="532">Create a new control-binding that attaches the #GstControlSource to the
-#GObject property. It will directly map the control source values to the
-target property range without any transformations.</doc>
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="122"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.c"
- line="542">the new #GstDirectControlBinding</doc>
- <type name="Gst.ControlBinding" c:type="GstControlBinding*"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.c"
- line="534">the object of the property</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.c"
- line="535">the property-name to attach the control source</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="cs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.c"
- line="536">the control source</doc>
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </parameter>
- </parameters>
- </constructor>
- <property name="absolute"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="control-source"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="Gst.ControlSource"/>
- </property>
- <field name="parent">
- <type name="Gst.ControlBinding" c:type="GstControlBinding"/>
- </field>
- <field name="cs" readable="0" private="1">
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </field>
- <field name="cur_value" readable="0" private="1">
- <type name="GObject.Value" c:type="GValue"/>
- </field>
- <field name="last_value" readable="0" private="1">
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="byte_size" readable="0" private="1">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="convert_value" readable="0" private="1">
- <type name="DirectControlBindingConvertValue"
- c:type="GstDirectControlBindingConvertValue"/>
- </field>
- <field name="convert_g_value" readable="0" private="1">
- <type name="DirectControlBindingConvertGValue"
- c:type="GstDirectControlBindingConvertGValue"/>
- </field>
- <union name="ABI" c:type="ABI">
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="94"/>
- <field name="_gst_reserved" writable="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <record name="abi" c:type="abi">
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="93"/>
- <field name="want_absolute" writable="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- </record>
- </union>
- </class>
- <record name="DirectControlBindingClass"
- c:type="GstDirectControlBindingClass"
- glib:is-gtype-struct-for="DirectControlBinding">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="97">The class structure of #GstDirectControlBinding.</doc>
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="111"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="99">Parent class</doc>
- <type name="Gst.ControlBindingClass" c:type="GstControlBindingClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <callback name="DirectControlBindingConvertGValue"
- c:type="GstDirectControlBindingConvertGValue">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="61">Function to map a control-value to the target GValue.</doc>
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="69"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="63">the #GstDirectControlBinding instance</doc>
- <type name="DirectControlBinding" c:type="GstDirectControlBinding*"/>
- </parameter>
- <parameter name="src_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="64">the value returned by the cotnrol source</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="dest_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="65">the target GValue</doc>
- <type name="GObject.Value" c:type="GValue*"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="DirectControlBindingConvertValue"
- c:type="GstDirectControlBindingConvertValue">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="51">Function to map a control-value to the target plain data type.</doc>
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="59"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="53">the #GstDirectControlBinding instance</doc>
- <type name="DirectControlBinding" c:type="GstDirectControlBinding*"/>
- </parameter>
- <parameter name="src_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="54">the value returned by the cotnrol source</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="dest_value"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="55">the target location</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <function-macro name="INTERPOLATION_CONTROL_SOURCE"
- c:identifier="GST_INTERPOLATION_CONTROL_SOURCE"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="INTERPOLATION_CONTROL_SOURCE_CLASS"
- c:identifier="GST_INTERPOLATION_CONTROL_SOURCE_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="38"/>
- <parameters>
- <parameter name="vtable">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="INTERPOLATION_CONTROL_SOURCE_GET_CLASS"
- c:identifier="GST_INTERPOLATION_CONTROL_SOURCE_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="44"/>
- <parameters>
- <parameter name="inst">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ARGB_CONTROL_BINDING"
- c:identifier="GST_IS_ARGB_CONTROL_BINDING"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstargbcontrolbinding.h"
- line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ARGB_CONTROL_BINDING_CLASS"
- c:identifier="GST_IS_ARGB_CONTROL_BINDING_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstargbcontrolbinding.h"
- line="43"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DIRECT_CONTROL_BINDING"
- c:identifier="GST_IS_DIRECT_CONTROL_BINDING"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="40"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DIRECT_CONTROL_BINDING_CLASS"
- c:identifier="GST_IS_DIRECT_CONTROL_BINDING_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstdirectcontrolbinding.h"
- line="42"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_INTERPOLATION_CONTROL_SOURCE"
- c:identifier="GST_IS_INTERPOLATION_CONTROL_SOURCE"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="40"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_INTERPOLATION_CONTROL_SOURCE_CLASS"
- c:identifier="GST_IS_INTERPOLATION_CONTROL_SOURCE_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="42"/>
- <parameters>
- <parameter name="vtable">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_LFO_CONTROL_SOURCE"
- c:identifier="GST_IS_LFO_CONTROL_SOURCE"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstlfocontrolsource.h"
- line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_LFO_CONTROL_SOURCE_CLASS"
- c:identifier="GST_IS_LFO_CONTROL_SOURCE_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstlfocontrolsource.h"
- line="40"/>
- <parameters>
- <parameter name="vtable">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PROXY_CONTROL_BINDING"
- c:identifier="GST_IS_PROXY_CONTROL_BINDING"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstproxycontrolbinding.h"
- line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PROXY_CONTROL_BINDING_CLASS"
- c:identifier="GST_IS_PROXY_CONTROL_BINDING_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstproxycontrolbinding.h"
- line="36"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TIMED_VALUE_CONTROL_SOURCE"
- c:identifier="GST_IS_TIMED_VALUE_CONTROL_SOURCE"
- introspectable="0">
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TIMED_VALUE_CONTROL_SOURCE_CLASS"
- c:identifier="GST_IS_TIMED_VALUE_CONTROL_SOURCE_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="41"/>
- <parameters>
- <parameter name="vtable">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TRIGGER_CONTROL_SOURCE"
- c:identifier="GST_IS_TRIGGER_CONTROL_SOURCE"
- introspectable="0">
- <source-position filename="libs/gst/controller/gsttriggercontrolsource.h"
- line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TRIGGER_CONTROL_SOURCE_CLASS"
- c:identifier="GST_IS_TRIGGER_CONTROL_SOURCE_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gsttriggercontrolsource.h"
- line="43"/>
- <parameters>
- <parameter name="vtable">
- </parameter>
- </parameters>
- </function-macro>
- <class name="InterpolationControlSource"
- c:symbol-prefix="interpolation_control_source"
- c:type="GstInterpolationControlSource"
- parent="TimedValueControlSource"
- glib:type-name="GstInterpolationControlSource"
- glib:get-type="gst_interpolation_control_source_get_type"
- glib:type-struct="InterpolationControlSourceClass">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstinterpolationcontrolsource.c"
- line="24">#GstInterpolationControlSource is a #GstControlSource, that interpolates values between user-given
-control points. It supports several interpolation modes and property types.
-
-To use #GstInterpolationControlSource get a new instance by calling
-gst_interpolation_control_source_new(), bind it to a #GParamSpec and set some
-control points by calling gst_timed_value_control_source_set().
-
-All functions are MT-safe.</doc>
- <source-position filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="90"/>
- <constructor name="new"
- c:identifier="gst_interpolation_control_source_new">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstinterpolationcontrolsource.c"
- line="641">This returns a new, unbound #GstInterpolationControlSource.</doc>
- <source-position filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="98"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstinterpolationcontrolsource.c"
- line="646">a new, unbound #GstInterpolationControlSource.</doc>
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </return-value>
- </constructor>
- <property name="mode" writable="1" transfer-ownership="none">
- <type name="InterpolationMode"/>
- </property>
- <field name="parent">
- <type name="TimedValueControlSource"
- c:type="GstTimedValueControlSource"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="InterpolationControlSourcePrivate"
- c:type="GstInterpolationControlSourcePrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="InterpolationControlSourceClass"
- c:type="GstInterpolationControlSourceClass"
- glib:is-gtype-struct-for="InterpolationControlSource">
- <source-position filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="90"/>
- <field name="parent_class">
- <type name="TimedValueControlSourceClass"
- c:type="GstTimedValueControlSourceClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="InterpolationControlSourcePrivate"
- c:type="GstInterpolationControlSourcePrivate"
- disguised="1">
- <source-position filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="50"/>
- </record>
- <enumeration name="InterpolationMode"
- glib:type-name="GstInterpolationMode"
- glib:get-type="gst_interpolation_mode_get_type"
- c:type="GstInterpolationMode">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="52">The various interpolation modes available.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_INTERPOLATION_MODE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="54">steps-like interpolation, default</doc>
- </member>
- <member name="linear"
- value="1"
- c:identifier="GST_INTERPOLATION_MODE_LINEAR"
- glib:nick="linear">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="55">linear interpolation</doc>
- </member>
- <member name="cubic"
- value="2"
- c:identifier="GST_INTERPOLATION_MODE_CUBIC"
- glib:nick="cubic">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="56">cubic interpolation (natural), may overshoot
- the min or max values set by the control point, but is more 'curvy'</doc>
- </member>
- <member name="cubic_monotonic"
- value="3"
- c:identifier="GST_INTERPOLATION_MODE_CUBIC_MONOTONIC"
- glib:nick="cubic-monotonic">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstinterpolationcontrolsource.h"
- line="58">monotonic cubic interpolation, will not
- produce any values outside of the min-max range set by the control points
- (Since: 1.8)</doc>
- </member>
- </enumeration>
- <class name="LFOControlSource"
- c:symbol-prefix="lfo_control_source"
- c:type="GstLFOControlSource"
- parent="Gst.ControlSource"
- glib:type-name="GstLFOControlSource"
- glib:get-type="gst_lfo_control_source_get_type"
- glib:type-struct="LFOControlSourceClass">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.c"
- line="24">#GstLFOControlSource is a #GstControlSource, that provides several periodic
-waveforms as control values.
-
-To use #GstLFOControlSource get a new instance by calling
-gst_lfo_control_source_new(), bind it to a #GParamSpec and set the relevant
-properties.
-
-All functions are MT-safe.</doc>
- <source-position filename="libs/gst/controller/gstlfocontrolsource.h"
- line="88"/>
- <constructor name="new" c:identifier="gst_lfo_control_source_new">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.c"
- line="394">This returns a new, unbound #GstLFOControlSource.</doc>
- <source-position filename="libs/gst/controller/gstlfocontrolsource.h"
- line="96"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.c"
- line="399">a new, unbound #GstLFOControlSource.</doc>
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </return-value>
- </constructor>
- <property name="amplitude" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.c"
- line="575">Specifies the amplitude for the waveform of this #GstLFOControlSource.</doc>
- <type name="gdouble" c:type="gdouble"/>
- </property>
- <property name="frequency" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.c"
- line="548">Specifies the frequency that should be used for the waveform
-of this #GstLFOControlSource. It should be large enough
-so that the period is longer than one nanosecond.</doc>
- <type name="gdouble" c:type="gdouble"/>
- </property>
- <property name="offset" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.c"
- line="585">Specifies the value offset for the waveform of this #GstLFOControlSource.</doc>
- <type name="gdouble" c:type="gdouble"/>
- </property>
- <property name="timeshift" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.c"
- line="560">Specifies the timeshift to the right that should be used for the waveform
-of this #GstLFOControlSource in nanoseconds.
-
-To get a n nanosecond shift to the left use
-"(GST_SECOND / frequency) - n".</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="waveform" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.c"
- line="538">Specifies the waveform that should be used for this #GstLFOControlSource.</doc>
- <type name="LFOWaveform"/>
- </property>
- <field name="parent">
- <type name="Gst.ControlSource" c:type="GstControlSource"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="LFOControlSourcePrivate"
- c:type="GstLFOControlSourcePrivate*"/>
- </field>
- <field name="lock" readable="0" private="1">
- <type name="GLib.Mutex" c:type="GMutex"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="LFOControlSourceClass"
- c:type="GstLFOControlSourceClass"
- glib:is-gtype-struct-for="LFOControlSource">
- <source-position filename="libs/gst/controller/gstlfocontrolsource.h"
- line="88"/>
- <field name="parent_class">
- <type name="Gst.ControlSourceClass" c:type="GstControlSourceClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="LFOControlSourcePrivate"
- c:type="GstLFOControlSourcePrivate"
- disguised="1">
- <source-position filename="libs/gst/controller/gstlfocontrolsource.h"
- line="48"/>
- </record>
- <enumeration name="LFOWaveform"
- glib:type-name="GstLFOWaveform"
- glib:get-type="gst_lfo_waveform_get_type"
- c:type="GstLFOWaveform">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.h"
- line="50">The various waveform modes available.</doc>
- <member name="sine"
- value="0"
- c:identifier="GST_LFO_WAVEFORM_SINE"
- glib:nick="sine">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.h"
- line="52">sine waveform</doc>
- </member>
- <member name="square"
- value="1"
- c:identifier="GST_LFO_WAVEFORM_SQUARE"
- glib:nick="square">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.h"
- line="53">square waveform</doc>
- </member>
- <member name="saw"
- value="2"
- c:identifier="GST_LFO_WAVEFORM_SAW"
- glib:nick="saw">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.h"
- line="54">saw waveform</doc>
- </member>
- <member name="reverse_saw"
- value="3"
- c:identifier="GST_LFO_WAVEFORM_REVERSE_SAW"
- glib:nick="reverse-saw">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.h"
- line="55">reverse saw waveform</doc>
- </member>
- <member name="triangle"
- value="4"
- c:identifier="GST_LFO_WAVEFORM_TRIANGLE"
- glib:nick="triangle">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstlfocontrolsource.h"
- line="56">triangle waveform</doc>
- </member>
- </enumeration>
- <function-macro name="LFO_CONTROL_SOURCE"
- c:identifier="GST_LFO_CONTROL_SOURCE"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstlfocontrolsource.h"
- line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="LFO_CONTROL_SOURCE_CLASS"
- c:identifier="GST_LFO_CONTROL_SOURCE_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstlfocontrolsource.h"
- line="36"/>
- <parameters>
- <parameter name="vtable">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="LFO_CONTROL_SOURCE_GET_CLASS"
- c:identifier="GST_LFO_CONTROL_SOURCE_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstlfocontrolsource.h"
- line="42"/>
- <parameters>
- <parameter name="inst">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PROXY_CONTROL_BINDING"
- c:identifier="GST_PROXY_CONTROL_BINDING"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstproxycontrolbinding.h"
- line="30"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PROXY_CONTROL_BINDING_CLASS"
- c:identifier="GST_PROXY_CONTROL_BINDING_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstproxycontrolbinding.h"
- line="32"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PROXY_CONTROL_BINDING_GET_CLASS"
- c:identifier="GST_PROXY_CONTROL_BINDING_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gstproxycontrolbinding.h"
- line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <class name="ProxyControlBinding"
- c:symbol-prefix="proxy_control_binding"
- c:type="GstProxyControlBinding"
- parent="Gst.ControlBinding"
- glib:type-name="GstProxyControlBinding"
- glib:get-type="gst_proxy_control_binding_get_type"
- glib:type-struct="ProxyControlBindingClass">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstproxycontrolbinding.c"
- line="20">A #GstControlBinding that forwards requests to another #GstControlBinding</doc>
- <source-position filename="libs/gst/controller/gstproxycontrolbinding.h"
- line="71"/>
- <constructor name="new"
- c:identifier="gst_proxy_control_binding_new"
- version="1.12">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstproxycontrolbinding.c"
- line="165">#GstProxyControlBinding forwards all access to data or `sync_values()`
-requests from @property_name on @object to the control binding at
-@ref_property_name on @ref_object.</doc>
- <source-position filename="libs/gst/controller/gstproxycontrolbinding.h"
- line="77"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstproxycontrolbinding.c"
- line="177">a new #GstControlBinding that proxies the control interface between
-properties on different #GstObject's</doc>
- <type name="Gst.ControlBinding" c:type="GstControlBinding*"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstproxycontrolbinding.c"
- line="167">a #GstObject</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstproxycontrolbinding.c"
- line="168">the property name in @object to control</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="ref_object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstproxycontrolbinding.c"
- line="169">a #GstObject to forward all
- #GstControlBinding requests to</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="ref_property_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstproxycontrolbinding.c"
- line="171">the property_name in @ref_object to control</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <field name="parent" readable="0" private="1">
- <type name="Gst.ControlBinding" c:type="GstControlBinding"/>
- </field>
- <field name="ref_object" readable="0" private="1">
- <type name="GObject.WeakRef" c:type="GWeakRef"/>
- </field>
- <field name="property_name" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="_padding" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="ProxyControlBindingClass"
- c:type="GstProxyControlBindingClass"
- glib:is-gtype-struct-for="ProxyControlBinding">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gstproxycontrolbinding.h"
- line="60">Opaque #GstProxyControlBindingClass struct</doc>
- <source-position filename="libs/gst/controller/gstproxycontrolbinding.h"
- line="71"/>
- <field name="parent_class" readable="0" private="1">
- <type name="Gst.ControlBindingClass" c:type="GstControlBindingClass"/>
- </field>
- <field name="_padding" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <function-macro name="TIMED_VALUE_CONTROL_SOURCE"
- c:identifier="GST_TIMED_VALUE_CONTROL_SOURCE"
- introspectable="0">
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMED_VALUE_CONTROL_SOURCE_CLASS"
- c:identifier="GST_TIMED_VALUE_CONTROL_SOURCE_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="37"/>
- <parameters>
- <parameter name="vtable">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMED_VALUE_CONTROL_SOURCE_GET_CLASS"
- c:identifier="GST_TIMED_VALUE_CONTROL_SOURCE_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="43"/>
- <parameters>
- <parameter name="inst">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMED_VALUE_CONTROL_SOURCE_LOCK"
- c:identifier="GST_TIMED_VALUE_CONTROL_SOURCE_LOCK"
- introspectable="0">
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="112"/>
- <parameters>
- <parameter name="o">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TIMED_VALUE_CONTROL_SOURCE_UNLOCK"
- c:identifier="GST_TIMED_VALUE_CONTROL_SOURCE_UNLOCK"
- introspectable="0">
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="114"/>
- <parameters>
- <parameter name="o">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRIGGER_CONTROL_SOURCE"
- c:identifier="GST_TRIGGER_CONTROL_SOURCE"
- introspectable="0">
- <source-position filename="libs/gst/controller/gsttriggercontrolsource.h"
- line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRIGGER_CONTROL_SOURCE_CLASS"
- c:identifier="GST_TRIGGER_CONTROL_SOURCE_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gsttriggercontrolsource.h"
- line="39"/>
- <parameters>
- <parameter name="vtable">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TRIGGER_CONTROL_SOURCE_GET_CLASS"
- c:identifier="GST_TRIGGER_CONTROL_SOURCE_GET_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/controller/gsttriggercontrolsource.h"
- line="45"/>
- <parameters>
- <parameter name="inst">
- </parameter>
- </parameters>
- </function-macro>
- <class name="TimedValueControlSource"
- c:symbol-prefix="timed_value_control_source"
- c:type="GstTimedValueControlSource"
- parent="Gst.ControlSource"
- abstract="1"
- glib:type-name="GstTimedValueControlSource"
- glib:get-type="gst_timed_value_control_source_get_type"
- glib:type-struct="TimedValueControlSourceClass">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="25">Base class for #GstControlSource that use time-stamped values.
-
-When overriding bind, chain up first to give this bind implementation a
-chance to setup things.
-
-All functions are MT-safe.</doc>
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="111"/>
- <method name="find_control_point_iter"
- c:identifier="gst_timed_value_control_source_find_control_point_iter">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="224">Find last value before given timestamp in control point list.
-If all values in the control point list come after the given
-timestamp or no values exist, %NULL is returned.
-
-For use in control source implementations.</doc>
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="124"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="235">the found #GSequenceIter or %NULL</doc>
- <type name="GLib.SequenceIter" c:type="GSequenceIter*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="226">the control source to search in</doc>
- <type name="TimedValueControlSource"
- c:type="GstTimedValueControlSource*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="227">the search key</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_all"
- c:identifier="gst_timed_value_control_source_get_all">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="393">Returns a read-only copy of the list of #GstTimedValue for the given property.
-Free the list after done with it.</doc>
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="142"/>
- <return-value transfer-ownership="container">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="400">a copy
-of the list, or %NULL if the property isn't handled by the controller</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Gst.TimedValue"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="395">the #GstTimedValueControlSource to get the list from</doc>
- <type name="TimedValueControlSource"
- c:type="GstTimedValueControlSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_count"
- c:identifier="gst_timed_value_control_source_get_count">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="418">Get the number of control points that are set.</doc>
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="145"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="424">the number of control points that are set.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="420">the #GstTimedValueControlSource to get the number of values from</doc>
- <type name="TimedValueControlSource"
- c:type="GstTimedValueControlSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set" c:identifier="gst_timed_value_control_source_set">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="260">Set the value of given controller-handled property at a certain time.</doc>
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="128"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="268">FALSE if the values couldn't be set, TRUE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="262">the #GstTimedValueControlSource object</doc>
- <type name="TimedValueControlSource"
- c:type="GstTimedValueControlSource*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="263">the time the control-change is scheduled for</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="264">the control-value</doc>
- <type name="gdouble" c:type="const gdouble"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_from_list"
- c:identifier="gst_timed_value_control_source_set_from_list">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="282">Sets multiple timed values at once.</doc>
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="132"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="290">FALSE if the values couldn't be set, TRUE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="284">the #GstTimedValueControlSource object</doc>
- <type name="TimedValueControlSource"
- c:type="GstTimedValueControlSource*"/>
- </instance-parameter>
- <parameter name="timedvalues" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="285">a list
-with #GstTimedValue items</doc>
- <type name="GLib.SList" c:type="const GSList*">
- <type name="Gst.TimedValue"/>
- </type>
- </parameter>
- </parameters>
- </method>
- <method name="unset" c:identifier="gst_timed_value_control_source_unset">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="316">Used to remove the value of given controller-handled property at a certain
-time.</doc>
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="135"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="324">FALSE if the value couldn't be unset (i.e. not found, TRUE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="318">the #GstTimedValueControlSource object</doc>
- <type name="TimedValueControlSource"
- c:type="GstTimedValueControlSource*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="319">the time the control-change should be removed from</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="unset_all"
- c:identifier="gst_timed_value_control_source_unset_all">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="363">Used to remove all time-stamped values of given controller-handled property</doc>
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="139"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="365">the #GstTimedValueControlSource object</doc>
- <type name="TimedValueControlSource"
- c:type="GstTimedValueControlSource*"/>
- </instance-parameter>
- </parameters>
- </method>
- <field name="parent">
- <type name="Gst.ControlSource" c:type="GstControlSource"/>
- </field>
- <field name="lock">
- <type name="GLib.Mutex" c:type="GMutex"/>
- </field>
- <field name="values">
- <type name="GLib.Sequence" c:type="GSequence*"/>
- </field>
- <field name="nvalues">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="valid_cache">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TimedValueControlSourcePrivate"
- c:type="GstTimedValueControlSourcePrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="value-added" when="first" version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="486">Emitted right after the new value has been added to @self</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="timed_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="490">The newly added #GstTimedValue</doc>
- <type name="ControlPoint"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="value-changed" when="first" version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="472">Emitted right after the new value has been set on @timed_signals</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="timed_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="475">The #GstTimedValue where the value changed</doc>
- <type name="ControlPoint"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="value-removed" when="first" version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="501">Emitted when @timed_value is removed from @self</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="timed_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="505">The removed #GstTimedValue</doc>
- <type name="ControlPoint"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="TimedValueControlSourceClass"
- c:type="GstTimedValueControlSourceClass"
- glib:is-gtype-struct-for="TimedValueControlSource">
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="111"/>
- <field name="parent_class">
- <type name="Gst.ControlSourceClass" c:type="GstControlSourceClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="TimedValueControlSourcePrivate"
- c:type="GstTimedValueControlSourcePrivate"
- disguised="1">
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="49"/>
- </record>
- <class name="TriggerControlSource"
- c:symbol-prefix="trigger_control_source"
- c:type="GstTriggerControlSource"
- parent="TimedValueControlSource"
- glib:type-name="GstTriggerControlSource"
- glib:get-type="gst_trigger_control_source_get_type"
- glib:type-struct="TriggerControlSourceClass">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttriggercontrolsource.c"
- line="25">#GstTriggerControlSource is a #GstControlSource, that returns values from user-given
-control points. It allows for a tolerance on the time-stamps.
-
-To use #GstTriggerControlSource get a new instance by calling
-gst_trigger_control_source_new(), bind it to a #GParamSpec and set some
-control points by calling gst_timed_value_control_source_set().
-
-All functions are MT-safe.</doc>
- <source-position filename="libs/gst/controller/gsttriggercontrolsource.h"
- line="73"/>
- <constructor name="new" c:identifier="gst_trigger_control_source_new">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttriggercontrolsource.c"
- line="185">This returns a new, unbound #GstTriggerControlSource.</doc>
- <source-position filename="libs/gst/controller/gsttriggercontrolsource.h"
- line="81"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttriggercontrolsource.c"
- line="190">a new, unbound #GstTriggerControlSource.</doc>
- <type name="Gst.ControlSource" c:type="GstControlSource*"/>
- </return-value>
- </constructor>
- <property name="tolerance" writable="1" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </property>
- <field name="parent">
- <type name="TimedValueControlSource"
- c:type="GstTimedValueControlSource"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TriggerControlSourcePrivate"
- c:type="GstTriggerControlSourcePrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TriggerControlSourceClass"
- c:type="GstTriggerControlSourceClass"
- glib:is-gtype-struct-for="TriggerControlSource">
- <source-position filename="libs/gst/controller/gsttriggercontrolsource.h"
- line="73"/>
- <field name="parent_class">
- <type name="TimedValueControlSourceClass"
- c:type="GstTimedValueControlSourceClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="TriggerControlSourcePrivate"
- c:type="GstTriggerControlSourcePrivate"
- disguised="1">
- <source-position filename="libs/gst/controller/gsttriggercontrolsource.h"
- line="53"/>
- </record>
- <function name="timed_value_control_invalidate_cache"
- c:identifier="gst_timed_value_control_invalidate_cache">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="433">Reset the controlled value cache.</doc>
- <source-position filename="libs/gst/controller/gsttimedvaluecontrolsource.h"
- line="148"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/controller/gsttimedvaluecontrolsource.c"
- line="435">the #GstTimedValueControlSource</doc>
- <type name="TimedValueControlSource"
- c:type="GstTimedValueControlSource*"/>
- </parameter>
- </parameters>
- </function>
- </namespace>
-</repository>
diff --git a/girs/GstNet-1.0.gir b/girs/GstNet-1.0.gir
deleted file mode 100644
index 52535405e5..0000000000
--- a/girs/GstNet-1.0.gir
+++ /dev/null
@@ -1,1290 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="GLib" version="2.0"/>
- <include name="GModule" version="2.0"/>
- <include name="GObject" version="2.0"/>
- <include name="Gio" version="2.0"/>
- <include name="Gst" version="1.0"/>
- <package name="gstreamer-net-1.0"/>
- <c:include name="gst/net/net.h"/>
- <namespace name="GstNet"
- version="1.0"
- shared-library="libgstnet-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <function-macro name="IS_NET_CLIENT_CLOCK"
- c:identifier="GST_IS_NET_CLIENT_CLOCK"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_NET_CLIENT_CLOCK_CLASS"
- c:identifier="GST_IS_NET_CLIENT_CLOCK_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="43"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_NET_TIME_PROVIDER"
- c:identifier="GST_IS_NET_TIME_PROVIDER"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnettimeprovider.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_NET_TIME_PROVIDER_CLASS"
- c:identifier="GST_IS_NET_TIME_PROVIDER_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnettimeprovider.h" line="38"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_NTP_CLOCK"
- c:identifier="GST_IS_NTP_CLOCK"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="83"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_NTP_CLOCK_CLASS"
- c:identifier="GST_IS_NTP_CLOCK_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="85"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PTP_CLOCK"
- c:identifier="GST_IS_PTP_CLOCK"
- introspectable="0">
- <source-position filename="libs/gst/net/gstptpclock.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_PTP_CLOCK_CLASS"
- c:identifier="GST_IS_PTP_CLOCK_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/net/gstptpclock.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="NET_CLIENT_CLOCK"
- c:identifier="GST_NET_CLIENT_CLOCK"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="NET_CLIENT_CLOCK_CLASS"
- c:identifier="GST_NET_CLIENT_CLOCK_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="39"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="NET_TIME_PACKET_SIZE"
- value="16"
- c:type="GST_NET_TIME_PACKET_SIZE">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.h"
- line="30">The size of the packets sent between network clocks.</doc>
- <source-position filename="libs/gst/net/gstnettimepacket.h" line="35"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="NET_TIME_PROVIDER"
- c:identifier="GST_NET_TIME_PROVIDER"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnettimeprovider.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="NET_TIME_PROVIDER_CLASS"
- c:identifier="GST_NET_TIME_PROVIDER_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnettimeprovider.h" line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="NTP_CLOCK"
- c:identifier="GST_NTP_CLOCK"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="79"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="NTP_CLOCK_CLASS"
- c:identifier="GST_NTP_CLOCK_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="81"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <record name="NetAddressMeta" c:type="GstNetAddressMeta">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetaddressmeta.c"
- line="20">#GstNetAddressMeta can be used to store a network address (a #GSocketAddress)
-in a #GstBuffer so that it network elements can track the to and from address
-of the buffer.</doc>
- <source-position filename="libs/gst/net/gstnetaddressmeta.h" line="42"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetaddressmeta.h"
- line="33">the parent type</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="addr" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetaddressmeta.h"
- line="34">a #GSocketAddress stored as metadata</doc>
- <type name="Gio.SocketAddress" c:type="GSocketAddress*"/>
- </field>
- <function name="get_info" c:identifier="gst_net_address_meta_get_info">
- <source-position filename="libs/gst/net/gstnetaddressmeta.h"
- line="51"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <class name="NetClientClock"
- c:symbol-prefix="net_client_clock"
- c:type="GstNetClientClock"
- parent="Gst.SystemClock"
- glib:type-name="GstNetClientClock"
- glib:get-type="gst_net_client_clock_get_type"
- glib:type-struct="NetClientClockClass">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="26">#GstNetClientClock implements a custom #GstClock that synchronizes its time
-to a remote time provider such as #GstNetTimeProvider. #GstNtpClock
-implements a #GstClock that synchronizes its time to a remote NTPv4 server.
-
-A new clock is created with gst_net_client_clock_new() or
-gst_ntp_clock_new(), which takes the address and port of the remote time
-provider along with a name and an initial time.
-
-This clock will poll the time provider and will update its calibration
-parameters based on the local and remote observations.
-
-The "round-trip" property limits the maximum round trip packets can take.
-
-Various parameters of the clock can be configured with the parent #GstClock
-"timeout", "window-size" and "window-threshold" object properties.
-
-A #GstNetClientClock and #GstNtpClock is typically set on a #GstPipeline with
-gst_pipeline_use_clock().
-
-If you set a #GstBus on the clock via the "bus" object property, it will
-send @GST_MESSAGE_ELEMENT messages with an attached #GstStructure containing
-statistics about clock accuracy and network traffic.</doc>
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="70"/>
- <constructor name="new" c:identifier="gst_net_client_clock_new">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="1411">Create a new #GstNetClientClock that will report the time
-provided by the #GstNetTimeProvider on @remote_address and
-@remote_port.</doc>
- <source-position filename="libs/gst/net/gstnetclientclock.h"
- line="76"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="1422">a new #GstClock that receives a time from the remote
-clock.</doc>
- <type name="Gst.Clock" c:type="GstClock*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="1413">a name for the clock</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="remote_address" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="1414">the address or hostname of the remote clock provider</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="remote_port" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="1415">the port of the remote clock provider</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="base_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="1416">initial time of the clock</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </constructor>
- <property name="address"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="base-time"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="bus" writable="1" transfer-ownership="none">
- <type name="Gst.Bus"/>
- </property>
- <property name="internal-clock" transfer-ownership="none">
- <type name="Gst.Clock"/>
- </property>
- <property name="minimum-update-interval"
- writable="1"
- transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="port"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <property name="qos-dscp" writable="1" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <property name="round-trip-limit" writable="1" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <field name="clock">
- <type name="Gst.SystemClock" c:type="GstSystemClock"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="NetClientClockPrivate" c:type="GstNetClientClockPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="NetClientClockClass"
- c:type="GstNetClientClockClass"
- glib:is-gtype-struct-for="NetClientClock">
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="70"/>
- <field name="parent_class">
- <type name="Gst.SystemClockClass" c:type="GstSystemClockClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="NetClientClockPrivate"
- c:type="GstNetClientClockPrivate"
- disguised="1">
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="49"/>
- </record>
- <record name="NetControlMessageMeta" c:type="GstNetControlMessageMeta">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetcontrolmessagemeta.c"
- line="20">#GstNetControlMessageMeta can be used to store control messages (ancillary
-data) which was received with or is to be sent alongside the buffer data.
-When used with socket sinks and sources which understand this meta it allows
-sending and receiving ancillary data such as unix credentials (See
-#GUnixCredentialsMessage) and Unix file descriptions (See #GUnixFDMessage).</doc>
- <source-position filename="libs/gst/net/gstnetcontrolmessagemeta.h"
- line="43"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetcontrolmessagemeta.h"
- line="33">the parent type</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="message" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetcontrolmessagemeta.h"
- line="34">a #GSocketControlMessage stored as metadata</doc>
- <type name="Gio.SocketControlMessage" c:type="GSocketControlMessage*"/>
- </field>
- <function name="get_info"
- c:identifier="gst_net_control_message_meta_get_info">
- <source-position filename="libs/gst/net/gstnetcontrolmessagemeta.h"
- line="57"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <record name="NetTimePacket"
- c:type="GstNetTimePacket"
- glib:type-name="GstNetTimePacket"
- glib:get-type="gst_net_time_packet_get_type"
- c:symbol-prefix="net_time_packet">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="21">Various functions for receiving, sending an serializing #GstNetTimePacket
-structures.</doc>
- <source-position filename="libs/gst/net/gstnettimepacket.h" line="49"/>
- <field name="local_time" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.h"
- line="41">the local time when this packet was sent</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="remote_time" writable="1">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.h"
- line="42">the remote time observation</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <constructor name="new" c:identifier="gst_net_time_packet_new">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="48">Creates a new #GstNetTimePacket from a buffer received over the network. The
-caller is responsible for ensuring that @buffer is at least
-#GST_NET_TIME_PACKET_SIZE bytes long.
-
-If @buffer is %NULL, the local and remote times will be set to
-#GST_CLOCK_TIME_NONE.
-
-MT safe. Caller owns return value (gst_net_time_packet_free to free).</doc>
- <source-position filename="libs/gst/net/gstnettimepacket.h" line="55"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="61">The new #GstNetTimePacket.</doc>
- <type name="NetTimePacket" c:type="GstNetTimePacket*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="50">a buffer from which to construct the packet, or NULL</doc>
- <array zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </constructor>
- <method name="copy" c:identifier="gst_net_time_packet_copy">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="95">Make a copy of @packet.</doc>
- <source-position filename="libs/gst/net/gstnettimepacket.h" line="58"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="101">a copy of @packet, free with gst_net_time_packet_free().</doc>
- <type name="NetTimePacket" c:type="GstNetTimePacket*"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="97">the #GstNetTimePacket</doc>
- <type name="NetTimePacket" c:type="const GstNetTimePacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_net_time_packet_free">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="83">Free @packet.</doc>
- <source-position filename="libs/gst/net/gstnettimepacket.h" line="61"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="85">the #GstNetTimePacket</doc>
- <type name="NetTimePacket" c:type="GstNetTimePacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="send" c:identifier="gst_net_time_packet_send" throws="1">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="201">Sends a #GstNetTimePacket over a socket.
-
-MT safe.</doc>
- <source-position filename="libs/gst/net/gstnettimepacket.h" line="71"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="212">TRUE if successful, FALSE in case an error occurred.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="203">the #GstNetTimePacket to send</doc>
- <type name="NetTimePacket" c:type="const GstNetTimePacket*"/>
- </instance-parameter>
- <parameter name="socket" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="204">socket to send the time packet on</doc>
- <type name="Gio.Socket" c:type="GSocket*"/>
- </parameter>
- <parameter name="dest_address" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="205">address to send the time packet to</doc>
- <type name="Gio.SocketAddress" c:type="GSocketAddress*"/>
- </parameter>
- </parameters>
- </method>
- <method name="serialize" c:identifier="gst_net_time_packet_serialize">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="115">Serialized a #GstNetTimePacket into a newly-allocated sequence of
-#GST_NET_TIME_PACKET_SIZE bytes, in network byte order. The value returned is
-suitable for passing to write(2) or sendto(2) for communication over the
-network.
-
-MT safe. Caller owns return value (g_free to free).</doc>
- <source-position filename="libs/gst/net/gstnettimepacket.h" line="64"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="126">A newly allocated sequence of #GST_NET_TIME_PACKET_SIZE bytes.</doc>
- <type name="guint8" c:type="guint8*"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="117">the #GstNetTimePacket</doc>
- <type name="NetTimePacket" c:type="const GstNetTimePacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="receive"
- c:identifier="gst_net_time_packet_receive"
- throws="1">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="143">Receives a #GstNetTimePacket over a socket. Handles interrupted system
-calls, but otherwise returns NULL on error.</doc>
- <source-position filename="libs/gst/net/gstnettimepacket.h" line="67"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="152">a new #GstNetTimePacket, or NULL on error. Free
- with gst_net_time_packet_free() when done.</doc>
- <type name="NetTimePacket" c:type="GstNetTimePacket*"/>
- </return-value>
- <parameters>
- <parameter name="socket" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="145">socket to receive the time packet on</doc>
- <type name="Gio.Socket" c:type="GSocket*"/>
- </parameter>
- <parameter name="src_address"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="146">address of variable to return sender address</doc>
- <type name="Gio.SocketAddress" c:type="GSocketAddress**"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <class name="NetTimeProvider"
- c:symbol-prefix="net_time_provider"
- c:type="GstNetTimeProvider"
- parent="Gst.Object"
- glib:type-name="GstNetTimeProvider"
- glib:get-type="gst_net_time_provider_get_type"
- glib:type-struct="NetTimeProviderClass">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimeprovider.c"
- line="19">This object exposes the time of a #GstClock on the network.
-
-A #GstNetTimeProvider is created with gst_net_time_provider_new() which
-takes a #GstClock, an address and a port number as arguments.
-
-After creating the object, a client clock such as #GstNetClientClock can
-query the exposed clock over the network for its values.
-
-The #GstNetTimeProvider typically wraps the clock used by a #GstPipeline.</doc>
- <source-position filename="libs/gst/net/gstnettimeprovider.h" line="64"/>
- <implements name="Gio.Initable"/>
- <constructor name="new" c:identifier="gst_net_time_provider_new">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimeprovider.c"
- line="450">Allows network clients to get the current time of @clock.</doc>
- <source-position filename="libs/gst/net/gstnettimeprovider.h"
- line="70"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimeprovider.c"
- line="459">the new #GstNetTimeProvider, or NULL on error</doc>
- <type name="NetTimeProvider" c:type="GstNetTimeProvider*"/>
- </return-value>
- <parameters>
- <parameter name="clock" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimeprovider.c"
- line="452">a #GstClock to export over the network</doc>
- <type name="Gst.Clock" c:type="GstClock*"/>
- </parameter>
- <parameter name="address"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimeprovider.c"
- line="453">an address to bind on as a dotted quad
- (xxx.xxx.xxx.xxx), IPv6 address, or NULL to bind to all addresses</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="port" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimeprovider.c"
- line="455">a port to bind on, or 0 to let the kernel choose</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </constructor>
- <property name="active" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="address"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="clock"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="Gst.Clock"/>
- </property>
- <property name="port"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <property name="qos-dscp" writable="1" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <field name="parent">
- <type name="Gst.Object" c:type="GstObject"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="NetTimeProviderPrivate"
- c:type="GstNetTimeProviderPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="NetTimeProviderClass"
- c:type="GstNetTimeProviderClass"
- glib:is-gtype-struct-for="NetTimeProvider">
- <source-position filename="libs/gst/net/gstnettimeprovider.h" line="64"/>
- <field name="parent_class">
- <type name="Gst.ObjectClass" c:type="GstObjectClass"/>
- </field>
- <field name="_gst_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="NetTimeProviderPrivate"
- c:type="GstNetTimeProviderPrivate"
- disguised="1">
- <source-position filename="libs/gst/net/gstnettimeprovider.h" line="44"/>
- </record>
- <class name="NtpClock"
- c:symbol-prefix="ntp_clock"
- c:type="GstNtpClock"
- parent="NetClientClock"
- glib:type-name="GstNtpClock"
- glib:get-type="gst_ntp_clock_get_type"
- glib:type-struct="NtpClockClass">
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="91"/>
- <constructor name="new" c:identifier="gst_ntp_clock_new" version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="1459">Create a new #GstNtpClock that will report the time provided by
-the NTPv4 server on @remote_address and @remote_port.</doc>
- <source-position filename="libs/gst/net/gstnetclientclock.h"
- line="97"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="1469">a new #GstClock that receives a time from the remote
-clock.</doc>
- <type name="Gst.Clock" c:type="GstClock*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="1461">a name for the clock</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="remote_address" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="1462">the address or hostname of the remote clock provider</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="remote_port" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="1463">the port of the remote clock provider</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="base_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetclientclock.c"
- line="1464">initial time of the clock</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </constructor>
- <field name="clock">
- <type name="Gst.SystemClock" c:type="GstSystemClock"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="NetClientClockPrivate" c:type="GstNetClientClockPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="NtpClockClass"
- c:type="GstNtpClockClass"
- glib:is-gtype-struct-for="NtpClock">
- <source-position filename="libs/gst/net/gstnetclientclock.h" line="91"/>
- <field name="parent_class">
- <type name="Gst.SystemClockClass" c:type="GstSystemClockClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <function-macro name="PTP_CLOCK"
- c:identifier="GST_PTP_CLOCK"
- introspectable="0">
- <source-position filename="libs/gst/net/gstptpclock.h" line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="PTP_CLOCK_CLASS"
- c:identifier="GST_PTP_CLOCK_CLASS"
- introspectable="0">
- <source-position filename="libs/gst/net/gstptpclock.h" line="33"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="PTP_CLOCK_ID_NONE"
- value="18446744073709551615"
- c:type="GST_PTP_CLOCK_ID_NONE">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.h"
- line="72">PTP clock identification that can be passed to gst_ptp_init() to
-automatically select one based on the MAC address of interfaces</doc>
- <source-position filename="libs/gst/net/gstptpclock.h" line="76"/>
- <type name="guint64" c:type="guint64"/>
- </constant>
- <constant name="PTP_STATISTICS_BEST_MASTER_CLOCK_SELECTED"
- value="GstPtpStatisticsBestMasterClockSelected"
- c:type="GST_PTP_STATISTICS_BEST_MASTER_CLOCK_SELECTED">
- <source-position filename="libs/gst/net/gstptpclock.h" line="94"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="PTP_STATISTICS_NEW_DOMAIN_FOUND"
- value="GstPtpStatisticsNewDomainFound"
- c:type="GST_PTP_STATISTICS_NEW_DOMAIN_FOUND">
- <source-position filename="libs/gst/net/gstptpclock.h" line="93"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="PTP_STATISTICS_PATH_DELAY_MEASURED"
- value="GstPtpStatisticsPathDelayMeasured"
- c:type="GST_PTP_STATISTICS_PATH_DELAY_MEASURED">
- <source-position filename="libs/gst/net/gstptpclock.h" line="95"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="PTP_STATISTICS_TIME_UPDATED"
- value="GstPtpStatisticsTimeUpdated"
- c:type="GST_PTP_STATISTICS_TIME_UPDATED">
- <source-position filename="libs/gst/net/gstptpclock.h" line="96"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <class name="PtpClock"
- c:symbol-prefix="ptp_clock"
- c:type="GstPtpClock"
- version="1.6"
- parent="Gst.SystemClock"
- glib:type-name="GstPtpClock"
- glib:get-type="gst_ptp_clock_get_type"
- glib:type-struct="PtpClockClass">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="20">GstPtpClock implements a PTP (IEEE1588:2008) ordinary clock in slave-only
-mode, that allows a GStreamer pipeline to synchronize to a PTP network
-clock in some specific domain.
-
-The PTP subsystem can be initialized with gst_ptp_init(), which then starts
-a helper process to do the actual communication via the PTP ports. This is
-required as PTP listens on ports &lt; 1024 and thus requires special
-privileges. Once this helper process is started, the main process will
-synchronize to all PTP domains that are detected on the selected
-interfaces.
-
-gst_ptp_clock_new() then allows to create a GstClock that provides the PTP
-time from a master clock inside a specific PTP domain. This clock will only
-return valid timestamps once the timestamps in the PTP domain are known. To
-check this, you can use gst_clock_wait_for_sync(), the GstClock::synced
-signal and gst_clock_is_synced().
-
-To gather statistics about the PTP clock synchronization,
-gst_ptp_statistics_callback_add() can be used. This gives the application
-the possibility to collect all kinds of statistics from the clock
-synchronization.</doc>
- <source-position filename="libs/gst/net/gstptpclock.h" line="70"/>
- <constructor name="new" c:identifier="gst_ptp_clock_new" version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2536">Creates a new PTP clock instance that exports the PTP time of the master
-clock in @domain. This clock can be slaved to other clocks as needed.
-
-If gst_ptp_init() was not called before, this will call gst_ptp_init() with
-default parameters.
-
-This clock only returns valid timestamps after it received the first
-times from the PTP master clock on the network. Once this happens the
-GstPtpClock::internal-clock property will become non-NULL. You can
-check this with gst_clock_wait_for_sync(), the GstClock::synced signal and
-gst_clock_is_synced().</doc>
- <source-position filename="libs/gst/net/gstptpclock.h" line="153"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2553">A new #GstClock</doc>
- <type name="Gst.Clock" c:type="GstClock*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2538">Name of the clock</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="domain" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2539">PTP domain</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </constructor>
- <property name="domain"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="grandmaster-clock-id" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="internal-clock" transfer-ownership="none">
- <type name="Gst.Clock"/>
- </property>
- <property name="master-clock-id" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <field name="clock">
- <type name="Gst.SystemClock" c:type="GstSystemClock"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="PtpClockPrivate" c:type="GstPtpClockPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="PtpClockClass"
- c:type="GstPtpClockClass"
- glib:is-gtype-struct-for="PtpClock">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.h"
- line="59">Opaque #GstPtpClockClass structure.</doc>
- <source-position filename="libs/gst/net/gstptpclock.h" line="70"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.h"
- line="61">parented to #GstSystemClockClass</doc>
- <type name="Gst.SystemClockClass" c:type="GstSystemClockClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="PtpClockPrivate" c:type="GstPtpClockPrivate" disguised="1">
- <source-position filename="libs/gst/net/gstptpclock.h" line="43"/>
- </record>
- <callback name="PtpStatisticsCallback" c:type="GstPtpStatisticsCallback">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.h"
- line="99">The statistics can be the following structures:
-
-GST_PTP_STATISTICS_NEW_DOMAIN_FOUND:
-"domain" G_TYPE_UINT The domain identifier of the domain
-"clock" GST_TYPE_CLOCK The internal clock that is slaved to the
- PTP domain
-
-GST_PTP_STATISTICS_BEST_MASTER_CLOCK_SELECTED:
-"domain" G_TYPE_UINT The domain identifier of the domain
-"master-clock-id" G_TYPE_UINT64 PTP clock identifier of the selected master
- clock
-"master-clock-port" G_TYPE_UINT PTP port number of the selected master clock
-"grandmaster-clock-id" G_TYPE_UINT64 PTP clock identifier of the grandmaster clock
-
-GST_PTP_STATISTICS_PATH_DELAY_MEASURED:
-"domain" G_TYPE_UINT The domain identifier of the domain
-"mean-path-delay-avg" GST_TYPE_CLOCK_TIME Average mean path delay
-"mean-path-delay" GST_TYPE_CLOCK_TIME Latest mean path delay
-"delay-request-delay" GST_TYPE_CLOCK_TIME Delay of DELAY_REQ / DELAY_RESP messages
-
-GST_PTP_STATISTICS_TIME_UPDATED:
-"domain" G_TYPE_UINT The domain identifier of the domain
-"mean-path-delay-avg" GST_TYPE_CLOCK_TIME Average mean path delay
-"local-time" GST_TYPE_CLOCK_TIME Local time that corresponds to ptp-time
-"ptp-time" GST_TYPE_CLOCK_TIME Newly measured PTP time at local-time
-"estimated-ptp-time" GST_TYPE_CLOCK_TIME Estimated PTP time based on previous measurements
-"discontinuity" G_TYPE_INT64 Difference between estimated and measured PTP time
-"synced" G_TYPE_BOOLEAN Currently synced to the remote clock
-"r-squared" G_TYPE_DOUBLE R² of clock estimation regression
-"internal-time" GST_TYPE_CLOCK_TIME Internal time clock parameter
-"external-time" GST_TYPE_CLOCK_TIME External time clock parameter
-"rate-num" G_TYPE_UINT64 Internal/external rate numerator
-"rate-den" G_TYPE_UINT64 Internal/external rate denominator
-"rate" G_TYPE_DOUBLE Internal/external rate
-
-If %FALSE is returned, the callback is removed and never called again.</doc>
- <source-position filename="libs/gst/net/gstptpclock.h" line="143"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="domain" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.h"
- line="101">PTP domain identifier</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="stats" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.h"
- line="102">New statistics</doc>
- <type name="Gst.Structure" c:type="const GstStructure*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.h"
- line="103">Data passed to gst_ptp_statistics_callback_add()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <function name="buffer_add_net_address_meta"
- c:identifier="gst_buffer_add_net_address_meta">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetaddressmeta.c"
- line="101">Attaches @addr as metadata in a #GstNetAddressMeta to @buffer.</doc>
- <source-position filename="libs/gst/net/gstnetaddressmeta.h" line="55"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetaddressmeta.c"
- line="108">a #GstNetAddressMeta connected to @buffer</doc>
- <type name="NetAddressMeta" c:type="GstNetAddressMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetaddressmeta.c"
- line="103">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="addr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetaddressmeta.c"
- line="104">a @GSocketAddress to connect to @buffer</doc>
- <type name="Gio.SocketAddress" c:type="GSocketAddress*"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_net_control_message_meta"
- c:identifier="gst_buffer_add_net_control_message_meta">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetcontrolmessagemeta.c"
- line="107">Attaches @message as metadata in a #GstNetControlMessageMeta to @buffer.</doc>
- <source-position filename="libs/gst/net/gstnetcontrolmessagemeta.h"
- line="63"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetcontrolmessagemeta.c"
- line="114">a #GstNetControlMessageMeta connected to @buffer</doc>
- <type name="NetControlMessageMeta" c:type="GstNetControlMessageMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetcontrolmessagemeta.c"
- line="109">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetcontrolmessagemeta.c"
- line="110">a @GSocketControlMessage to attach to @buffer</doc>
- <type name="Gio.SocketControlMessage"
- c:type="GSocketControlMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_get_net_address_meta"
- c:identifier="gst_buffer_get_net_address_meta">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetaddressmeta.c"
- line="127">Find the #GstNetAddressMeta on @buffer.</doc>
- <source-position filename="libs/gst/net/gstnetaddressmeta.h" line="58"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetaddressmeta.c"
- line="133">the #GstNetAddressMeta or %NULL when there
-is no such metadata on @buffer.</doc>
- <type name="NetAddressMeta" c:type="GstNetAddressMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetaddressmeta.c"
- line="129">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="buffer_get_net_control_message_meta"
- c:identifier="gst_buffer_get_net_control_message_meta"
- introspectable="0">
- <source-position filename="libs/gst/net/gstnetcontrolmessagemeta.h"
- line="50"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <docsection name="gstnetutils">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetutils.c"
- line="20">GstNetUtils gathers network utility functions, enabling use for all
-gstreamer plugins.</doc>
- </docsection>
- <function name="net_address_meta_api_get_type"
- c:identifier="gst_net_address_meta_api_get_type">
- <source-position filename="libs/gst/net/gstnetaddressmeta.h" line="45"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="net_address_meta_get_info"
- c:identifier="gst_net_address_meta_get_info"
- moved-to="NetAddressMeta.get_info">
- <source-position filename="libs/gst/net/gstnetaddressmeta.h" line="51"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="net_control_message_meta_api_get_type"
- c:identifier="gst_net_control_message_meta_api_get_type">
- <source-position filename="libs/gst/net/gstnetcontrolmessagemeta.h"
- line="46"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="net_control_message_meta_get_info"
- c:identifier="gst_net_control_message_meta_get_info"
- moved-to="NetControlMessageMeta.get_info">
- <source-position filename="libs/gst/net/gstnetcontrolmessagemeta.h"
- line="57"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="net_time_packet_receive"
- c:identifier="gst_net_time_packet_receive"
- moved-to="NetTimePacket.receive"
- throws="1">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="143">Receives a #GstNetTimePacket over a socket. Handles interrupted system
-calls, but otherwise returns NULL on error.</doc>
- <source-position filename="libs/gst/net/gstnettimepacket.h" line="67"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="152">a new #GstNetTimePacket, or NULL on error. Free
- with gst_net_time_packet_free() when done.</doc>
- <type name="NetTimePacket" c:type="GstNetTimePacket*"/>
- </return-value>
- <parameters>
- <parameter name="socket" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="145">socket to receive the time packet on</doc>
- <type name="Gio.Socket" c:type="GSocket*"/>
- </parameter>
- <parameter name="src_address"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnettimepacket.c"
- line="146">address of variable to return sender address</doc>
- <type name="Gio.SocketAddress" c:type="GSocketAddress**"/>
- </parameter>
- </parameters>
- </function>
- <function name="net_utils_set_socket_tos"
- c:identifier="gst_net_utils_set_socket_tos"
- version="1.18">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetutils.c"
- line="48">Configures IP_TOS value of socket, i.e. sets QoS DSCP.</doc>
- <source-position filename="libs/gst/net/gstnetutils.h" line="32"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetutils.c"
- line="55">TRUE if successful, FALSE in case an error occurred.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="socket" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetutils.c"
- line="50">Socket to configure</doc>
- <type name="Gio.Socket" c:type="GSocket*"/>
- </parameter>
- <parameter name="qos_dscp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstnetutils.c"
- line="51">QoS DSCP value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="ptp_deinit" c:identifier="gst_ptp_deinit" version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2225">Deinitialize the GStreamer PTP subsystem and stop the PTP clock. If there
-are any remaining GstPtpClock instances, they won't be further synchronized
-to the PTP network clock.</doc>
- <source-position filename="libs/gst/net/gstptpclock.h" line="92"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </function>
- <function name="ptp_init" c:identifier="gst_ptp_init" version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2025">Initialize the GStreamer PTP subsystem and create a PTP ordinary clock in
-slave-only mode for all domains on the given @interfaces with the
-given @clock_id.
-
-If @clock_id is %GST_PTP_CLOCK_ID_NONE, a clock id is automatically
-generated from the MAC address of the first network interface.
-
-This function is automatically called by gst_ptp_clock_new() with default
-parameters if it wasn't called before.</doc>
- <source-position filename="libs/gst/net/gstptpclock.h" line="89"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2040">%TRUE if the GStreamer PTP clock subsystem could be initialized.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="clock_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2027">PTP clock id of this process' clock or %GST_PTP_CLOCK_ID_NONE</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="interfaces"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2028">network interfaces to run the clock on</doc>
- <array c:type="gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="ptp_is_initialized"
- c:identifier="gst_ptp_is_initialized"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2010">Check if the GStreamer PTP clock subsystem is initialized.</doc>
- <source-position filename="libs/gst/net/gstptpclock.h" line="86"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2015">%TRUE if the GStreamer PTP clock subsystem is initialized.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="ptp_is_supported"
- c:identifier="gst_ptp_is_supported"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="1993">Check if PTP clocks are generally supported on this system, and if previous
-initializations did not fail.</doc>
- <source-position filename="libs/gst/net/gstptpclock.h" line="83"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="1999">%TRUE if PTP clocks are generally supported on this system, and
-previous initializations did not fail.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="ptp_statistics_callback_add"
- c:identifier="gst_ptp_statistics_callback_add"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2604">Installs a new statistics callback for gathering PTP statistics. See
-GstPtpStatisticsCallback for a list of statistics that are provided.</doc>
- <source-position filename="libs/gst/net/gstptpclock.h" line="147"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2613">Id for the callback that can be passed to
-gst_ptp_statistics_callback_remove()</doc>
- <type name="gulong" c:type="gulong"/>
- </return-value>
- <parameters>
- <parameter name="callback"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2606">GstPtpStatisticsCallback to call</doc>
- <type name="PtpStatisticsCallback"
- c:type="GstPtpStatisticsCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2607">Data to pass to the callback</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="destroy_data" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2608">GDestroyNotify to destroy the data</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </function>
- <function name="ptp_statistics_callback_remove"
- c:identifier="gst_ptp_statistics_callback_remove"
- version="1.6">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2643">Removes a PTP statistics callback that was previously added with
-gst_ptp_statistics_callback_add().</doc>
- <source-position filename="libs/gst/net/gstptpclock.h" line="150"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="libs/gst/net/gstptpclock.c"
- line="2645">Callback id to remove</doc>
- <type name="gulong" c:type="gulong"/>
- </parameter>
- </parameters>
- </function>
- </namespace>
-</repository>
diff --git a/girs/GstPbutils-1.0.gir b/girs/GstPbutils-1.0.gir
deleted file mode 100644
index f7a5945932..0000000000
--- a/girs/GstPbutils-1.0.gir
+++ /dev/null
@@ -1,6836 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="Gst" version="1.0"/>
- <include name="GstAudio" version="1.0"/>
- <include name="GstBase" version="1.0"/>
- <include name="GstVideo" version="1.0"/>
- <package name="gstreamer-pbutils-1.0"/>
- <c:include name="gst/pbutils/pbutils.h"/>
- <namespace name="GstPbutils"
- version="1.0"
- shared-library="libgstpbutils-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <alias name="DiscovererAudioInfoClass"
- c:type="GstDiscovererAudioInfoClass">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="120"/>
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </alias>
- <alias name="DiscovererContainerInfoClass"
- c:type="GstDiscovererContainerInfoClass">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="99"/>
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </alias>
- <alias name="DiscovererInfoClass" c:type="GstDiscovererInfoClass">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="274"/>
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </alias>
- <alias name="DiscovererStreamInfoClass"
- c:type="GstDiscovererStreamInfoClass">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="36"/>
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </alias>
- <alias name="DiscovererSubtitleInfoClass"
- c:type="GstDiscovererSubtitleInfoClass">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="209"/>
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </alias>
- <alias name="DiscovererVideoInfoClass"
- c:type="GstDiscovererVideoInfoClass">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="158"/>
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </alias>
- <alias name="EncodingTargetClass" c:type="GstEncodingTargetClass">
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="101"/>
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </alias>
- <function-macro name="AUDIO_VISUALIZER"
- c:identifier="GST_AUDIO_VISUALIZER"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_VISUALIZER_CLASS"
- c:identifier="GST_AUDIO_VISUALIZER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="AUDIO_VISUALIZER_GET_CLASS"
- c:identifier="GST_AUDIO_VISUALIZER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <class name="AudioVisualizer"
- c:symbol-prefix="audio_visualizer"
- c:type="GstAudioVisualizer"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstAudioVisualizer"
- glib:get-type="gst_audio_visualizer_get_type"
- glib:type-struct="AudioVisualizerClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstaudiovisualizer.c"
- line="22">A baseclass for scopes (visualizers). It takes care of re-fitting the
-audio-rate to video-rate and handles renegotiation (downstream video size
-changes).
-
-It also provides several background shading effects. These effects are
-applied to a previous picture before the `render()` implementation can draw a
-new frame.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="104"/>
- <virtual-method name="decide_allocation">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="103"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="scope" transfer-ownership="none">
- <type name="AudioVisualizer" c:type="GstAudioVisualizer*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="render">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="101"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="scope" transfer-ownership="none">
- <type name="AudioVisualizer" c:type="GstAudioVisualizer*"/>
- </instance-parameter>
- <parameter name="audio" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="video" transfer-ownership="none">
- <type name="GstVideo.VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="setup">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="98"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="scope" transfer-ownership="none">
- <type name="AudioVisualizer" c:type="GstAudioVisualizer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <property name="shade-amount" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="shader" writable="1" transfer-ownership="none">
- <type name="AudioVisualizerShader"/>
- </property>
- <field name="parent">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="req_spf">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="vinfo">
- <type name="GstVideo.VideoInfo" c:type="GstVideoInfo"/>
- </field>
- <field name="ainfo">
- <type name="GstAudio.AudioInfo" c:type="GstAudioInfo"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="AudioVisualizerPrivate"
- c:type="GstAudioVisualizerPrivate*"/>
- </field>
- </class>
- <record name="AudioVisualizerClass"
- c:type="GstAudioVisualizerClass"
- glib:is-gtype-struct-for="AudioVisualizer">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="104"/>
- <field name="parent_class" readable="0" private="1">
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="setup">
- <callback name="setup">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="98"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="scope" transfer-ownership="none">
- <type name="AudioVisualizer" c:type="GstAudioVisualizer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="render">
- <callback name="render">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="101"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="scope" transfer-ownership="none">
- <type name="AudioVisualizer" c:type="GstAudioVisualizer*"/>
- </parameter>
- <parameter name="audio" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="video" transfer-ownership="none">
- <type name="GstVideo.VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="decide_allocation">
- <callback name="decide_allocation">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="103"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="scope" transfer-ownership="none">
- <type name="AudioVisualizer" c:type="GstAudioVisualizer*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- </record>
- <record name="AudioVisualizerPrivate"
- c:type="GstAudioVisualizerPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="43"/>
- </record>
- <enumeration name="AudioVisualizerShader"
- glib:type-name="GstAudioVisualizerShader"
- glib:get-type="gst_audio_visualizer_shader_get_type"
- c:type="GstAudioVisualizerShader">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="47">Different types of supported background shading functions.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_AUDIO_VISUALIZER_SHADER_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="49">no shading</doc>
- </member>
- <member name="fade"
- value="1"
- c:identifier="GST_AUDIO_VISUALIZER_SHADER_FADE"
- glib:nick="fade">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="50">plain fading</doc>
- </member>
- <member name="fade_and_move_up"
- value="2"
- c:identifier="GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_UP"
- glib:nick="fade-and-move-up">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="51">fade and move up</doc>
- </member>
- <member name="fade_and_move_down"
- value="3"
- c:identifier="GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_DOWN"
- glib:nick="fade-and-move-down">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="52">fade and move down</doc>
- </member>
- <member name="fade_and_move_left"
- value="4"
- c:identifier="GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_LEFT"
- glib:nick="fade-and-move-left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="53">fade and move left</doc>
- </member>
- <member name="fade_and_move_right"
- value="5"
- c:identifier="GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_RIGHT"
- glib:nick="fade-and-move-right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="54">fade and move right</doc>
- </member>
- <member name="fade_and_move_horiz_out"
- value="6"
- c:identifier="GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_HORIZ_OUT"
- glib:nick="fade-and-move-horiz-out">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="55">fade and move horizontally out</doc>
- </member>
- <member name="fade_and_move_horiz_in"
- value="7"
- c:identifier="GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_HORIZ_IN"
- glib:nick="fade-and-move-horiz-in">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="56">fade and move horizontally in</doc>
- </member>
- <member name="fade_and_move_vert_out"
- value="8"
- c:identifier="GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_VERT_OUT"
- glib:nick="fade-and-move-vert-out">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="57">fade and move vertically out</doc>
- </member>
- <member name="fade_and_move_vert_in"
- value="9"
- c:identifier="GST_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_VERT_IN"
- glib:nick="fade-and-move-vert-in">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="58">fade and move vertically in</doc>
- </member>
- </enumeration>
- <callback name="AudioVisualizerShaderFunc"
- c:type="GstAudioVisualizerShaderFunc">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="45"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="scope" transfer-ownership="none">
- <type name="AudioVisualizer" c:type="GstAudioVisualizer*"/>
- </parameter>
- <parameter name="s" transfer-ownership="none">
- <type name="GstVideo.VideoFrame" c:type="const GstVideoFrame*"/>
- </parameter>
- <parameter name="d" transfer-ownership="none">
- <type name="GstVideo.VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </callback>
- <function-macro name="CHECK_PLUGINS_BASE_VERSION"
- c:identifier="GST_CHECK_PLUGINS_BASE_VERSION"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstpluginsbaseversion.h"
- line="63"/>
- <parameters>
- <parameter name="major">
- </parameter>
- <parameter name="minor">
- </parameter>
- <parameter name="micro">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DISCOVERER"
- c:identifier="GST_DISCOVERER"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="338"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DISCOVERER_AUDIO_INFO"
- c:identifier="GST_DISCOVERER_AUDIO_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="112"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DISCOVERER_CLASS"
- c:identifier="GST_DISCOVERER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="340"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DISCOVERER_CONTAINER_INFO"
- c:identifier="GST_DISCOVERER_CONTAINER_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="92"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DISCOVERER_INFO"
- c:identifier="GST_DISCOVERER_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="264"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DISCOVERER_STREAM_INFO"
- c:identifier="GST_DISCOVERER_STREAM_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="30"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DISCOVERER_SUBTITLE_INFO"
- c:identifier="GST_DISCOVERER_SUBTITLE_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="199"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="DISCOVERER_VIDEO_INFO"
- c:identifier="GST_DISCOVERER_VIDEO_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="149"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <class name="Discoverer"
- c:symbol-prefix="discoverer"
- c:type="GstDiscoverer"
- parent="GObject.Object"
- glib:type-name="GstDiscoverer"
- glib:get-type="gst_discoverer_get_type"
- glib:type-struct="DiscovererClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="21">The #GstDiscoverer is a utility object which allows to get as much
-information as possible from one or many URIs.
-
-It provides two APIs, allowing usage in blocking or non-blocking mode.
-
-The blocking mode just requires calling gst_discoverer_discover_uri()
-with the URI one wishes to discover.
-
-The non-blocking mode requires a running #GMainLoop iterating a
-#GMainContext, where one connects to the various signals, appends the
-URIs to be processed (through gst_discoverer_discover_uri_async()) and then
-asks for the discovery to begin (through gst_discoverer_start()).
-By default this will use the GLib default main context unless you have
-set a custom context using g_main_context_push_thread_default().
-
-All the information is returned in a #GstDiscovererInfo structure.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="385"/>
- <constructor name="new" c:identifier="gst_discoverer_new" throws="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2616">Creates a new #GstDiscoverer with the provided timeout.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="391"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2624">The new #GstDiscoverer.
-If an error occurred when creating the discoverer, @err will be set
-accordingly and %NULL will be returned. If @err is set, the caller must
-free it when no longer needed using g_error_free().</doc>
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </return-value>
- <parameters>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2618">timeout per file, in nanoseconds. Allowed are values between
- one second (#GST_SECOND) and one hour (3600 * #GST_SECOND)</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </constructor>
- <virtual-method name="discovered">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="378"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="discoverer" transfer-ownership="none">
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="none">
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </parameter>
- <parameter name="err" transfer-ownership="none">
- <type name="GLib.Error" c:type="const GError*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="finished">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="376"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="discoverer" transfer-ownership="none">
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="source_setup">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="381"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="discoverer" transfer-ownership="none">
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </instance-parameter>
- <parameter name="source" transfer-ownership="none">
- <type name="Gst.Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="starting">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="377"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="discoverer" transfer-ownership="none">
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <method name="discover_uri"
- c:identifier="gst_discoverer_discover_uri"
- throws="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2554">Synchronously discovers the given @uri.
-
-A copy of @uri will be made internally, so the caller can safely g_free()
-afterwards.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="409"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2565">the result of the scanning. Can be %NULL if an
-error occurred.</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </return-value>
- <parameters>
- <instance-parameter name="discoverer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2556">A #GstDiscoverer</doc>
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </instance-parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2557">The URI to run on.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="discover_uri_async"
- c:identifier="gst_discoverer_discover_uri_async">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2515">Appends the given @uri to the list of URIs to discoverer. The actual
-discovery of the @uri will only take place if gst_discoverer_start() has
-been called.
-
-A copy of @uri will be made internally, so the caller can safely g_free()
-afterwards.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="402"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2527">%TRUE if the @uri was successfully appended to the list of pending
-uris, else %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="discoverer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2517">A #GstDiscoverer</doc>
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </instance-parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2518">the URI to add.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="start" c:identifier="gst_discoverer_start">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2414">Allow asynchronous discovering of URIs to take place.
-A #GMainLoop must be available for #GstDiscoverer to properly work in
-asynchronous mode.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="396"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="discoverer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2416">A #GstDiscoverer</doc>
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="stop" c:identifier="gst_discoverer_stop">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2457">Stop the discovery of any pending URIs and clears the list of
-pending URIS (if any).</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="399"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="discoverer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2459">A #GstDiscoverer</doc>
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <property name="timeout"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="232">The duration (in nanoseconds) after which the discovery of an individual
-URI will timeout.
-
-If the discovery of a URI times out, the %GST_DISCOVERER_TIMEOUT will be
-set on the result flags.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="use-cache"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="parent">
- <type name="GObject.Object" c:type="GObject"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="DiscovererPrivate" c:type="GstDiscovererPrivate*"/>
- </field>
- <field name="_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="discovered" when="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="287">Will be emitted in async mode when all information on a URI could be
-discovered, or an error occurred.
-
-When an error occurs, @info might still contain some partial information,
-depending on the circumstances of the error.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="290">the results #GstDiscovererInfo</doc>
- <type name="DiscovererInfo"/>
- </parameter>
- <parameter name="error"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="291">#GError, which will be non-NULL
- if an error occurred during
- discovery. You must not free
- this #GError, it will be freed by
- the discoverer.</doc>
- <type name="GLib.Error"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="finished" when="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="265">Will be emitted in async mode when all pending URIs have been processed.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="source-setup" when="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="309">This signal is emitted after the source element has been created for, so
-the URI being discovered, so it can be configured by setting additional
-properties (e.g. set a proxy server for an http source, or set the device
-and read speed for an audio cd source).
-
-This signal is usually emitted from the context of a GStreamer streaming
-thread.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="source" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="312">source element</doc>
- <type name="Gst.Element"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="starting" when="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="276">Will be emitted when the discover starts analyzing the pending URIs</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- </class>
- <class name="DiscovererAudioInfo"
- c:symbol-prefix="discoverer_audio_info"
- c:type="GstDiscovererAudioInfo"
- parent="DiscovererStreamInfo"
- glib:type-name="GstDiscovererAudioInfo"
- glib:get-type="gst_discoverer_audio_info_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="108">#GstDiscovererStreamInfo specific to audio streams.</doc>
- <method name="get_bitrate"
- c:identifier="gst_discoverer_audio_info_get_bitrate">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="138"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="792">the average or nominal bitrate of the stream in bits/second.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="790">a #GstDiscovererAudioInfo</doc>
- <type name="DiscovererAudioInfo"
- c:type="const GstDiscovererAudioInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_channel_mask"
- c:identifier="gst_discoverer_audio_info_get_channel_mask"
- version="1.14">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="129"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="761">the channel-mask of the stream, refer to
-gst_audio_channel_positions_from_mask() for more
-information.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="759">a #GstDiscovererAudioInfo</doc>
- <type name="DiscovererAudioInfo"
- c:type="const GstDiscovererAudioInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_channels"
- c:identifier="gst_discoverer_audio_info_get_channels">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="126"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="752">the number of channels in the stream.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="750">a #GstDiscovererAudioInfo</doc>
- <type name="DiscovererAudioInfo"
- c:type="const GstDiscovererAudioInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_depth"
- c:identifier="gst_discoverer_audio_info_get_depth">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="135"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="783">the number of bits used per sample in each channel.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="781">a #GstDiscovererAudioInfo</doc>
- <type name="DiscovererAudioInfo"
- c:type="const GstDiscovererAudioInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_language"
- c:identifier="gst_discoverer_audio_info_get_language">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="144"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="810">the language of the stream, or NULL if unknown.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="808">a #GstDiscovererAudioInfo</doc>
- <type name="DiscovererAudioInfo"
- c:type="const GstDiscovererAudioInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_max_bitrate"
- c:identifier="gst_discoverer_audio_info_get_max_bitrate">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="141"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="801">the maximum bitrate of the stream in bits/second.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="799">a #GstDiscovererAudioInfo</doc>
- <type name="DiscovererAudioInfo"
- c:type="const GstDiscovererAudioInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_sample_rate"
- c:identifier="gst_discoverer_audio_info_get_sample_rate">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="132"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="774">the sample rate of the stream in Hertz.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="772">a #GstDiscovererAudioInfo</doc>
- <type name="DiscovererAudioInfo"
- c:type="const GstDiscovererAudioInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- </class>
- <record name="DiscovererClass"
- c:type="GstDiscovererClass"
- glib:is-gtype-struct-for="Discoverer">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="385"/>
- <field name="parentclass">
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </field>
- <field name="finished">
- <callback name="finished">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="376"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="discoverer" transfer-ownership="none">
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="starting">
- <callback name="starting">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="377"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="discoverer" transfer-ownership="none">
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="discovered">
- <callback name="discovered">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="378"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="discoverer" transfer-ownership="none">
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </parameter>
- <parameter name="err" transfer-ownership="none">
- <type name="GLib.Error" c:type="const GError*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="source_setup">
- <callback name="source_setup">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="381"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="discoverer" transfer-ownership="none">
- <type name="Discoverer" c:type="GstDiscoverer*"/>
- </parameter>
- <parameter name="source" transfer-ownership="none">
- <type name="Gst.Element" c:type="GstElement*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_reserved">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="DiscovererContainerInfo"
- c:symbol-prefix="discoverer_container_info"
- c:type="GstDiscovererContainerInfo"
- parent="DiscovererStreamInfo"
- glib:type-name="GstDiscovererContainerInfo"
- glib:get-type="gst_discoverer_container_info_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="87">#GstDiscovererStreamInfo specific to container streams.</doc>
- <method name="get_streams"
- c:identifier="gst_discoverer_container_info_get_streams">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="105"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="721">the list of
-#GstDiscovererStreamInfo this container stream offers.
-Free with gst_discoverer_stream_info_list_free() after usage.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="DiscovererStreamInfo"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="719">a #GstDiscovererStreamInfo</doc>
- <type name="DiscovererContainerInfo"
- c:type="GstDiscovererContainerInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- </class>
- <class name="DiscovererInfo"
- c:symbol-prefix="discoverer_info"
- c:type="GstDiscovererInfo"
- parent="GObject.Object"
- glib:type-name="GstDiscovererInfo"
- glib:get-type="gst_discoverer_info_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="261">Structure containing the information of a URI analyzed by #GstDiscoverer.</doc>
- <function name="from_variant"
- c:identifier="gst_discoverer_info_from_variant"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2689">Parses a #GVariant as produced by gst_discoverer_info_to_variant()
-back to a #GstDiscovererInfo.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="338"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2696">A newly-allocated #GstDiscovererInfo.</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </return-value>
- <parameters>
- <parameter name="variant" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2691">A #GVariant to deserialize into a #GstDiscovererInfo.</doc>
- <type name="GLib.Variant" c:type="GVariant*"/>
- </parameter>
- </parameters>
- </function>
- <method name="copy" c:identifier="gst_discoverer_info_copy">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="283"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="395">A copy of the #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </return-value>
- <parameters>
- <instance-parameter name="ptr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="393">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_audio_streams"
- c:identifier="gst_discoverer_info_get_audio_streams">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="494">Finds all the #GstDiscovererAudioInfo contained in @info</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="322"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="500">A #GList of
-matching #GstDiscovererStreamInfo. The caller should free it with
-gst_discoverer_stream_info_list_free().</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="DiscovererStreamInfo"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="496">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_container_streams"
- c:identifier="gst_discoverer_info_get_container_streams">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="543">Finds all the #GstDiscovererContainerInfo contained in @info</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="331"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="549">A #GList of
-matching #GstDiscovererStreamInfo. The caller should free it with
-gst_discoverer_stream_info_list_free().</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="DiscovererStreamInfo"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="545">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_duration"
- c:identifier="gst_discoverer_info_get_duration">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="298"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1021">the duration of the URI in #GstClockTime (nanoseconds).</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1019">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="const GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_live"
- c:identifier="gst_discoverer_info_get_live"
- version="1.14">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="304"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1039">whether the URI is live.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1037">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="const GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_misc"
- c:identifier="gst_discoverer_info_get_misc"
- deprecated="1">
- <doc-deprecated xml:space="preserve">This functions is deprecated since version 1.4, use
-#gst_discoverer_info_get_missing_elements_installer_details</doc-deprecated>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="307"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1054">Miscellaneous information stored as a #GstStructure
-(for example: information about missing plugins). If you wish to use the
-#GstStructure after the life-time of @info, you will need to copy it.</doc>
- <type name="Gst.Structure" c:type="const GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1049">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="const GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_missing_elements_installer_details"
- c:identifier="gst_discoverer_info_get_missing_elements_installer_details"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1115">Get the installer details for missing elements</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="315"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1122">An array of strings
-containing information about how to install the various missing elements
-for @info to be usable. If you wish to use the strings after the life-time
-of @info, you will need to copy them.</doc>
- <array c:type="const gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1117">a #GstDiscovererStreamInfo to retrieve installer detail
-for the missing element</doc>
- <type name="DiscovererInfo" c:type="const GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_result" c:identifier="gst_discoverer_info_get_result">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="289"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="969">the result of the discovery as a #GstDiscovererResult.</doc>
- <type name="DiscovererResult" c:type="GstDiscovererResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="967">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="const GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_seekable"
- c:identifier="gst_discoverer_info_get_seekable">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="301"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1030">the whether the URI is seekable.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1028">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="const GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_info"
- c:identifier="gst_discoverer_info_get_stream_info">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="292"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="978">the structure (or topology) of the URI as a
-#GstDiscovererStreamInfo.
-This structure can be traversed to see the original hierarchy. Unref with
-gst_discoverer_stream_info_unref() after usage.</doc>
- <type name="DiscovererStreamInfo" c:type="GstDiscovererStreamInfo*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="976">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_list"
- c:identifier="gst_discoverer_info_get_stream_list">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="295"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="998">the list of
-all streams contained in the #info. Free after usage
-with gst_discoverer_stream_info_list_free().</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="DiscovererStreamInfo"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="996">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_streams"
- c:identifier="gst_discoverer_info_get_streams">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="467">Finds the #GstDiscovererStreamInfo contained in @info that match the
-given @streamtype.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="318"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="475">A #GList of
-matching #GstDiscovererStreamInfo. The caller should free it with
-gst_discoverer_stream_info_list_free().</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="DiscovererStreamInfo"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="469">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </instance-parameter>
- <parameter name="streamtype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="470">a #GType derived from #GstDiscovererStreamInfo</doc>
- <type name="GType" c:type="GType"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_subtitle_streams"
- c:identifier="gst_discoverer_info_get_subtitle_streams">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="526">Finds all the #GstDiscovererSubtitleInfo contained in @info</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="328"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="532">A #GList of
-matching #GstDiscovererStreamInfo. The caller should free it with
-gst_discoverer_stream_info_list_free().</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="DiscovererStreamInfo"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="528">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tags" c:identifier="gst_discoverer_info_get_tags">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="310"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1066">all tags contained in the URI. If you wish to use
-the tags after the life-time of @info, you will need to copy them.</doc>
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1064">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="const GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_toc" c:identifier="gst_discoverer_info_get_toc">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="312"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1076">TOC contained in the URI. If you wish to use
-the TOC after the life-time of @info, you will need to copy it.</doc>
- <type name="Gst.Toc" c:type="const GstToc*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1074">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="const GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_uri" c:identifier="gst_discoverer_info_get_uri">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="286"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="959">the URI to which this information corresponds to.
-Copy it if you wish to use it after the life-time of @info.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="957">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="const GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_video_streams"
- c:identifier="gst_discoverer_info_get_video_streams">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="510">Finds all the #GstDiscovererVideoInfo contained in @info</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="325"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="516">A #GList of
-matching #GstDiscovererStreamInfo. The caller should free it with
-gst_discoverer_stream_info_list_free().</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="DiscovererStreamInfo"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="512">a #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="to_variant"
- c:identifier="gst_discoverer_info_to_variant"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2645">Serializes @info to a #GVariant that can be parsed again
-through gst_discoverer_info_from_variant().
-
-Note that any #GstToc (s) that might have been discovered will not be serialized
-for now.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="334"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2657">A newly-allocated #GVariant representing @info.</doc>
- <type name="GLib.Variant" c:type="GVariant*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2647">A #GstDiscovererInfo</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.c"
- line="2648">A combination of #GstDiscovererSerializeFlags to specify
-what needs to be serialized.</doc>
- <type name="DiscovererSerializeFlags"
- c:type="GstDiscovererSerializeFlags"/>
- </parameter>
- </parameters>
- </method>
- </class>
- <record name="DiscovererPrivate"
- c:type="GstDiscovererPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="356"/>
- </record>
- <enumeration name="DiscovererResult"
- glib:type-name="GstDiscovererResult"
- glib:get-type="gst_discoverer_result_get_type"
- c:type="GstDiscovererResult">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="217">Result values for the discovery process.</doc>
- <member name="ok"
- value="0"
- c:identifier="GST_DISCOVERER_OK"
- glib:nick="ok">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="219">The discovery was successful</doc>
- </member>
- <member name="uri_invalid"
- value="1"
- c:identifier="GST_DISCOVERER_URI_INVALID"
- glib:nick="uri-invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="220">the URI is invalid</doc>
- </member>
- <member name="error"
- value="2"
- c:identifier="GST_DISCOVERER_ERROR"
- glib:nick="error">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="221">an error happened and the GError is set</doc>
- </member>
- <member name="timeout"
- value="3"
- c:identifier="GST_DISCOVERER_TIMEOUT"
- glib:nick="timeout">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="222">the discovery timed-out</doc>
- </member>
- <member name="busy"
- value="4"
- c:identifier="GST_DISCOVERER_BUSY"
- glib:nick="busy">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="223">the discoverer was already discovering a file</doc>
- </member>
- <member name="missing_plugins"
- value="5"
- c:identifier="GST_DISCOVERER_MISSING_PLUGINS"
- glib:nick="missing-plugins">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="224">Some plugins are missing for full discovery</doc>
- </member>
- </enumeration>
- <bitfield name="DiscovererSerializeFlags"
- version="1.6"
- glib:type-name="GstDiscovererSerializeFlags"
- glib:get-type="gst_discoverer_serialize_flags_get_type"
- c:type="GstDiscovererSerializeFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="237">You can use these flags to control what is serialized by
-gst_discoverer_info_to_variant()</doc>
- <member name="basic"
- value="0"
- c:identifier="GST_DISCOVERER_SERIALIZE_BASIC"
- glib:nick="basic">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="239">Serialize only basic information, excluding
-caps, tags and miscellaneous information</doc>
- </member>
- <member name="caps"
- value="1"
- c:identifier="GST_DISCOVERER_SERIALIZE_CAPS"
- glib:nick="caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="241">Serialize the caps for each stream</doc>
- </member>
- <member name="tags"
- value="2"
- c:identifier="GST_DISCOVERER_SERIALIZE_TAGS"
- glib:nick="tags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="242">Serialize the tags for each stream</doc>
- </member>
- <member name="misc"
- value="4"
- c:identifier="GST_DISCOVERER_SERIALIZE_MISC"
- glib:nick="misc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="243">Serialize miscellaneous information for each stream</doc>
- </member>
- <member name="all"
- value="7"
- c:identifier="GST_DISCOVERER_SERIALIZE_ALL"
- glib:nick="all">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="244">Serialize all the available info, including
-caps, tags and miscellaneous information</doc>
- </member>
- </bitfield>
- <class name="DiscovererStreamInfo"
- c:symbol-prefix="discoverer_stream_info"
- c:type="GstDiscovererStreamInfo"
- parent="GObject.Object"
- glib:type-name="GstDiscovererStreamInfo"
- glib:get-type="gst_discoverer_stream_info_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="41">Base structure for information concerning a media stream. Depending on the
-stream type, one can find more media-specific information in
-#GstDiscovererAudioInfo, #GstDiscovererVideoInfo, and
-#GstDiscovererContainerInfo.
-
-The #GstDiscovererStreamInfo represents the topology of the stream. Siblings
-can be iterated over with gst_discoverer_stream_info_get_next() and
-gst_discoverer_stream_info_get_previous(). Children (sub-streams) of a
-stream can be accessed using the #GstDiscovererContainerInfo API.
-
-As a simple example, if you run #GstDiscoverer on an AVI file with one audio
-and one video stream, you will get a #GstDiscovererContainerInfo
-corresponding to the AVI container, which in turn will have a
-#GstDiscovererAudioInfo sub-stream and a #GstDiscovererVideoInfo sub-stream
-for the audio and video streams respectively.</doc>
- <function name="list_free"
- c:identifier="gst_discoverer_stream_info_list_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="450">Decrements the reference count of all contained #GstDiscovererStreamInfo
-and fress the #GList.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="341"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="infos" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="452">a #GList of #GstDiscovererStreamInfo</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="DiscovererStreamInfo"/>
- </type>
- </parameter>
- </parameters>
- </function>
- <method name="get_caps"
- c:identifier="gst_discoverer_stream_info_get_caps">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="70"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="636">the #GstCaps of the stream. Unref with
-#gst_caps_unref after usage.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="634">a #GstDiscovererStreamInfo</doc>
- <type name="DiscovererStreamInfo"
- c:type="GstDiscovererStreamInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_misc"
- c:identifier="gst_discoverer_stream_info_get_misc"
- deprecated="1">
- <doc-deprecated xml:space="preserve">This functions is deprecated since version 1.4, use
-#gst_discoverer_info_get_missing_elements_installer_details</doc-deprecated>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="82"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="702">additional information regarding the stream (for
-example codec version, profile, etc..). If you wish to use the #GstStructure
-after the life-time of @info you will need to copy it.</doc>
- <type name="Gst.Structure" c:type="const GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="697">a #GstDiscovererStreamInfo</doc>
- <type name="DiscovererStreamInfo"
- c:type="GstDiscovererStreamInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_next"
- c:identifier="gst_discoverer_stream_info_get_next">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="67"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="617">the next #GstDiscovererStreamInfo in a chain. %NULL
-for final streams.
-Unref with #gst_discoverer_stream_info_unref after usage.</doc>
- <type name="DiscovererStreamInfo" c:type="GstDiscovererStreamInfo*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="615">a #GstDiscovererStreamInfo</doc>
- <type name="DiscovererStreamInfo"
- c:type="GstDiscovererStreamInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_previous"
- c:identifier="gst_discoverer_stream_info_get_previous">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="64"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="599">the previous #GstDiscovererStreamInfo in a chain.
-%NULL for starting points. Unref with #gst_discoverer_stream_info_unref
-after usage.</doc>
- <type name="DiscovererStreamInfo" c:type="GstDiscovererStreamInfo*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="597">a #GstDiscovererStreamInfo</doc>
- <type name="DiscovererStreamInfo"
- c:type="GstDiscovererStreamInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_id"
- c:identifier="gst_discoverer_stream_info_get_stream_id">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="79"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="683">the stream ID of this stream. If you wish to
-use the stream ID after the life-time of @info you will need to copy it.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="681">a #GstDiscovererStreamInfo</doc>
- <type name="DiscovererStreamInfo"
- c:type="GstDiscovererStreamInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_stream_type_nick"
- c:identifier="gst_discoverer_stream_info_get_stream_type_nick">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="85"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="564">a human readable name for the stream type of the given @info (ex : "audio",
-"container",...).</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="562">a #GstDiscovererStreamInfo</doc>
- <type name="DiscovererStreamInfo"
- c:type="GstDiscovererStreamInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tags"
- c:identifier="gst_discoverer_stream_info_get_tags">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="73"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="653">the tags contained in this stream. If you wish to
-use the tags after the life-time of @info you will need to copy them.</doc>
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="651">a #GstDiscovererStreamInfo</doc>
- <type name="DiscovererStreamInfo"
- c:type="GstDiscovererStreamInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_toc" c:identifier="gst_discoverer_stream_info_get_toc">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="76"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="668">the TOC contained in this stream. If you wish to
-use the TOC after the life-time of @info you will need to copy it.</doc>
- <type name="Gst.Toc" c:type="const GstToc*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="666">a #GstDiscovererStreamInfo</doc>
- <type name="DiscovererStreamInfo"
- c:type="GstDiscovererStreamInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- </class>
- <class name="DiscovererSubtitleInfo"
- c:symbol-prefix="discoverer_subtitle_info"
- c:type="GstDiscovererSubtitleInfo"
- parent="DiscovererStreamInfo"
- glib:type-name="GstDiscovererSubtitleInfo"
- glib:get-type="gst_discoverer_subtitle_info_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="196">#GstDiscovererStreamInfo specific to subtitle streams (this includes text and
-image based ones).</doc>
- <method name="get_language"
- c:identifier="gst_discoverer_subtitle_info_get_language">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="215"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="943">the language of the stream, or NULL if unknown.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="941">a #GstDiscovererSubtitleInfo</doc>
- <type name="DiscovererSubtitleInfo"
- c:type="const GstDiscovererSubtitleInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- </class>
- <class name="DiscovererVideoInfo"
- c:symbol-prefix="discoverer_video_info"
- c:type="GstDiscovererVideoInfo"
- parent="DiscovererStreamInfo"
- glib:type-name="GstDiscovererVideoInfo"
- glib:get-type="gst_discoverer_video_info_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="146">#GstDiscovererStreamInfo specific to video streams (this includes images).</doc>
- <method name="get_bitrate"
- c:identifier="gst_discoverer_video_info_get_bitrate">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="188"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="903">the average or nominal bitrate of the video stream in bits/second.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="901">a #GstDiscovererVideoInfo</doc>
- <type name="DiscovererVideoInfo"
- c:type="const GstDiscovererVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_depth"
- c:identifier="gst_discoverer_video_info_get_depth">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="170"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="844">the depth in bits of the video stream.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="842">a #GstDiscovererVideoInfo</doc>
- <type name="DiscovererVideoInfo"
- c:type="const GstDiscovererVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_framerate_denom"
- c:identifier="gst_discoverer_video_info_get_framerate_denom">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="176"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="862">the framerate of the video stream (denominator).</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="860">a #GstDiscovererVideoInfo</doc>
- <type name="DiscovererVideoInfo"
- c:type="const GstDiscovererVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_framerate_num"
- c:identifier="gst_discoverer_video_info_get_framerate_num">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="173"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="853">the framerate of the video stream (numerator).</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="851">a #GstDiscovererVideoInfo</doc>
- <type name="DiscovererVideoInfo"
- c:type="const GstDiscovererVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_height"
- c:identifier="gst_discoverer_video_info_get_height">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="167"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="835">the height of the video stream in pixels.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="833">a #GstDiscovererVideoInfo</doc>
- <type name="DiscovererVideoInfo"
- c:type="const GstDiscovererVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_max_bitrate"
- c:identifier="gst_discoverer_video_info_get_max_bitrate">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="191"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="912">the maximum bitrate of the video stream in bits/second.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="910">a #GstDiscovererVideoInfo</doc>
- <type name="DiscovererVideoInfo"
- c:type="const GstDiscovererVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_par_denom"
- c:identifier="gst_discoverer_video_info_get_par_denom">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="182"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="880">the Pixel Aspect Ratio (PAR) of the video stream (denominator).</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="878">a #GstDiscovererVideoInfo</doc>
- <type name="DiscovererVideoInfo"
- c:type="const GstDiscovererVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_par_num"
- c:identifier="gst_discoverer_video_info_get_par_num">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="179"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="871">the Pixel Aspect Ratio (PAR) of the video stream (numerator).</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="869">a #GstDiscovererVideoInfo</doc>
- <type name="DiscovererVideoInfo"
- c:type="const GstDiscovererVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_width"
- c:identifier="gst_discoverer_video_info_get_width">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="164"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="826">the width of the video stream in pixels.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="824">a #GstDiscovererVideoInfo</doc>
- <type name="DiscovererVideoInfo"
- c:type="const GstDiscovererVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_image"
- c:identifier="gst_discoverer_video_info_is_image">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="194"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="921">%TRUE if the video stream corresponds to an image (i.e. only contains
-one frame).</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="919">a #GstDiscovererVideoInfo</doc>
- <type name="DiscovererVideoInfo"
- c:type="const GstDiscovererVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_interlaced"
- c:identifier="gst_discoverer_video_info_is_interlaced">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="185"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="889">%TRUE if the stream is interlaced, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="887">a #GstDiscovererVideoInfo</doc>
- <type name="DiscovererVideoInfo"
- c:type="const GstDiscovererVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- </class>
- <function-macro name="ENCODING_AUDIO_PROFILE"
- c:identifier="GST_ENCODING_AUDIO_PROFILE"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="93"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="ENCODING_CATEGORY_CAPTURE"
- value="capture"
- c:type="GST_ENCODING_CATEGORY_CAPTURE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.h"
- line="66">#GstEncodingTarget category for recording and capture.
-Targets within this category are optimized for low latency encoding.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="72"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ENCODING_CATEGORY_DEVICE"
- value="device"
- c:type="GST_ENCODING_CATEGORY_DEVICE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.h"
- line="35">#GstEncodingTarget category for device-specific targets.
-The name of the target will usually be the constructor and model of the device,
-and that target will contain #GstEncodingProfiles suitable for that device.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="42"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ENCODING_CATEGORY_FILE_EXTENSION"
- value="file-extension"
- c:type="GST_ENCODING_CATEGORY_FILE_EXTENSION">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.h"
- line="74">#GstEncodingTarget category for file extensions.
-The name of the target will be the name of the file extensions possible
-for a particular target. Those targets are defining like 'default' formats
-usually used for a particular file extension.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="83"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ENCODING_CATEGORY_ONLINE_SERVICE"
- value="online-service"
- c:type="GST_ENCODING_CATEGORY_ONLINE_SERVICE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.h"
- line="44">#GstEncodingTarget category for online-services.
-The name of the target will usually be the name of the online service
-and that target will contain #GstEncodingProfiles suitable for that online
-service.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="53"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="ENCODING_CATEGORY_STORAGE_EDITING"
- value="storage-editing"
- c:type="GST_ENCODING_CATEGORY_STORAGE_EDITING">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.h"
- line="55">#GstEncodingTarget category for storage, archiving and editing targets.
-Those targets can be lossless and/or provide very fast random access content.
-The name of the target will usually be the container type or editing target,
-and that target will contain #GstEncodingProfiles suitable for editing or
-storage.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="64"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="ENCODING_CONTAINER_PROFILE"
- c:identifier="GST_ENCODING_CONTAINER_PROFILE"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="57"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ENCODING_PROFILE"
- c:identifier="GST_ENCODING_PROFILE"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ENCODING_TARGET"
- c:identifier="GST_ENCODING_TARGET"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="94"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="ENCODING_VIDEO_PROFILE"
- c:identifier="GST_ENCODING_VIDEO_PROFILE"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="75"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <class name="EncodingAudioProfile"
- c:symbol-prefix="encoding_audio_profile"
- c:type="GstEncodingAudioProfile"
- parent="EncodingProfile"
- glib:type-name="GstEncodingAudioProfile"
- glib:get-type="gst_encoding_audio_profile_get_type"
- glib:type-struct="EncodingAudioProfileClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="90">Variant of #GstEncodingProfile for audio streams.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="102"/>
- <constructor name="new" c:identifier="gst_encoding_audio_profile_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1181">Creates a new #GstEncodingAudioProfile
-
-All provided allocatable arguments will be internally copied, so can be
-safely freed/unreferenced after calling this method.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="244"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1195">the newly created #GstEncodingAudioProfile.</doc>
- <type name="EncodingAudioProfile" c:type="GstEncodingAudioProfile*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1183">the #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="preset"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1184">the preset(s) to use on the encoder, can be %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="restriction"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1185">the #GstCaps used to restrict the input to the encoder, can be
-NULL. See gst_encoding_profile_get_restriction() for more details.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="presence" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1187">the number of time this stream must be used. 0 means any number of
- times (including never)</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </constructor>
- </class>
- <record name="EncodingAudioProfileClass"
- c:type="GstEncodingAudioProfileClass"
- disguised="1"
- glib:is-gtype-struct-for="EncodingAudioProfile">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="102"/>
- </record>
- <class name="EncodingContainerProfile"
- c:symbol-prefix="encoding_container_profile"
- c:type="GstEncodingContainerProfile"
- parent="EncodingProfile"
- glib:type-name="GstEncodingContainerProfile"
- glib:get-type="gst_encoding_container_profile_get_type"
- glib:type-struct="EncodingContainerProfileClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="52">Encoding profiles for containers. Keeps track of a list of #GstEncodingProfile</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="64"/>
- <constructor name="new"
- c:identifier="gst_encoding_container_profile_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1127">Creates a new #GstEncodingContainerProfile.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="229"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1137">The newly created #GstEncodingContainerProfile.</doc>
- <type name="EncodingContainerProfile"
- c:type="GstEncodingContainerProfile*"/>
- </return-value>
- <parameters>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1129">The name of the container profile, can be %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="description"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1130">The description of the container profile,
- can be %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1132">The format to use for this profile</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="preset"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1133">The preset to use for this profile.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="add_profile"
- c:identifier="gst_encoding_container_profile_add_profile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1075">Add a #GstEncodingProfile to the list of profiles handled by @container.
-
-No copy of @profile will be made, if you wish to use it elsewhere after this
-method you should increment its reference count.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="217"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1085">%TRUE if the @stream was properly added, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1077">the #GstEncodingContainerProfile to use</doc>
- <type name="EncodingContainerProfile"
- c:type="GstEncodingContainerProfile*"/>
- </instance-parameter>
- <parameter name="profile" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1078">the #GstEncodingProfile to add.</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </parameter>
- </parameters>
- </method>
- <method name="contains_profile"
- c:identifier="gst_encoding_container_profile_contains_profile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1053">Checks if @container contains a #GstEncodingProfile identical to
-@profile.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="221"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1061">%TRUE if @container contains a #GstEncodingProfile identical
-to @profile, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="container" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1055">a #GstEncodingContainerProfile</doc>
- <type name="EncodingContainerProfile"
- c:type="GstEncodingContainerProfile*"/>
- </instance-parameter>
- <parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1056">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_profiles"
- c:identifier="gst_encoding_container_profile_get_profiles">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="225"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="845">
-the list of contained #GstEncodingProfile.</doc>
- <type name="GLib.List" c:type="const GList*">
- <type name="EncodingProfile"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="843">a #GstEncodingContainerProfile</doc>
- <type name="EncodingContainerProfile"
- c:type="GstEncodingContainerProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- </class>
- <record name="EncodingContainerProfileClass"
- c:type="GstEncodingContainerProfileClass"
- disguised="1"
- glib:is-gtype-struct-for="EncodingContainerProfile">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="64"/>
- </record>
- <class name="EncodingProfile"
- c:symbol-prefix="encoding_profile"
- c:type="GstEncodingProfile"
- parent="GObject.Object"
- glib:type-name="GstEncodingProfile"
- glib:get-type="gst_encoding_profile_get_type"
- glib:type-struct="EncodingProfileClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="31">The opaque base class object for all encoding profiles. This contains generic
-information like name, description, format and preset.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="45"/>
- <function name="find" c:identifier="gst_encoding_profile_find">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1443">Find the #GstEncodingProfile with the specified name and category.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="204"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1452">The matching #GstEncodingProfile or %NULL.</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </return-value>
- <parameters>
- <parameter name="targetname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1445">The name of the target</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="profilename"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1446">The name of the profile, if %NULL
-provided, it will default to the encoding profile called `default`.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="category"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1448">The target category. Can be %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="from_discoverer"
- c:identifier="gst_encoding_profile_from_discoverer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="2055">Creates a #GstEncodingProfile matching the formats from the given
-#GstDiscovererInfo. Streams other than audio or video (eg,
-subtitles), are currently ignored.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="264"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="2063">The new #GstEncodingProfile or %NULL.</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </return-value>
- <parameters>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="2057">The #GstDiscovererInfo to read from</doc>
- <type name="DiscovererInfo" c:type="GstDiscovererInfo*"/>
- </parameter>
- </parameters>
- </function>
- <method name="copy"
- c:identifier="gst_encoding_profile_copy"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="2096">Makes a deep copy of @self</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="267"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="2102">The copy of @self</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </return-value>
- <parameters>
- <instance-parameter name="self" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="2098">The #GstEncodingProfile to copy</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_allow_dynamic_output"
- c:identifier="gst_encoding_profile_get_allow_dynamic_output">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="614">Get whether the format that has been negotiated in at some point can be renegotiated
-later during the encoding.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="149"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="616">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_description"
- c:identifier="gst_encoding_profile_get_description">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="135"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="457">the description of the profile, can be %NULL.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="455">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_file_extension"
- c:identifier="gst_encoding_profile_get_file_extension">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="201"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1342">a suitable file extension for @profile, or NULL.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1340">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_format" c:identifier="gst_encoding_profile_get_format">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="142"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="471">the #GstCaps corresponding to the media format used
-in the profile. Unref after usage.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="469">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_input_caps"
- c:identifier="gst_encoding_profile_get_input_caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1226">Computes the full output caps that this @profile will be able to consume.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="195"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1232">The full caps the given @profile can consume. Call
-gst_caps_unref() when you are done with the caps.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1228">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_name" c:identifier="gst_encoding_profile_get_name">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="128"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="443">the name of the profile, can be %NULL.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="441">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_presence"
- c:identifier="gst_encoding_profile_get_presence">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="173"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="515">The number of times the profile is used in its parent
-container profile. If 0, it is not a mandatory stream.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="513">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_preset" c:identifier="gst_encoding_profile_get_preset">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="163"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="486">the name of the #GstPreset to be used in the profile.
-This is the name that has been set when saving the preset.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="484">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_preset_name"
- c:identifier="gst_encoding_profile_get_preset_name">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="166"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="501">the name of the #GstPreset factory to be used in the profile.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="499">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_restriction"
- c:identifier="gst_encoding_profile_get_restriction">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="184"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="546">The restriction #GstCaps to apply before the encoder
-that will be used in the profile. The fields present in restriction caps are
-properties of the raw stream (that is before encoding), such as height and
-width for video and depth and sampling rate for audio. Does not apply to
-#GstEncodingContainerProfile (since there is no corresponding raw stream).
-Can be %NULL. Unref after usage.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="544">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_single_segment"
- c:identifier="gst_encoding_profile_get_single_segment"
- version="1.18">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="156"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="651">#TRUE if the stream represented by @profile should use a single
-segment before the encoder, #FALSE otherwise. This means that buffers will be retimestamped
-and segments will be eat so as to appear as one segment.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="649">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_type_nick"
- c:identifier="gst_encoding_profile_get_type_nick">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="198"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1286">the human-readable name of the type of @profile.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1284">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_enabled" c:identifier="gst_encoding_profile_is_enabled">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="209"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_equal" c:identifier="gst_encoding_profile_is_equal">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1207">Checks whether the two #GstEncodingProfile are equal</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="191"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1214">%TRUE if @a and @b are equal, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="a" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1209">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- <parameter name="b" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1210">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_allow_dynamic_output"
- c:identifier="gst_encoding_profile_set_allow_dynamic_output">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="629">Sets whether the format that has been negotiated in at some point can be renegotiated
-later during the encoding.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="152"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="631">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- <parameter name="allow_dynamic_output" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="632">Whether the format that has been negotiated first can be renegotiated
-during the encoding</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_description"
- c:identifier="gst_encoding_profile_set_description">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="579">Set @description as the given description for the @profile. A copy of
-@description will be made internally.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="138"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="581">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- <parameter name="description"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="582">the description to set on the profile</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_enabled"
- c:identifier="gst_encoding_profile_set_enabled"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="740">Set whether the profile should be used or not.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="212"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="742">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="743">%FALSE to disable @profile, %TRUE to enable it</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_format" c:identifier="gst_encoding_profile_set_format">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="597">Sets the media format used in the profile.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="145"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="599">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="600">the media format to use in the profile.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_name" c:identifier="gst_encoding_profile_set_name">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="562">Set @name as the given name for the @profile. A copy of @name will be made
-internally.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="131"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="564">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- <parameter name="name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="565">the name to set on the profile</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_presence"
- c:identifier="gst_encoding_profile_set_presence">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="724">Set the number of time the profile is used in its parent
-container profile. If 0, it is not a mandatory stream</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="176"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="726">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- <parameter name="presence" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="727">the number of time the profile can be used</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_preset" c:identifier="gst_encoding_profile_set_preset">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="688">Sets the name of the #GstElement that implements the #GstPreset interface
-to use for the profile.
-This is the name that has been set when saving the preset.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="169"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="690">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- <parameter name="preset"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="691">the element preset to use</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_preset_name"
- c:identifier="gst_encoding_profile_set_preset_name">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="707">Sets the name of the #GstPreset's factory to be used in the profile.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="180"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="709">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- <parameter name="preset_name"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="710">The name of the preset to use in this @profile.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_restriction"
- c:identifier="gst_encoding_profile_set_restriction">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="758">Set the restriction #GstCaps to apply before the encoder
-that will be used in the profile. See gst_encoding_profile_get_restriction()
-for more about restrictions. Does not apply to #GstEncodingContainerProfile.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="187"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="760">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- <parameter name="restriction"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="761">the restriction to apply</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_single_segment"
- c:identifier="gst_encoding_profile_set_single_segment"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="665">If using a single segment, buffers will be retimestamped and segments will be
-eat so as to appear as one segment.
-
-&gt; *NOTE*: Single segment is not property supported when using
-&gt; #encodebin:avoid-reencoding</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="159"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="profile" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="667">a #GstEncodingProfile</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </instance-parameter>
- <parameter name="single_segment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="668">#TRUE if the stream represented by @profile should use a
-single segment before the encoder, #FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <property name="restriction-caps" writable="1" transfer-ownership="none">
- <type name="Gst.Caps"/>
- </property>
- </class>
- <record name="EncodingProfileClass"
- c:type="GstEncodingProfileClass"
- disguised="1"
- glib:is-gtype-struct-for="EncodingProfile">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="45"/>
- </record>
- <class name="EncodingTarget"
- c:symbol-prefix="encoding_target"
- c:type="GstEncodingTarget"
- parent="GObject.Object"
- glib:type-name="GstEncodingTarget"
- glib:get-type="gst_encoding_target_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.h"
- line="85">Collection of #GstEncodingProfile for a specific target or use-case.
-
-When being stored/loaded, targets come from a specific category, like
-#GST_ENCODING_CATEGORY_DEVICE.</doc>
- <constructor name="new" c:identifier="gst_encoding_target_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="270">Creates a new #GstEncodingTarget.
-
-The name and category can only consist of lowercase ASCII letters for the
-first character, followed by either lowercase ASCII letters, digits or
-hyphens ('-').
-
-The @category *should* be one of the existing
-well-defined categories, like #GST_ENCODING_CATEGORY_DEVICE, but it
-*can* be a application or user specific category if
-needed.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="125"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="291">The newly created #GstEncodingTarget or %NULL if
-there was an error.</doc>
- <type name="EncodingTarget" c:type="GstEncodingTarget*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="272">The name of the target.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="category" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="273">The name of the category to which this @target
-belongs. For example: #GST_ENCODING_CATEGORY_DEVICE.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="description" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="275">A description of #GstEncodingTarget in the
-current locale.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="profiles" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="277">A #GList of
-#GstEncodingProfile.</doc>
- <type name="GLib.List" c:type="const GList*">
- <type name="EncodingProfile"/>
- </type>
- </parameter>
- </parameters>
- </constructor>
- <function name="load" c:identifier="gst_encoding_target_load" throws="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="875">Searches for the #GstEncodingTarget with the given name, loads it
-and returns it.
-
-If the category name is specified only targets from that category will be
-searched for.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="163"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="890">The #GstEncodingTarget if available, else %NULL.</doc>
- <type name="EncodingTarget" c:type="GstEncodingTarget*"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="877">the name of the #GstEncodingTarget to load (automatically
-converted to lower case internally as capital letters are not
-valid for target names).</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="category"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="880">the name of the target category, like
-#GST_ENCODING_CATEGORY_DEVICE. Can be %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="load_from_file"
- c:identifier="gst_encoding_target_load_from_file"
- throws="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="775">Opens the provided file and returns the contained #GstEncodingTarget.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="168"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="782">The #GstEncodingTarget contained in the file, else
-%NULL</doc>
- <type name="EncodingTarget" c:type="GstEncodingTarget*"/>
- </return-value>
- <parameters>
- <parameter name="filepath" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="777">The file location to load the #GstEncodingTarget from</doc>
- <type name="filename" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <method name="add_profile"
- c:identifier="gst_encoding_target_add_profile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="339">Adds the given @profile to the @target. Each added profile must have
-a unique name within the profile.
-
-The @target will steal a reference to the @profile. If you wish to use
-the profile after calling this method, you should increase its reference
-count.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="150"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="351">%TRUE if the profile was added, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="341">the #GstEncodingTarget to add a profile to</doc>
- <type name="EncodingTarget" c:type="GstEncodingTarget*"/>
- </instance-parameter>
- <parameter name="profile" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="342">the #GstEncodingProfile to add</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_category"
- c:identifier="gst_encoding_target_get_category">
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="134"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="155">The category of the @target. For example:
-#GST_ENCODING_CATEGORY_DEVICE.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="153">a #GstEncodingTarget</doc>
- <type name="EncodingTarget" c:type="GstEncodingTarget*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_description"
- c:identifier="gst_encoding_target_get_description">
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="137"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="168">The description of the @target.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="166">a #GstEncodingTarget</doc>
- <type name="EncodingTarget" c:type="GstEncodingTarget*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_name" c:identifier="gst_encoding_target_get_name">
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="131"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="143">The name of the @target.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="141">a #GstEncodingTarget</doc>
- <type name="EncodingTarget" c:type="GstEncodingTarget*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_path"
- c:identifier="gst_encoding_target_get_path"
- version="1.18">
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="140"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="180">The path to the @target file.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="178">a #GstEncodingTarget</doc>
- <type name="EncodingTarget" c:type="GstEncodingTarget*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_profile"
- c:identifier="gst_encoding_target_get_profile">
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="146"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="209">The matching #GstEncodingProfile, or %NULL.</doc>
- <type name="EncodingProfile" c:type="GstEncodingProfile*"/>
- </return-value>
- <parameters>
- <instance-parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="206">a #GstEncodingTarget</doc>
- <type name="EncodingTarget" c:type="GstEncodingTarget*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="207">the name of the profile to retrieve</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_profiles"
- c:identifier="gst_encoding_target_get_profiles">
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="143"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="195">A list of
-#GstEncodingProfile(s) this @target handles.</doc>
- <type name="GLib.List" c:type="const GList*">
- <type name="EncodingProfile"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="193">a #GstEncodingTarget</doc>
- <type name="EncodingTarget" c:type="GstEncodingTarget*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="save" c:identifier="gst_encoding_target_save" throws="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="1061">Saves the @target to a default user-local directory.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="154"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="1068">%TRUE if the target was correctly saved, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="1063">a #GstEncodingTarget</doc>
- <type name="EncodingTarget" c:type="GstEncodingTarget*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="save_to_file"
- c:identifier="gst_encoding_target_save_to_file"
- throws="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="991">Saves the @target to the provided file location.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="158"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="999">%TRUE if the target was correctly saved, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="target" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="993">a #GstEncodingTarget</doc>
- <type name="EncodingTarget" c:type="GstEncodingTarget*"/>
- </instance-parameter>
- <parameter name="filepath" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="994">the location to store the @target at.</doc>
- <type name="filename" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- </class>
- <class name="EncodingVideoProfile"
- c:symbol-prefix="encoding_video_profile"
- c:type="GstEncodingVideoProfile"
- parent="EncodingProfile"
- glib:type-name="GstEncodingVideoProfile"
- glib:get-type="gst_encoding_video_profile_get_type"
- glib:type-struct="EncodingVideoProfileClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="71">Variant of #GstEncodingProfile for video streams, allows specifying the @pass.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="83"/>
- <constructor name="new" c:identifier="gst_encoding_video_profile_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1150">Creates a new #GstEncodingVideoProfile
-
-All provided allocatable arguments will be internally copied, so can be
-safely freed/unreferenced after calling this method.
-
-If you wish to control the pass number (in case of multi-pass scenarios),
-please refer to the gst_encoding_video_profile_set_pass() documentation.
-
-If you wish to use/force a constant framerate please refer to the
-gst_encoding_video_profile_set_variableframerate() documentation.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="238"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1170">the newly created #GstEncodingVideoProfile.</doc>
- <type name="EncodingVideoProfile" c:type="GstEncodingVideoProfile*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1152">the #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="preset"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1153">the preset(s) to use on the encoder, can be %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="restriction"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1154">the #GstCaps used to restrict the input to the encoder, can be
-NULL. See gst_encoding_profile_get_restriction() for more details.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="presence" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="1156">the number of time this stream must be used. 0 means any number of
- times (including never)</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="get_pass"
- c:identifier="gst_encoding_video_profile_get_pass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="898">Get the pass number if this is part of a multi-pass profile.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="250"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="904">The pass number. Starts at 1 for multi-pass. 0 if this is
-not a multi-pass profile</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="prof" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="900">a #GstEncodingVideoProfile</doc>
- <type name="EncodingVideoProfile"
- c:type="GstEncodingVideoProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_variableframerate"
- c:identifier="gst_encoding_video_profile_get_variableframerate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="915">&gt; *NOTE*: Fixed framerate won't be enforced when #encodebin:avoid-reencoding
-&gt; is set.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="253"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="922">Whether non-constant video framerate is allowed for encoding.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="prof" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="917">a #GstEncodingVideoProfile</doc>
- <type name="EncodingVideoProfile"
- c:type="GstEncodingVideoProfile*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_pass"
- c:identifier="gst_encoding_video_profile_set_pass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="933">Sets the pass number of this video profile. The first pass profile should have
-this value set to 1. If this video profile isn't part of a multi-pass profile,
-you may set it to 0 (the default value).</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="256"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="prof" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="935">a #GstEncodingVideoProfile</doc>
- <type name="EncodingVideoProfile"
- c:type="GstEncodingVideoProfile*"/>
- </instance-parameter>
- <parameter name="pass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="936">the pass number for this profile</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_variableframerate"
- c:identifier="gst_encoding_video_profile_set_variableframerate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="950">If set to %TRUE, then the incoming stream will be allowed to have non-constant
-framerate. If set to %FALSE (default value), then the incoming stream will
-be normalized by dropping/duplicating frames in order to produce a
-constance framerate.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="260"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="prof" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="952">a #GstEncodingVideoProfile</doc>
- <type name="EncodingVideoProfile"
- c:type="GstEncodingVideoProfile*"/>
- </instance-parameter>
- <parameter name="variableframerate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="953">a boolean</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- </class>
- <record name="EncodingVideoProfileClass"
- c:type="GstEncodingVideoProfileClass"
- disguised="1"
- glib:is-gtype-struct-for="EncodingVideoProfile">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="83"/>
- </record>
- <function-macro name="IS_DISCOVERER"
- c:identifier="GST_IS_DISCOVERER"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="342"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DISCOVERER_AUDIO_INFO"
- c:identifier="GST_IS_DISCOVERER_AUDIO_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="114"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DISCOVERER_CLASS"
- c:identifier="GST_IS_DISCOVERER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="344"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DISCOVERER_CONTAINER_INFO"
- c:identifier="GST_IS_DISCOVERER_CONTAINER_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="94"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DISCOVERER_INFO"
- c:identifier="GST_IS_DISCOVERER_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="266"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DISCOVERER_STREAM_INFO"
- c:identifier="GST_IS_DISCOVERER_STREAM_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DISCOVERER_SUBTITLE_INFO"
- c:identifier="GST_IS_DISCOVERER_SUBTITLE_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="201"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_DISCOVERER_VIDEO_INFO"
- c:identifier="GST_IS_DISCOVERER_VIDEO_INFO"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="151"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ENCODING_AUDIO_PROFILE"
- c:identifier="GST_IS_ENCODING_AUDIO_PROFILE"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="95"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ENCODING_CONTAINER_PROFILE"
- c:identifier="GST_IS_ENCODING_CONTAINER_PROFILE"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="59"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ENCODING_PROFILE"
- c:identifier="GST_IS_ENCODING_PROFILE"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ENCODING_TARGET"
- c:identifier="GST_IS_ENCODING_TARGET"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="96"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_ENCODING_VIDEO_PROFILE"
- c:identifier="GST_IS_ENCODING_VIDEO_PROFILE"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="77"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_SYNAESTHESIA"
- c:identifier="GST_IS_SYNAESTHESIA"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_SYNAESTHESIA_CLASS"
- c:identifier="GST_IS_SYNAESTHESIA_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/gstaudiovisualizer.h"
- line="40"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <record name="InstallPluginsContext"
- c:type="GstInstallPluginsContext"
- glib:type-name="GstInstallPluginsContext"
- glib:get-type="gst_install_plugins_context_get_type"
- c:symbol-prefix="install_plugins_context">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="90">Opaque context structure for the plugin installation. Use the provided
-API to set details on it.</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="99"/>
- <constructor name="new" c:identifier="gst_install_plugins_context_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="415">Creates a new #GstInstallPluginsContext.</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="102"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="420">a new #GstInstallPluginsContext. Free with
-gst_install_plugins_context_free() when no longer needed</doc>
- <type name="InstallPluginsContext"
- c:type="GstInstallPluginsContext*"/>
- </return-value>
- </constructor>
- <method name="copy"
- c:identifier="gst_install_plugins_context_copy"
- version="1.12.1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="446">Copies a #GstInstallPluginsContext.</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="105"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="452">A copy of @ctx</doc>
- <type name="InstallPluginsContext"
- c:type="GstInstallPluginsContext*"/>
- </return-value>
- <parameters>
- <instance-parameter name="ctx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="448">a #GstInstallPluginsContext</doc>
- <type name="InstallPluginsContext"
- c:type="GstInstallPluginsContext*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_install_plugins_context_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="429">Frees a #GstInstallPluginsContext.</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="107"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="ctx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="431">a #GstInstallPluginsContext</doc>
- <type name="InstallPluginsContext"
- c:type="GstInstallPluginsContext*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_confirm_search"
- c:identifier="gst_install_plugins_context_set_confirm_search"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="294">This function is used to tell the external installer process whether it
-should ask for confirmation or not before searching for missing plugins.
-
-If set, this option will be passed to the installer via a
---interaction=[show-confirm-search|hide-confirm-search] command line option.</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="110"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="ctx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="296">a #GstInstallPluginsContext</doc>
- <type name="InstallPluginsContext"
- c:type="GstInstallPluginsContext*"/>
- </instance-parameter>
- <parameter name="confirm_search" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="297">whether to ask for confirmation before searching for plugins</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_desktop_id"
- c:identifier="gst_install_plugins_context_set_desktop_id"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="319">This function is used to pass the calling application's desktop file ID to
-the external installer process.
-
-A desktop file ID is the basename of the desktop file, including the
-.desktop extension.
-
-If set, the desktop file ID will be passed to the installer via a
---desktop-id= command line option.</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="114"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="ctx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="321">a #GstInstallPluginsContext</doc>
- <type name="InstallPluginsContext"
- c:type="GstInstallPluginsContext*"/>
- </instance-parameter>
- <parameter name="desktop_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="322">the desktop file ID of the calling application</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_startup_notification_id"
- c:identifier="gst_install_plugins_context_set_startup_notification_id"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="344">Sets the startup notification ID for the launched process.
-
-This is typically used to to pass the current X11 event timestamp to the
-external installer process.
-
-Startup notification IDs are defined in the
-[FreeDesktop.Org Startup Notifications standard](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt).
-
-If set, the ID will be passed to the installer via a
---startup-notification-id= command line option.
-
-GTK+/GNOME applications should be able to create a startup notification ID
-like this:
-|[
- timestamp = gtk_get_current_event_time ();
- startup_id = g_strdup_printf ("_TIME%u", timestamp);
-...
-]|</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="118"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="ctx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="346">a #GstInstallPluginsContext</doc>
- <type name="InstallPluginsContext"
- c:type="GstInstallPluginsContext*"/>
- </instance-parameter>
- <parameter name="startup_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="347">the startup notification ID</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_xid"
- c:identifier="gst_install_plugins_context_set_xid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="378">This function is for X11-based applications (such as most Gtk/Qt
-applications on linux/unix) only. You can use it to tell the external
-installer the XID of your main application window. That way the installer
-can make its own window transient to your application window during the
-installation.
-
-If set, the XID will be passed to the installer via a --transient-for=XID
-command line option.
-
-Gtk+/Gnome application should be able to obtain the XID of the top-level
-window like this:
-|[
-##include &amp;lt;gtk/gtk.h&amp;gt;
-##ifdef GDK_WINDOWING_X11
-##include &amp;lt;gdk/gdkx.h&amp;gt;
-##endif
-...
-##ifdef GDK_WINDOWING_X11
- xid = GDK_WINDOW_XWINDOW (GTK_WIDGET (application_window)-&amp;gt;window);
-##endif
-...
-]|</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="122"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="ctx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="380">a #GstInstallPluginsContext</doc>
- <type name="InstallPluginsContext"
- c:type="GstInstallPluginsContext*"/>
- </instance-parameter>
- <parameter name="xid" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="381">the XWindow ID (XID) of the top-level application</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <callback name="InstallPluginsResultFunc"
- c:type="GstInstallPluginsResultFunc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="128">The prototype of the callback function that will be called once the
-external plugin installer program has returned. You only need to provide
-a callback function if you are using the asynchronous interface.</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="137"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="result" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="130">whether the installation of the requested plugins succeeded or not</doc>
- <type name="InstallPluginsReturn" c:type="GstInstallPluginsReturn"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="131">the user data passed to gst_install_plugins_async()</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <enumeration name="InstallPluginsReturn"
- glib:type-name="GstInstallPluginsReturn"
- glib:get-type="gst_install_plugins_return_get_type"
- c:type="GstInstallPluginsReturn">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="33">Result codes returned by gst_install_plugins_async() and
-gst_install_plugins_sync(), and also the result code passed to the
-#GstInstallPluginsResultFunc specified with gst_install_plugins_async().
-
-These codes indicate success or failure of starting an external installer
-program and to what extent the requested plugins could be installed.</doc>
- <member name="success"
- value="0"
- c:identifier="GST_INSTALL_PLUGINS_SUCCESS"
- glib:nick="success">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="35">all of the requested plugins could be
- installed</doc>
- </member>
- <member name="not_found"
- value="1"
- c:identifier="GST_INSTALL_PLUGINS_NOT_FOUND"
- glib:nick="not-found">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="37">no appropriate installation candidate for
- any of the requested plugins could be found. Only return this if nothing
- has been installed. Return #GST_INSTALL_PLUGINS_PARTIAL_SUCCESS if
- some (but not all) of the requested plugins could be installed.</doc>
- </member>
- <member name="error"
- value="2"
- c:identifier="GST_INSTALL_PLUGINS_ERROR"
- glib:nick="error">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="41">an error occurred during the installation. If
- this happens, the user has already seen an error message and another
- one should not be displayed</doc>
- </member>
- <member name="partial_success"
- value="3"
- c:identifier="GST_INSTALL_PLUGINS_PARTIAL_SUCCESS"
- glib:nick="partial-success">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="46">some of the requested plugins could
- be installed, but not all</doc>
- </member>
- <member name="user_abort"
- value="4"
- c:identifier="GST_INSTALL_PLUGINS_USER_ABORT"
- glib:nick="user-abort">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="48">the user has aborted the installation</doc>
- </member>
- <member name="crashed"
- value="100"
- c:identifier="GST_INSTALL_PLUGINS_CRASHED"
- glib:nick="crashed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="44">the installer had an unclean exit code
- (ie. death by signal)</doc>
- </member>
- <member name="invalid"
- value="101"
- c:identifier="GST_INSTALL_PLUGINS_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="49">the helper returned an invalid status code</doc>
- </member>
- <member name="started_ok"
- value="200"
- c:identifier="GST_INSTALL_PLUGINS_STARTED_OK"
- glib:nick="started-ok">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="50">returned by gst_install_plugins_async() to
- indicate that everything went fine so far and the provided callback
- will be called with the result of the installation later</doc>
- </member>
- <member name="internal_failure"
- value="201"
- c:identifier="GST_INSTALL_PLUGINS_INTERNAL_FAILURE"
- glib:nick="internal-failure">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="53">some internal failure has
- occurred when trying to start the installer</doc>
- </member>
- <member name="helper_missing"
- value="202"
- c:identifier="GST_INSTALL_PLUGINS_HELPER_MISSING"
- glib:nick="helper-missing">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="55">the helper script to call the
- actual installer is not installed</doc>
- </member>
- <member name="install_in_progress"
- value="203"
- c:identifier="GST_INSTALL_PLUGINS_INSTALL_IN_PROGRESS"
- glib:nick="install-in-progress">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.h"
- line="57">a previously-started plugin
- installation is still in progress, try again later</doc>
- </member>
- <function name="get_name"
- c:identifier="gst_install_plugins_return_get_name">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="708">Convenience function to return the descriptive string associated
-with a status code. This function returns English strings and
-should not be used for user messages. It is here only to assist
-in debugging.</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="151"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="717">a descriptive string for the status code in @ret</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="ret" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="710">the return status code</doc>
- <type name="InstallPluginsReturn"
- c:type="GstInstallPluginsReturn"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <function-macro name="PBUTILS_DEPRECATED_FOR"
- c:identifier="GST_PBUTILS_DEPRECATED_FOR"
- introspectable="0">
- <source-position filename="gst-libs/gst/pbutils/pbutils-prelude.h"
- line="35"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="PLUGINS_BASE_VERSION_MAJOR"
- value="1"
- c:type="GST_PLUGINS_BASE_VERSION_MAJOR">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstpluginsbaseversion.h"
- line="28">The major version of GStreamer's gst-plugins-base libraries at compile time.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstpluginsbaseversion.h"
- line="33"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PLUGINS_BASE_VERSION_MICRO"
- value="0"
- c:type="GST_PLUGINS_BASE_VERSION_MICRO">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstpluginsbaseversion.h"
- line="40">The micro version of GStreamer's gst-plugins-base libraries at compile time.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstpluginsbaseversion.h"
- line="45"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PLUGINS_BASE_VERSION_MINOR"
- value="19"
- c:type="GST_PLUGINS_BASE_VERSION_MINOR">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstpluginsbaseversion.h"
- line="34">The minor version of GStreamer's gst-plugins-base libraries at compile time.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstpluginsbaseversion.h"
- line="39"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PLUGINS_BASE_VERSION_NANO"
- value="1"
- c:type="GST_PLUGINS_BASE_VERSION_NANO">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstpluginsbaseversion.h"
- line="46">The nano version of GStreamer's gst-plugins-base libraries at compile time.
-Actual releases have 0, GIT versions have 1, prerelease versions have 2-...</doc>
- <source-position filename="gst-libs/gst/pbutils/gstpluginsbaseversion.h"
- line="52"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function name="codec_utils_aac_caps_set_level_and_profile"
- c:identifier="gst_codec_utils_aac_caps_set_level_and_profile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="490">Sets the level and profile on @caps if it can be determined from
-@audio_config. See gst_codec_utils_aac_get_level() and
-gst_codec_utils_aac_get_profile() for more details on the parameters.
-@caps must be audio/mpeg caps with an "mpegversion" field of either 2 or 4.
-If mpegversion is 4, the "base-profile" field is also set in @caps.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="51"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="504">%TRUE if the level and profile could be set, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="492">the #GstCaps to which level and profile fields are to be added</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="audio_config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="493">a pointer to the AudioSpecificConfig
- as specified in the Elementary Stream Descriptor (esds)
- in ISO/IEC 14496-1. (See below for more details)</doc>
- <array length="2" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="496">Length of @audio_config in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_aac_get_channels"
- c:identifier="gst_codec_utils_aac_get_channels"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="218">Returns the channels of the given AAC stream.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="48"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="227">The channels or 0 if the channel could not be determined.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="audio_config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="220">a pointer to the AudioSpecificConfig
- as specified in the Elementary Stream Descriptor (esds)
- in ISO/IEC 14496-1.</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="223">Length of @audio_config in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_aac_get_index_from_sample_rate"
- c:identifier="gst_codec_utils_aac_get_index_from_sample_rate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="89">Translates the sample rate to the index corresponding to it in AAC spec.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="36"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="95">The AAC index for this sample rate, -1 if the rate is not a
-valid AAC sample rate.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="91">Sample rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_aac_get_level"
- c:identifier="gst_codec_utils_aac_get_level">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="301">Determines the level of a stream as defined in ISO/IEC 14496-3. For AAC LC
-streams, the constraints from the AAC audio profile are applied. For AAC
-Main, LTP, SSR and others, the Main profile is used.
-
-The @audio_config parameter follows the following format, starting from the
-most significant bit of the first byte:
-
- * Bit 0:4 contains the AudioObjectType (if this is 0x5, then the
- real AudioObjectType is carried after the rate and channel data)
- * Bit 5:8 contains the sample frequency index (if this is 0xf, then the
- next 24 bits define the actual sample frequency, and subsequent
- fields are appropriately shifted).
- * Bit 9:12 contains the channel configuration</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="42"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="322">The level as a const string and %NULL if the level could not be
-determined.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="audio_config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="303">a pointer to the AudioSpecificConfig
- as specified in the Elementary Stream Descriptor (esds)
- in ISO/IEC 14496-1.</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="306">Length of @audio_config in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_aac_get_profile"
- c:identifier="gst_codec_utils_aac_get_profile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="248">Returns the profile of the given AAC stream as a string. The profile is
-normally determined using the AudioObjectType field which is in the first
-5 bits of @audio_config</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="39"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="259">The profile as a const string and %NULL if the profile could not be
-determined.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="audio_config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="250">a pointer to the AudioSpecificConfig
- as specified in the Elementary Stream Descriptor (esds)
- in ISO/IEC 14496-1.</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="253">Length of @audio_config in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_aac_get_sample_rate"
- c:identifier="gst_codec_utils_aac_get_sample_rate"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="188">Translates the sample rate index found in AAC headers to the actual sample
-rate.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="45"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="198">The sample rate if sr_idx is valid, 0 otherwise.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="audio_config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="190">a pointer to the AudioSpecificConfig
- as specified in the Elementary Stream Descriptor (esds)
- in ISO/IEC 14496-1.</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="193">Length of @audio_config</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_aac_get_sample_rate_from_index"
- c:identifier="gst_codec_utils_aac_get_sample_rate_from_index">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="69">Translates the sample rate index found in AAC headers to the actual sample
-rate.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="33"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="77">The sample rate if @sr_idx is valid, 0 otherwise.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="sr_idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="71">Sample rate index as from the AudioSpecificConfig (MPEG-4
- container) or ADTS frame header</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_h264_caps_set_level_and_profile"
- c:identifier="gst_codec_utils_h264_caps_set_level_and_profile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="782">Sets the level and profile in @caps if it can be determined from @sps. See
-gst_codec_utils_h264_get_level() and gst_codec_utils_h264_get_profile()
-for more details on the parameters.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="792">%TRUE if the level and profile could be set, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="784">the #GstCaps to which the level and profile are to be added</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="sps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="785">Pointer to the sequence parameter set for the stream.</doc>
- <array length="2" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="786">Length of the data available in @sps.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_h264_get_level"
- c:identifier="gst_codec_utils_h264_get_level">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="659">Converts the level indication (level_idc) in the stream's
-sequence parameter set into a string. The SPS is expected to have the
-same format as for gst_codec_utils_h264_get_profile().</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="61"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="668">The level as a const string, or %NULL if there is an error.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="sps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="661">Pointer to the sequence parameter set for the stream.</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="662">Length of the data available in @sps.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_h264_get_level_idc"
- c:identifier="gst_codec_utils_h264_get_level_idc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="724">Transform a level string from the caps into the level_idc</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="64"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="730">the level_idc or 0 if the level is unknown</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="726">A level string from caps</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_h264_get_profile"
- c:identifier="gst_codec_utils_h264_get_profile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="547">Converts the profile indication (profile_idc) in the stream's
-sequence parameter set into a string. The SPS is expected to have the
-following format, as defined in the H.264 specification. The SPS is viewed
-as a bitstream here, with bit 0 being the most significant bit of the first
-byte.
-
-* Bit 0:7 - Profile indication
-* Bit 8 - constraint_set0_flag
-* Bit 9 - constraint_set1_flag
-* Bit 10 - constraint_set2_flag
-* Bit 11 - constraint_set3_flag
-* Bit 12 - constraint_set3_flag
-* Bit 13:15 - Reserved
-* Bit 16:24 - Level indication</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="58"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="567">The profile as a const string, or %NULL if there is an error.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="sps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="549">Pointer to the sequence parameter set for the stream.</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="550">Length of the data available in @sps.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_h265_caps_set_level_tier_and_profile"
- c:identifier="gst_codec_utils_h265_caps_set_level_tier_and_profile"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1426">Sets the level, tier and profile in @caps if it can be determined from
-@profile_tier_level. See gst_codec_utils_h265_get_level(),
-gst_codec_utils_h265_get_tier() and gst_codec_utils_h265_get_profile()
-for more details on the parameters.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="89"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1438">%TRUE if the level, tier, profile could be set, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1428">the #GstCaps to which the level, tier and profile are to be added</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="profile_tier_level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1429">Pointer to the profile_tier_level
- struct</doc>
- <array length="2" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1431">Length of the data available in @profile_tier_level.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_h265_get_level"
- c:identifier="gst_codec_utils_h265_get_level"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1323">Converts the level indication (general_level_idc) in the stream's
-profile_tier_level structure into a string. The profiel_tier_level is
-expected to have the same format as for gst_codec_utils_h264_get_profile().</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="82"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1333">The level as a const string, or %NULL if there is an error.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="profile_tier_level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1325">Pointer to the profile_tier_level
- for the stream</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1327">Length of the data available in @profile_tier_level.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_h265_get_level_idc"
- c:identifier="gst_codec_utils_h265_get_level_idc"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1380">Transform a level string from the caps into the level_idc</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="86"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1386">the level_idc or 0 if the level is unknown</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1382">A level string from caps</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_h265_get_profile"
- c:identifier="gst_codec_utils_h265_get_profile"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1107">Converts the profile indication (general_profile_idc) in the stream's
-profile_level_tier structure into a string. The profile_tier_level is
-expected to have the following format, as defined in the H.265
-specification. The profile_tier_level is viewed as a bitstream here,
-with bit 0 being the most significant bit of the first byte.
-
-* Bit 0:1 - general_profile_space
-* Bit 2 - general_tier_flag
-* Bit 3:7 - general_profile_idc
-* Bit 8:39 - gernal_profile_compatibility_flags
-* Bit 40 - general_progressive_source_flag
-* Bit 41 - general_interlaced_source_flag
-* Bit 42 - general_non_packed_constraint_flag
-* Bit 43 - general_frame_only_constraint_flag
-* Bit 44:87 - See below
-* Bit 88:95 - general_level_idc</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="74"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1130">The profile as a const string, or %NULL if there is an error.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="profile_tier_level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1109">Pointer to the profile_tier_level
- structure for the stream.</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1111">Length of the data available in @profile_tier_level</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_h265_get_tier"
- c:identifier="gst_codec_utils_h265_get_tier"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1286">Converts the tier indication (general_tier_flag) in the stream's
-profile_tier_level structure into a string. The profile_tier_level
-is expected to have the same format as for gst_codec_utils_h264_get_profile().</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="78"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1296">The tier as a const string, or %NULL if there is an error.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="profile_tier_level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1288">Pointer to the profile_tier_level
- for the stream.</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1290">Length of the data available in @profile_tier_level.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_mpeg4video_caps_set_level_and_profile"
- c:identifier="gst_codec_utils_mpeg4video_caps_set_level_and_profile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1637">Sets the level and profile in @caps if it can be determined from
-@vis_obj_seq. See gst_codec_utils_mpeg4video_get_level() and
-gst_codec_utils_mpeg4video_get_profile() for more details on the
-parameters.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="101"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1649">%TRUE if the level and profile could be set, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1639">the #GstCaps to which the level and profile are to be added</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="vis_obj_seq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1640">Pointer to the visual object
- sequence for the stream.</doc>
- <array length="2" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1642">Length of the data available in @sps.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_mpeg4video_get_level"
- c:identifier="gst_codec_utils_mpeg4video_get_level">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1545">Converts the level indication in the stream's visual object sequence into
-a string. @vis_obj_seq is expected to be the data following the visual
-object sequence start code. Only the first byte
-(profile_and_level_indication) is used.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="98"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1556">The level as a const string, or NULL if there is an error.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="vis_obj_seq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1547">Pointer to the visual object
- sequence for the stream.</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1549">Length of the data available in @sps.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_mpeg4video_get_profile"
- c:identifier="gst_codec_utils_mpeg4video_get_profile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1472">Converts the profile indication in the stream's visual object sequence into
-a string. @vis_obj_seq is expected to be the data following the visual
-object sequence start code. Only the first byte
-(profile_and_level_indication) is used.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="95"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1483">The profile as a const string, or NULL if there is an error.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="vis_obj_seq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1474">Pointer to the visual object
- sequence for the stream.</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1476">Length of the data available in @sps.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_opus_create_caps"
- c:identifier="gst_codec_utils_opus_create_caps"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1794">Creates Opus caps from the given parameters.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="117"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1805">The #GstCaps, or %NULL if the parameters would lead to
-invalid Opus caps.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1796">the sample rate</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1797">the number of channels</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="channel_mapping_family" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1798">the channel mapping family</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="stream_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1799">the number of independent streams</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="coupled_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1800">the number of stereo streams</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="channel_mapping"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1801">the mapping between the streams</doc>
- <array zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_opus_create_caps_from_header"
- c:identifier="gst_codec_utils_opus_create_caps_from_header"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1963">Creates Opus caps from the given OpusHead @header and comment header
-@comments.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="125"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1971">The #GstCaps.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="header" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1965">OpusHead header</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="comments"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1966">Comment header or NULL</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_opus_create_header"
- c:identifier="gst_codec_utils_opus_create_header"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2018">Creates OpusHead header from the given parameters.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="128"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2031">The #GstBuffer containing the OpusHead.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2020">the sample rate</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="channels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2021">the number of channels</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="channel_mapping_family" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2022">the channel mapping family</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="stream_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2023">the number of independent streams</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="coupled_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2024">the number of stereo streams</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="channel_mapping"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2025">the mapping between the streams</doc>
- <array zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="pre_skip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2026">Pre-skip in 48kHz samples or 0</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="output_gain" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2027">Output gain or 0</doc>
- <type name="gint16" c:type="gint16"/>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_opus_parse_caps"
- c:identifier="gst_codec_utils_opus_parse_caps"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1677">Parses Opus caps and fills the different fields with defaults if possible.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1689">%TRUE if parsing was successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1679">the #GstCaps to parse the data from</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="rate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1680">the sample rate</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="channels"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1681">the number of channels</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="channel_mapping_family"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1682">the channel mapping family</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="stream_count"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1683">the number of independent streams</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="coupled_count"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1684">the number of stereo streams</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="channel_mapping"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="1685">the mapping between the streams</doc>
- <array zero-terminated="0" c:type="guint8*" fixed-size="256">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="codec_utils_opus_parse_header"
- c:identifier="gst_codec_utils_opus_parse_header"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2099">Parses the OpusHead header.</doc>
- <source-position filename="gst-libs/gst/pbutils/codec-utils.h"
- line="138"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2113">%TRUE if parsing was successful, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="header" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2101">the OpusHead #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="rate"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2102">the sample rate</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="channels"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2103">the number of channels</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="channel_mapping_family"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2104">the channel mapping family</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="stream_count"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2105">the number of independent streams</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="coupled_count"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2106">the number of stereo streams</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="channel_mapping"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2107">the mapping between the streams</doc>
- <array zero-terminated="0" c:type="guint8*" fixed-size="256">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="pre_skip"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2108">Pre-skip in 48kHz samples or 0</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="output_gain"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="2109">Output gain or 0</doc>
- <type name="gint16" c:type="gint16*"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="discoverer_info_ref"
- c:identifier="gst_discoverer_info_ref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1082">Increments the reference count of @info.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="274"/>
- <parameters>
- <parameter name="info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1084">a #GstDiscovererInfo</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="discoverer_info_unref"
- c:identifier="gst_discoverer_info_unref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1091">Decrements the reference count of @info.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="273"/>
- <parameters>
- <parameter name="info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1093">a #GstDiscovererInfo</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="discoverer_stream_info_ref"
- c:identifier="gst_discoverer_stream_info_ref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1098">Increments the reference count of @info.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="59"/>
- <parameters>
- <parameter name="info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1100">a #GstDiscovererStreamInfo</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="discoverer_stream_info_unref"
- c:identifier="gst_discoverer_stream_info_unref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1107">Decrements the reference count of @info.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstdiscoverer.h"
- line="60"/>
- <parameters>
- <parameter name="info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstdiscoverer-types.c"
- line="1109">a #GstDiscovererStreamInfo</doc>
- </parameter>
- </parameters>
- </function-macro>
- <docsection name="encoding-profile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.c"
- line="21">Functions to create and handle encoding profiles.
-
-Encoding profiles describe the media types and settings one wishes to use
-for an encoding process. The top-level profiles are commonly
-#GstEncodingContainerProfile(s) (which contains a user-readable name and
-description along with which container format to use). These, in turn,
-reference one or more #GstEncodingProfile(s) which indicate which encoding
-format should be used on each individual streams.
-
-#GstEncodingProfile(s) can be provided to the 'encodebin' element, which
-will take care of selecting and setting up the required elements to produce
-an output stream conforming to the specifications of the profile.
-
-Unlike other systems, the encoding profiles do not specify which #GstElement
-to use for the various encoding and muxing steps, but instead relies on
-specifying the format one wishes to use.
-
-Encoding profiles can be created at runtime by the application or loaded
-from (and saved to) file using the #GstEncodingTarget API.
-
-## Defining a GstEncodingProfile as a string
-
-### Serialized encoding profile formats
-
-#### Using encoders and muxer element factory name:
-
-```
- muxer_factory_name:video_encoder_factory_name:audio_encoder_factory_name
-```
-
-For example to encode a stream into a WebM container, with an OGG audio
-stream and a VP8 video stream, the serialized #GstEncodingProfile looks
-like:
-
-```
- webmmux:vp8enc:vorbisenc
-```
-
-#### Define the encoding profile in a generic way using caps:
-
-```
- muxer_source_caps:video_encoder_source_caps:audio_encoder_source_caps
-```
-
-For example to encode a stream into a WebM container, with an OGG audio
-stream and a VP8 video stream, the serialized #GstEncodingProfile looks
-like:
-
-```
- video/webm:video/x-vp8:audio/x-vorbis
-```
-
-It is possible to mix caps and element type names so you can specify a specific
-video encoder while using caps for other encoders/muxer.
-
-### Advanced encoding format serialization features:
-
-You can also set the preset name of the encoding profile using the
-caps+preset_name syntax as in:
-
-```
- video/webm:video/x-vp8+youtube-preset:audio/x-vorbis
-```
-
-Moreover, you can set extra properties `presence`, `single-segment` and
-`variable-framerate` * of an * encoding profile using the `|presence=` syntax
-as in:
-
-```
- video/webm:video/x-vp8|presence=1,variable-framerate=true|single-segment=true:audio/x-vorbis
-```
-
-This field allows specifies the maximum number of times a
-#GstEncodingProfile can be used inside an encodebin. If 0, it is not a
-mandatory stream and can be used as many times as necessary.
-
-You can also use the `restriction_caps-&gt;encoded_format_caps` syntax to
-specify the restriction caps to be set on a #GstEncodingProfile
-
-It corresponds to the restriction #GstCaps to apply before the encoder that
-will be used in the profile. The fields present in restriction caps are
-properties of the raw stream (that is, before encoding), such as height and
-width for video and depth and sampling rate for audio. This property does
-not make sense for muxers. See #gst_encoding_profile_get_restriction for
-more details.
-
-To force a video stream to be encoded with a Full HD resolution (using WebM
-as the container format, VP8 as the video codec and Vorbis as the audio
-codec), you should use:
-
-```
- "video/webm:video/x-raw,width=1920,height=1080-&gt;video/x-vp8:audio/x-vorbis"
-```
-
-&gt; NOTE: Make sure to enclose into quotes to avoid '&gt;' to be reinterpreted by
-&gt; the shell.
-
-In the case you are using encoder types, the following is also possible:
-
-```
- "matroskamux:x264enc,width=1920,height=1080:audio/x-vorbis"
-```
-
-## Some serialized encoding formats examples:
-
-MP3 audio and H264 in MP4:
-
-```
- video/quicktime,variant=iso:video/x-h264:audio/mpeg,mpegversion=1,layer=3
-```
-
-Vorbis and theora in OGG:
-
-```
- application/ogg:video/x-theora:audio/x-vorbis
-```
-
-AC3 and H264 in MPEG-TS:
-
-```
- video/mpegts:video/x-h264:audio/x-ac3
-```
-
-## Loading a profile from encoding targets
-
-Anywhere where you have to use a string to define a #GstEncodingProfile,
-you can use load it from a #GstEncodingTarget using the following syntaxes:
-
-```
- target_name[/profilename/category]
-```
-
-or
-
-```
- /path/to/target.gep:profilename
-```
-
-## Examples
-
-### Creating a profile
-
-``` c
-#include &lt;gst/pbutils/encoding-profile.h&gt;
-...
-GstEncodingProfile *
-create_ogg_theora_profile(void)
-{
- GstEncodingContainerProfile *prof;
- GstCaps *caps;
-
- caps = gst_caps_from_string("application/ogg");
- prof = gst_encoding_container_profile_new("Ogg audio/video",
- "Standard OGG/THEORA/VORBIS",
- caps, NULL);
- gst_caps_unref (caps);
-
- caps = gst_caps_from_string("video/x-theora");
- gst_encoding_container_profile_add_profile(prof,
- (GstEncodingProfile*) gst_encoding_video_profile_new(caps, NULL, NULL, 0));
- gst_caps_unref (caps);
-
- caps = gst_caps_from_string("audio/x-vorbis");
- gst_encoding_container_profile_add_profile(prof,
- (GstEncodingProfile*) gst_encoding_audio_profile_new(caps, NULL, NULL, 0));
- gst_caps_unref (caps);
-
- return (GstEncodingProfile*) prof;
-}
-
-```
-
-### Example: Using an encoder preset with a profile
-
-``` c
-#include &lt;gst/pbutils/encoding-profile.h&gt;
-...
-GstEncodingProfile *
-create_ogg_theora_profile(void)
-{
- GstEncodingVideoProfile *v;
- GstEncodingAudioProfile *a;
- GstEncodingContainerProfile *prof;
- GstCaps *caps;
- GstPreset *preset;
-
- caps = gst_caps_from_string ("application/ogg");
- prof = gst_encoding_container_profile_new ("Ogg audio/video",
- "Standard OGG/THEORA/VORBIS",
- caps, NULL);
- gst_caps_unref (caps);
-
- preset = GST_PRESET (gst_element_factory_make ("theoraenc", "theorapreset"));
- g_object_set (preset, "bitrate", 1000, NULL);
- // The preset will be saved on the filesystem,
- // so try to use a descriptive name
- gst_preset_save_preset (preset, "theora_bitrate_preset");
- gst_object_unref (preset);
-
- caps = gst_caps_from_string ("video/x-theora");
- v = gst_encoding_video_profile_new (caps, "theora_bitrate_preset", NULL, 0);
- gst_encoding_container_profile_add_profile (prof, (GstEncodingProfile*) v);
- gst_caps_unref (caps);
-
- caps = gst_caps_from_string ("audio/x-vorbis");
- a = gst_encoding_audio_profile_new (caps, NULL, NULL, 0);
- gst_encoding_container_profile_add_profile (prof, (GstEncodingProfile*) a);
- gst_caps_unref (caps);
-
- return (GstEncodingProfile*) prof;
-}
-
-```
-
-### Listing categories, targets and profiles
-
-``` c
-#include &lt;gst/pbutils/encoding-profile.h&gt;
-...
-GstEncodingProfile *prof;
-GList *categories, *tmpc;
-GList *targets, *tmpt;
-...
-categories = gst_encoding_list_available_categories ();
-
-... Show available categories to user ...
-
-for (tmpc = categories; tmpc; tmpc = tmpc-&gt;next) {
- gchar *category = (gchar *) tmpc-&gt;data;
-
- ... and we can list all targets within that category ...
-
- targets = gst_encoding_list_all_targets (category);
-
- ... and show a list to our users ...
-
- g_list_foreach (targets, (GFunc) gst_encoding_target_unref, NULL);
- g_list_free (targets);
-}
-
-g_list_foreach (categories, (GFunc) g_free, NULL);
-g_list_free (categories);
-
-...
-```</doc>
- </docsection>
- <docsection name="encoding-target">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="20">On top of the notion of profiles, we implement the notion of EncodingTarget.
-Encoding Targets are basically a higher level of abstraction to define formats
-for specific target types. Those can define several GstEncodingProfiles with
-different names, for example one for transcoding in full HD, another one for
-low res, etc.. which are defined in the same encoding target.
-
-Basically if you want to encode a stream to send it to, say, youtube you should
-have a Youtube encoding target defined in the "online-service" category.
-
-## Encoding target serialization format
-
-Encoding targets are serialized in a KeyFile like files.
-
-|[
-[GStreamer Encoding Target]
-name : &lt;name&gt;
-category : &lt;category&gt;
-\description : &lt;description&gt; #translatable
-
-[profile-&lt;profile1name&gt;]
-name : &lt;name&gt;
-\description : &lt;description&gt; #optional
-format : &lt;format&gt;
-preset : &lt;preset&gt;
-
-[streamprofile-&lt;id&gt;]
-parent : &lt;encodingprofile.name&gt;[,&lt;encodingprofile.name&gt;..]
-\type : &lt;type&gt; # "audio", "video", "text"
-format : &lt;format&gt;
-preset : &lt;preset&gt;
-restriction : &lt;restriction&gt;
-presence : &lt;presence&gt;
-pass : &lt;pass&gt;
-variableframerate : &lt;variableframerate&gt;
-]|
-
-## Location of encoding target files
-
-$GST_DATADIR/gstreamer-GST_API_VERSION/encoding-profile
-$HOME/gstreamer-GST_API_VERSION/encoding-profile
-
-There also is a GST_ENCODING_TARGET_PATH environment variable
-defining a list of folder containing encoding target files.
-
-## Naming convention
-
-|[
- $(target.category)/$(target.name).gep
-]|
-
-## Naming restrictions:
-
- * lowercase ASCII letter for the first character
- * Same for all other characters + numerics + hyphens</doc>
- </docsection>
- <function name="encoding_list_all_targets"
- c:identifier="gst_encoding_list_all_targets">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="1260">List all available #GstEncodingTarget for the specified category, or all categories
-if @categoryname is %NULL.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="175"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="1268">The list of #GstEncodingTarget</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="EncodingTarget"/>
- </type>
- </return-value>
- <parameters>
- <parameter name="categoryname"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="1262">The category, for ex: #GST_ENCODING_CATEGORY_DEVICE.
-Can be %NULL.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="encoding_list_available_categories"
- c:identifier="gst_encoding_list_available_categories">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="1127">Lists all #GstEncodingTarget categories present on disk.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="172"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.c"
- line="1132">A list
-of #GstEncodingTarget categories.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="utf8"/>
- </type>
- </return-value>
- </function>
- <function-macro name="encoding_profile_ref"
- c:identifier="gst_encoding_profile_ref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="119">Increases the reference count of the @profile.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="121"/>
- <parameters>
- <parameter name="profile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="121">a #GstEncodingProfile</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="encoding_profile_unref"
- c:identifier="gst_encoding_profile_unref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="111">Decreases the reference count of the @profile, possibly freeing the @profile.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="113"/>
- <parameters>
- <parameter name="profile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-profile.h"
- line="113">a #GstEncodingProfile</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="encoding_target_ref"
- c:identifier="gst_encoding_target_ref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.h"
- line="115">Increases the reference count of the @target.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="120"/>
- <parameters>
- <parameter name="target">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.h"
- line="117">a #GstEncodingTarget</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="encoding_target_unref"
- c:identifier="gst_encoding_target_unref"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.h"
- line="106">Decreases the reference count of the @target, possibly freeing it.</doc>
- <source-position filename="gst-libs/gst/pbutils/encoding-target.h"
- line="111"/>
- <parameters>
- <parameter name="target">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/encoding-target.h"
- line="108">a #GstEncodingTarget</doc>
- </parameter>
- </parameters>
- </function-macro>
- <docsection name="gstpbutils">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/pbutils.c"
- line="20">libgstpbutils is a general utility library for plugins and applications.
-It currently provides the
-following:
-
-* human-readable description strings of codecs, elements, sources, decoders,
-encoders, or sinks from decoder/encoder caps, element names, or protocol
-names.
-
-* support for applications to initiate installation of missing plugins (if
-this is supported by the distribution or operating system used)
-
-* API for GStreamer elements to create missing-plugin messages in order to
-communicate to the application that a certain type of plugin is missing
-(decoder, encoder, URI protocol source, URI protocol sink, named element)
-
-* API for applications to recognise and handle missing-plugin messages
-
-## Linking to this library
-
-You should obtain the required CFLAGS and LIBS using pkg-config on the
-gstreamer-plugins-base-1.0 module. You will then also need to add
-'-lgstreamer-pbutils-1.0' manually to your LIBS line.
-
-## Library initialisation
-
-Before using any of its functions, applications and plugins must call
-gst_pb_utils_init() to initialise the library.</doc>
- </docsection>
- <docsection name="gstpbutilscodecutils">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/codec-utils.c"
- line="25">Provides codec-specific ulility functions such as functions to provide the
-codec profile and level in human-readable string form from header data.</doc>
- </docsection>
- <docsection name="gstpbutilsdescriptions">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="20">The above functions provide human-readable strings for media formats
-and decoder/demuxer/depayloader/encoder/muxer/payloader elements for use
-in error dialogs or other messages shown to users.
-
-gst_pb_utils_add_codec_description_to_tag_list() is a utility function
-for demuxer and decoder elements to add audio/video codec tags from a
-given (fixed) #GstCaps.</doc>
- </docsection>
- <docsection name="gstpbutilsinstallplugins">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="21">## Overview
-
-Using this API, applications can request the installation of missing
-GStreamer plugins. These may be missing decoders/demuxers or
-encoders/muxers for a certain format, sources or sinks for a certain URI
-protocol (e.g. 'http'), or certain elements known by their element
-factory name ('audioresample').
-
-Whether plugin installation is supported or not depends on the operating
-system and/or distribution in question. The vendor of the operating
-system needs to make sure the necessary hooks and mechanisms are in
-place for plugin installation to work. See below for more detailed
-information.
-
-From the application perspective, plugin installation is usually
-triggered either
-
-- when the application itself has found that it wants or needs to
- install a certain element
-- when the application has been notified by an element (such as
- playbin or decodebin) that one or more plugins are missing *and* the
- application has decided that it wants to install one or more of
- those missing plugins
-
-The install functions in this section all take one or more 'detail
-strings'. These detail strings contain information about the type of
-plugin that needs to be installed (decoder, encoder, source, sink, or
-named element), and some additional information such GStreamer version
-used and a human-readable description of the component to install for
-user dialogs.
-
-Applications should not concern themselves with the composition of the
-string itself. They should regard the string as if it was a shared
-secret between GStreamer and the plugin installer application.
-
-Detail strings can be obtained using the function
-gst_missing_plugin_message_get_installer_detail() on a
-missing-plugin message. Such a message will either have been found by
-the application on a pipeline's #GstBus, or the application will have
-created it itself using gst_missing_element_message_new(),
-gst_missing_decoder_message_new(),
-gst_missing_encoder_message_new(),
-gst_missing_uri_sink_message_new(), or
-gst_missing_uri_source_message_new().
-
-For each GStreamer element/plugin/component that should be installed,
-the application needs one of those 'installer detail' string mentioned
-in the previous section. This string can be obtained, as already
-mentioned above, from a missing-plugin message using the function
-gst_missing_plugin_message_get_installer_detail(). The
-missing-plugin message is either posted by another element and then
-found on the bus by the application, or the application has created it
-itself as described above.
-
-The application will then call gst_install_plugins_async(), passing a
-NULL-terminated array of installer detail strings, and a function that
-should be called when the installation of the plugins has finished
-(successfully or not). Optionally, a #GstInstallPluginsContext created
-with gst_install_plugins_context_new() may be passed as well. This
-way additional optional arguments like the application window's XID can
-be passed to the external installer application.
-
-gst_install_plugins_async() will return almost immediately, with the
-return code indicating whether plugin installation was started or not.
-If the necessary hooks for plugin installation are in place and an
-external installer application has in fact been called, the passed in
-function will be called with a result code as soon as the external
-installer has finished. If the result code indicates that new plugins
-have been installed, the application will want to call
-gst_update_registry() so the run-time plugin registry is updated and
-the new plugins are made available to the application.
-
-&gt; A Gtk/GLib main loop must be running in order for the result function
-&gt; to be called when the external installer has finished. If this is not
-&gt; the case, make sure to regularly call in your code:
-&gt;
-&gt; g_main_context_iteration (NULL,FALSE);
-
-## 1. Installer hook
-
-When GStreamer applications initiate plugin installation via
-gst_install_plugins_async() or gst_install_plugins_sync(), a
-pre-defined helper application will be called.
-
-The exact path of the helper application to be called is set at compile
-time, usually by the build system based on the install prefix.
-For a normal package build into the `/usr` prefix, this will usually
-default to `/usr/libexec/gst-install-plugins-helper` or
-`/usr/lib/gst-install-plugins-helper`.
-
-Vendors/distros who want to support GStreamer plugin installation should
-either provide such a helper script/application or use the meson option
-`-Dinstall_plugins_helper'=/path/to/installer` to make GStreamer call an
-installer of their own directly.
-
-It is strongly recommended that vendors provide a small helper
-application as interlocutor to the real installer though, even more so
-if command line argument munging is required to transform the command
-line arguments passed by GStreamer to the helper application into
-arguments that are understood by the real installer.
-
-The helper application path defined at compile time can be overridden at
-runtime by setting the GST_INSTALL_PLUGINS_HELPER environment
-variable. This can be useful for testing/debugging purposes.
-
-## 2. Arguments passed to the install helper
-
-GStreamer will pass the following arguments to the install helper (this
-is in addition to the path of the executable itself, which is by
-convention argv[0]):
-
-- none to many optional arguments in the form of `--foo-bar=val`.
- Example: `--transient-for=XID` where XID is the X Window ID of the
- main window of the calling application (so the installer can make
- itself transient to that window). Unknown optional arguments should
- be ignored by the installer.
-
-- one 'installer detail string' argument for each plugin to be
- installed; these strings will have a `gstreamer` prefix; the exact
- format of the detail string is explained below
-
-## 3. Detail string describing the missing plugin
-
-The string is in UTF-8 encoding and is made up of several fields,
-separated by '|' characters (but neither the first nor the last
-character is a '|'). The fields are:
-
-- plugin system identifier, ie. "gstreamer"
- This identifier determines the format of the rest of the detail
- string. Automatic plugin installers should not process detail
- strings with unknown identifiers. This allows other plugin-based
- libraries to use the same mechanism for their automatic plugin
- installation needs, or for the format to be changed should it turn
- out to be insufficient.
-- plugin system version, e.g. "1.0"
- This is required so that when there is GStreamer-2.0 at some point
- in future, the different major versions can still co-exist and use
- the same plugin install mechanism in the same way.
-- application identifier, e.g. "totem"
- This may also be in the form of "pid/12345" if the program name
- can't be obtained for some reason.
-- human-readable localised description of the required component, e.g.
- "Vorbis audio decoder"
-- identifier string for the required component (see below for details
- about how to map this to the package/plugin that needs installing),
- e.g.
- - urisource-$(PROTOCOL_REQUIRED), e.g. urisource-http or
- urisource-mms
- - element-$(ELEMENT_REQUIRED), e.g. element-videoconvert
- - decoder-$(CAPS_REQUIRED), e.g. (do read below for more
- details!):
- - decoder-audio/x-vorbis
- - decoder-application/ogg
- - decoder-audio/mpeg, mpegversion=(int)4
- - decoder-video/mpeg, systemstream=(boolean)true,
- mpegversion=(int)2
- - encoder-$(CAPS_REQUIRED), e.g. encoder-audio/x-vorbis
-- optional further fields not yet specified
-
-An entire ID string might then look like this, for example: `
-gstreamer|1.0|totem|Vorbis audio decoder|decoder-audio/x-vorbis`
-
-Plugin installers parsing this ID string should expect further fields
-also separated by '|' symbols and either ignore them, warn the user, or
-error out when encountering them.
-
-Those unfamiliar with the GStreamer 'caps' system should note a few
-things about the caps string used in the above decoder/encoder case:
-
-- the first part ("video/mpeg") of the caps string is a GStreamer
- media type and *not* a MIME type. Wherever possible, the GStreamer
- media type will be the same as the corresponding MIME type, but
- often it is not.
-- a caps string may or may not have additional comma-separated fields
- of various types (as seen in the examples above)
-- the caps string of a 'required' component (as above) will always
- have fields with fixed values, whereas an introspected string (see
- below) may have fields with non-fixed values. Compare for example:
- - `audio/mpeg, mpegversion=(int)4` vs.
- `audio/mpeg, mpegversion=(int){2, 4}`
- - `video/mpeg, mpegversion=(int)2` vs.
- `video/mpeg, systemstream=(boolean){ true, false}, mpegversion=(int)[1, 2]`
-
-## 4. Exit codes the installer should return
-
-The installer should return one of the following exit codes when it
-exits:
-
-- 0 if all of the requested plugins could be installed
- (#GST_INSTALL_PLUGINS_SUCCESS)
-- 1 if no appropriate installation candidate for any of the requested
- plugins could be found. Only return this if nothing has been
- installed (#GST_INSTALL_PLUGINS_NOT_FOUND)
-- 2 if an error occurred during the installation. The application will
- assume that the user will already have seen an error message by the
- installer in this case and will usually not show another one
- (#GST_INSTALL_PLUGINS_ERROR)
-- 3 if some of the requested plugins could be installed, but not all
- (#GST_INSTALL_PLUGINS_PARTIAL_SUCCESS)
-- 4 if the user aborted the installation
- (#GST_INSTALL_PLUGINS_USER_ABORT)
-
-## 5. How to map the required detail string to packages
-
-It is up to the vendor to find mechanism to map required components from
-the detail string to the actual packages/plugins to install. This could
-be a hardcoded list of mappings, for example, or be part of the
-packaging system metadata.
-
-GStreamer plugin files can be introspected for this information. The
-`gst-inspect` utility has a special command line option that will output
-information similar to what is required. For example `
-$ gst-inspect-1.0 --print-plugin-auto-install-info /path/to/libgstvorbis.so
-should output something along the lines of
-`decoder-audio/x-vorbis`, `element-vorbisdec` `element-vorbisenc`
-`element-vorbisparse`, `element-vorbistag`, `encoder-audio/x-vorbis`
-
-Note that in the encoder and decoder case the introspected caps can be
-more complex with additional fields, e.g.
-`audio/mpeg,mpegversion=(int){2,4}`, so they will not always exactly
-match the caps wanted by the application. It is up to the installer to
-deal with this (either by doing proper caps intersection using the
-GStreamer #GstCaps API, or by only taking into account the media type).
-
-Another potential source of problems are plugins such as ladspa or
-libvisual where the list of elements depends on the installed
-ladspa/libvisual plugins at the time. This is also up to the
-distribution to handle (but usually not relevant for playback
-applications).</doc>
- </docsection>
- <docsection name="gstpbutilsmissingplugins">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="20">Functions to create, recognise and parse missing-plugins messages for
-applications and elements.
-
-Missing-plugin messages are posted on the bus by elements like decodebin
-or playbin if they can't find an appropriate source element or decoder
-element. The application can use these messages for two things:
-
- * concise error/problem reporting to the user mentioning what exactly
- is missing, see gst_missing_plugin_message_get_description()
-
- * initiate installation of missing plugins, see
- gst_missing_plugin_message_get_installer_detail() and
- gst_install_plugins_async()
-
-Applications may also create missing-plugin messages themselves to install
-required elements that are missing, using the install mechanism mentioned
-above.</doc>
- </docsection>
- <docsection name="gstpluginsbaseversion">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstpluginsbaseversion.c"
- line="20">Use the GST_PLUGINS_BASE_VERSION_* macros e.g. to check what version of
-gst-plugins-base you are building against, and gst_plugins_base_version()
-if you need to check at runtime what version of the gst-plugins-base
-libraries are being used / you are currently linked against.
-
-The version macros get defined by including &amp;lt;gst/pbutils/pbutils.h&amp;gt;.</doc>
- </docsection>
- <function name="install_plugins_async"
- c:identifier="gst_install_plugins_async">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="610">Requests plugin installation without blocking. Once the plugins have been
-installed or installation has failed, @func will be called with the result
-of the installation and your provided @user_data pointer.
-
-This function requires a running GLib/Gtk main loop. If you are not
-running a GLib/Gtk main loop, make sure to regularly call
-g_main_context_iteration(NULL,FALSE).
-
-The installer strings that make up @detail are typically obtained by
-calling gst_missing_plugin_message_get_installer_detail() on missing-plugin
-messages that have been caught on a pipeline's bus or created by the
-application via the provided API, such as gst_missing_element_message_new().
-
-It is possible to request the installation of multiple missing plugins in
-one go (as might be required if there is a demuxer for a certain format
-installed but no suitable video decoder and no suitable audio decoder).</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="141"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="635">result code whether an external installer could be started</doc>
- <type name="InstallPluginsReturn" c:type="GstInstallPluginsReturn"/>
- </return-value>
- <parameters>
- <parameter name="details" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="612">NULL-terminated array
- of installer string details (see below)</doc>
- <array c:type="const gchar* const*">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- <parameter name="ctx"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="614">a #GstInstallPluginsContext, or NULL</doc>
- <type name="InstallPluginsContext"
- c:type="GstInstallPluginsContext*"/>
- </parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="async"
- closure="3">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="615">the function to call when the installer program returns</doc>
- <type name="InstallPluginsResultFunc"
- c:type="GstInstallPluginsResultFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="616">the user data to pass to @func when called, or NULL</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="install_plugins_installation_in_progress"
- c:identifier="gst_install_plugins_installation_in_progress">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="751">Checks whether plugin installation (initiated by this application only)
-is currently in progress.</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="154"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="757">TRUE if plugin installation is in progress, otherwise FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="install_plugins_return_get_name"
- c:identifier="gst_install_plugins_return_get_name"
- moved-to="InstallPluginsReturn.get_name">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="708">Convenience function to return the descriptive string associated
-with a status code. This function returns English strings and
-should not be used for user messages. It is here only to assist
-in debugging.</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="151"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="717">a descriptive string for the status code in @ret</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="ret" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="710">the return status code</doc>
- <type name="InstallPluginsReturn" c:type="GstInstallPluginsReturn"/>
- </parameter>
- </parameters>
- </function>
- <function name="install_plugins_supported"
- c:identifier="gst_install_plugins_supported">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="765">Checks whether plugin installation is likely to be supported by the
-current environment. This currently only checks whether the helper script
-that is to be provided by the distribution or operating system vendor
-exists.</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="157"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="773">TRUE if plugin installation is likely to be supported.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- </function>
- <function name="install_plugins_sync"
- c:identifier="gst_install_plugins_sync">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="669">Requests plugin installation and block until the plugins have been
-installed or installation has failed.
-
-This function should almost never be used, it only exists for cases where
-a non-GLib main loop is running and the user wants to run it in a separate
-thread and marshal the result back asynchronously into the main thread
-using the other non-GLib main loop. You should almost always use
-gst_install_plugins_async() instead of this function.</doc>
- <source-position filename="gst-libs/gst/pbutils/install-plugins.h"
- line="147"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="684">the result of the installation.</doc>
- <type name="InstallPluginsReturn" c:type="GstInstallPluginsReturn"/>
- </return-value>
- <parameters>
- <parameter name="details" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="671">NULL-terminated array
- of installer string details</doc>
- <array c:type="const gchar* const*">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- <parameter name="ctx"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/install-plugins.c"
- line="673">a #GstInstallPluginsContext, or NULL</doc>
- <type name="InstallPluginsContext"
- c:type="GstInstallPluginsContext*"/>
- </parameter>
- </parameters>
- </function>
- <function name="is_missing_plugin_message"
- c:identifier="gst_is_missing_plugin_message">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="586">Checks whether @msg is a missing plugins message.</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="63"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="592">%TRUE if @msg is a missing-plugins message, otherwise %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="588">a #GstMessage</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="missing_decoder_installer_detail_new"
- c:identifier="gst_missing_decoder_installer_detail_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="724">Returns an opaque string containing all the details about the missing
-element to be passed to an external installer called via
-gst_install_plugins_async() or gst_install_plugins_sync().
-
-This function is mainly for applications that call external plugin
-installation mechanisms using one of the two above-mentioned functions in
-the case where the application knows exactly what kind of plugin it is
-missing.</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="82"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="737">a newly-allocated detail string, or NULL on error. Free string
- with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="decode_caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="726">the (fixed) caps for which a decoder element is needed</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="missing_decoder_message_new"
- c:identifier="gst_missing_decoder_message_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="256">Creates a missing-plugin message for @element to notify the application
-that a decoder element for a particular set of (fixed) caps is missing.
-This function is mainly for use in plugins.</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="45"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="265">a new #GstMessage, or NULL on error</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="258">the #GstElement posting the message</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="decode_caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="259">the (fixed) caps for which a decoder element is needed</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="missing_element_installer_detail_new"
- c:identifier="gst_missing_element_installer_detail_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="696">Returns an opaque string containing all the details about the missing
-element to be passed to an external installer called via
-gst_install_plugins_async() or gst_install_plugins_sync().
-
-This function is mainly for applications that call external plugin
-installation mechanisms using one of the two above-mentioned functions in
-the case where the application knows exactly what kind of plugin it is
-missing.</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="79"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="710">a newly-allocated detail string, or NULL on error. Free string
- with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="factory_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="698">the name of the missing element (element factory),
- e.g. "videoscale" or "cdparanoiasrc"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="missing_element_message_new"
- c:identifier="gst_missing_element_message_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="223">Creates a missing-plugin message for @element to notify the application
-that a certain required element is missing. This function is mainly for
-use in plugins.</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="41"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="233">a new #GstMessage, or NULL on error</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="225">the #GstElement posting the message</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="factory_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="226">the name of the missing element (element factory),
- e.g. "videoscale" or "cdparanoiasrc"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="missing_encoder_installer_detail_new"
- c:identifier="gst_missing_encoder_installer_detail_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="762">Returns an opaque string containing all the details about the missing
-element to be passed to an external installer called via
-gst_install_plugins_async() or gst_install_plugins_sync().
-
-This function is mainly for applications that call external plugin
-installation mechanisms using one of the two above-mentioned functions in
-the case where the application knows exactly what kind of plugin it is
-missing.</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="85"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="775">a newly-allocated detail string, or NULL on error. Free string
- with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="encode_caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="764">the (fixed) caps for which an encoder element is needed</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="missing_encoder_message_new"
- c:identifier="gst_missing_encoder_message_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="296">Creates a missing-plugin message for @element to notify the application
-that an encoder element for a particular set of (fixed) caps is missing.
-This function is mainly for use in plugins.</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="49"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="305">a new #GstMessage, or NULL on error</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="298">the #GstElement posting the message</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="encode_caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="299">the (fixed) caps for which an encoder element is needed</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="missing_plugin_message_get_description"
- c:identifier="gst_missing_plugin_message_get_description">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="481">Returns a localised string describing the missing feature, for use in
-error dialogs and the like. Should never return NULL unless @msg is not
-a valid missing-plugin message.
-
-This function is mainly for applications that need a human-readable string
-describing a missing plugin, given a previously collected missing-plugin
-message</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="60"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="493">a newly-allocated description string, or NULL on error. Free
- string with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="483">a missing-plugin #GstMessage of type #GST_MESSAGE_ELEMENT</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="missing_plugin_message_get_installer_detail"
- c:identifier="gst_missing_plugin_message_get_installer_detail">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="385">Returns an opaque string containing all the details about the missing
-element to be passed to an external installer called via
-gst_install_plugins_async() or gst_install_plugins_sync().
-
-This function is mainly for applications that call external plugin
-installation mechanisms using one of the two above-mentioned functions.</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="57"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="396">a newly-allocated detail string, or NULL on error. Free string
- with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="387">a missing-plugin #GstMessage of type #GST_MESSAGE_ELEMENT</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="missing_uri_sink_installer_detail_new"
- c:identifier="gst_missing_uri_sink_installer_detail_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="668">Returns an opaque string containing all the details about the missing
-element to be passed to an external installer called via
-gst_install_plugins_async() or gst_install_plugins_sync().
-
-This function is mainly for applications that call external plugin
-installation mechanisms using one of the two above-mentioned functions in
-the case where the application knows exactly what kind of plugin it is
-missing.</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="76"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="682">a newly-allocated detail string, or NULL on error. Free string
- with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="670">the URI protocol the missing source needs to implement,
- e.g. "http" or "mms"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="missing_uri_sink_message_new"
- c:identifier="gst_missing_uri_sink_message_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="191">Creates a missing-plugin message for @element to notify the application
-that a sink element for a particular URI protocol is missing. This
-function is mainly for use in plugins.</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="37"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="201">a new #GstMessage, or NULL on error</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="193">the #GstElement posting the message</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="194">the URI protocol the missing sink needs to implement,
- e.g. "http" or "smb"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="missing_uri_source_installer_detail_new"
- c:identifier="gst_missing_uri_source_installer_detail_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="640">Returns an opaque string containing all the details about the missing
-element to be passed to an external installer called via
-gst_install_plugins_async() or gst_install_plugins_sync().
-
-This function is mainly for applications that call external plugin
-installation mechanisms using one of the two above-mentioned functions in
-the case where the application knows exactly what kind of plugin it is
-missing.</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="73"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="654">a newly-allocated detail string, or NULL on error. Free string
- with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="642">the URI protocol the missing source needs to implement,
- e.g. "http" or "mms"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="missing_uri_source_message_new"
- c:identifier="gst_missing_uri_source_message_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="158">Creates a missing-plugin message for @element to notify the application
-that a source element for a particular URI protocol is missing. This
-function is mainly for use in plugins.</doc>
- <source-position filename="gst-libs/gst/pbutils/missing-plugins.h"
- line="33"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="168">a new #GstMessage, or NULL on error</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="element" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="160">the #GstElement posting the message</doc>
- <type name="Gst.Element" c:type="GstElement*"/>
- </parameter>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/missing-plugins.c"
- line="161">the URI protocol the missing source needs to implement,
- e.g. "http" or "mms"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="pb_utils_add_codec_description_to_tag_list"
- c:identifier="gst_pb_utils_add_codec_description_to_tag_list">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1141">Adds a codec tag describing the format specified by @caps to @taglist.</doc>
- <source-position filename="gst-libs/gst/pbutils/descriptions.h"
- line="35"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1151">TRUE if a codec tag was added, FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="taglist" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1143">a #GstTagList</doc>
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </parameter>
- <parameter name="codec_tag"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1144">a GStreamer codec tag such as #GST_TAG_AUDIO_CODEC,
- #GST_TAG_VIDEO_CODEC or #GST_TAG_CODEC. If none is specified,
- the function will attempt to detect the appropriate category.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1147">the (fixed) #GstCaps for which a codec tag should be added.</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="pb_utils_get_codec_description"
- c:identifier="gst_pb_utils_get_codec_description">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1192">Returns a localised (as far as this is possible) string describing the
-media format specified in @caps, for use in error dialogs or other messages
-to be seen by the user. Should never return NULL unless @caps is invalid.
-
-Also see the convenience function
-gst_pb_utils_add_codec_description_to_tag_list().</doc>
- <source-position filename="gst-libs/gst/pbutils/descriptions.h"
- line="40"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1203">a newly-allocated description string, or NULL on error. Free
- string with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1194">the (fixed) #GstCaps for which an format description is needed</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="pb_utils_get_decoder_description"
- c:identifier="gst_pb_utils_get_decoder_description">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1003">Returns a localised string describing an decoder for the format specified
-in @caps, for use in error dialogs or other messages to be seen by the user.
-Should never return NULL unless @factory_name or @caps are invalid.
-
-This function is mainly for internal use, applications would typically
-use gst_missing_plugin_message_get_description() to get a description of
-a missing feature from a missing-plugin message.</doc>
- <source-position filename="gst-libs/gst/pbutils/descriptions.h"
- line="54"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1015">a newly-allocated description string, or NULL on error. Free
- string with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1005">the (fixed) #GstCaps for which an decoder description is needed</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="pb_utils_get_element_description"
- c:identifier="gst_pb_utils_get_element_description">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1110">Returns a localised string describing the given element, for use in
-error dialogs or other messages to be seen by the user. Should never
-return NULL unless @factory_name is invalid.
-
-This function is mainly for internal use, applications would typically
-use gst_missing_plugin_message_get_description() to get a description of
-a missing feature from a missing-plugin message.</doc>
- <source-position filename="gst-libs/gst/pbutils/descriptions.h"
- line="60"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1122">a newly-allocated description string, or NULL on error. Free
- string with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="factory_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1112">the name of the element, e.g. "giosrc"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="pb_utils_get_encoder_description"
- c:identifier="gst_pb_utils_get_encoder_description">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1058">Returns a localised string describing an encoder for the format specified
-in @caps, for use in error dialogs or other messages to be seen by the user.
-Should never return NULL unless @factory_name or @caps are invalid.
-
-This function is mainly for internal use, applications would typically
-use gst_missing_plugin_message_get_description() to get a description of
-a missing feature from a missing-plugin message.</doc>
- <source-position filename="gst-libs/gst/pbutils/descriptions.h"
- line="57"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1070">a newly-allocated description string, or NULL on error. Free
- string with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="1060">the (fixed) #GstCaps for which an encoder description is needed</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="pb_utils_get_sink_description"
- c:identifier="gst_pb_utils_get_sink_description">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="968">Returns a localised string describing a sink element handling the protocol
-specified in @protocol, for use in error dialogs or other messages to be
-seen by the user. Should never return NULL unless @protocol is invalid.
-
-This function is mainly for internal use, applications would typically
-use gst_missing_plugin_message_get_description() to get a description of
-a missing feature from a missing-plugin message.</doc>
- <source-position filename="gst-libs/gst/pbutils/descriptions.h"
- line="51"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="980">a newly-allocated description string, or NULL on error. Free
- string with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="970">the protocol the sink element needs to handle, e.g. "http"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="pb_utils_get_source_description"
- c:identifier="gst_pb_utils_get_source_description">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="918">Returns a localised string describing a source element handling the protocol
-specified in @protocol, for use in error dialogs or other messages to be
-seen by the user. Should never return NULL unless @protocol is invalid.
-
-This function is mainly for internal use, applications would typically
-use gst_missing_plugin_message_get_description() to get a description of
-a missing feature from a missing-plugin message.</doc>
- <source-position filename="gst-libs/gst/pbutils/descriptions.h"
- line="48"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="930">a newly-allocated description string, or NULL on error. Free
- string with g_free() when not needed any longer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="protocol" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/descriptions.c"
- line="920">the protocol the source element needs to handle, e.g. "http"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="pb_utils_init" c:identifier="gst_pb_utils_init">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/pbutils.c"
- line="85">Initialises the base utils support library. This function is not
-thread-safe. Applications should call it after calling gst_init(),
-plugins should call it from their plugin_init function.
-
-This function may be called multiple times. It will do nothing if the
-library has already been initialised.</doc>
- <source-position filename="gst-libs/gst/pbutils/pbutils.h" line="39"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </function>
- <function name="plugins_base_version"
- c:identifier="gst_plugins_base_version">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstpluginsbaseversion.c"
- line="38">Gets the version number of the GStreamer Plugins Base libraries.</doc>
- <source-position filename="gst-libs/gst/pbutils/gstpluginsbaseversion.h"
- line="72"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="major"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstpluginsbaseversion.c"
- line="40">pointer to a guint to store the major version number, or %NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="minor"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstpluginsbaseversion.c"
- line="41">pointer to a guint to store the minor version number, or %NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="micro"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstpluginsbaseversion.c"
- line="42">pointer to a guint to store the micro version number, or %NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="nano"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstpluginsbaseversion.c"
- line="43">pointer to a guint to store the nano version number, or %NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="plugins_base_version_string"
- c:identifier="gst_plugins_base_version_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstpluginsbaseversion.c"
- line="61">This function returns a string that is useful for describing this version
-of GStreamer's gst-plugins-base libraries to the outside world: user agent
-strings, logging, about dialogs ...</doc>
- <source-position filename="gst-libs/gst/pbutils/gstpluginsbaseversion.h"
- line="75"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/pbutils/gstpluginsbaseversion.c"
- line="68">a newly allocated string describing this version of gst-plugins-base</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- </function>
- </namespace>
-</repository>
diff --git a/girs/GstRtp-1.0.gir b/girs/GstRtp-1.0.gir
deleted file mode 100644
index 58af7ee5dd..0000000000
--- a/girs/GstRtp-1.0.gir
+++ /dev/null
@@ -1,8509 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="Gst" version="1.0"/>
- <include name="GstBase" version="1.0"/>
- <package name="gstreamer-rtp-1.0"/>
- <c:include name="gst/rtp/rtp.h"/>
- <namespace name="GstRtp"
- version="1.0"
- shared-library="libgstrtp-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <function-macro name="IS_RTP_BASE_AUDIO_PAYLOAD"
- c:identifier="GST_IS_RTP_BASE_AUDIO_PAYLOAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_RTP_BASE_AUDIO_PAYLOAD_CLASS"
- c:identifier="GST_IS_RTP_BASE_AUDIO_PAYLOAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="43"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_RTP_BASE_DEPAYLOAD"
- c:identifier="GST_IS_RTP_BASE_DEPAYLOAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_RTP_BASE_DEPAYLOAD_CLASS"
- c:identifier="GST_IS_RTP_BASE_DEPAYLOAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_RTP_BASE_PAYLOAD"
- c:identifier="GST_IS_RTP_BASE_PAYLOAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_RTP_BASE_PAYLOAD_CLASS"
- c:identifier="GST_IS_RTP_BASE_PAYLOAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <record name="RTCPBuffer" c:type="GstRTCPBuffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="23">Note: The API in this module is not yet declared stable.
-
-The GstRTPCBuffer helper functions makes it easy to parse and create regular
-#GstBuffer objects that contain compound RTCP packets. These buffers are typically
-of 'application/x-rtcp' #GstCaps.
-
-An RTCP buffer consists of 1 or more #GstRTCPPacket structures that you can
-retrieve with gst_rtcp_buffer_get_first_packet(). #GstRTCPPacket acts as a pointer
-into the RTCP buffer; you can move to the next packet with
-gst_rtcp_packet_move_to_next().</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="229"/>
- <field name="buffer" writable="1">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="map" writable="1">
- <type name="Gst.MapInfo" c:type="GstMapInfo"/>
- </field>
- <method name="add_packet" c:identifier="gst_rtcp_buffer_add_packet">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="530">Add a new packet of @type to @rtcp. @packet will point to the newly created
-packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="300"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="539">%TRUE if the packet could be created. This function returns %FALSE
-if the max mtu is exceeded for the buffer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtcp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="532">a valid RTCP buffer</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="533">the #GstRTCPType of the new packet</doc>
- <type name="RTCPType" c:type="GstRTCPType"/>
- </parameter>
- <parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="534">pointer to new packet</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_first_packet"
- c:identifier="gst_rtcp_buffer_get_first_packet">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="460">Initialize a new #GstRTCPPacket pointer that points to the first packet in
-@rtcp.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="294"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="468">TRUE if the packet existed in @rtcp.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtcp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="462">a valid RTCP buffer</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </instance-parameter>
- <parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="463">a #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_packet_count"
- c:identifier="gst_rtcp_buffer_get_packet_count">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="348">Get the number of RTCP packets in @rtcp.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="291"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="354">the number of RTCP packets in @rtcp.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtcp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="350">a valid RTCP buffer</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unmap" c:identifier="gst_rtcp_buffer_unmap">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="321">Finish @rtcp after being constructed. This function is usually called
-after gst_rtcp_buffer_map() and after adding the RTCP items to the new buffer.
-
-The function adjusts the size of @rtcp with the total length of all the
-added packets.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="286"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtcp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="323">a buffer with an RTCP packet</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="map" c:identifier="gst_rtcp_buffer_map">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="297">Open @buffer for reading or writing, depending on @flags. The resulting RTCP
-buffer state is stored in @rtcp.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="283"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="299">a buffer with an RTCP packet</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="300">flags for the mapping</doc>
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- <parameter name="rtcp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="301">resulting #GstRTCPBuffer</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="new" c:identifier="gst_rtcp_buffer_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="273">Create a new buffer for constructing RTCP packets. The packet will have a
-maximum size of @mtu.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="280"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="280">A newly allocated buffer.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="mtu" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="275">the maximum mtu size.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_copy_data"
- c:identifier="gst_rtcp_buffer_new_copy_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="73">Create a new buffer and set the data to a copy of @len
-bytes of @data and the size to @len. The data will be freed when the buffer
-is freed.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="264"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="82">A newly allocated buffer with a copy of @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="75">data for the new buffer</doc>
- <array length="1" zero-terminated="0" c:type="gconstpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="76">the length of data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_take_data"
- c:identifier="gst_rtcp_buffer_new_take_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="49">Create a new buffer and set the data and size of the buffer to @data and @len
-respectively. @data will be freed when the buffer is unreffed, so this
-function transfers ownership of @data to the new buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="261"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="58">A newly allocated buffer with @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="51">data for the new buffer</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="52">the length of data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="validate" c:identifier="gst_rtcp_buffer_validate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="249">Check if the data pointed to by @buffer is a valid RTCP packet using
-gst_rtcp_buffer_validate_data().</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="270"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="256">TRUE if @buffer is a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="251">the buffer to validate</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="validate_data"
- c:identifier="gst_rtcp_buffer_validate_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="204">Check if the @data and @size point to the data of a valid compound,
-non-reduced size RTCP packet.
-Use this function to validate a packet before using the other functions in
-this module.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="267"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="214">TRUE if the data points to a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="206">the data to validate</doc>
- <array length="1" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="207">the length of @data to validate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="validate_data_reduced"
- c:identifier="gst_rtcp_buffer_validate_data_reduced"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="180">Check if the @data and @size point to the data of a valid RTCP packet.
-Use this function to validate a packet before using the other functions in
-this module.
-
-This function is updated to support reduced size rtcp packets according to
-RFC 5506 and will validate full compound RTCP packets as well as reduced
-size RTCP packets.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="273"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="193">TRUE if the data points to a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="182">the data to validate</doc>
- <array length="1" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="183">the length of @data to validate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="validate_reduced"
- c:identifier="gst_rtcp_buffer_validate_reduced"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="223">Check if the data pointed to by @buffer is a valid RTCP packet using
-gst_rtcp_buffer_validate_reduced().</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="276"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="230">TRUE if @buffer is a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="225">the buffer to validate</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <enumeration name="RTCPFBType"
- glib:type-name="GstRTCPFBType"
- glib:get-type="gst_rtcpfb_type_get_type"
- c:type="GstRTCPFBType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="68">Different types of feedback messages.</doc>
- <member name="fb_type_invalid"
- value="0"
- c:identifier="GST_RTCP_FB_TYPE_INVALID"
- glib:nick="fb-type-invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="70">Invalid type</doc>
- </member>
- <member name="rtpfb_type_nack"
- value="1"
- c:identifier="GST_RTCP_RTPFB_TYPE_NACK"
- glib:nick="rtpfb-type-nack">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="71">Generic NACK</doc>
- </member>
- <member name="rtpfb_type_tmmbr"
- value="3"
- c:identifier="GST_RTCP_RTPFB_TYPE_TMMBR"
- glib:nick="rtpfb-type-tmmbr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="72">Temporary Maximum Media Stream Bit Rate Request</doc>
- </member>
- <member name="rtpfb_type_tmmbn"
- value="4"
- c:identifier="GST_RTCP_RTPFB_TYPE_TMMBN"
- glib:nick="rtpfb-type-tmmbn">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="73">Temporary Maximum Media Stream Bit Rate
- Notification</doc>
- </member>
- <member name="rtpfb_type_rtcp_sr_req"
- value="5"
- c:identifier="GST_RTCP_RTPFB_TYPE_RTCP_SR_REQ"
- glib:nick="rtpfb-type-rtcp-sr-req">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="75">Request an SR packet for early
- synchronization</doc>
- </member>
- <member name="rtpfb_type_twcc"
- value="15"
- c:identifier="GST_RTCP_RTPFB_TYPE_TWCC"
- glib:nick="rtpfb-type-twcc">
- </member>
- <member name="psfb_type_pli"
- value="1"
- c:identifier="GST_RTCP_PSFB_TYPE_PLI"
- glib:nick="psfb-type-pli">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="77">Picture Loss Indication</doc>
- </member>
- <member name="psfb_type_sli"
- value="2"
- c:identifier="GST_RTCP_PSFB_TYPE_SLI"
- glib:nick="psfb-type-sli">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="78">Slice Loss Indication</doc>
- </member>
- <member name="psfb_type_rpsi"
- value="3"
- c:identifier="GST_RTCP_PSFB_TYPE_RPSI"
- glib:nick="psfb-type-rpsi">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="79">Reference Picture Selection Indication</doc>
- </member>
- <member name="psfb_type_afb"
- value="15"
- c:identifier="GST_RTCP_PSFB_TYPE_AFB"
- glib:nick="psfb-type-afb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="80">Application layer Feedback</doc>
- </member>
- <member name="psfb_type_fir"
- value="4"
- c:identifier="GST_RTCP_PSFB_TYPE_FIR"
- glib:nick="psfb-type-fir">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="81">Full Intra Request Command</doc>
- </member>
- <member name="psfb_type_tstr"
- value="5"
- c:identifier="GST_RTCP_PSFB_TYPE_TSTR"
- glib:nick="psfb-type-tstr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="82">Temporal-Spatial Trade-off Request</doc>
- </member>
- <member name="psfb_type_tstn"
- value="6"
- c:identifier="GST_RTCP_PSFB_TYPE_TSTN"
- glib:nick="psfb-type-tstn">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="83">Temporal-Spatial Trade-off Notification</doc>
- </member>
- <member name="psfb_type_vbcn"
- value="7"
- c:identifier="GST_RTCP_PSFB_TYPE_VBCN"
- glib:nick="psfb-type-vbcn">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="84">Video Back Channel Message</doc>
- </member>
- </enumeration>
- <record name="RTCPPacket" c:type="GstRTCPPacket">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="233">Data structure that points to a packet at @offset in @buffer.
-The size of the structure is made public to allow stack allocations.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="256"/>
- <field name="rtcp" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="235">pointer to RTCP buffer</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </field>
- <field name="offset" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="236">offset of packet in buffer data</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="padding" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="count" readable="0" private="1">
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="type" readable="0" private="1">
- <type name="RTCPType" c:type="GstRTCPType"/>
- </field>
- <field name="length" readable="0" private="1">
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="item_offset" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="item_count" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="entry_offset" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <method name="add_profile_specific_ext"
- c:identifier="gst_rtcp_packet_add_profile_specific_ext"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1068">Add profile-specific extension @data to @packet. If @packet already
-contains profile-specific extension @data will be appended to the existing
-extension.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="367"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1078">%TRUE if the profile specific extension data was added.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1070">a valid SR or RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1071">profile-specific data</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1072">length of the profile-specific data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_rb" c:identifier="gst_rtcp_packet_add_rb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="951">Add a new report block to @packet with the given values.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="353"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="964">%TRUE if the packet was created. This function can return %FALSE if
-the max MTU is exceeded or the number of report blocks is greater than
-#GST_RTCP_MAX_RB_COUNT.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="953">a valid SR or RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="954">data source being reported</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="fractionlost" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="955">fraction lost since last SR/RR</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="packetslost" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="956">the cumululative number of packets lost</doc>
- <type name="gint32" c:type="gint32"/>
- </parameter>
- <parameter name="exthighestseq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="957">the extended last sequence number received</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="jitter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="958">the interarrival jitter</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="lsr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="959">the last SR packet from this source</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="dlsr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="960">the delay since last SR packet</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="app_get_data"
- c:identifier="gst_rtcp_packet_app_get_data"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2547">Get the application-dependent data attached to a RTPFB or PSFB @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="468"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2553">A pointer to the data</doc>
- <type name="guint8" c:type="guint8*"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2549">a valid APP #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="app_get_data_length"
- c:identifier="gst_rtcp_packet_app_get_data_length"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2486">Get the length of the application-dependent data attached to an APP
-@packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="462"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2493">The length of data in 32-bit words.</doc>
- <type name="guint16" c:type="guint16"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2488">a valid APP #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="app_get_name"
- c:identifier="gst_rtcp_packet_app_get_name"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2465">Get the name field of the APP @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="459"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2471">The 4-byte name field, not zero-terminated.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2467">a valid APP #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="app_get_ssrc"
- c:identifier="gst_rtcp_packet_app_get_ssrc"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2417">Get the SSRC/CSRC field of the APP @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="453"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2423">The SSRC/CSRC.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2419">a valid APP #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="app_get_subtype"
- c:identifier="gst_rtcp_packet_app_get_subtype"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2369">Get the subtype field of the APP @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="447"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2375">The subtype.</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2371">a valid APP #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="app_set_data_length"
- c:identifier="gst_rtcp_packet_app_set_data_length"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2512">Set the length of the application-dependent data attached to an APP
-@packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="465"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2520">%TRUE if there was enough space in the packet to add this much
-data.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2514">a valid APP #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="wordlen" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2515">Length of the data in 32-bit words</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </method>
- <method name="app_set_name"
- c:identifier="gst_rtcp_packet_app_set_name"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2442">Set the name field of the APP @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="456"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2444">a valid APP #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2445">4-byte ASCII name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="app_set_ssrc"
- c:identifier="gst_rtcp_packet_app_set_ssrc"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2394">Set the SSRC/CSRC field of the APP @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="450"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2396">a valid APP #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2397">SSRC/CSRC of the packet</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="app_set_subtype"
- c:identifier="gst_rtcp_packet_app_set_subtype"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2346">Set the subtype field of the APP @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="444"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2348">a valid APP #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="subtype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2349">subtype of the packet</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="bye_add_ssrc" c:identifier="gst_rtcp_packet_bye_add_ssrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1717">Add @ssrc to the BYE @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="427"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1724">%TRUE if the ssrc was added. This function can return %FALSE if
-the max MTU is exceeded or the number of sources blocks is greater than
-#GST_RTCP_MAX_BYE_SSRC_COUNT.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1719">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1720">an SSRC to add</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="bye_add_ssrcs"
- c:identifier="gst_rtcp_packet_bye_add_ssrcs">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1777">Adds @len SSRCs in @ssrc to BYE @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="430"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1785">%TRUE if the all the SSRCs were added. This function can return %FALSE if
-the max MTU is exceeded or the number of sources blocks is greater than
-#GST_RTCP_MAX_BYE_SSRC_COUNT.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1779">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1780">an array of SSRCs to add</doc>
- <array length="1" zero-terminated="0" c:type="guint32*">
- <type name="guint32" c:type="guint32"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1781">number of elements in @ssrc</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="bye_get_nth_ssrc"
- c:identifier="gst_rtcp_packet_bye_get_nth_ssrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1673">Get the @nth SSRC of the BYE @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="424"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1680">The @nth SSRC of @packet.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1675">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1676">the nth SSRC to get</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="bye_get_reason"
- c:identifier="gst_rtcp_packet_bye_get_reason">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1861">Get the reason in @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="436"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1867">The reason for the BYE @packet or NULL if the packet did not contain
-a reason string. The string must be freed with g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1863">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="bye_get_reason_len"
- c:identifier="gst_rtcp_packet_bye_get_reason_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1832">Get the length of the reason string.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="433"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1838">The length of the reason string or 0 when there is no reason string
-present.</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1834">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="bye_get_ssrc_count"
- c:identifier="gst_rtcp_packet_bye_get_ssrc_count">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1656">Get the number of SSRC fields in @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="421"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1662">The number of SSRC fields in @packet.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1658">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="bye_set_reason"
- c:identifier="gst_rtcp_packet_bye_set_reason">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1903">Set the reason string to @reason in @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="439"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1910">TRUE if the string could be set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1905">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="reason" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1906">a reason string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy_profile_specific_ext"
- c:identifier="gst_rtcp_packet_copy_profile_specific_ext"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1184">The profile-specific extension data is copied into a new allocated
-memory area @data. This must be freed with g_free() after usage.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="378"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1193">%TRUE if there was valid data.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1186">a valid SR or RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1187">result profile-specific data</doc>
- <array length="1" zero-terminated="0" c:type="guint8**">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </parameter>
- <parameter name="len"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1188">length of the profile-specific extension data</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="fb_get_fci" c:identifier="gst_rtcp_packet_fb_get_fci">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2319">Get the Feedback Control Information attached to a RTPFB or PSFB @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="497"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2325">a pointer to the FCI</doc>
- <type name="guint8" c:type="guint8*"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2321">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="fb_get_fci_length"
- c:identifier="gst_rtcp_packet_fb_get_fci_length">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2261">Get the length of the Feedback Control Information attached to a
-RTPFB or PSFB @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="491"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2268">The length of the FCI in 32-bit words.</doc>
- <type name="guint16" c:type="guint16"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2263">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="fb_get_media_ssrc"
- c:identifier="gst_rtcp_packet_fb_get_media_ssrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2023">Get the media SSRC field of the RTPFB or PSFB @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="479"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2029">the media SSRC.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2025">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="fb_get_sender_ssrc"
- c:identifier="gst_rtcp_packet_fb_get_sender_ssrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1969">Get the sender SSRC field of the RTPFB or PSFB @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="473"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1975">the sender SSRC.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1971">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="fb_get_type" c:identifier="gst_rtcp_packet_fb_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2077">Get the feedback message type of the FB @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="485"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2083">The feedback message type.</doc>
- <type name="RTCPFBType" c:type="GstRTCPFBType"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2079">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="fb_set_fci_length"
- c:identifier="gst_rtcp_packet_fb_set_fci_length">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2286">Set the length of the Feedback Control Information attached to a
-RTPFB or PSFB @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="494"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2294">%TRUE if there was enough space in the packet to add this much FCI</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2288">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="wordlen" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2289">Length of the FCI in 32-bit words</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </method>
- <method name="fb_set_media_ssrc"
- c:identifier="gst_rtcp_packet_fb_set_media_ssrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2052">Set the media SSRC field of the RTPFB or PSFB @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="482"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2054">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2055">a media SSRC</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="fb_set_sender_ssrc"
- c:identifier="gst_rtcp_packet_fb_set_sender_ssrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1998">Set the sender SSRC field of the RTPFB or PSFB @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="476"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2000">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2001">a sender SSRC</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="fb_set_type" c:identifier="gst_rtcp_packet_fb_set_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2095">Set the feedback message type of the FB @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="488"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2097">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2098">the #GstRTCPFBType to set</doc>
- <type name="RTCPFBType" c:type="GstRTCPFBType"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_count" c:identifier="gst_rtcp_packet_get_count">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="680">Get the count field in @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="312"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="686">The count field in @packet or -1 if @packet does not point to a
-valid packet.</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="682">a valid #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_length" c:identifier="gst_rtcp_packet_get_length">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="698">Get the length field of @packet. This is the length of the packet in
-32-bit words minus one.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="318"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="705">The length field of @packet.</doc>
- <type name="guint16" c:type="guint16"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="700">a valid #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_padding" c:identifier="gst_rtcp_packet_get_padding">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="646">Get the packet padding of the packet pointed to by @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="309"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="652">If the packet has the padding bit set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="648">a valid #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_profile_specific_ext"
- c:identifier="gst_rtcp_packet_get_profile_specific_ext"
- version="1.10">
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="374"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1152">%TRUE if there was valid data.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1148">a valid SR or RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1149">result profile-specific data</doc>
- <array length="1" zero-terminated="0" c:type="guint8**">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </parameter>
- <parameter name="len"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1150">result length of the profile-specific data</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_profile_specific_ext_length"
- c:identifier="gst_rtcp_packet_get_profile_specific_ext_length"
- version="1.10">
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="371"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1119">The number of 32-bit words containing profile-specific extension
- data from @packet.</doc>
- <type name="guint16" c:type="guint16"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1117">a valid SR or RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_rb" c:identifier="gst_rtcp_packet_get_rb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="868">Parse the values of the @nth report block in @packet and store the result in
-the values.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="347"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="870">a valid SR or RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="871">the nth report block in @packet</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ssrc"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="872">result for data source being reported</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="fractionlost"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="873">result for fraction lost since last SR/RR</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="packetslost"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="874">result for the cumululative number of packets lost</doc>
- <type name="gint32" c:type="gint32*"/>
- </parameter>
- <parameter name="exthighestseq"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="875">result for the extended last sequence number received</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="jitter"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="876">result for the interarrival jitter</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="lsr"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="877">result for the last SR packet from this source</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="dlsr"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="878">result for the delay since last SR packet</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_rb_count" c:identifier="gst_rtcp_packet_get_rb_count">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="848">Get the number of report blocks in @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="344"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="854">The number of report blocks in @packet.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="850">a valid SR or RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_type" c:identifier="gst_rtcp_packet_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="663">Get the packet type of the packet pointed to by @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="315"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="669">The packet type or GST_RTCP_TYPE_INVALID when @packet is not
-pointing to a valid packet.</doc>
- <type name="RTCPType" c:type="GstRTCPType"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="665">a valid #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="move_to_next" c:identifier="gst_rtcp_packet_move_to_next">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="490">Move the packet pointer @packet to the next packet in the payload.
-Use gst_rtcp_buffer_get_first_packet() to initialize @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="297"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="497">TRUE if @packet is pointing to a valid packet after calling this
-function.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="492">a #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove" c:identifier="gst_rtcp_packet_remove">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="609">Removes the packet pointed to by @packet and moves pointer to the next one</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="304"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="615">TRUE if @packet is pointing to a valid packet after calling this
-function.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="611">a #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="rr_get_ssrc" c:identifier="gst_rtcp_packet_rr_get_ssrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="796">Get the ssrc field of the RR @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="335"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="802">the ssrc.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="798">a valid RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="rr_set_ssrc" c:identifier="gst_rtcp_packet_rr_set_ssrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="824">Set the ssrc field of the RR @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="338"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="826">a valid RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="827">the SSRC to set</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="sdes_add_entry"
- c:identifier="gst_rtcp_packet_sdes_add_entry">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1591">Add a new SDES entry to the current item in @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="415"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1600">%TRUE if the item could be added, %FALSE if the MTU has been
-reached.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1593">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1594">the #GstRTCPSDESType of the SDES entry</doc>
- <type name="RTCPSDESType" c:type="GstRTCPSDESType"/>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1595">the data length</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1596">the data</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="sdes_add_item"
- c:identifier="gst_rtcp_packet_sdes_add_item">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1520">Add a new SDES item for @ssrc to @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="412"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1527">%TRUE if the item could be added, %FALSE if the maximum amount of
-items has been exceeded for the SDES packet or the MTU has been reached.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1522">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1523">the SSRC of the new item to add</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="sdes_copy_entry"
- c:identifier="gst_rtcp_packet_sdes_copy_entry">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1485">This function is like gst_rtcp_packet_sdes_get_entry() but it returns a
-null-terminated copy of the data instead. use g_free() after usage.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="407"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1495">%TRUE if there was valid data.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1487">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1488">result of the entry type</doc>
- <type name="RTCPSDESType" c:type="GstRTCPSDESType*"/>
- </parameter>
- <parameter name="len"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1489">result length of the entry data</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1490">result entry data</doc>
- <array length="1" zero-terminated="0" c:type="guint8**">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="sdes_first_entry"
- c:identifier="gst_rtcp_packet_sdes_first_entry">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1350">Move to the first SDES entry in the current item.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="396"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1356">%TRUE if there was a first entry.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1352">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="sdes_first_item"
- c:identifier="gst_rtcp_packet_sdes_first_item">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1243">Move to the first SDES item in @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="387"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1249">TRUE if there was a first item.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1245">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="sdes_get_entry"
- c:identifier="gst_rtcp_packet_sdes_get_entry">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1435">Get the data of the current SDES item entry. @type (when not NULL) will
-contain the type of the entry. @data (when not NULL) will point to @len
-bytes.
-
-When @type refers to a text item, @data will point to a UTF8 string. Note
-that this UTF8 string is NOT null-terminated. Use
-gst_rtcp_packet_sdes_copy_entry() to get a null-terminated copy of the entry.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="402"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1450">%TRUE if there was valid data.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1437">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1438">result of the entry type</doc>
- <type name="RTCPSDESType" c:type="GstRTCPSDESType*"/>
- </parameter>
- <parameter name="len"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1439">result length of the entry data</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1440">result entry data</doc>
- <array length="1" zero-terminated="0" c:type="guint8**">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="sdes_get_item_count"
- c:identifier="gst_rtcp_packet_sdes_get_item_count">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1226">Get the number of items in the SDES packet @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="384"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1232">The number of items in @packet.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1228">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="sdes_get_ssrc"
- c:identifier="gst_rtcp_packet_sdes_get_ssrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1320">Get the SSRC of the current SDES item.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="393"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1326">the SSRC of the current item.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1322">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="sdes_next_entry"
- c:identifier="gst_rtcp_packet_sdes_next_entry">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1390">Move to the next SDES entry in the current item.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="399"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1396">%TRUE if there was a next entry.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1392">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="sdes_next_item"
- c:identifier="gst_rtcp_packet_sdes_next_item">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1267">Move to the next SDES item in @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="390"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1273">TRUE if there was a next item.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1269">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_rb" c:identifier="gst_rtcp_packet_set_rb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1037">Set the @nth new report block in @packet with the given values.
-
-Note: Not implemented.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="359"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1039">a valid SR or RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1040">the nth report block to set</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1041">data source being reported</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="fractionlost" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1042">fraction lost since last SR/RR</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="packetslost" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1043">the cumululative number of packets lost</doc>
- <type name="gint32" c:type="gint32"/>
- </parameter>
- <parameter name="exthighestseq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1044">the extended last sequence number received</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="jitter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1045">the interarrival jitter</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="lsr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1046">the last SR packet from this source</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="dlsr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="1047">the delay since last SR packet</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="sr_get_sender_info"
- c:identifier="gst_rtcp_packet_sr_get_sender_info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="716">Parse the SR sender info and store the values.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="324"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="718">a valid SR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="719">result SSRC</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="ntptime"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="720">result NTP time</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="rtptime"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="721">result RTP time</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="packet_count"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="722">result packet count</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="octet_count"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="723">result octet count</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="sr_set_sender_info"
- c:identifier="gst_rtcp_packet_sr_set_sender_info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="759">Set the given values in the SR packet @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="329"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="761">a valid SR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="762">the SSRC</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="ntptime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="763">the NTP time</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="rtptime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="764">the RTP time</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="packet_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="765">the packet count</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="octet_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="766">the octet count</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_first_rb"
- c:identifier="gst_rtcp_packet_xr_first_rb"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2605">Move to the first extended report block in XR @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="519"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2611">TRUE if there was a first extended report block.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2607">a valid XR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="xr_get_block_length"
- c:identifier="gst_rtcp_packet_xr_get_block_length"
- version="1.16">
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="528"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2739">The number of 32-bit words containing type-specific block
- data from @packet.</doc>
- <type name="guint16" c:type="guint16"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2737">a valid XR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="xr_get_block_type"
- c:identifier="gst_rtcp_packet_xr_get_block_type"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2682">Get the extended report block type of the XR @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="525"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2688">The extended report block type.</doc>
- <type name="RTCPXRType" c:type="GstRTCPXRType"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2684">a valid XR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="xr_get_dlrr_block"
- c:identifier="gst_rtcp_packet_xr_get_dlrr_block"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2988">Parse the extended report block for DLRR report block type.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="553"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2998">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2990">a valid XR #GstRTCPPacket which has DLRR Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2991">the index of sub-block to retrieve.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2992">the SSRC of the receiver.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="last_rr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2993">the last receiver reference timestamp of @ssrc.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="delay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2994">the delay since @last_rr.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_prt_by_seq"
- c:identifier="gst_rtcp_packet_xr_get_prt_by_seq"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2915">Retrieve the packet receipt time of @seq which ranges in [begin_seq, end_seq).</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="546"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2923">%TRUE if the report block returns the receipt time correctly.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2917">a valid XR #GstRTCPPacket which has the Packet Recept Times Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="seq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2918">the sequence to retrieve the time.</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="receipt_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2919">the packet receipt time of @seq.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_prt_info"
- c:identifier="gst_rtcp_packet_xr_get_prt_info"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2863">Parse the Packet Recept Times Report Block from a XR @packet</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="541"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2873">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2865">a valid XR #GstRTCPPacket which has a Packet Receipt Times Report Block</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2866">the SSRC of the RTP data packet source being reported upon by this report block.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="thinning" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2867">the amount of thinning performed on the sequence number space.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="begin_seq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2868">the first sequence number that this block reports on.</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="end_seq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2869">the last sequence number that this block reports on plus one.</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_rle_info"
- c:identifier="gst_rtcp_packet_xr_get_rle_info"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2764">Parse the extended report block for Loss RLE and Duplicated LRE block type.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="531"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2775">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2766">a valid XR #GstRTCPPacket which is Loss RLE or Duplicate RLE report.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2767">the SSRC of the RTP data packet source being reported upon by this report block.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="thinning" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2768">the amount of thinning performed on the sequence number space.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="begin_seq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2769">the first sequence number that this block reports on.</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="end_seq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2770">the last sequence number that this block reports on plus one.</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="chunk_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2771">the number of chunks calculated by block length.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_rle_nth_chunk"
- c:identifier="gst_rtcp_packet_xr_get_rle_nth_chunk"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2822">Retrieve actual chunk data.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="537"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2830">%TRUE if the report block returns chunk correctly.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2824">a valid XR #GstRTCPPacket which is Loss RLE or Duplicate RLE report.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2825">the index of chunk to retrieve.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="chunk" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2826">the @nth chunk.</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_rrt"
- c:identifier="gst_rtcp_packet_xr_get_rrt"
- version="1.16">
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="550"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2961">%TRUE if the report block returns the reference time correctly.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2958">a valid XR #GstRTCPPacket which has the Receiver Reference Time.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2959">NTP timestamp</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_ssrc"
- c:identifier="gst_rtcp_packet_xr_get_ssrc"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2575">Get the ssrc field of the XR @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="516"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2581">the ssrc.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2577">a valid XR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="xr_get_summary_info"
- c:identifier="gst_rtcp_packet_xr_get_summary_info"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3038">Extract a basic information from static summary report block of XR @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="558"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3047">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3040">a valid XR #GstRTCPPacket which has Statics Summary Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3041">the SSRC of the source.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="begin_seq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3042">the first sequence number that this block reports on.</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="end_seq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3043">the last sequence number that this block reports on plus one.</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_summary_jitter"
- c:identifier="gst_rtcp_packet_xr_get_summary_jitter"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3134">Extract jitter information from the statistics summary. If the jitter flag in
-a block header is set as zero, all of jitters will be zero.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="566"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3145">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3136">a valid XR #GstRTCPPacket which has Statics Summary Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="min_jitter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3137">the minimum relative transit time between two sequences.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="max_jitter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3138">the maximum relative transit time between two sequences.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="mean_jitter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3139">the mean relative transit time between two sequences.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="dev_jitter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3140">the standard deviation of the relative transit time between two sequences.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_summary_pkt"
- c:identifier="gst_rtcp_packet_xr_get_summary_pkt"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3084">Get the number of lost or duplicate packets. If the flag in a block header
-is set as zero, @lost_packets or @dup_packets will be zero.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="562"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3093">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3086">a valid XR #GstRTCPPacket which has Statics Summary Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="lost_packets" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3087">the number of lost packets between begin_seq and end_seq.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="dup_packets" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3088">the number of duplicate packets between begin_seq and end_seq.</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_summary_ttl"
- c:identifier="gst_rtcp_packet_xr_get_summary_ttl"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3201">Extract the value of ttl for ipv4, or hop limit for ipv6.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="571"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3212">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3203">a valid XR #GstRTCPPacket which has Statics Summary Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="is_ipv4" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3204">the flag to indicate that the return values are ipv4 ttl or ipv6 hop limits.</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="min_ttl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3205">the minimum TTL or Hop Limit value of data packets between two sequences.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="max_ttl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3206">the maximum TTL or Hop Limit value of data packets between two sequences.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="mean_ttl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3207">the mean TTL or Hop Limit value of data packets between two sequences.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="dev_ttl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3208">the standard deviation of the TTL or Hop Limit value of data packets between two sequences.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_voip_burst_metrics"
- c:identifier="gst_rtcp_packet_xr_get_voip_burst_metrics"
- version="1.16">
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="583"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3336">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3330">a valid XR #GstRTCPPacket which has VoIP Metrics Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="burst_density" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3331">the fraction of RTP data packets within burst periods.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="gap_density" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3332">the fraction of RTP data packets within inter-burst gaps.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="burst_duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3333">the mean duration(ms) of the burst periods.</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="gap_duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3334">the mean duration(ms) of the gap periods.</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_voip_configuration_params"
- c:identifier="gst_rtcp_packet_xr_get_voip_configuration_params"
- version="1.16">
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="603"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3512">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3508">a valid XR #GstRTCPPacket which has VoIP Metrics Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="gmin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3509">the gap threshold.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="rx_config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3510">the receiver configuration byte.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_voip_delay_metrics"
- c:identifier="gst_rtcp_packet_xr_get_voip_delay_metrics"
- version="1.16">
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="588"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3382">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3378">a valid XR #GstRTCPPacket which has VoIP Metrics Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="roundtrip_delay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3379">the most recently calculated round trip time between RTP interfaces(ms)</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="end_system_delay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3380">the most recently estimated end system delay(ms)</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_voip_jitter_buffer_params"
- c:identifier="gst_rtcp_packet_xr_get_voip_jitter_buffer_params"
- version="1.16">
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="607"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3548">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3543">a valid XR #GstRTCPPacket which has VoIP Metrics Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="jb_nominal" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3544">the current nominal jitter buffer delay(ms)</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="jb_maximum" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3545">the current maximum jitter buffer delay(ms)</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="jb_abs_max" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3546">the absolute maximum delay(ms)</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_voip_metrics_ssrc"
- c:identifier="gst_rtcp_packet_xr_get_voip_metrics_ssrc"
- version="1.16">
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="576"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3263">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3260">a valid XR #GstRTCPPacket which has VoIP Metrics Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3261">the SSRC of source</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_voip_packet_metrics"
- c:identifier="gst_rtcp_packet_xr_get_voip_packet_metrics"
- version="1.16">
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="579"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3297">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3293">a valid XR #GstRTCPPacket which has VoIP Metrics Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="loss_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3294">the fraction of RTP data packets from the source lost.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="discard_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3295">the fraction of RTP data packets from the source that have been discarded.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_voip_quality_metrics"
- c:identifier="gst_rtcp_packet_xr_get_voip_quality_metrics"
- version="1.16">
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="598"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3468">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3462">a valid XR #GstRTCPPacket which has VoIP Metrics Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="r_factor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3463">the R factor is a voice quality metric describing the segment of the call.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="ext_r_factor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3464">the external R factor is a voice quality metric.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="mos_lq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3465">the estimated mean opinion score for listening quality.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="mos_cq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3466">the estimated mean opinion score for conversational quality.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_get_voip_signal_metrics"
- c:identifier="gst_rtcp_packet_xr_get_voip_signal_metrics"
- version="1.16">
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="593"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3422">%TRUE if the report block is correctly parsed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3416">a valid XR #GstRTCPPacket which has VoIP Metrics Report Block.</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="signal_level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3417">the ratio of the signal level to a 0 dBm reference.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="noise_level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3418">the ratio of the silent period background noise level to a 0 dBm reference.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="rerl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3419">the residual echo return loss value.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="gmin" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="3420">the gap threshold.</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- </parameters>
- </method>
- <method name="xr_next_rb"
- c:identifier="gst_rtcp_packet_xr_next_rb"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2644">Move to the next extended report block in XR @packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="522"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2650">TRUE if there was a next extended report block.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2646">a valid XR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <enumeration name="RTCPSDESType"
- glib:type-name="GstRTCPSDESType"
- glib:get-type="gst_rtcpsdes_type_get_type"
- c:type="GstRTCPSDESType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="114">Different types of SDES content.</doc>
- <member name="invalid"
- value="-1"
- c:identifier="GST_RTCP_SDES_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="116">Invalid SDES entry</doc>
- </member>
- <member name="end"
- value="0"
- c:identifier="GST_RTCP_SDES_END"
- glib:nick="end">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="117">End of SDES list</doc>
- </member>
- <member name="cname"
- value="1"
- c:identifier="GST_RTCP_SDES_CNAME"
- glib:nick="cname">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="118">Canonical name</doc>
- </member>
- <member name="name"
- value="2"
- c:identifier="GST_RTCP_SDES_NAME"
- glib:nick="name">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="119">User name</doc>
- </member>
- <member name="email"
- value="3"
- c:identifier="GST_RTCP_SDES_EMAIL"
- glib:nick="email">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="120">User's electronic mail address</doc>
- </member>
- <member name="phone"
- value="4"
- c:identifier="GST_RTCP_SDES_PHONE"
- glib:nick="phone">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="121">User's phone number</doc>
- </member>
- <member name="loc"
- value="5"
- c:identifier="GST_RTCP_SDES_LOC"
- glib:nick="loc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="122">Geographic user location</doc>
- </member>
- <member name="tool"
- value="6"
- c:identifier="GST_RTCP_SDES_TOOL"
- glib:nick="tool">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="123">Name of application or tool</doc>
- </member>
- <member name="note"
- value="7"
- c:identifier="GST_RTCP_SDES_NOTE"
- glib:nick="note">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="124">Notice about the source</doc>
- </member>
- <member name="priv"
- value="8"
- c:identifier="GST_RTCP_SDES_PRIV"
- glib:nick="priv">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="125">Private extensions</doc>
- </member>
- </enumeration>
- <enumeration name="RTCPType"
- glib:type-name="GstRTCPType"
- glib:get-type="gst_rtcp_type_get_type"
- c:type="GstRTCPType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="38">Different RTCP packet types.</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_RTCP_TYPE_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="40">Invalid type</doc>
- </member>
- <member name="sr"
- value="200"
- c:identifier="GST_RTCP_TYPE_SR"
- glib:nick="sr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="41">Sender report</doc>
- </member>
- <member name="rr"
- value="201"
- c:identifier="GST_RTCP_TYPE_RR"
- glib:nick="rr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="42">Receiver report</doc>
- </member>
- <member name="sdes"
- value="202"
- c:identifier="GST_RTCP_TYPE_SDES"
- glib:nick="sdes">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="43">Source description</doc>
- </member>
- <member name="bye"
- value="203"
- c:identifier="GST_RTCP_TYPE_BYE"
- glib:nick="bye">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="44">Goodbye</doc>
- </member>
- <member name="app"
- value="204"
- c:identifier="GST_RTCP_TYPE_APP"
- glib:nick="app">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="45">Application defined</doc>
- </member>
- <member name="rtpfb"
- value="205"
- c:identifier="GST_RTCP_TYPE_RTPFB"
- glib:nick="rtpfb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="46">Transport layer feedback.</doc>
- </member>
- <member name="psfb"
- value="206"
- c:identifier="GST_RTCP_TYPE_PSFB"
- glib:nick="psfb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="47">Payload-specific feedback.</doc>
- </member>
- <member name="xr"
- value="207"
- c:identifier="GST_RTCP_TYPE_XR"
- glib:nick="xr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="48">Extended report.</doc>
- </member>
- </enumeration>
- <enumeration name="RTCPXRType"
- version="1.16"
- glib:type-name="GstRTCPXRType"
- glib:get-type="gst_rtcpxr_type_get_type"
- c:type="GstRTCPXRType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="143">Types of RTCP Extended Reports, those are defined in RFC 3611 and other RFCs
-according to the [IANA registry](https://www.iana.org/assignments/rtcp-xr-block-types/rtcp-xr-block-types.xhtml).</doc>
- <member name="invalid"
- value="-1"
- c:identifier="GST_RTCP_XR_TYPE_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="145">Invalid XR Report Block</doc>
- </member>
- <member name="lrle"
- value="1"
- c:identifier="GST_RTCP_XR_TYPE_LRLE"
- glib:nick="lrle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="146">Loss RLE Report Block</doc>
- </member>
- <member name="drle"
- value="2"
- c:identifier="GST_RTCP_XR_TYPE_DRLE"
- glib:nick="drle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="147">Duplicate RLE Report Block</doc>
- </member>
- <member name="prt"
- value="3"
- c:identifier="GST_RTCP_XR_TYPE_PRT"
- glib:nick="prt">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="148">Packet Receipt Times Report Block</doc>
- </member>
- <member name="rrt"
- value="4"
- c:identifier="GST_RTCP_XR_TYPE_RRT"
- glib:nick="rrt">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="149">Receiver Reference Time Report Block</doc>
- </member>
- <member name="dlrr"
- value="5"
- c:identifier="GST_RTCP_XR_TYPE_DLRR"
- glib:nick="dlrr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="150">Delay since the last Receiver Report</doc>
- </member>
- <member name="ssumm"
- value="6"
- c:identifier="GST_RTCP_XR_TYPE_SSUMM"
- glib:nick="ssumm">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="151">Statistics Summary Report Block</doc>
- </member>
- <member name="voip_metrics"
- value="7"
- c:identifier="GST_RTCP_XR_TYPE_VOIP_METRICS"
- glib:nick="voip-metrics">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="152">VoIP Metrics Report Block</doc>
- </member>
- </enumeration>
- <constant name="RTCP_MAX_BYE_SSRC_COUNT"
- value="31"
- c:type="GST_RTCP_MAX_BYE_SSRC_COUNT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="192">The maximum amount of SSRCs in a BYE packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="197"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_MAX_RB_COUNT"
- value="31"
- c:type="GST_RTCP_MAX_RB_COUNT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="178">The maximum amount of Receiver report blocks in RR and SR messages.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="183"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_MAX_SDES" value="255" c:type="GST_RTCP_MAX_SDES">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="171">The maximum text length for an SDES item.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="176"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_MAX_SDES_ITEM_COUNT"
- value="31"
- c:type="GST_RTCP_MAX_SDES_ITEM_COUNT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="185">The maximum amount of SDES items.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="190"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_REDUCED_SIZE_VALID_MASK"
- value="57592"
- c:type="GST_RTCP_REDUCED_SIZE_VALID_MASK">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="206">Mask for version, padding bit and packet type pair allowing reduced size
-packets, basically it accepts other types than RR and SR</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="212"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_VALID_MASK"
- value="57598"
- c:type="GST_RTCP_VALID_MASK">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="199">Mask for version, padding bit and packet type pair</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="204"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_VALID_VALUE"
- value="200"
- c:type="GST_RTCP_VALID_VALUE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="214">Valid value for the first two bytes of an RTCP packet after applying
-#GST_RTCP_VALID_MASK to them.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="220"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_VERSION" value="2" c:type="GST_RTCP_VERSION">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.h"
- line="31">The supported RTCP version 2.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="36"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <class name="RTPBaseAudioPayload"
- c:symbol-prefix="rtp_base_audio_payload"
- c:type="GstRTPBaseAudioPayload"
- parent="RTPBasePayload"
- glib:type-name="GstRTPBaseAudioPayload"
- glib:get-type="gst_rtp_base_audio_payload_get_type"
- glib:type-struct="RTPBaseAudioPayloadClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="20">Provides a base class for audio RTP payloaders for frame or sample based
-audio codecs (constant bitrate)
-
-This class derives from GstRTPBasePayload. It can be used for payloading
-audio codecs. It will only work with constant bitrate codecs. It supports
-both frame based and sample based codecs. It takes care of packing up the
-audio data into RTP packets and filling up the headers accordingly. The
-payloading is done based on the maximum MTU (mtu) and the maximum time per
-packet (max-ptime). The general idea is to divide large data buffers into
-smaller RTP packets. The RTP packet size is the minimum of either the MTU,
-max-ptime (if set) or available data. The RTP packet size is always larger or
-equal to min-ptime (if set). If min-ptime is not set, any residual data is
-sent in a last RTP packet. In the case of frame based codecs, the resulting
-RTP packets always contain full frames.
-
-## Usage
-
-To use this base class, your child element needs to call either
-gst_rtp_base_audio_payload_set_frame_based() or
-gst_rtp_base_audio_payload_set_sample_based(). This is usually done in the
-element's `_init()` function. Then, the child element must call either
-gst_rtp_base_audio_payload_set_frame_options(),
-gst_rtp_base_audio_payload_set_sample_options() or
-gst_rtp_base_audio_payload_set_samplebits_options. Since
-GstRTPBaseAudioPayload derives from GstRTPBasePayload, the child element
-must set any variables or call/override any functions required by that base
-class. The child element does not need to override any other functions
-specific to GstRTPBaseAudioPayload.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="77"/>
- <method name="flush" c:identifier="gst_rtp_base_audio_payload_flush">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="567">Create an RTP buffer and store @payload_len bytes of the adapter as the
-payload. Set the timestamp on the new buffer to @timestamp before pushing
-the buffer downstream.
-
-If @payload_len is -1, all pending bytes will be flushed. If @timestamp is
--1, the timestamp will be calculated automatically.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="117"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="580">a #GstFlowReturn</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="baseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="569">a #GstRTPBasePayload</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="570">length of payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="571">a #GstClockTime</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_adapter"
- c:identifier="gst_rtp_base_audio_payload_get_adapter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="1006">Gets the internal adapter used by the depayloader.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="107"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="1012">a #GstAdapter.</doc>
- <type name="GstBase.Adapter" c:type="GstAdapter*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtpbaseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="1008">a #GstRTPBaseAudioPayload</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="push" c:identifier="gst_rtp_base_audio_payload_push">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="434">Create an RTP buffer and store @payload_len bytes of @data as the
-payload. Set the timestamp on the new buffer to @timestamp before pushing
-the buffer downstream.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="445">a #GstFlowReturn</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="baseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="436">a #GstRTPBasePayload</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="437">data to set as payload</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="438">length of payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="439">a #GstClockTime</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_frame_based"
- c:identifier="gst_rtp_base_audio_payload_set_frame_based">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="266">Tells #GstRTPBaseAudioPayload that the child element is for a frame based
-audio codec</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="85"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtpbaseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="268">a pointer to the element.</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_frame_options"
- c:identifier="gst_rtp_base_audio_payload_set_frame_options">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="314">Sets the options for frame based audio codecs.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="88"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtpbaseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="316">a pointer to the element.</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- <parameter name="frame_duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="317">The duraction of an audio frame in milliseconds.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="frame_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="318">The size of an audio frame in bytes.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_sample_based"
- c:identifier="gst_rtp_base_audio_payload_set_sample_based">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="290">Tells #GstRTPBaseAudioPayload that the child element is for a sample based
-audio codec</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="94"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtpbaseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="292">a pointer to the element.</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_sample_options"
- c:identifier="gst_rtp_base_audio_payload_set_sample_options">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="344">Sets the options for sample based audio codecs.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="97"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtpbaseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="346">a pointer to the element.</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- <parameter name="sample_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="347">Size per sample in bytes.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_samplebits_options"
- c:identifier="gst_rtp_base_audio_payload_set_samplebits_options">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="362">Sets the options for sample based audio codecs.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="101"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtpbaseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="364">a pointer to the element.</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- <parameter name="sample_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.c"
- line="365">Size per sample in bits.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <property name="buffer-list" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="payload">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload"/>
- </field>
- <field name="priv">
- <type name="RTPBaseAudioPayloadPrivate"
- c:type="GstRTPBaseAudioPayloadPrivate*"/>
- </field>
- <field name="base_ts">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="frame_size">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="frame_duration">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="sample_size">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="RTPBaseAudioPayloadClass"
- c:type="GstRTPBaseAudioPayloadClass"
- glib:is-gtype-struct-for="RTPBaseAudioPayload">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="65">Base class for audio RTP payloader.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="77"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="67">the parent class</doc>
- <type name="RTPBasePayloadClass" c:type="GstRTPBasePayloadClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="RTPBaseAudioPayloadPrivate"
- c:type="GstRTPBaseAudioPayloadPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="32"/>
- </record>
- <class name="RTPBaseDepayload"
- c:symbol-prefix="rtp_base_depayload"
- c:type="GstRTPBaseDepayload"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstRTPBaseDepayload"
- glib:get-type="gst_rtp_base_depayload_get_type"
- glib:type-struct="RTPBaseDepayloadClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="21">Provides a base class for RTP depayloaders</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="112"/>
- <virtual-method name="handle_event">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="106"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="packet_lost">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="102"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="process">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="97"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="base" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="in" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="process_rtp_packet">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="108"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="base" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="rtp_buffer" transfer-ownership="none">
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_caps">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="94"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="is_source_info_enabled"
- c:identifier="gst_rtp_base_depayload_is_source_info_enabled"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="1153">Queries whether #GstRTPSourceMeta will be added to depayloaded buffers.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="124"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="1159">%TRUE if source-info is enabled.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="depayload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="1155">a #GstRTPBaseDepayload</doc>
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="push" c:identifier="gst_rtp_base_depayload_push">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="897">Push @out_buf to the peer of @filter. This function takes ownership of
-@out_buf.
-
-This function will by default apply the last incoming timestamp on
-the outgoing buffer when it didn't have a timestamp already.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="118"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="908">a #GstFlowReturn.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="899">a #GstRTPBaseDepayload</doc>
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="out_buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="900">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="push_list" c:identifier="gst_rtp_base_depayload_push_list">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="928">Push @out_list to the peer of @filter. This function takes ownership of
-@out_list.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="121"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="936">a #GstFlowReturn.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="930">a #GstRTPBaseDepayload</doc>
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="out_list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="931">a #GstBufferList</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_source_info_enabled"
- c:identifier="gst_rtp_base_depayload_set_source_info_enabled"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="1137">Enable or disable adding #GstRTPSourceMeta to depayloaded buffers.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="127"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="depayload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="1139">a #GstRTPBaseDepayload</doc>
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="enable" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="1140">whether to add meta about RTP sources to buffer</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <property name="max-reorder"
- version="1.18"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="211">Max seqnum reorder before the sender is assumed to have restarted.
-
-When max-reorder is set to 0 all reordered/duplicate packets are
-considered coming from a restarted sender.</doc>
- <type name="gint" c:type="gint"/>
- </property>
- <property name="source-info"
- version="1.16"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="199">Add RTP source information found in RTP header as meta to output buffer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="stats" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.c"
- line="175">Various depayloader statistics retrieved atomically (and are therefore
-synchroized with each other). This property return a GstStructure named
-application/x-rtp-depayload-stats containing the following fields relating to
-the last processed buffer and current state of the stream being depayloaded:
-
- * `clock-rate`: #G_TYPE_UINT, clock-rate of the stream
- * `npt-start`: #G_TYPE_UINT64, time of playback start
- * `npt-stop`: #G_TYPE_UINT64, time of playback stop
- * `play-speed`: #G_TYPE_DOUBLE, the playback speed
- * `play-scale`: #G_TYPE_DOUBLE, the playback scale
- * `running-time-dts`: #G_TYPE_UINT64, the last running-time of the
- last DTS
- * `running-time-pts`: #G_TYPE_UINT64, the last running-time of the
- last PTS
- * `seqnum`: #G_TYPE_UINT, the last seen seqnum
- * `timestamp`: #G_TYPE_UINT, the last seen RTP timestamp</doc>
- <type name="Gst.Structure"/>
- </property>
- <field name="parent">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="sinkpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="srcpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="clock_rate">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="segment">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="need_newsegment">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="RTPBaseDepayloadPrivate"
- c:type="GstRTPBaseDepayloadPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="RTPBaseDepayloadClass"
- c:type="GstRTPBaseDepayloadClass"
- glib:is-gtype-struct-for="RTPBaseDepayload">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="66">Base class for RTP depayloaders.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="112"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="68">the parent class</doc>
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="set_caps">
- <callback name="set_caps">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="94"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="filter" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="process">
- <callback name="process">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="97"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="base" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </parameter>
- <parameter name="in" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="packet_lost">
- <callback name="packet_lost">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="102"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="filter" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="handle_event">
- <callback name="handle_event">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="106"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="filter" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="process_rtp_packet">
- <callback name="process_rtp_packet">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="108"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="base" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </parameter>
- <parameter name="rtp_buffer" transfer-ownership="none">
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="RTPBaseDepayloadPrivate"
- c:type="GstRTPBaseDepayloadPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="46"/>
- </record>
- <class name="RTPBasePayload"
- c:symbol-prefix="rtp_base_payload"
- c:type="GstRTPBasePayload"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstRTPBasePayload"
- glib:get-type="gst_rtp_base_payload_get_type"
- glib:type-struct="RTPBasePayloadClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="15">Provides a base class for RTP payloaders</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="147"/>
- <virtual-method name="get_caps">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="132"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="handle_buffer">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="138"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="query">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="143"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_caps">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="134"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_event">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="141"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_event">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="142"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="allocate_output_buffer"
- c:identifier="gst_rtp_base_payload_allocate_output_buffer"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1528">Allocate a new #GstBuffer with enough data to hold an RTP packet with
-minimum @csrc_count CSRCs, a payload length of @payload_len and padding of
-@pad_len. If @payload has #GstRTPBasePayload:source-info %TRUE additional
-CSRCs may be allocated and filled with RTP source information.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="176"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1540">A newly allocated buffer that can hold an RTP packet with given
-parameters.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1530">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1531">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1532">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1533">the minimum number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_source_count"
- c:identifier="gst_rtp_base_payload_get_source_count"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1846">Count the total number of RTP sources found in the meta of @buffer, which
-will be automically added by gst_rtp_base_payload_allocate_output_buffer().
-If #GstRTPBasePayload:source-info is %FALSE the count will be 0.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="188"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1855">The number of sources.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1848">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1849">a #GstBuffer, typically the buffer to payload</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_filled" c:identifier="gst_rtp_base_payload_is_filled">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1208">Check if the packet with @size and @duration would exceed the configured
-maximum size.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="164"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1217">%TRUE if the packet of @size and @duration would exceed the
-configured MTU or max_ptime.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1210">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1211">the size of the packet</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1212">the duration of the packet</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_source_info_enabled"
- c:identifier="gst_rtp_base_payload_is_source_info_enabled"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1828">Queries whether the payloader will add contributing sources (CSRCs) to the
-RTP header from #GstRTPSourceMeta.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="185"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1835">%TRUE if source-info is enabled.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1830">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="push" c:identifier="gst_rtp_base_payload_push">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1495">Push @buffer to the peer element of the payloader. The SSRC, payload type,
-seqnum and timestamp of the RTP buffer will be updated first.
-
-This function takes ownership of @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="168"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1505">a #GstFlowReturn.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1497">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1498">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="push_list" c:identifier="gst_rtp_base_payload_push_list">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1461">Push @list to the peer element of the payloader. The SSRC, payload type,
-seqnum and timestamp of the RTP buffer will be updated first.
-
-This function takes ownership of @list.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="172"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1471">a #GstFlowReturn.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1463">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1464">a #GstBufferList</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_options"
- c:identifier="gst_rtp_base_payload_set_options">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="800">Set the rtp options of the payloader. These options will be set in the caps
-of the payloader. Subclasses must call this method before calling
-gst_rtp_base_payload_push() or gst_rtp_base_payload_set_outcaps().</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="153"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="802">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="803">the media type (typically "audio" or "video")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dynamic" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="804">if the payload type is dynamic</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="encoding_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="805">the encoding name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="clock_rate" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="806">the clock rate of the media</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_outcaps"
- c:identifier="gst_rtp_base_payload_set_outcaps"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="852">Configure the output caps with the optional parameters.
-
-Variable arguments should be in the form field name, field type
-(as a GType), value(s). The last variable argument should be NULL.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="160"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="863">%TRUE if the caps could be set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="854">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="855">the first field name or %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="856">field values</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="set_source_info_enabled"
- c:identifier="gst_rtp_base_payload_set_source_info_enabled"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1811">Enable or disable adding contributing sources to RTP packets from
-#GstRTPSourceMeta.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="181"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1813">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="enable" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="1814">whether to add contributing sources to RTP packets</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <property name="max-ptime" writable="1" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="min-ptime" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="247">Minimum duration of the packet data in ns (can't go above MTU)</doc>
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="mtu" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="onvif-no-rate-control"
- version="1.16"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="336">Make the payloader timestamp packets according to the Rate-Control=no
-behaviour specified in the ONVIF replay spec.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="perfect-rtptime" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="267">Try to use the offset fields to generate perfect RTP timestamps. When this
-option is disabled, RTP timestamps are generated from GST_BUFFER_PTS of
-each payloaded buffer. The PTSes of buffers may not necessarily increment
-with the amount of data in each input buffer, consider e.g. the case where
-the buffer arrives from a network which means that the PTS is unrelated to
-the amount of data. Because the RTP timestamps are generated from
-GST_BUFFER_PTS this can result in RTP timestamps that also don't increment
-with the amount of data in the payloaded packet. To circumvent this it is
-possible to set the perfect rtptime option enabled. When this option is
-enabled the payloader will increment the RTP timestamps based on
-GST_BUFFER_OFFSET which relates to the amount of data in each packet
-rather than the GST_BUFFER_PTS of each buffer and therefore the RTP
-timestamps will more closely correlate with the amount of data in each
-buffer. Currently GstRTPBasePayload is limited to handling perfect RTP
-timestamps for audio streams.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="pt" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="ptime-multiple" writable="1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="290">Force buffers to be multiples of this duration in ns (0 disables)</doc>
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="scale-rtptime"
- version="1.18"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="377">Make the RTP packets' timestamps be scaled with the segment's rate
-(corresponding to RTSP speed parameter). Disabling this property means
-the timestamps will not be affected by the set delivery speed (RTSP speed).
-
-Example: A server wants to allow streaming a recorded video in double
-speed but still have the timestamps correspond to the position in the
-video. This is achieved by the client setting RTSP Speed to 2 while the
-server has this property disabled.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="seqnum" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="seqnum-offset" writable="1" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <property name="source-info"
- version="1.16"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="323">Enable writing the CSRC field in allocated RTP header based on RTP source
-information found in the input buffer's #GstRTPSourceMeta.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="ssrc" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="stats" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.c"
- line="301">Various payloader statistics retrieved atomically (and are therefore
-synchroized with each other), these can be used e.g. to generate an
-RTP-Info header. This property return a GstStructure named
-application/x-rtp-payload-stats containing the following fields relating to
-the last processed buffer and current state of the stream being payloaded:
-
- * `clock-rate` :#G_TYPE_UINT, clock-rate of the stream
- * `running-time` :#G_TYPE_UINT64, running time
- * `seqnum` :#G_TYPE_UINT, sequence number, same as #GstRTPBasePayload:seqnum
- * `timestamp` :#G_TYPE_UINT, RTP timestamp, same as #GstRTPBasePayload:timestamp
- * `ssrc` :#G_TYPE_UINT, The SSRC in use
- * `pt` :#G_TYPE_UINT, The Payload type in use, same as #GstRTPBasePayload:pt
- * `seqnum-offset` :#G_TYPE_UINT, The current offset added to the seqnum
- * `timestamp-offset` :#G_TYPE_UINT, The current offset added to the timestamp</doc>
- <type name="Gst.Structure"/>
- </property>
- <property name="timestamp" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="timestamp-offset" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <field name="element">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="sinkpad" readable="0" private="1">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="srcpad" readable="0" private="1">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="ts_base" readable="0" private="1">
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="seqnum_base" readable="0" private="1">
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="media" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="encoding_name" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="dynamic" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="clock_rate" readable="0" private="1">
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="ts_offset" readable="0" private="1">
- <type name="gint32" c:type="gint32"/>
- </field>
- <field name="timestamp" readable="0" private="1">
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="seqnum_offset" readable="0" private="1">
- <type name="gint16" c:type="gint16"/>
- </field>
- <field name="seqnum" readable="0" private="1">
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="max_ptime" readable="0" private="1">
- <type name="gint64" c:type="gint64"/>
- </field>
- <field name="pt" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="ssrc" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="current_ssrc" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="mtu" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="segment" readable="0" private="1">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="min_ptime" readable="0" private="1">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="ptime" readable="0" private="1">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="ptime_multiple" readable="0" private="1">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="RTPBasePayloadPrivate" c:type="GstRTPBasePayloadPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="RTPBasePayloadClass"
- c:type="GstRTPBasePayloadClass"
- glib:is-gtype-struct-for="RTPBasePayload">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="115">Base class for audio RTP payloader.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="147"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="117">the parent class</doc>
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="get_caps">
- <callback name="get_caps">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="132"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_caps">
- <callback name="set_caps">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="134"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="handle_buffer">
- <callback name="handle_buffer">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="138"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_event">
- <callback name="sink_event">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="141"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_event">
- <callback name="src_event">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="142"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="query">
- <callback name="query">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="143"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="RTPBasePayloadPrivate"
- c:type="GstRTPBasePayloadPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="44"/>
- </record>
- <record name="RTPBuffer" c:type="GstRTPBuffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="21">The GstRTPBuffer helper functions makes it easy to parse and create regular
-#GstBuffer objects that contain RTP payloads. These buffers are typically of
-'application/x-rtp' #GstCaps.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="60"/>
- <field name="buffer" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="44">pointer to RTP buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="state" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="45">internal state</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="data" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="46">array of data</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="47">array of size</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="gsize" c:type="gsize"/>
- </array>
- </field>
- <field name="map" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="48">array of #GstMapInfo</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="Gst.MapInfo" c:type="GstMapInfo"/>
- </array>
- </field>
- <method name="add_extension_onebyte_header"
- c:identifier="gst_rtp_buffer_add_extension_onebyte_header">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1555">Adds a RFC 5285 header extension with a one byte header to the end of the
-RTP header. If there is already a RFC 5285 header extension with a one byte
-header, the new extension will be appended.
-It will not work if there is already a header extension that does not follow
-the mechanism described in RFC 5285 or if there is a header extension with
-a two bytes header as described in RFC 5285. In that case, use
-gst_rtp_buffer_add_extension_twobytes_header()</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="219"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1570">%TRUE if header extension could be added</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1557">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1558">The ID of the header extension (between 1 and 14).</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1559">location for data</doc>
- <array length="2" zero-terminated="0" c:type="gconstpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1560">the size of the data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_extension_twobytes_header"
- c:identifier="gst_rtp_buffer_add_extension_twobytes_header">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1654">Adds a RFC 5285 header extension with a two bytes header to the end of the
-RTP header. If there is already a RFC 5285 header extension with a two bytes
-header, the new extension will be appended.
-It will not work if there is already a header extension that does not follow
-the mechanism described in RFC 5285 or if there is a header extension with
-a one byte header as described in RFC 5285. In that case, use
-gst_rtp_buffer_add_extension_onebyte_header()</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="225"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1670">%TRUE if header extension could be added</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1656">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="appbits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1657">Application specific bits</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1658">The ID of the header extension</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1659">location for data</doc>
- <array length="3" zero-terminated="0" c:type="gconstpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1660">the size of the data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_csrc" c:identifier="gst_rtp_buffer_get_csrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="931">Get the CSRC at index @idx in @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="148"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="938">the CSRC at index @idx in host order.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="933">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="934">the index of the CSRC to get</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_csrc_count"
- c:identifier="gst_rtp_buffer_get_csrc_count">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="917">Get the CSRC count of the RTP packet in @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="145"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="923">the CSRC count of @buffer.</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="919">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_extension" c:identifier="gst_rtp_buffer_get_extension">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="657">Check if the extension bit is set on the RTP packet in @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="123"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="663">TRUE if @buffer has the extension bit set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="659">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_extension_bytes"
- c:identifier="gst_rtp_buffer_get_extension_bytes"
- shadows="get_extension_data"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="722">Similar to gst_rtp_buffer_get_extension_data, but more suitable for language
-bindings usage. @bits will contain the extension 16 bits of custom data and
-the extension data (not including the extension header) is placed in a new
-#GBytes structure.
-
-If @rtp did not contain an extension, this function will return %NULL, with
-@bits unchanged. If there is an extension header but no extension data then
-an empty #GBytes will be returned.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="133"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="736">A new #GBytes if an extension header was present
-and %NULL otherwise.</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="724">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="bits"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="725">location for header bits</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_extension_data"
- c:identifier="gst_rtp_buffer_get_extension_data"
- shadowed-by="get_extension_bytes"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="684">Get the extension data. @bits will contain the extension 16 bits of custom
-data. @data will point to the data in the extension and @wordlen will contain
-the length of @data in 32 bits words.
-
-If @buffer did not contain an extension, this function will return %FALSE
-with @bits, @data and @wordlen unchanged.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="129"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="698">TRUE if @buffer had the extension bit set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="686">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="bits"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="687">location for result bits</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="688">location for data</doc>
- <array zero-terminated="0" c:type="gpointer*">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="wordlen"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="689">location for length of @data in 32 bits words</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_extension_onebyte_header"
- c:identifier="gst_rtp_buffer_get_extension_onebyte_header">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1405">Parses RFC 5285 style header extensions with a one byte header. It will
-return the nth extension with the requested id.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="204"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1417">TRUE if @buffer had the requested header extension</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1407">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1408">The ID of the header extension to be read (between 1 and 14).</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1409">Read the nth extension packet with the requested ID</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1410">
- location for data</doc>
- <array length="3" zero-terminated="0" c:type="gpointer*">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1412">the size of the data in bytes</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_extension_twobytes_header"
- c:identifier="gst_rtp_buffer_get_extension_twobytes_header">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1437">Parses RFC 5285 style header extensions with a two bytes header. It will
-return the nth extension with the requested id.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="211"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1450">TRUE if @buffer had the requested header extension</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1439">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="appbits"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1440">Application specific bits</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1441">The ID of the header extension to be read (between 1 and 14).</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1442">Read the nth extension packet with the requested ID</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1443">
- location for data</doc>
- <array length="4" zero-terminated="0" c:type="gpointer*">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1445">the size of the data in bytes</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_header_len"
- c:identifier="gst_rtp_buffer_get_header_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="561">Return the total length of the header in @buffer. This include the length of
-the fixed header, the CSRC list and the extension header.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="105"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="568">The total length of the header in @buffer.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="563">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_marker" c:identifier="gst_rtp_buffer_get_marker">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="972">Check if the marker bit is set on the RTP packet in @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="154"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="978">TRUE if @buffer has the marker bit set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="974">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_packet_len"
- c:identifier="gst_rtp_buffer_get_packet_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="547">Return the total length of the packet in @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="102"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="553">The total length of the packet in @buffer.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="549">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_padding" c:identifier="gst_rtp_buffer_get_padding">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="605">Check if the padding bit is set on the RTP packet in @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="114"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="611">TRUE if @buffer has the padding bit set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="607">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_payload"
- c:identifier="gst_rtp_buffer_get_payload"
- shadowed-by="get_payload_bytes"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1156">Get a pointer to the payload data in @buffer. This pointer is valid as long
-as a reference to @buffer is held.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="187"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1163">A pointer
-to the payload data in @buffer.</doc>
- <array zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1158">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_payload_buffer"
- c:identifier="gst_rtp_buffer_get_payload_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1125">Create a buffer of the payload of the RTP packet in @buffer. This function
-will internally create a subbuffer of @buffer so that a memcpy can be
-avoided.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="178"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1133">A new buffer with the data of the payload.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1127">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_payload_bytes"
- c:identifier="gst_rtp_buffer_get_payload_bytes"
- shadows="get_payload"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1178">Similar to gst_rtp_buffer_get_payload, but more suitable for language
-bindings usage. The return value is a pointer to a #GBytes structure
-containing the payload data in @rtp.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="190"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1186">A new #GBytes containing the payload data in @rtp.</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1180">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_payload_len"
- c:identifier="gst_rtp_buffer_get_payload_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1141">Get the length of the payload of the RTP packet in @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="184"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1147">The length of the payload in @buffer.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1143">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_payload_subbuffer"
- c:identifier="gst_rtp_buffer_get_payload_subbuffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1083">Create a subbuffer of the payload of the RTP packet in @buffer. @offset bytes
-are skipped in the payload and the subbuffer will be of size @len.
-If @len is -1 the total payload starting from @offset is subbuffered.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="181"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1093">A new buffer with the specified data of the payload.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1085">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1086">the offset in the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1087">the length in the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_payload_type"
- c:identifier="gst_rtp_buffer_get_payload_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="999">Get the payload type of the RTP packet in @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="160"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1005">The payload type.</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1001">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_seq" c:identifier="gst_rtp_buffer_get_seq">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1028">Get the sequence number of the RTP packet in @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="166"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1034">The sequence number in host order.</doc>
- <type name="guint16" c:type="guint16"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1030">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_ssrc" c:identifier="gst_rtp_buffer_get_ssrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="890">Get the SSRC of the RTP packet in @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="139"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="896">the SSRC of @buffer in host order.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="892">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_timestamp" c:identifier="gst_rtp_buffer_get_timestamp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1055">Get the timestamp of the RTP packet in @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="172"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1061">The timestamp in host order.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1057">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_version" c:identifier="gst_rtp_buffer_get_version">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="576">Get the version number of the RTP packet in @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="582">The version of @buffer.</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="578">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pad_to" c:identifier="gst_rtp_buffer_pad_to">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="632">Set the amount of padding in the RTP packet in @buffer to
-@len. If @len is 0, the padding is removed.
-
-NOTE: This function does not work correctly.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="120"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="634">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="635">the new amount of padding</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_csrc" c:identifier="gst_rtp_buffer_set_csrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="952">Modify the CSRC at index @idx in @buffer to @csrc.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="151"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="954">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="955">the CSRC index to set</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="956">the CSRC in host order to set at @idx</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_extension" c:identifier="gst_rtp_buffer_set_extension">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="671">Set the extension bit on the RTP packet in @buffer to @extension.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="126"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="673">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="extension" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="674">the new extension</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_extension_data"
- c:identifier="gst_rtp_buffer_set_extension_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="825">Set the extension bit of the rtp buffer and fill in the @bits and @length of the
-extension header. If the existing extension data is not large enough, it will
-be made larger.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="136"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="836">True if done.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="827">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="bits" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="828">the bits specific for the extension</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="829">the length that counts the number of 32-bit words in
-the extension, excluding the extension header ( therefore zero is a valid length)</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_marker" c:identifier="gst_rtp_buffer_set_marker">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="986">Set the marker bit on the RTP packet in @buffer to @marker.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="157"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="988">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="marker" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="989">the new marker</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_packet_len"
- c:identifier="gst_rtp_buffer_set_packet_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="518">Set the total @rtp size to @len. The data in the buffer will be made
-larger if needed. Any padding will be removed from the packet.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="99"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="520">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="521">the new packet length</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_padding" c:identifier="gst_rtp_buffer_set_padding">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="619">Set the padding bit on the RTP packet in @buffer to @padding.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="117"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="621">the buffer</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="padding" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="622">the new padding</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_payload_type"
- c:identifier="gst_rtp_buffer_set_payload_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1013">Set the payload type of the RTP packet in @buffer to @payload_type.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="163"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1015">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="payload_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1016">the new type</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_seq" c:identifier="gst_rtp_buffer_set_seq">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1042">Set the sequence number of the RTP packet in @buffer to @seq.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="169"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1044">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="seq" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1045">the new sequence number</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_ssrc" c:identifier="gst_rtp_buffer_set_ssrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="904">Set the SSRC on the RTP packet in @buffer to @ssrc.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="142"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="906">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="907">the new SSRC</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_timestamp" c:identifier="gst_rtp_buffer_set_timestamp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1069">Set the timestamp of the RTP packet in @buffer to @timestamp.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="175"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1071">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1072">the new timestamp</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_version" c:identifier="gst_rtp_buffer_set_version">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="590">Set the version of the RTP packet in @buffer to @version.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="111"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="592">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="593">the new version</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="unmap" c:identifier="gst_rtp_buffer_unmap">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="492">Unmap @rtp previously mapped with gst_rtp_buffer_map().</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="96"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="494">a #GstRTPBuffer</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="allocate_data"
- c:identifier="gst_rtp_buffer_allocate_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="85">Allocate enough data in @buffer to hold an RTP packet with @csrc_count CSRCs,
-a payload length of @payload_len and padding of @pad_len.
-@buffer must be writable and all previous memory in @buffer will be freed.
-If @pad_len is &gt;0, the padding bit will be set. All other RTP header fields
-will be set to 0/FALSE.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="68"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="87">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="88">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="89">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="90">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="calc_header_len"
- c:identifier="gst_rtp_buffer_calc_header_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="243">Calculate the header length of an RTP packet with @csrc_count CSRC entries.
-An RTP packet can have at most 15 CSRC entries.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="84"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="250">The length of an RTP header with @csrc_count CSRC entries.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="245">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="calc_packet_len"
- c:identifier="gst_rtp_buffer_calc_packet_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="260">Calculate the total length of an RTP packet with a payload size of @payload_len,
-a padding of @pad_len and a @csrc_count CSRC entries.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="87"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="269">The total length of an RTP header with given parameters.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="262">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="263">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="264">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="calc_payload_len"
- c:identifier="gst_rtp_buffer_calc_payload_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="281">Calculate the length of the payload of an RTP packet with size @packet_len,
-a padding of @pad_len and a @csrc_count CSRC entries.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="90"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="290">The length of the payload of an RTP packet with given parameters.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="packet_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="283">the length of the total RTP packet</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="284">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="285">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="compare_seqnum"
- c:identifier="gst_rtp_buffer_compare_seqnum">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1231">Compare two sequence numbers, taking care of wraparounds. This function
-returns the difference between @seqnum1 and @seqnum2.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="198"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1239">a negative value if @seqnum1 is bigger than @seqnum2, 0 if they
-are equal or a positive value if @seqnum1 is smaller than @segnum2.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="seqnum1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1233">a sequence number</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="seqnum2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1234">a sequence number</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </function>
- <function name="default_clock_rate"
- c:identifier="gst_rtp_buffer_default_clock_rate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1204">Get the default clock-rate for the static payload type @payload_type.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="195"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1210">the default clock rate or -1 if the payload type is not static or
-the clock-rate is undefined.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <parameter name="payload_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1206">the static payload type</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="ext_timestamp"
- c:identifier="gst_rtp_buffer_ext_timestamp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1253">Update the @exttimestamp field with the extended timestamp of @timestamp
-For the first call of the method, @exttimestamp should point to a location
-with a value of -1.
-
-This function is able to handle both forward and backward timestamps taking
-into account:
- - timestamp wraparound making sure that the returned value is properly increased.
- - timestamp unwraparound making sure that the returned value is properly decreased.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="201"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1267">The extended timestamp of @timestamp or 0 if the result can't go anywhere backwards.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="exttimestamp"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1255">a previous extended timestamp</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1256">a new timestamp</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_extension_onebyte_header_from_bytes"
- c:identifier="gst_rtp_buffer_get_extension_onebyte_header_from_bytes"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1375">Similar to gst_rtp_buffer_get_extension_onebyte_header, but working
-on the #GBytes you get from gst_rtp_buffer_get_extension_bytes.
-Parses RFC 5285 style header extensions with a one byte header. It will
-return the nth extension with the requested id.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="232"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1390">TRUE if @bytes had the requested header extension</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="bytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1377">#GBytes</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </parameter>
- <parameter name="bit_pattern" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1378">The bit-pattern. Anything but 0xBEDE is rejected.</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1379">The ID of the header extension to be read (between 1 and 14).</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1380">Read the nth extension packet with the requested ID</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1381">
- location for data</doc>
- <array length="5" zero-terminated="0" c:type="gpointer*">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1383">the size of the data in bytes</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="map" c:identifier="gst_rtp_buffer_map">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="306">Map the contents of @buffer into @rtp.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="93"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="314">%TRUE if @buffer could be mapped.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="308">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="309">#GstMapFlags</doc>
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- <parameter name="rtp"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="310">a #GstRTPBuffer</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_allocate" c:identifier="gst_rtp_buffer_new_allocate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="190">Allocate a new #GstBuffer with enough data to hold an RTP packet with
-@csrc_count CSRCs, a payload length of @payload_len and padding of @pad_len.
-All other RTP header fields will be set to 0/FALSE.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="78"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="200">A newly allocated buffer that can hold an RTP packet with given
-parameters.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="192">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="193">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="194">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_allocate_len"
- c:identifier="gst_rtp_buffer_new_allocate_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="217">Create a new #GstBuffer that can hold an RTP packet that is exactly
-@packet_len long. The length of the payload depends on @pad_len and
-@csrc_count and can be calculated with gst_rtp_buffer_calc_payload_len().
-All RTP header fields will be set to 0/FALSE.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="81"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="228">A newly allocated buffer that can hold an RTP packet of @packet_len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="packet_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="219">the total length of the packet</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="220">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="221">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_copy_data"
- c:identifier="gst_rtp_buffer_new_copy_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="172">Create a new buffer and set the data to a copy of @len
-bytes of @data and the size to @len. The data will be freed when the buffer
-is freed.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="75"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="182">A newly allocated buffer with a copy of @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="174">data for the new
- buffer</doc>
- <array length="1" zero-terminated="0" c:type="gconstpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="176">the length of data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_take_data"
- c:identifier="gst_rtp_buffer_new_take_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="151">Create a new buffer and set the data and size of the buffer to @data and @len
-respectively. @data will be freed when the buffer is unreffed, so this
-function transfers ownership of @data to the new buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="72"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="161">A newly allocated buffer with @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="153">
- data for the new buffer</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="155">the length of data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <bitfield name="RTPBufferFlags"
- version="1.10"
- glib:type-name="GstRTPBufferFlags"
- glib:get-type="gst_rtp_buffer_flags_get_type"
- c:type="GstRTPBufferFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="239">Additional RTP buffer flags. These flags can potentially be used on any
-buffers carrying RTP packets.
-
-Note that these are only valid for #GstCaps of type: application/x-rtp (x-rtcp).
-They can conflict with other extended buffer flags.</doc>
- <member name="retransmission"
- value="1048576"
- c:identifier="GST_RTP_BUFFER_FLAG_RETRANSMISSION"
- glib:nick="retransmission">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="241">The #GstBuffer was once wrapped
- in a retransmitted packet as specified by RFC 4588.</doc>
- </member>
- <member name="redundant"
- value="2097152"
- c:identifier="GST_RTP_BUFFER_FLAG_REDUNDANT"
- glib:nick="redundant">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="243">The packet represents redundant RTP packet.
- The flag is used in gstrtpstorage to be able to hold the packetback
- and use it only for recovery from packet loss.
- Since: 1.14</doc>
- </member>
- <member name="last"
- value="268435456"
- c:identifier="GST_RTP_BUFFER_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="247">Offset to define more flags.</doc>
- </member>
- </bitfield>
- <bitfield name="RTPBufferMapFlags"
- version="1.6.1"
- glib:type-name="GstRTPBufferMapFlags"
- glib:get-type="gst_rtp_buffer_map_flags_get_type"
- c:type="GstRTPBufferMapFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="263">Additional mapping flags for gst_rtp_buffer_map().</doc>
- <member name="skip_padding"
- value="65536"
- c:identifier="GST_RTP_BUFFER_MAP_FLAG_SKIP_PADDING"
- glib:nick="skip-padding">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="265">Skip mapping and validation of RTP
- padding and RTP pad count when present. Useful for buffers where
- the padding may be encrypted.</doc>
- </member>
- <member name="last"
- value="16777216"
- c:identifier="GST_RTP_BUFFER_MAP_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="268">Offset to define more flags</doc>
- </member>
- </bitfield>
- <enumeration name="RTPPayload"
- glib:type-name="GstRTPPayload"
- glib:get-type="gst_rtp_payload_get_type"
- c:type="GstRTPPayload">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="31">Standard predefined fixed payload types.
-
-The official list is at:
-http://www.iana.org/assignments/rtp-parameters
-
-Audio:
-reserved: 19
-unassigned: 20-23,
-
-Video:
-unassigned: 24, 27, 29, 30, 35-71, 77-95
-Reserved for RTCP conflict avoidance: 72-76</doc>
- <member name="pcmu"
- value="0"
- c:identifier="GST_RTP_PAYLOAD_PCMU"
- glib:nick="pcmu">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="33">ITU-T G.711. mu-law audio (RFC 3551)</doc>
- </member>
- <member name="1016"
- value="1"
- c:identifier="GST_RTP_PAYLOAD_1016"
- glib:nick="1016">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="34">RFC 3551 says reserved</doc>
- </member>
- <member name="g721"
- value="2"
- c:identifier="GST_RTP_PAYLOAD_G721"
- glib:nick="g721">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="35">RFC 3551 says reserved</doc>
- </member>
- <member name="gsm"
- value="3"
- c:identifier="GST_RTP_PAYLOAD_GSM"
- glib:nick="gsm">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="36">GSM audio</doc>
- </member>
- <member name="g723"
- value="4"
- c:identifier="GST_RTP_PAYLOAD_G723"
- glib:nick="g723">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="37">ITU G.723.1 audio</doc>
- </member>
- <member name="dvi4_8000"
- value="5"
- c:identifier="GST_RTP_PAYLOAD_DVI4_8000"
- glib:nick="dvi4-8000">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="38">IMA ADPCM wave type (RFC 3551)</doc>
- </member>
- <member name="dvi4_16000"
- value="6"
- c:identifier="GST_RTP_PAYLOAD_DVI4_16000"
- glib:nick="dvi4-16000">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="39">IMA ADPCM wave type (RFC 3551)</doc>
- </member>
- <member name="lpc"
- value="7"
- c:identifier="GST_RTP_PAYLOAD_LPC"
- glib:nick="lpc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="40">experimental linear predictive encoding</doc>
- </member>
- <member name="pcma"
- value="8"
- c:identifier="GST_RTP_PAYLOAD_PCMA"
- glib:nick="pcma">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="41">ITU-T G.711 A-law audio (RFC 3551)</doc>
- </member>
- <member name="g722"
- value="9"
- c:identifier="GST_RTP_PAYLOAD_G722"
- glib:nick="g722">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="42">ITU-T G.722 (RFC 3551)</doc>
- </member>
- <member name="l16_stereo"
- value="10"
- c:identifier="GST_RTP_PAYLOAD_L16_STEREO"
- glib:nick="l16-stereo">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="43">stereo PCM</doc>
- </member>
- <member name="l16_mono"
- value="11"
- c:identifier="GST_RTP_PAYLOAD_L16_MONO"
- glib:nick="l16-mono">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="44">mono PCM</doc>
- </member>
- <member name="qcelp"
- value="12"
- c:identifier="GST_RTP_PAYLOAD_QCELP"
- glib:nick="qcelp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="45">EIA &amp; TIA standard IS-733</doc>
- </member>
- <member name="cn"
- value="13"
- c:identifier="GST_RTP_PAYLOAD_CN"
- glib:nick="cn">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="46">Comfort Noise (RFC 3389)</doc>
- </member>
- <member name="mpa"
- value="14"
- c:identifier="GST_RTP_PAYLOAD_MPA"
- glib:nick="mpa">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="47">Audio MPEG 1-3.</doc>
- </member>
- <member name="g728"
- value="15"
- c:identifier="GST_RTP_PAYLOAD_G728"
- glib:nick="g728">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="48">ITU-T G.728 Speech coder (RFC 3551)</doc>
- </member>
- <member name="dvi4_11025"
- value="16"
- c:identifier="GST_RTP_PAYLOAD_DVI4_11025"
- glib:nick="dvi4-11025">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="49">IMA ADPCM wave type (RFC 3551)</doc>
- </member>
- <member name="dvi4_22050"
- value="17"
- c:identifier="GST_RTP_PAYLOAD_DVI4_22050"
- glib:nick="dvi4-22050">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="50">IMA ADPCM wave type (RFC 3551)</doc>
- </member>
- <member name="g729"
- value="18"
- c:identifier="GST_RTP_PAYLOAD_G729"
- glib:nick="g729">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="51">ITU-T G.729 Speech coder (RFC 3551)</doc>
- </member>
- <member name="cellb"
- value="25"
- c:identifier="GST_RTP_PAYLOAD_CELLB"
- glib:nick="cellb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="52">See RFC 2029</doc>
- </member>
- <member name="jpeg"
- value="26"
- c:identifier="GST_RTP_PAYLOAD_JPEG"
- glib:nick="jpeg">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="53">ISO Standards 10918-1 and 10918-2 (RFC 2435)</doc>
- </member>
- <member name="nv"
- value="28"
- c:identifier="GST_RTP_PAYLOAD_NV"
- glib:nick="nv">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="54">nv encoding by Ron Frederick</doc>
- </member>
- <member name="h261"
- value="31"
- c:identifier="GST_RTP_PAYLOAD_H261"
- glib:nick="h261">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="55">ITU-T Recommendation H.261 (RFC 2032)</doc>
- </member>
- <member name="mpv"
- value="32"
- c:identifier="GST_RTP_PAYLOAD_MPV"
- glib:nick="mpv">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="56">Video MPEG 1 &amp; 2 (RFC 2250)</doc>
- </member>
- <member name="mp2t"
- value="33"
- c:identifier="GST_RTP_PAYLOAD_MP2T"
- glib:nick="mp2t">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="57">MPEG-2 transport stream (RFC 2250)</doc>
- </member>
- <member name="h263"
- value="34"
- c:identifier="GST_RTP_PAYLOAD_H263"
- glib:nick="h263">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="58">Video H263 (RFC 2190)</doc>
- </member>
- </enumeration>
- <record name="RTPPayloadInfo" c:type="GstRTPPayloadInfo">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="164">Structure holding default payload type information.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="188"/>
- <field name="payload_type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="166">payload type, -1 means dynamic</doc>
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="media" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="167">the media type(s), usually "audio", "video", "application", "text",
-"message".</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="encoding_name" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="169">the encoding name of @pt</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="clock_rate" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="170">default clock rate, 0 = unknown/variable</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="encoding_parameters" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="171">encoding parameters. For audio this is the number of
-channels. NULL = not applicable.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="bitrate" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="173">the bitrate of the media. 0 = unknown/variable.</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <function name="for_name" c:identifier="gst_rtp_payload_info_for_name">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="205">Get the #GstRTPPayloadInfo for @media and @encoding_name. This function is
-mostly used to get the default clock-rate and bandwidth for dynamic payload
-types specified with @media and @encoding name.
-
-The search for @encoding_name will be performed in a case insensitive way.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="194"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="216">a #GstRTPPayloadInfo or NULL when no info could be found.</doc>
- <type name="RTPPayloadInfo" c:type="const GstRTPPayloadInfo*"/>
- </return-value>
- <parameters>
- <parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="207">the media to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="encoding_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="208">the encoding name to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="for_pt" c:identifier="gst_rtp_payload_info_for_pt">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="180">Get the #GstRTPPayloadInfo for @payload_type. This function is
-mostly used to get the default clock-rate and bandwidth for static payload
-types specified with @payload_type.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="191"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="188">a #GstRTPPayloadInfo or NULL when no info could be found.</doc>
- <type name="RTPPayloadInfo" c:type="const GstRTPPayloadInfo*"/>
- </return-value>
- <parameters>
- <parameter name="payload_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="182">the payload_type to find</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <enumeration name="RTPProfile"
- version="1.6"
- glib:type-name="GstRTPProfile"
- glib:get-type="gst_rtp_profile_get_type"
- c:type="GstRTPProfile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpdefs.h"
- line="38">The transfer profile to use.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_RTP_PROFILE_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpdefs.h"
- line="40">invalid profile</doc>
- </member>
- <member name="avp"
- value="1"
- c:identifier="GST_RTP_PROFILE_AVP"
- glib:nick="avp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpdefs.h"
- line="41">the Audio/Visual profile (RFC 3551)</doc>
- </member>
- <member name="savp"
- value="2"
- c:identifier="GST_RTP_PROFILE_SAVP"
- glib:nick="savp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpdefs.h"
- line="42">the secure Audio/Visual profile (RFC 3711)</doc>
- </member>
- <member name="avpf"
- value="3"
- c:identifier="GST_RTP_PROFILE_AVPF"
- glib:nick="avpf">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpdefs.h"
- line="43">the Audio/Visual profile with feedback (RFC 4585)</doc>
- </member>
- <member name="savpf"
- value="4"
- c:identifier="GST_RTP_PROFILE_SAVPF"
- glib:nick="savpf">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpdefs.h"
- line="44">the secure Audio/Visual profile with feedback (RFC 5124)</doc>
- </member>
- </enumeration>
- <record name="RTPSourceMeta" c:type="GstRTPSourceMeta" version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.h"
- line="34">Meta describing the source(s) of the buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpmeta.h" line="54"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.h"
- line="36">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="ssrc" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.h"
- line="37">the SSRC</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="ssrc_valid" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.h"
- line="38">whether @ssrc is set and valid</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="csrc" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.h"
- line="39">pointer to the CSRCs</doc>
- <array zero-terminated="0" fixed-size="15">
- <type name="guint32" c:type="guint32"/>
- </array>
- </field>
- <field name="csrc_count" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.h"
- line="40">number of elements in @csrc</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <method name="append_csrc"
- c:identifier="gst_rtp_source_meta_append_csrc"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="161">Appends @csrc to the list of contributing sources in @meta.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpmeta.h" line="72"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="169">%TRUE if all elements in @csrc was added, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="163">a #GstRTPSourceMeta</doc>
- <type name="RTPSourceMeta" c:type="GstRTPSourceMeta*"/>
- </instance-parameter>
- <parameter name="csrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="164">the csrcs to append</doc>
- <type name="guint32" c:type="const guint32*"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="165">number of elements in @csrc</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_source_count"
- c:identifier="gst_rtp_source_meta_get_source_count"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="117">Count the total number of RTP sources found in @meta, both SSRC and CSRC.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpmeta.h" line="66"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="123">The number of RTP sources</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="119">a #GstRTPSourceMeta</doc>
- <type name="RTPSourceMeta" c:type="const GstRTPSourceMeta*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_ssrc"
- c:identifier="gst_rtp_source_meta_set_ssrc"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="137">Sets @ssrc in @meta. If @ssrc is %NULL the ssrc of @meta will be unset.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpmeta.h" line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="144">%TRUE on success, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="139">a #GstRTPSourceMeta</doc>
- <type name="RTPSourceMeta" c:type="GstRTPSourceMeta*"/>
- </instance-parameter>
- <parameter name="ssrc"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="140">pointer to the SSRC</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <function name="get_info" c:identifier="gst_rtp_source_meta_get_info">
- <source-position filename="gst-libs/gst/rtp/gstrtpmeta.h" line="75"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <function-macro name="RTP_BASE_AUDIO_PAYLOAD"
- c:identifier="GST_RTP_BASE_AUDIO_PAYLOAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_AUDIO_PAYLOAD_CAST"
- c:identifier="GST_RTP_BASE_AUDIO_PAYLOAD_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="45"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_AUDIO_PAYLOAD_CLASS"
- c:identifier="GST_RTP_BASE_AUDIO_PAYLOAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbaseaudiopayload.h"
- line="38"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_DEPAYLOAD"
- c:identifier="GST_RTP_BASE_DEPAYLOAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="29"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_DEPAYLOAD_CAST"
- c:identifier="GST_RTP_BASE_DEPAYLOAD_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_DEPAYLOAD_CLASS"
- c:identifier="GST_RTP_BASE_DEPAYLOAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="31"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_DEPAYLOAD_GET_CLASS"
- c:identifier="GST_RTP_BASE_DEPAYLOAD_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_DEPAYLOAD_SINKPAD"
- c:identifier="GST_RTP_BASE_DEPAYLOAD_SINKPAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="41"/>
- <parameters>
- <parameter name="depayload">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_DEPAYLOAD_SRCPAD"
- c:identifier="GST_RTP_BASE_DEPAYLOAD_SRCPAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasedepayload.h"
- line="42"/>
- <parameters>
- <parameter name="depayload">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_PAYLOAD"
- c:identifier="GST_RTP_BASE_PAYLOAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="29"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_PAYLOAD_CAST"
- c:identifier="GST_RTP_BASE_PAYLOAD_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_PAYLOAD_CLASS"
- c:identifier="GST_RTP_BASE_PAYLOAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="31"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_PAYLOAD_GET_CLASS"
- c:identifier="GST_RTP_BASE_PAYLOAD_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_PAYLOAD_MTU"
- c:identifier="GST_RTP_BASE_PAYLOAD_MTU"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="69">Get access to the configured MTU of @payload.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="74"/>
- <parameters>
- <parameter name="payload">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="71">a #GstRTPBasePayload</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_PAYLOAD_PT"
- c:identifier="GST_RTP_BASE_PAYLOAD_PT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="62">Get access to the configured payload type of @payload.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="67"/>
- <parameters>
- <parameter name="payload">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="64">a #GstRTPBasePayload</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_PAYLOAD_SINKPAD"
- c:identifier="GST_RTP_BASE_PAYLOAD_SINKPAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="47">Get access to the sinkpad of @payload.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="52"/>
- <parameters>
- <parameter name="payload">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="49">a #GstRTPBasePayload</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTP_BASE_PAYLOAD_SRCPAD"
- c:identifier="GST_RTP_BASE_PAYLOAD_SRCPAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="54">Get access to the srcpad of @payload.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="59"/>
- <parameters>
- <parameter name="payload">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbasepayload.h"
- line="56">a #GstRTPBasePayload</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="RTP_HDREXT_BASE"
- value="urn:ietf:params:rtp-hdrext:"
- c:type="GST_RTP_HDREXT_BASE">
- <source-position filename="gst-libs/gst/rtp/gstrtphdrext.h" line="30"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_HDREXT_NTP_56"
- value="ntp-56"
- c:type="GST_RTP_HDREXT_NTP_56">
- <source-position filename="gst-libs/gst/rtp/gstrtphdrext.h" line="43"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_HDREXT_NTP_56_SIZE"
- value="7"
- c:type="GST_RTP_HDREXT_NTP_56_SIZE">
- <source-position filename="gst-libs/gst/rtp/gstrtphdrext.h" line="45"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_HDREXT_NTP_64"
- value="ntp-64"
- c:type="GST_RTP_HDREXT_NTP_64">
- <source-position filename="gst-libs/gst/rtp/gstrtphdrext.h" line="33"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_HDREXT_NTP_64_SIZE"
- value="8"
- c:type="GST_RTP_HDREXT_NTP_64_SIZE">
- <source-position filename="gst-libs/gst/rtp/gstrtphdrext.h" line="35"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_PAYLOAD_1016_STRING"
- value="1"
- c:type="GST_RTP_PAYLOAD_1016_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="124"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_CELLB_STRING"
- value="25"
- c:type="GST_RTP_PAYLOAD_CELLB_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="143"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_CN_STRING"
- value="13"
- c:type="GST_RTP_PAYLOAD_CN_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="136"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_DVI4_11025_STRING"
- value="16"
- c:type="GST_RTP_PAYLOAD_DVI4_11025_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="139"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_DVI4_16000_STRING"
- value="6"
- c:type="GST_RTP_PAYLOAD_DVI4_16000_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="129"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_DVI4_22050_STRING"
- value="17"
- c:type="GST_RTP_PAYLOAD_DVI4_22050_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="140"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_DVI4_8000_STRING"
- value="5"
- c:type="GST_RTP_PAYLOAD_DVI4_8000_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="128"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_DYNAMIC_STRING"
- value="[96, 127]"
- c:type="GST_RTP_PAYLOAD_DYNAMIC_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="152"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G721_STRING"
- value="2"
- c:type="GST_RTP_PAYLOAD_G721_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="125"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G722_STRING"
- value="9"
- c:type="GST_RTP_PAYLOAD_G722_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="132"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G723_53"
- value="17"
- c:type="GST_RTP_PAYLOAD_G723_53">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="111"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_PAYLOAD_G723_53_STRING"
- value="17"
- c:type="GST_RTP_PAYLOAD_G723_53_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="116"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G723_63"
- value="16"
- c:type="GST_RTP_PAYLOAD_G723_63">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="110"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_PAYLOAD_G723_63_STRING"
- value="16"
- c:type="GST_RTP_PAYLOAD_G723_63_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="115"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G723_STRING"
- value="4"
- c:type="GST_RTP_PAYLOAD_G723_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="127"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G728_STRING"
- value="15"
- c:type="GST_RTP_PAYLOAD_G728_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="138"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G729_STRING"
- value="18"
- c:type="GST_RTP_PAYLOAD_G729_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="141"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_GSM_STRING"
- value="3"
- c:type="GST_RTP_PAYLOAD_GSM_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="126"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_H261_STRING"
- value="31"
- c:type="GST_RTP_PAYLOAD_H261_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="147"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_H263_STRING"
- value="34"
- c:type="GST_RTP_PAYLOAD_H263_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="150"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="RTP_PAYLOAD_IS_DYNAMIC"
- c:identifier="GST_RTP_PAYLOAD_IS_DYNAMIC"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="154">Check if @pt is a dynamic payload type.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="160"/>
- <parameters>
- <parameter name="pt">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="156">a payload type</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="RTP_PAYLOAD_JPEG_STRING"
- value="26"
- c:type="GST_RTP_PAYLOAD_JPEG_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="144"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_L16_MONO_STRING"
- value="11"
- c:type="GST_RTP_PAYLOAD_L16_MONO_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="134"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_L16_STEREO_STRING"
- value="10"
- c:type="GST_RTP_PAYLOAD_L16_STEREO_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="133"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_LPC_STRING"
- value="7"
- c:type="GST_RTP_PAYLOAD_LPC_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="130"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_MP2T_STRING"
- value="33"
- c:type="GST_RTP_PAYLOAD_MP2T_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="149"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_MPA_STRING"
- value="14"
- c:type="GST_RTP_PAYLOAD_MPA_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="137"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_MPV_STRING"
- value="32"
- c:type="GST_RTP_PAYLOAD_MPV_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="148"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_NV_STRING"
- value="28"
- c:type="GST_RTP_PAYLOAD_NV_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="145"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_PCMA_STRING"
- value="8"
- c:type="GST_RTP_PAYLOAD_PCMA_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="131"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_PCMU_STRING"
- value="0"
- c:type="GST_RTP_PAYLOAD_PCMU_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="123"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_QCELP_STRING"
- value="12"
- c:type="GST_RTP_PAYLOAD_QCELP_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="135"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_TS41" value="19" c:type="GST_RTP_PAYLOAD_TS41">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="113"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_PAYLOAD_TS41_STRING"
- value="19"
- c:type="GST_RTP_PAYLOAD_TS41_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="118"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_TS48" value="18" c:type="GST_RTP_PAYLOAD_TS48">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="112"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_PAYLOAD_TS48_STRING"
- value="18"
- c:type="GST_RTP_PAYLOAD_TS48_STRING">
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="117"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_SOURCE_META_MAX_CSRC_COUNT"
- value="15"
- c:type="GST_RTP_SOURCE_META_MAX_CSRC_COUNT">
- <source-position filename="gst-libs/gst/rtp/gstrtpmeta.h" line="32"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_VERSION" value="2" c:type="GST_RTP_VERSION">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.h"
- line="32">The supported RTP version 2.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="37"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function name="buffer_add_rtp_source_meta"
- c:identifier="gst_buffer_add_rtp_source_meta"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="34">Attaches RTP source information to @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpmeta.h" line="60"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="43">the #GstRTPSourceMeta on @buffer.</doc>
- <type name="RTPSourceMeta" c:type="GstRTPSourceMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="36">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="ssrc"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="37">pointer to the SSRC</doc>
- <type name="guint32" c:type="const guint32*"/>
- </parameter>
- <parameter name="csrc"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="38">pointer to the CSRCs</doc>
- <type name="guint32" c:type="const guint32*"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="39">number of elements in @csrc</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_get_rtp_source_meta"
- c:identifier="gst_buffer_get_rtp_source_meta"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="78">Find the #GstRTPSourceMeta on @buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpmeta.h" line="63"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="84">the #GstRTPSourceMeta or %NULL when there
-is no such metadata on @buffer.</doc>
- <type name="RTPSourceMeta" c:type="GstRTPSourceMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpmeta.c"
- line="80">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <docsection name="gstrtpdefs">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpdefs.h"
- line="30">Provides common defines for the RTP library.</doc>
- </docsection>
- <docsection name="gstrtppayloads">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="23">The GstRTPPayloads helper functions makes it easy to deal with static and dynamic
-payloads. Its main purpose is to retrieve properties such as the default clock-rate
-and get session bandwidth information.</doc>
- </docsection>
- <function name="rtcp_buffer_map"
- c:identifier="gst_rtcp_buffer_map"
- moved-to="RTCPBuffer.map">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="297">Open @buffer for reading or writing, depending on @flags. The resulting RTCP
-buffer state is stored in @rtcp.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="283"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="299">a buffer with an RTCP packet</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="300">flags for the mapping</doc>
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- <parameter name="rtcp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="301">resulting #GstRTCPBuffer</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_new"
- c:identifier="gst_rtcp_buffer_new"
- moved-to="RTCPBuffer.new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="273">Create a new buffer for constructing RTCP packets. The packet will have a
-maximum size of @mtu.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="280"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="280">A newly allocated buffer.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="mtu" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="275">the maximum mtu size.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_new_copy_data"
- c:identifier="gst_rtcp_buffer_new_copy_data"
- moved-to="RTCPBuffer.new_copy_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="73">Create a new buffer and set the data to a copy of @len
-bytes of @data and the size to @len. The data will be freed when the buffer
-is freed.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="264"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="82">A newly allocated buffer with a copy of @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="75">data for the new buffer</doc>
- <array length="1" zero-terminated="0" c:type="gconstpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="76">the length of data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_new_take_data"
- c:identifier="gst_rtcp_buffer_new_take_data"
- moved-to="RTCPBuffer.new_take_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="49">Create a new buffer and set the data and size of the buffer to @data and @len
-respectively. @data will be freed when the buffer is unreffed, so this
-function transfers ownership of @data to the new buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="261"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="58">A newly allocated buffer with @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="51">data for the new buffer</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="52">the length of data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_validate"
- c:identifier="gst_rtcp_buffer_validate"
- moved-to="RTCPBuffer.validate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="249">Check if the data pointed to by @buffer is a valid RTCP packet using
-gst_rtcp_buffer_validate_data().</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="270"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="256">TRUE if @buffer is a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="251">the buffer to validate</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_validate_data"
- c:identifier="gst_rtcp_buffer_validate_data"
- moved-to="RTCPBuffer.validate_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="204">Check if the @data and @size point to the data of a valid compound,
-non-reduced size RTCP packet.
-Use this function to validate a packet before using the other functions in
-this module.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="267"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="214">TRUE if the data points to a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="206">the data to validate</doc>
- <array length="1" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="207">the length of @data to validate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_validate_data_reduced"
- c:identifier="gst_rtcp_buffer_validate_data_reduced"
- moved-to="RTCPBuffer.validate_data_reduced"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="180">Check if the @data and @size point to the data of a valid RTCP packet.
-Use this function to validate a packet before using the other functions in
-this module.
-
-This function is updated to support reduced size rtcp packets according to
-RFC 5506 and will validate full compound RTCP packets as well as reduced
-size RTCP packets.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="273"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="193">TRUE if the data points to a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="182">the data to validate</doc>
- <array length="1" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="183">the length of @data to validate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_validate_reduced"
- c:identifier="gst_rtcp_buffer_validate_reduced"
- moved-to="RTCPBuffer.validate_reduced"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="223">Check if the data pointed to by @buffer is a valid RTCP packet using
-gst_rtcp_buffer_validate_reduced().</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="276"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="230">TRUE if @buffer is a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="225">the buffer to validate</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_ntp_to_unix" c:identifier="gst_rtcp_ntp_to_unix">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2119">Converts an NTP time to UNIX nanoseconds. @ntptime can typically be
-the NTP time of an SR RTCP message and contains, in the upper 32 bits, the
-number of seconds since 1900 and, in the lower 32 bits, the fractional
-seconds. The resulting value will be the number of nanoseconds since 1970.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="502"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2128">the UNIX time for @ntptime in nanoseconds.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="ntptime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2121">an NTP timestamp</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_sdes_name_to_type"
- c:identifier="gst_rtcp_sdes_name_to_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2221">Convert @name into a @GstRTCPSDESType. @name is typically a key in a
-#GstStructure containing SDES items.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="511"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2228">the #GstRTCPSDESType for @name or #GST_RTCP_SDES_PRIV when @name
-is a private sdes item.</doc>
- <type name="RTCPSDESType" c:type="GstRTCPSDESType"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2223">a SDES name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_sdes_type_to_name"
- c:identifier="gst_rtcp_sdes_type_to_name">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2175">Converts @type to the string equivalent. The string is typically used as a
-key in a #GstStructure containing SDES items.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="508"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2182">the string equivalent of @type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2177">a #GstRTCPSDESType</doc>
- <type name="RTCPSDESType" c:type="GstRTCPSDESType"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_unix_to_ntp" c:identifier="gst_rtcp_unix_to_ntp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2146">Converts a UNIX timestamp in nanoseconds to an NTP time. The caller should
-pass a value with nanoseconds since 1970. The NTP time will, in the upper
-32 bits, contain the number of seconds since 1900 and, in the lower 32
-bits, the fractional seconds. The resulting value can be used as an ntptime
-for constructing SR RTCP packets.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtcpbuffer.h" line="505"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2156">the NTP time for @unixtime.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="unixtime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtcpbuffer.c"
- line="2148">an UNIX timestamp in nanoseconds</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_allocate_data"
- c:identifier="gst_rtp_buffer_allocate_data"
- moved-to="RTPBuffer.allocate_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="85">Allocate enough data in @buffer to hold an RTP packet with @csrc_count CSRCs,
-a payload length of @payload_len and padding of @pad_len.
-@buffer must be writable and all previous memory in @buffer will be freed.
-If @pad_len is &gt;0, the padding bit will be set. All other RTP header fields
-will be set to 0/FALSE.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="68"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="87">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="88">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="89">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="90">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_calc_header_len"
- c:identifier="gst_rtp_buffer_calc_header_len"
- moved-to="RTPBuffer.calc_header_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="243">Calculate the header length of an RTP packet with @csrc_count CSRC entries.
-An RTP packet can have at most 15 CSRC entries.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="84"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="250">The length of an RTP header with @csrc_count CSRC entries.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="245">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_calc_packet_len"
- c:identifier="gst_rtp_buffer_calc_packet_len"
- moved-to="RTPBuffer.calc_packet_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="260">Calculate the total length of an RTP packet with a payload size of @payload_len,
-a padding of @pad_len and a @csrc_count CSRC entries.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="87"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="269">The total length of an RTP header with given parameters.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="262">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="263">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="264">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_calc_payload_len"
- c:identifier="gst_rtp_buffer_calc_payload_len"
- moved-to="RTPBuffer.calc_payload_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="281">Calculate the length of the payload of an RTP packet with size @packet_len,
-a padding of @pad_len and a @csrc_count CSRC entries.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="90"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="290">The length of the payload of an RTP packet with given parameters.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="packet_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="283">the length of the total RTP packet</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="284">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="285">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_compare_seqnum"
- c:identifier="gst_rtp_buffer_compare_seqnum"
- moved-to="RTPBuffer.compare_seqnum">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1231">Compare two sequence numbers, taking care of wraparounds. This function
-returns the difference between @seqnum1 and @seqnum2.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="198"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1239">a negative value if @seqnum1 is bigger than @seqnum2, 0 if they
-are equal or a positive value if @seqnum1 is smaller than @segnum2.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="seqnum1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1233">a sequence number</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="seqnum2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1234">a sequence number</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_default_clock_rate"
- c:identifier="gst_rtp_buffer_default_clock_rate"
- moved-to="RTPBuffer.default_clock_rate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1204">Get the default clock-rate for the static payload type @payload_type.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="195"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1210">the default clock rate or -1 if the payload type is not static or
-the clock-rate is undefined.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <parameter name="payload_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1206">the static payload type</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_ext_timestamp"
- c:identifier="gst_rtp_buffer_ext_timestamp"
- moved-to="RTPBuffer.ext_timestamp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1253">Update the @exttimestamp field with the extended timestamp of @timestamp
-For the first call of the method, @exttimestamp should point to a location
-with a value of -1.
-
-This function is able to handle both forward and backward timestamps taking
-into account:
- - timestamp wraparound making sure that the returned value is properly increased.
- - timestamp unwraparound making sure that the returned value is properly decreased.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="201"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1267">The extended timestamp of @timestamp or 0 if the result can't go anywhere backwards.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="exttimestamp"
- direction="inout"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1255">a previous extended timestamp</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1256">a new timestamp</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_get_extension_onebyte_header_from_bytes"
- c:identifier="gst_rtp_buffer_get_extension_onebyte_header_from_bytes"
- moved-to="RTPBuffer.get_extension_onebyte_header_from_bytes"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1375">Similar to gst_rtp_buffer_get_extension_onebyte_header, but working
-on the #GBytes you get from gst_rtp_buffer_get_extension_bytes.
-Parses RFC 5285 style header extensions with a one byte header. It will
-return the nth extension with the requested id.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="232"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1390">TRUE if @bytes had the requested header extension</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="bytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1377">#GBytes</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </parameter>
- <parameter name="bit_pattern" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1378">The bit-pattern. Anything but 0xBEDE is rejected.</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1379">The ID of the header extension to be read (between 1 and 14).</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1380">Read the nth extension packet with the requested ID</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1381">
- location for data</doc>
- <array length="5" zero-terminated="0" c:type="gpointer*">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="1383">the size of the data in bytes</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_map"
- c:identifier="gst_rtp_buffer_map"
- moved-to="RTPBuffer.map">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="306">Map the contents of @buffer into @rtp.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="93"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="314">%TRUE if @buffer could be mapped.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="308">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="309">#GstMapFlags</doc>
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- <parameter name="rtp"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="310">a #GstRTPBuffer</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_new_allocate"
- c:identifier="gst_rtp_buffer_new_allocate"
- moved-to="RTPBuffer.new_allocate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="190">Allocate a new #GstBuffer with enough data to hold an RTP packet with
-@csrc_count CSRCs, a payload length of @payload_len and padding of @pad_len.
-All other RTP header fields will be set to 0/FALSE.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="78"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="200">A newly allocated buffer that can hold an RTP packet with given
-parameters.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="192">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="193">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="194">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_new_allocate_len"
- c:identifier="gst_rtp_buffer_new_allocate_len"
- moved-to="RTPBuffer.new_allocate_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="217">Create a new #GstBuffer that can hold an RTP packet that is exactly
-@packet_len long. The length of the payload depends on @pad_len and
-@csrc_count and can be calculated with gst_rtp_buffer_calc_payload_len().
-All RTP header fields will be set to 0/FALSE.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="81"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="228">A newly allocated buffer that can hold an RTP packet of @packet_len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="packet_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="219">the total length of the packet</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="220">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="221">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_new_copy_data"
- c:identifier="gst_rtp_buffer_new_copy_data"
- moved-to="RTPBuffer.new_copy_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="172">Create a new buffer and set the data to a copy of @len
-bytes of @data and the size to @len. The data will be freed when the buffer
-is freed.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="75"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="182">A newly allocated buffer with a copy of @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="174">data for the new
- buffer</doc>
- <array length="1" zero-terminated="0" c:type="gconstpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="176">the length of data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_new_take_data"
- c:identifier="gst_rtp_buffer_new_take_data"
- moved-to="RTPBuffer.new_take_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="151">Create a new buffer and set the data and size of the buffer to @data and @len
-respectively. @data will be freed when the buffer is unreffed, so this
-function transfers ownership of @data to the new buffer.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtpbuffer.h" line="72"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="161">A newly allocated buffer with @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="153">
- data for the new buffer</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtpbuffer.c"
- line="155">the length of data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_hdrext_get_ntp_56"
- c:identifier="gst_rtp_hdrext_get_ntp_56">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="108">Reads the NTP time from the @size NTP-56 extension bytes in @data and store the
-result in @ntptime.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtphdrext.h" line="51"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="117">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="110">the data to read from</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="111">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ntptime"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="112">the result NTP time</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_hdrext_get_ntp_64"
- c:identifier="gst_rtp_hdrext_get_ntp_64">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="58">Reads the NTP time from the @size NTP-64 extension bytes in @data and store the
-result in @ntptime.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtphdrext.h" line="41"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="67">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="60">the data to read from</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="61">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ntptime"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="62">the result NTP time</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_hdrext_set_ntp_56"
- c:identifier="gst_rtp_hdrext_set_ntp_56">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="81">Writes the NTP time in @ntptime to the format required for the NTP-56 header
-extension. @data must hold at least #GST_RTP_HDREXT_NTP_56_SIZE bytes.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtphdrext.h" line="48"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="90">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="83">the data to write to</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="84">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ntptime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="85">the NTP time</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_hdrext_set_ntp_64"
- c:identifier="gst_rtp_hdrext_set_ntp_64">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="36">Writes the NTP time in @ntptime to the format required for the NTP-64 header
-extension. @data must hold at least #GST_RTP_HDREXT_NTP_64_SIZE bytes.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtphdrext.h" line="38"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="45">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="38">the data to write to</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="39">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ntptime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtphdrext.c"
- line="40">the NTP time</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_payload_info_for_name"
- c:identifier="gst_rtp_payload_info_for_name"
- moved-to="RTPPayloadInfo.for_name">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="205">Get the #GstRTPPayloadInfo for @media and @encoding_name. This function is
-mostly used to get the default clock-rate and bandwidth for dynamic payload
-types specified with @media and @encoding name.
-
-The search for @encoding_name will be performed in a case insensitive way.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="194"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="216">a #GstRTPPayloadInfo or NULL when no info could be found.</doc>
- <type name="RTPPayloadInfo" c:type="const GstRTPPayloadInfo*"/>
- </return-value>
- <parameters>
- <parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="207">the media to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="encoding_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="208">the encoding name to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_payload_info_for_pt"
- c:identifier="gst_rtp_payload_info_for_pt"
- moved-to="RTPPayloadInfo.for_pt">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="180">Get the #GstRTPPayloadInfo for @payload_type. This function is
-mostly used to get the default clock-rate and bandwidth for static payload
-types specified with @payload_type.</doc>
- <source-position filename="gst-libs/gst/rtp/gstrtppayloads.h"
- line="191"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="188">a #GstRTPPayloadInfo or NULL when no info could be found.</doc>
- <type name="RTPPayloadInfo" c:type="const GstRTPPayloadInfo*"/>
- </return-value>
- <parameters>
- <parameter name="payload_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtp/gstrtppayloads.c"
- line="182">the payload_type to find</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_source_meta_api_get_type"
- c:identifier="gst_rtp_source_meta_api_get_type">
- <source-position filename="gst-libs/gst/rtp/gstrtpmeta.h" line="57"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="rtp_source_meta_get_info"
- c:identifier="gst_rtp_source_meta_get_info"
- moved-to="RTPSourceMeta.get_info">
- <source-position filename="gst-libs/gst/rtp/gstrtpmeta.h" line="75"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </namespace>
-</repository>
diff --git a/girs/GstRtsp-1.0.gir b/girs/GstRtsp-1.0.gir
deleted file mode 100644
index 4c90bd9440..0000000000
--- a/girs/GstRtsp-1.0.gir
+++ /dev/null
@@ -1,7642 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="Gio" version="2.0"/>
- <include name="Gst" version="1.0"/>
- <include name="GstBase" version="1.0"/>
- <include name="GstSdp" version="1.0"/>
- <package name="gstreamer-rtsp-1.0"/>
- <c:include name="gst/rtsp/rtsp.h"/>
- <namespace name="GstRtsp"
- version="1.0"
- shared-library="libgstrtsp-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <function-macro name="IS_RTSP_EXTENSION"
- c:identifier="GST_IS_RTSP_EXTENSION"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <record name="RTSPAuthCredential"
- c:type="GstRTSPAuthCredential"
- version="1.12"
- glib:type-name="GstRTSPAuthCredential"
- glib:get-type="gst_rtsp_auth_credential_get_type"
- c:symbol-prefix="rtsp_auth_credential">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="284">RTSP Authentication credentials</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="303"/>
- <field name="scheme" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="286">a #GstRTSPAuthMethod</doc>
- <type name="RTSPAuthMethod" c:type="GstRTSPAuthMethod"/>
- </field>
- <field name="params" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="287">A NULL-terminated array of #GstRTSPAuthParam</doc>
- <type name="RTSPAuthParam" c:type="GstRTSPAuthParam**"/>
- </field>
- <field name="authorization" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="288">The authorization for the basic schem</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- </record>
- <enumeration name="RTSPAuthMethod"
- glib:type-name="GstRTSPAuthMethod"
- glib:get-type="gst_rtsp_auth_method_get_type"
- c:type="GstRTSPAuthMethod">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="209">Authentication methods, ordered by strength</doc>
- <member name="none"
- value="0"
- c:identifier="GST_RTSP_AUTH_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="211">no authentication</doc>
- </member>
- <member name="basic"
- value="1"
- c:identifier="GST_RTSP_AUTH_BASIC"
- glib:nick="basic">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="212">basic authentication</doc>
- </member>
- <member name="digest"
- value="2"
- c:identifier="GST_RTSP_AUTH_DIGEST"
- glib:nick="digest">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="213">digest authentication</doc>
- </member>
- </enumeration>
- <record name="RTSPAuthParam"
- c:type="GstRTSPAuthParam"
- version="1.12"
- glib:type-name="GstRTSPAuthParam"
- glib:get-type="gst_rtsp_auth_param_get_type"
- c:symbol-prefix="rtsp_auth_param">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="305">RTSP Authentication parameter</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="317"/>
- <field name="name" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="307">The name of the parameter</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="value" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="308">The value of the parameter</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <method name="copy" c:identifier="gst_rtsp_auth_param_copy">
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="320"/>
- <return-value transfer-ownership="full">
- <type name="RTSPAuthParam" c:type="GstRTSPAuthParam*"/>
- </return-value>
- <parameters>
- <instance-parameter name="param" transfer-ownership="none">
- <type name="RTSPAuthParam" c:type="GstRTSPAuthParam*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_rtsp_auth_param_free">
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="322"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="param" transfer-ownership="none">
- <type name="RTSPAuthParam" c:type="GstRTSPAuthParam*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <record name="RTSPConnection" c:type="GstRTSPConnection" disguised="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="43">This object manages the RTSP connection to the server. It provides function
-to receive and send bytes and messages.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="61"/>
- <method name="clear_auth_params"
- c:identifier="gst_rtsp_connection_clear_auth_params">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3157">Clear the list of authentication directives stored in @conn.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="184"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3159">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="close" c:identifier="gst_rtsp_connection_close">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2756">Close the connected @conn. After this call, the connection is in the same
-state as when it was first created.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="85"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2763">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2758">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="connect"
- c:identifier="gst_rtsp_connection_connect"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4813">Attempt to connect to the url of @conn made with
-gst_rtsp_connection_create(). If @timeout is %NULL this function can block
-forever. If @timeout contains a valid timeout, this function will return
-#GST_RTSP_ETIMEOUT after the timeout expired.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="345"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4825">#GST_RTSP_OK when a connection could be made.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4815">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4816">a GTimeVal timeout</doc>
- <type name="GLib.TimeVal" c:type="GTimeVal*"/>
- </parameter>
- </parameters>
- </method>
- <method name="connect_usec"
- c:identifier="gst_rtsp_connection_connect_usec"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1150">Attempt to connect to the url of @conn made with
-gst_rtsp_connection_create(). If @timeout is 0 this function can block
-forever. If @timeout contains a valid timeout, this function will return
-#GST_RTSP_ETIMEOUT after the timeout expired.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="79"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1162">#GST_RTSP_OK when a connection could be made.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1152">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1153">a timeout in microseconds</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="connect_with_response"
- c:identifier="gst_rtsp_connection_connect_with_response"
- version="1.8"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4835">Attempt to connect to the url of @conn made with
-gst_rtsp_connection_create(). If @timeout is %NULL this function can block
-forever. If @timeout contains a valid timeout, this function will return
-#GST_RTSP_ETIMEOUT after the timeout expired. If @conn is set to tunneled,
-@response will contain a response to the tunneling request messages.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="348"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4849">#GST_RTSP_OK when a connection could be made.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4837">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4838">a GTimeVal timeout</doc>
- <type name="GLib.TimeVal" c:type="GTimeVal*"/>
- </parameter>
- <parameter name="response" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4839">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </method>
- <method name="connect_with_response_usec"
- c:identifier="gst_rtsp_connection_connect_with_response_usec"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="957">Attempt to connect to the url of @conn made with
-gst_rtsp_connection_create(). If @timeout is 0 this function can block
-forever. If @timeout contains a valid timeout, this function will return
-#GST_RTSP_ETIMEOUT after the timeout expired. If @conn is set to tunneled,
-@response will contain a response to the tunneling request messages.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="82"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="971">#GST_RTSP_OK when a connection could be made.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="959">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="960">a timeout in microseconds</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="response" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="961">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </method>
- <method name="do_tunnel" c:identifier="gst_rtsp_connection_do_tunnel">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3444">If @conn received the first tunnel connection and @conn2 received
-the second tunnel connection, link the two connections together so that
-@conn manages the tunneled connection.
-
-After this call, @conn2 cannot be used anymore and must be freed with
-gst_rtsp_connection_free().
-
-If @conn2 is %NULL then only the base64 decoding context will be setup for
-@conn.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="230"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3459">return GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3446">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="conn2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3447">a #GstRTSPConnection or %NULL</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </parameter>
- </parameters>
- </method>
- <method name="flush" c:identifier="gst_rtsp_connection_flush">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3003">Start or stop the flushing action on @conn. When flushing, all current
-and future actions on @conn will return #GST_RTSP_EINTR until the connection
-is set to non-flushing mode again.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="164"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3012">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3005">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="flush" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3006">start or stop the flush</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_rtsp_connection_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2816">Close and free @conn.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="88"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2822">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2818">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_ip" c:identifier="gst_rtsp_connection_get_ip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3305">Retrieve the IP address of the other end of @conn.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="203"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3311">The IP address as a string. this value remains valid until the
-connection is closed.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3307">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="const GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_read_socket"
- c:identifier="gst_rtsp_connection_get_read_socket">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3338">Get the file descriptor for reading.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="209"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3344">the file descriptor used for reading or %NULL on
-error. The file descriptor remains valid until the connection is closed.</doc>
- <type name="Gio.Socket" c:type="GSocket*"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3340">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="const GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_remember_session_id"
- c:identifier="gst_rtsp_connection_get_remember_session_id">
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="236"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3555">%TRUE if the #GstRTSPConnection remembers the session id in the
-last response to set it on any further request.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3553">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tls"
- c:identifier="gst_rtsp_connection_get_tls"
- version="1.2"
- throws="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="545">Get the TLS connection of @conn.
-
-For client side this will return the #GTlsClientConnection when connected
-over TLS.
-
-For server side connections, this function will create a GTlsServerConnection
-when called the first time and will return that same connection on subsequent
-calls. The server is then responsible for configuring the TLS connection.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="93"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="559">the TLS connection for @conn.</doc>
- <type name="Gio.TlsConnection" c:type="GTlsConnection*"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="547">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tls_database"
- c:identifier="gst_rtsp_connection_get_tls_database"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="666">Gets the anchor certificate authorities database that will be used
-after a server certificate can't be verified with the default
-certificate database.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="105"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="674">the anchor certificate authorities database, or NULL if no
-database has been previously set. Use g_object_unref() to release the
-certificate database.</doc>
- <type name="Gio.TlsDatabase" c:type="GTlsDatabase*"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="668">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tls_interaction"
- c:identifier="gst_rtsp_connection_get_tls_interaction"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="722">Gets a #GTlsInteraction object to be used when the connection or certificate
-database need to interact with the user. This will be used to prompt the
-user for passwords where necessary.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="111"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="730">a reference on the #GTlsInteraction. Use
-g_object_unref() to release.</doc>
- <type name="Gio.TlsInteraction" c:type="GTlsInteraction*"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="724">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tls_validation_flags"
- c:identifier="gst_rtsp_connection_get_tls_validation_flags"
- version="1.2.1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="618">Gets the TLS validation flags used to verify the peer certificate
-when a TLS connection is established.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="99"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="625">the validationg flags.</doc>
- <type name="Gio.TlsCertificateFlags" c:type="GTlsCertificateFlags"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="620">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_tunnelid"
- c:identifier="gst_rtsp_connection_get_tunnelid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3425">Get the tunnel session id the connection.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="227"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3431">returns a non-empty string if @conn is being tunneled over HTTP.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3427">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="const GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_url" c:identifier="gst_rtsp_connection_get_url">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3288">Retrieve the URL of the other end of @conn.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="200"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3294">The URL. This value remains valid until the
-connection is freed.</doc>
- <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3290">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="const GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_write_socket"
- c:identifier="gst_rtsp_connection_get_write_socket">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3356">Get the file descriptor for writing.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="212"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3362">the file descriptor used for writing or NULL on
-error. The file descriptor remains valid until the connection is closed.</doc>
- <type name="Gio.Socket" c:type="GSocket*"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3358">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="const GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_tunneled"
- c:identifier="gst_rtsp_connection_is_tunneled">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3409">Get the tunneling state of the connection.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="224"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3415">if @conn is using HTTP tunneling.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3411">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="const GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="next_timeout"
- c:identifier="gst_rtsp_connection_next_timeout"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="5011">Calculate the next timeout for @conn, storing the result in @timeout.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="377"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="5018">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="5013">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="5014">a timeout</doc>
- <type name="GLib.TimeVal" c:type="GTimeVal*"/>
- </parameter>
- </parameters>
- </method>
- <method name="next_timeout_usec"
- c:identifier="gst_rtsp_connection_next_timeout_usec"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2937">Calculate the next timeout for @conn</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="156"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2943">#the next timeout in microseconds</doc>
- <type name="gint64" c:type="gint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2939">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="poll"
- c:identifier="gst_rtsp_connection_poll"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4983">Wait up to the specified @timeout for the connection to become available for
-at least one of the operations specified in @events. When the function returns
-with #GST_RTSP_OK, @revents will contain a bitmask of available operations on
-@conn.
-
-@timeout can be %NULL, in which case this function might block forever.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="373"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4999">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4985">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="events" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4986">a bitmask of #GstRTSPEvent flags to check</doc>
- <type name="RTSPEvent" c:type="GstRTSPEvent"/>
- </parameter>
- <parameter name="revents" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4987">location for result flags</doc>
- <type name="RTSPEvent" c:type="GstRTSPEvent*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4988">a timeout</doc>
- <type name="GLib.TimeVal" c:type="GTimeVal*"/>
- </parameter>
- </parameters>
- </method>
- <method name="poll_usec"
- c:identifier="gst_rtsp_connection_poll_usec"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2853">Wait up to the specified @timeout for the connection to become available for
-at least one of the operations specified in @events. When the function returns
-with #GST_RTSP_OK, @revents will contain a bitmask of available operations on
-@conn.
-
-@timeout can be 0, in which case this function might block forever.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="150"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2869">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2855">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="events" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2856">a bitmask of #GstRTSPEvent flags to check</doc>
- <type name="RTSPEvent" c:type="GstRTSPEvent"/>
- </parameter>
- <parameter name="revents" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2857">location for result flags</doc>
- <type name="RTSPEvent" c:type="GstRTSPEvent*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2858">a timeout in microseconds</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="read"
- c:identifier="gst_rtsp_connection_read"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4862">Attempt to read @size bytes into @data from the connected @conn, blocking up to
-the specified @timeout. @timeout can be %NULL, in which case this function
-might block forever.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="352"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4875">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4864">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4865">the data to read</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4866">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4867">a timeout value or %NULL</doc>
- <type name="GLib.TimeVal" c:type="GTimeVal*"/>
- </parameter>
- </parameters>
- </method>
- <method name="read_usec"
- c:identifier="gst_rtsp_connection_read_usec"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2587">Attempt to read @size bytes into @data from the connected @conn, blocking up to
-the specified @timeout. @timeout can be 0, in which case this function
-might block forever.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="126"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2600">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2589">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2590">the data to read</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2591">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2592">a timeout value in microseconds</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="receive"
- c:identifier="gst_rtsp_connection_receive"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4960">Attempt to read into @message from the connected @conn, blocking up to
-the specified @timeout. @timeout can be %NULL, in which case this function
-might block forever.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="369"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4972">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4962">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4963">the message to read</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4964">a timeout value or %NULL</doc>
- <type name="GLib.TimeVal" c:type="GTimeVal*"/>
- </parameter>
- </parameters>
- </method>
- <method name="receive_usec"
- c:identifier="gst_rtsp_connection_receive_usec"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2669">Attempt to read into @message from the connected @conn, blocking up to
-the specified @timeout. @timeout can be 0, in which case this function
-might block forever.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="144"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2681">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2671">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2672">the message to read</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2673">a timeout value or 0</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="reset_timeout"
- c:identifier="gst_rtsp_connection_reset_timeout">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2985">Reset the timeout of @conn.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="159"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2991">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="2987">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="send"
- c:identifier="gst_rtsp_connection_send"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4911">Attempt to send @message to the connected @conn, blocking up to
-the specified @timeout. @timeout can be %NULL, in which case this function
-might block forever.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="361"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4923">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4913">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4914">the message to send</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4915">a timeout value or %NULL</doc>
- <type name="GLib.TimeVal" c:type="GTimeVal*"/>
- </parameter>
- </parameters>
- </method>
- <method name="send_messages"
- c:identifier="gst_rtsp_connection_send_messages"
- version="1.16"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4934">Attempt to send @messages to the connected @conn, blocking up to
-the specified @timeout. @timeout can be %NULL, in which case this function
-might block forever.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="365"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4947">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4936">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="messages" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4937">the messages to send</doc>
- <array length="1" zero-terminated="0" c:type="GstRTSPMessage*">
- <type name="RTSPMessage" c:type="GstRTSPMessage"/>
- </array>
- </parameter>
- <parameter name="n_messages" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4938">the number of messages to send</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4939">a timeout value or %NULL</doc>
- <type name="GLib.TimeVal" c:type="GTimeVal*"/>
- </parameter>
- </parameters>
- </method>
- <method name="send_messages_usec"
- c:identifier="gst_rtsp_connection_send_messages_usec"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1813">Attempt to send @messages to the connected @conn, blocking up to
-the specified @timeout. @timeout can be 0, in which case this function
-might block forever.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="140"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1826">#GST_RTSP_OK on Since.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1815">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="messages" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1816">the messages to send</doc>
- <array length="1" zero-terminated="0" c:type="GstRTSPMessage*">
- <type name="RTSPMessage" c:type="GstRTSPMessage"/>
- </array>
- </parameter>
- <parameter name="n_messages" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1817">the number of messages to send</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1818">a timeout value in microseconds</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="send_usec"
- c:identifier="gst_rtsp_connection_send_usec"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1787">Attempt to send @message to the connected @conn, blocking up to
-the specified @timeout. @timeout can be 0, in which case this function
-might block forever.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="136"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1799">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1789">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1790">the message to send</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1791">a timeout value in microseconds</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_accept_certificate_func"
- c:identifier="gst_rtsp_connection_set_accept_certificate_func"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="748">Sets a custom accept-certificate function for checking certificates for
-validity. This will directly map to #GTlsConnection 's "accept-certificate"
-signal and be performed after the default checks of #GstRTSPConnection
-(checking against the #GTlsDatabase with the given #GTlsCertificateFlags)
-have failed. If no #GTlsDatabase is set on this connection, only @func will
-be called.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="118"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="750">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="func"
- transfer-ownership="none"
- scope="notified"
- closure="1"
- destroy="2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="751">a #GstRTSPConnectionAcceptCertificateFunc to check certificates</doc>
- <type name="RTSPConnectionAcceptCertificateFunc"
- c:type="GstRTSPConnectionAcceptCertificateFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="753">User data passed to @func</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="destroy_notify"
- transfer-ownership="none"
- scope="async">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="752">#GDestroyNotify for @user_data</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_auth" c:identifier="gst_rtsp_connection_set_auth">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3052">Configure @conn for authentication mode @method with @user and @pass as the
-user and password respectively.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="175"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3062">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3054">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3055">authentication method</doc>
- <type name="RTSPAuthMethod" c:type="GstRTSPAuthMethod"/>
- </parameter>
- <parameter name="user" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3056">the user</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="pass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3057">the password</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_auth_param"
- c:identifier="gst_rtsp_connection_set_auth_param">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3131">Setup @conn with authentication directives. This is not necessary for
-methods #GST_RTSP_AUTH_NONE and #GST_RTSP_AUTH_BASIC. For
-#GST_RTSP_AUTH_DIGEST, directives should be taken from the digest challenge
-in the WWW-Authenticate response header and can include realm, domain,
-nonce, opaque, stale, algorithm, qop as per RFC2617.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="179"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3133">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="param" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3134">authentication directive</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3135">value</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_content_length_limit"
- c:identifier="gst_rtsp_connection_set_content_length_limit"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3268">Configure @conn to use the specified Content-Length limit.
-Both requests and responses are validated. If content-length is
-exceeded, ENOMEM error will be returned.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="194"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3270">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="limit" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3271">Content-Length limit</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_http_mode"
- c:identifier="gst_rtsp_connection_set_http_mode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3374">By setting the HTTP mode to %TRUE the message parsing will support HTTP
-messages in addition to the RTSP messages. It will also disable the
-automatic handling of setting up an HTTP tunnel.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="215"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3376">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="enable" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3377">%TRUE to enable manual HTTP mode</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_ip" c:identifier="gst_rtsp_connection_set_ip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3322">Set the IP address of the server.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="206"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3324">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="ip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3325">an ip address</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_proxy" c:identifier="gst_rtsp_connection_set_proxy">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3029">Set the proxy host and port.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="169"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3037">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3031">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="host" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3032">the proxy host</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="port" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3033">the proxy port</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_qos_dscp"
- c:identifier="gst_rtsp_connection_set_qos_dscp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3243">Configure @conn to use the specified DSCP value.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="189"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3250">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3245">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="qos_dscp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3246">DSCP value</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_remember_session_id"
- c:identifier="gst_rtsp_connection_set_remember_session_id">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3531">Sets if the #GstRTSPConnection should remember the session id from the last
-response received and force it onto any further requests.
-
-The default value is %TRUE</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="233"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3533">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="remember" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3534">%TRUE if the connection should remember the session id</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_tls_database"
- c:identifier="gst_rtsp_connection_set_tls_database"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="637">Sets the anchor certificate authorities database. This certificate
-database will be used to verify the server's certificate in case it
-can't be verified with the default certificate database first.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="102"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="639">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="database" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="640">a #GTlsDatabase</doc>
- <type name="Gio.TlsDatabase" c:type="GTlsDatabase*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_tls_interaction"
- c:identifier="gst_rtsp_connection_set_tls_interaction"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="693">Sets a #GTlsInteraction object to be used when the connection or certificate
-database need to interact with the user. This will be used to prompt the
-user for passwords where necessary.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="108"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="695">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="interaction" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="696">a #GTlsInteraction</doc>
- <type name="Gio.TlsInteraction" c:type="GTlsInteraction*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_tls_validation_flags"
- c:identifier="gst_rtsp_connection_set_tls_validation_flags"
- version="1.2.1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="590">Sets the TLS validation flags to be used to verify the peer
-certificate when a TLS connection is established.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="96"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="598">TRUE if the validation flags are set correctly, or FALSE if
-@conn is NULL or is not a TLS connection.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="592">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="593">the validation flags.</doc>
- <type name="Gio.TlsCertificateFlags"
- c:type="GTlsCertificateFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_tunneled"
- c:identifier="gst_rtsp_connection_set_tunneled">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3391">Set the HTTP tunneling state of the connection. This must be configured before
-the @conn is connected.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="221"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3393">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="tunneled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="3394">the new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="write"
- c:identifier="gst_rtsp_connection_write"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4886">Attempt to write @size bytes of @data to the connected @conn, blocking up to
-the specified @timeout. @timeout can be %NULL, in which case this function
-might block forever.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="357"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4899">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4888">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4889">the data to write</doc>
- <type name="guint8" c:type="const guint8*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4890">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4891">a timeout value or %NULL</doc>
- <type name="GLib.TimeVal" c:type="GTimeVal*"/>
- </parameter>
- </parameters>
- </method>
- <method name="write_usec"
- c:identifier="gst_rtsp_connection_write_usec"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1611">Attempt to write @size bytes of @data to the connected @conn, blocking up to
-the specified @timeout. @timeout can be 0, in which case this function
-might block forever.
-
-This function can be cancelled with gst_rtsp_connection_flush().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="130"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1624">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1613">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1614">the data to write</doc>
- <type name="guint8" c:type="const guint8*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1615">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="1616">a timeout value or 0</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <function name="accept" c:identifier="gst_rtsp_connection_accept">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="485">Accept a new connection on @socket and create a new #GstRTSPConnection for
-handling communication on new socket.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="76"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="494">#GST_RTSP_OK when @conn contains a valid connection.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="socket" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="487">a socket</doc>
- <type name="Gio.Socket" c:type="GSocket*"/>
- </parameter>
- <parameter name="conn"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="488">storage for a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection**"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="489">a #GCancellable to cancel the operation</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- </parameters>
- </function>
- <function name="create" c:identifier="gst_rtsp_connection_create">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="329">Create a newly allocated #GstRTSPConnection from @url and store it in @conn.
-The connection will not yet attempt to connect to @url, use
-gst_rtsp_connection_connect().
-
-A copy of @url will be made.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="66"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="340">#GST_RTSP_OK when @conn contains a valid connection.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="url" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="331">a #GstRTSPUrl</doc>
- <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
- </parameter>
- <parameter name="conn"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="332">storage for a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection**"/>
- </parameter>
- </parameters>
- </function>
- <function name="create_from_socket"
- c:identifier="gst_rtsp_connection_create_from_socket">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="408">Create a new #GstRTSPConnection for handling communication on the existing
-socket @socket. The @initial_buffer contains zero terminated data already
-read from @socket which should be used before starting to read new data.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="420">#GST_RTSP_OK when @conn contains a valid connection.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="socket" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="410">a #GSocket</doc>
- <type name="Gio.Socket" c:type="GSocket*"/>
- </parameter>
- <parameter name="ip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="411">the IP address of the other end</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="port" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="412">the port used by the other end</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="initial_buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="413">data already read from @fd</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="conn"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="414">storage for a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection**"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <callback name="RTSPConnectionAcceptCertificateFunc"
- c:type="GstRTSPConnectionAcceptCertificateFunc">
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="113"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="conn" transfer-ownership="none">
- <type name="Gio.TlsConnection" c:type="GTlsConnection*"/>
- </parameter>
- <parameter name="peer_cert" transfer-ownership="none">
- <type name="Gio.TlsCertificate" c:type="GTlsCertificate*"/>
- </parameter>
- <parameter name="errors" transfer-ownership="none">
- <type name="Gio.TlsCertificateFlags" c:type="GTlsCertificateFlags"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="3">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <bitfield name="RTSPEvent"
- glib:type-name="GstRTSPEvent"
- glib:get-type="gst_rtsp_event_get_type"
- c:type="GstRTSPEvent">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="111">The possible events for the connection.</doc>
- <member name="read"
- value="1"
- c:identifier="GST_RTSP_EV_READ"
- glib:nick="read">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="113">connection is readable</doc>
- </member>
- <member name="write"
- value="2"
- c:identifier="GST_RTSP_EV_WRITE"
- glib:nick="write">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="114">connection is writable</doc>
- </member>
- </bitfield>
- <interface name="RTSPExtension"
- c:symbol-prefix="rtsp_extension"
- c:type="GstRTSPExtension"
- glib:type-name="GstRTSPExtension"
- glib:get-type="gst_rtsp_extension_get_type"
- glib:type-struct="RTSPExtensionInterface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspextension.c"
- line="22">This interface is implemented e.g. by the Windows Media Streaming RTSP
- exentension (rtspwms) and the RealMedia RTSP extension (rtspreal).</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="77"/>
- <virtual-method name="after_send" invoker="after_send">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="58"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="req" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="resp" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="before_send" invoker="before_send">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="57"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="req" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="configure_stream" invoker="configure_stream">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="63"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="detect_server" invoker="detect_server">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="55"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="resp" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_transports" invoker="get_transports">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="65"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="protocols" transfer-ownership="none">
- <type name="RTSPLowerTrans" c:type="GstRTSPLowerTrans"/>
- </parameter>
- <parameter name="transport" transfer-ownership="none">
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="parse_sdp" invoker="parse_sdp">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="60"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="sdp" transfer-ownership="none">
- <type name="GstSdp.SDPMessage" c:type="GstSDPMessage*"/>
- </parameter>
- <parameter name="s" transfer-ownership="none">
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="receive_request" invoker="receive_request">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="73"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="req" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="send" invoker="send">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="70"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="req" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="resp" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="setup_media" invoker="setup_media">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="61"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="media" transfer-ownership="none">
- <type name="GstSdp.SDPMedia" c:type="GstSDPMedia*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stream_select" invoker="stream_select">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="67"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="url" transfer-ownership="none">
- <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="after_send" c:identifier="gst_rtsp_extension_after_send">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="91"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="req" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="resp" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </method>
- <method name="before_send" c:identifier="gst_rtsp_extension_before_send">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="88"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="req" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </method>
- <method name="configure_stream"
- c:identifier="gst_rtsp_extension_configure_stream">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="102"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="detect_server"
- c:identifier="gst_rtsp_extension_detect_server">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="85"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="resp" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_transports"
- c:identifier="gst_rtsp_extension_get_transports">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="105"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="protocols" transfer-ownership="none">
- <type name="RTSPLowerTrans" c:type="GstRTSPLowerTrans"/>
- </parameter>
- <parameter name="transport" transfer-ownership="none">
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_sdp" c:identifier="gst_rtsp_extension_parse_sdp">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="95"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="sdp" transfer-ownership="none">
- <type name="GstSdp.SDPMessage" c:type="GstSDPMessage*"/>
- </parameter>
- <parameter name="s" transfer-ownership="none">
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="receive_request"
- c:identifier="gst_rtsp_extension_receive_request">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="112"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="req" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </method>
- <method name="send" c:identifier="gst_rtsp_extension_send">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="117"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="req" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="resp" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </method>
- <method name="setup_media" c:identifier="gst_rtsp_extension_setup_media">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="99"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="media" transfer-ownership="none">
- <type name="GstSdp.SDPMedia" c:type="GstSDPMedia*"/>
- </parameter>
- </parameters>
- </method>
- <method name="stream_select"
- c:identifier="gst_rtsp_extension_stream_select">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="109"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </instance-parameter>
- <parameter name="url" transfer-ownership="none">
- <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
- </parameter>
- </parameters>
- </method>
- <glib:signal name="send" when="last">
- <return-value transfer-ownership="none">
- <type name="RTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="object"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="p0"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </glib:signal>
- </interface>
- <record name="RTSPExtensionInterface"
- c:type="GstRTSPExtensionInterface"
- glib:is-gtype-struct-for="RTSPExtension">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="43">An interface representing RTSP extensions.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="77"/>
- <field name="parent">
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- <field name="detect_server">
- <callback name="detect_server">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="55"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </parameter>
- <parameter name="resp" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="before_send">
- <callback name="before_send">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="57"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </parameter>
- <parameter name="req" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="after_send">
- <callback name="after_send">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="58"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </parameter>
- <parameter name="req" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="resp" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="parse_sdp">
- <callback name="parse_sdp">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="60"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </parameter>
- <parameter name="sdp" transfer-ownership="none">
- <type name="GstSdp.SDPMessage" c:type="GstSDPMessage*"/>
- </parameter>
- <parameter name="s" transfer-ownership="none">
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="setup_media">
- <callback name="setup_media">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="61"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </parameter>
- <parameter name="media" transfer-ownership="none">
- <type name="GstSdp.SDPMedia" c:type="GstSDPMedia*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="configure_stream">
- <callback name="configure_stream">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="63"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_transports">
- <callback name="get_transports">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="65"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </parameter>
- <parameter name="protocols" transfer-ownership="none">
- <type name="RTSPLowerTrans" c:type="GstRTSPLowerTrans"/>
- </parameter>
- <parameter name="transport" transfer-ownership="none">
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stream_select">
- <callback name="stream_select">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="67"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </parameter>
- <parameter name="url" transfer-ownership="none">
- <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="send">
- <callback name="send">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="70"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </parameter>
- <parameter name="req" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="resp" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="receive_request">
- <callback name="receive_request">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="73"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="ext" transfer-ownership="none">
- <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
- </parameter>
- <parameter name="req" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <enumeration name="RTSPFamily"
- glib:type-name="GstRTSPFamily"
- glib:get-type="gst_rtsp_family_get_type"
- c:type="GstRTSPFamily">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="123">The possible network families.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_RTSP_FAM_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="125">unknown network family</doc>
- </member>
- <member name="inet"
- value="1"
- c:identifier="GST_RTSP_FAM_INET"
- glib:nick="inet">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="126">internet</doc>
- </member>
- <member name="inet6"
- value="2"
- c:identifier="GST_RTSP_FAM_INET6"
- glib:nick="inet6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="127">internet V6</doc>
- </member>
- </enumeration>
- <enumeration name="RTSPHeaderField"
- glib:type-name="GstRTSPHeaderField"
- glib:get-type="gst_rtsp_header_field_get_type"
- c:type="GstRTSPHeaderField">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="230">Enumeration of rtsp header fields</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_RTSP_HDR_INVALID"
- glib:nick="invalid">
- </member>
- <member name="accept"
- value="1"
- c:identifier="GST_RTSP_HDR_ACCEPT"
- glib:nick="accept">
- </member>
- <member name="accept_encoding"
- value="2"
- c:identifier="GST_RTSP_HDR_ACCEPT_ENCODING"
- glib:nick="accept-encoding">
- </member>
- <member name="accept_language"
- value="3"
- c:identifier="GST_RTSP_HDR_ACCEPT_LANGUAGE"
- glib:nick="accept-language">
- </member>
- <member name="allow"
- value="4"
- c:identifier="GST_RTSP_HDR_ALLOW"
- glib:nick="allow">
- </member>
- <member name="authorization"
- value="5"
- c:identifier="GST_RTSP_HDR_AUTHORIZATION"
- glib:nick="authorization">
- </member>
- <member name="bandwidth"
- value="6"
- c:identifier="GST_RTSP_HDR_BANDWIDTH"
- glib:nick="bandwidth">
- </member>
- <member name="blocksize"
- value="7"
- c:identifier="GST_RTSP_HDR_BLOCKSIZE"
- glib:nick="blocksize">
- </member>
- <member name="cache_control"
- value="8"
- c:identifier="GST_RTSP_HDR_CACHE_CONTROL"
- glib:nick="cache-control">
- </member>
- <member name="conference"
- value="9"
- c:identifier="GST_RTSP_HDR_CONFERENCE"
- glib:nick="conference">
- </member>
- <member name="connection"
- value="10"
- c:identifier="GST_RTSP_HDR_CONNECTION"
- glib:nick="connection">
- </member>
- <member name="content_base"
- value="11"
- c:identifier="GST_RTSP_HDR_CONTENT_BASE"
- glib:nick="content-base">
- </member>
- <member name="content_encoding"
- value="12"
- c:identifier="GST_RTSP_HDR_CONTENT_ENCODING"
- glib:nick="content-encoding">
- </member>
- <member name="content_language"
- value="13"
- c:identifier="GST_RTSP_HDR_CONTENT_LANGUAGE"
- glib:nick="content-language">
- </member>
- <member name="content_length"
- value="14"
- c:identifier="GST_RTSP_HDR_CONTENT_LENGTH"
- glib:nick="content-length">
- </member>
- <member name="content_location"
- value="15"
- c:identifier="GST_RTSP_HDR_CONTENT_LOCATION"
- glib:nick="content-location">
- </member>
- <member name="content_type"
- value="16"
- c:identifier="GST_RTSP_HDR_CONTENT_TYPE"
- glib:nick="content-type">
- </member>
- <member name="cseq"
- value="17"
- c:identifier="GST_RTSP_HDR_CSEQ"
- glib:nick="cseq">
- </member>
- <member name="date"
- value="18"
- c:identifier="GST_RTSP_HDR_DATE"
- glib:nick="date">
- </member>
- <member name="expires"
- value="19"
- c:identifier="GST_RTSP_HDR_EXPIRES"
- glib:nick="expires">
- </member>
- <member name="from"
- value="20"
- c:identifier="GST_RTSP_HDR_FROM"
- glib:nick="from">
- </member>
- <member name="if_modified_since"
- value="21"
- c:identifier="GST_RTSP_HDR_IF_MODIFIED_SINCE"
- glib:nick="if-modified-since">
- </member>
- <member name="last_modified"
- value="22"
- c:identifier="GST_RTSP_HDR_LAST_MODIFIED"
- glib:nick="last-modified">
- </member>
- <member name="proxy_authenticate"
- value="23"
- c:identifier="GST_RTSP_HDR_PROXY_AUTHENTICATE"
- glib:nick="proxy-authenticate">
- </member>
- <member name="proxy_require"
- value="24"
- c:identifier="GST_RTSP_HDR_PROXY_REQUIRE"
- glib:nick="proxy-require">
- </member>
- <member name="public"
- value="25"
- c:identifier="GST_RTSP_HDR_PUBLIC"
- glib:nick="public">
- </member>
- <member name="range"
- value="26"
- c:identifier="GST_RTSP_HDR_RANGE"
- glib:nick="range">
- </member>
- <member name="referer"
- value="27"
- c:identifier="GST_RTSP_HDR_REFERER"
- glib:nick="referer">
- </member>
- <member name="require"
- value="28"
- c:identifier="GST_RTSP_HDR_REQUIRE"
- glib:nick="require">
- </member>
- <member name="retry_after"
- value="29"
- c:identifier="GST_RTSP_HDR_RETRY_AFTER"
- glib:nick="retry-after">
- </member>
- <member name="rtp_info"
- value="30"
- c:identifier="GST_RTSP_HDR_RTP_INFO"
- glib:nick="rtp-info">
- </member>
- <member name="scale"
- value="31"
- c:identifier="GST_RTSP_HDR_SCALE"
- glib:nick="scale">
- </member>
- <member name="session"
- value="32"
- c:identifier="GST_RTSP_HDR_SESSION"
- glib:nick="session">
- </member>
- <member name="server"
- value="33"
- c:identifier="GST_RTSP_HDR_SERVER"
- glib:nick="server">
- </member>
- <member name="speed"
- value="34"
- c:identifier="GST_RTSP_HDR_SPEED"
- glib:nick="speed">
- </member>
- <member name="transport"
- value="35"
- c:identifier="GST_RTSP_HDR_TRANSPORT"
- glib:nick="transport">
- </member>
- <member name="unsupported"
- value="36"
- c:identifier="GST_RTSP_HDR_UNSUPPORTED"
- glib:nick="unsupported">
- </member>
- <member name="user_agent"
- value="37"
- c:identifier="GST_RTSP_HDR_USER_AGENT"
- glib:nick="user-agent">
- </member>
- <member name="via"
- value="38"
- c:identifier="GST_RTSP_HDR_VIA"
- glib:nick="via">
- </member>
- <member name="www_authenticate"
- value="39"
- c:identifier="GST_RTSP_HDR_WWW_AUTHENTICATE"
- glib:nick="www-authenticate">
- </member>
- <member name="client_challenge"
- value="40"
- c:identifier="GST_RTSP_HDR_CLIENT_CHALLENGE"
- glib:nick="client-challenge">
- </member>
- <member name="real_challenge1"
- value="41"
- c:identifier="GST_RTSP_HDR_REAL_CHALLENGE1"
- glib:nick="real-challenge1">
- </member>
- <member name="real_challenge2"
- value="42"
- c:identifier="GST_RTSP_HDR_REAL_CHALLENGE2"
- glib:nick="real-challenge2">
- </member>
- <member name="real_challenge3"
- value="43"
- c:identifier="GST_RTSP_HDR_REAL_CHALLENGE3"
- glib:nick="real-challenge3">
- </member>
- <member name="subscribe"
- value="44"
- c:identifier="GST_RTSP_HDR_SUBSCRIBE"
- glib:nick="subscribe">
- </member>
- <member name="alert"
- value="45"
- c:identifier="GST_RTSP_HDR_ALERT"
- glib:nick="alert">
- </member>
- <member name="client_id"
- value="46"
- c:identifier="GST_RTSP_HDR_CLIENT_ID"
- glib:nick="client-id">
- </member>
- <member name="company_id"
- value="47"
- c:identifier="GST_RTSP_HDR_COMPANY_ID"
- glib:nick="company-id">
- </member>
- <member name="guid"
- value="48"
- c:identifier="GST_RTSP_HDR_GUID"
- glib:nick="guid">
- </member>
- <member name="region_data"
- value="49"
- c:identifier="GST_RTSP_HDR_REGION_DATA"
- glib:nick="region-data">
- </member>
- <member name="max_asm_width"
- value="50"
- c:identifier="GST_RTSP_HDR_MAX_ASM_WIDTH"
- glib:nick="max-asm-width">
- </member>
- <member name="language"
- value="51"
- c:identifier="GST_RTSP_HDR_LANGUAGE"
- glib:nick="language">
- </member>
- <member name="player_start_time"
- value="52"
- c:identifier="GST_RTSP_HDR_PLAYER_START_TIME"
- glib:nick="player-start-time">
- </member>
- <member name="location"
- value="53"
- c:identifier="GST_RTSP_HDR_LOCATION"
- glib:nick="location">
- </member>
- <member name="etag"
- value="54"
- c:identifier="GST_RTSP_HDR_ETAG"
- glib:nick="etag">
- </member>
- <member name="if_match"
- value="55"
- c:identifier="GST_RTSP_HDR_IF_MATCH"
- glib:nick="if-match">
- </member>
- <member name="accept_charset"
- value="56"
- c:identifier="GST_RTSP_HDR_ACCEPT_CHARSET"
- glib:nick="accept-charset">
- </member>
- <member name="supported"
- value="57"
- c:identifier="GST_RTSP_HDR_SUPPORTED"
- glib:nick="supported">
- </member>
- <member name="vary"
- value="58"
- c:identifier="GST_RTSP_HDR_VARY"
- glib:nick="vary">
- </member>
- <member name="x_accelerate_streaming"
- value="59"
- c:identifier="GST_RTSP_HDR_X_ACCELERATE_STREAMING"
- glib:nick="x-accelerate-streaming">
- </member>
- <member name="x_accept_authent"
- value="60"
- c:identifier="GST_RTSP_HDR_X_ACCEPT_AUTHENT"
- glib:nick="x-accept-authent">
- </member>
- <member name="x_accept_proxy_authent"
- value="61"
- c:identifier="GST_RTSP_HDR_X_ACCEPT_PROXY_AUTHENT"
- glib:nick="x-accept-proxy-authent">
- </member>
- <member name="x_broadcast_id"
- value="62"
- c:identifier="GST_RTSP_HDR_X_BROADCAST_ID"
- glib:nick="x-broadcast-id">
- </member>
- <member name="x_burst_streaming"
- value="63"
- c:identifier="GST_RTSP_HDR_X_BURST_STREAMING"
- glib:nick="x-burst-streaming">
- </member>
- <member name="x_notice"
- value="64"
- c:identifier="GST_RTSP_HDR_X_NOTICE"
- glib:nick="x-notice">
- </member>
- <member name="x_player_lag_time"
- value="65"
- c:identifier="GST_RTSP_HDR_X_PLAYER_LAG_TIME"
- glib:nick="x-player-lag-time">
- </member>
- <member name="x_playlist"
- value="66"
- c:identifier="GST_RTSP_HDR_X_PLAYLIST"
- glib:nick="x-playlist">
- </member>
- <member name="x_playlist_change_notice"
- value="67"
- c:identifier="GST_RTSP_HDR_X_PLAYLIST_CHANGE_NOTICE"
- glib:nick="x-playlist-change-notice">
- </member>
- <member name="x_playlist_gen_id"
- value="68"
- c:identifier="GST_RTSP_HDR_X_PLAYLIST_GEN_ID"
- glib:nick="x-playlist-gen-id">
- </member>
- <member name="x_playlist_seek_id"
- value="69"
- c:identifier="GST_RTSP_HDR_X_PLAYLIST_SEEK_ID"
- glib:nick="x-playlist-seek-id">
- </member>
- <member name="x_proxy_client_agent"
- value="70"
- c:identifier="GST_RTSP_HDR_X_PROXY_CLIENT_AGENT"
- glib:nick="x-proxy-client-agent">
- </member>
- <member name="x_proxy_client_verb"
- value="71"
- c:identifier="GST_RTSP_HDR_X_PROXY_CLIENT_VERB"
- glib:nick="x-proxy-client-verb">
- </member>
- <member name="x_receding_playlistchange"
- value="72"
- c:identifier="GST_RTSP_HDR_X_RECEDING_PLAYLISTCHANGE"
- glib:nick="x-receding-playlistchange">
- </member>
- <member name="x_rtp_info"
- value="73"
- c:identifier="GST_RTSP_HDR_X_RTP_INFO"
- glib:nick="x-rtp-info">
- </member>
- <member name="x_startupprofile"
- value="74"
- c:identifier="GST_RTSP_HDR_X_STARTUPPROFILE"
- glib:nick="x-startupprofile">
- </member>
- <member name="timestamp"
- value="75"
- c:identifier="GST_RTSP_HDR_TIMESTAMP"
- glib:nick="timestamp">
- </member>
- <member name="authentication_info"
- value="76"
- c:identifier="GST_RTSP_HDR_AUTHENTICATION_INFO"
- glib:nick="authentication-info">
- </member>
- <member name="host"
- value="77"
- c:identifier="GST_RTSP_HDR_HOST"
- glib:nick="host">
- </member>
- <member name="pragma"
- value="78"
- c:identifier="GST_RTSP_HDR_PRAGMA"
- glib:nick="pragma">
- </member>
- <member name="x_server_ip_address"
- value="79"
- c:identifier="GST_RTSP_HDR_X_SERVER_IP_ADDRESS"
- glib:nick="x-server-ip-address">
- </member>
- <member name="x_sessioncookie"
- value="80"
- c:identifier="GST_RTSP_HDR_X_SESSIONCOOKIE"
- glib:nick="x-sessioncookie">
- </member>
- <member name="rtcp_interval"
- value="81"
- c:identifier="GST_RTSP_HDR_RTCP_INTERVAL"
- glib:nick="rtcp-interval">
- </member>
- <member name="keymgmt"
- value="82"
- c:identifier="GST_RTSP_HDR_KEYMGMT"
- glib:nick="keymgmt">
- </member>
- <member name="pipelined_requests"
- value="83"
- c:identifier="GST_RTSP_HDR_PIPELINED_REQUESTS"
- glib:nick="pipelined-requests">
- </member>
- <member name="media_properties"
- value="84"
- c:identifier="GST_RTSP_HDR_MEDIA_PROPERTIES"
- glib:nick="media-properties">
- </member>
- <member name="seek_style"
- value="85"
- c:identifier="GST_RTSP_HDR_SEEK_STYLE"
- glib:nick="seek-style">
- </member>
- <member name="accept_ranges"
- value="86"
- c:identifier="GST_RTSP_HDR_ACCEPT_RANGES"
- glib:nick="accept-ranges">
- </member>
- <member name="frames"
- value="87"
- c:identifier="GST_RTSP_HDR_FRAMES"
- glib:nick="frames">
- </member>
- <member name="rate_control"
- value="88"
- c:identifier="GST_RTSP_HDR_RATE_CONTROL"
- glib:nick="rate-control">
- </member>
- <member name="last"
- value="89"
- c:identifier="GST_RTSP_HDR_LAST"
- glib:nick="last">
- </member>
- </enumeration>
- <bitfield name="RTSPLowerTrans"
- glib:type-name="GstRTSPLowerTrans"
- glib:get-type="gst_rtsp_lower_trans_get_type"
- c:type="GstRTSPLowerTrans">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="86">The different transport methods.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_RTSP_LOWER_TRANS_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="88">invalid transport flag</doc>
- </member>
- <member name="udp"
- value="1"
- c:identifier="GST_RTSP_LOWER_TRANS_UDP"
- glib:nick="udp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="89">stream data over UDP</doc>
- </member>
- <member name="udp_mcast"
- value="2"
- c:identifier="GST_RTSP_LOWER_TRANS_UDP_MCAST"
- glib:nick="udp-mcast">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="90">stream data over UDP multicast</doc>
- </member>
- <member name="tcp"
- value="4"
- c:identifier="GST_RTSP_LOWER_TRANS_TCP"
- glib:nick="tcp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="91">stream data over TCP</doc>
- </member>
- <member name="http"
- value="16"
- c:identifier="GST_RTSP_LOWER_TRANS_HTTP"
- glib:nick="http">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="92">stream data tunneled over HTTP.</doc>
- </member>
- <member name="tls"
- value="32"
- c:identifier="GST_RTSP_LOWER_TRANS_TLS"
- glib:nick="tls">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="93">encrypt TCP and HTTP with TLS</doc>
- </member>
- </bitfield>
- <record name="RTSPMessage"
- c:type="GstRTSPMessage"
- glib:type-name="GstRTSPMessage"
- glib:get-type="gst_rtsp_msg_get_type"
- c:symbol-prefix="rtsp_msg">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="45">Provides methods for creating and parsing request, response and data messages.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="109"/>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="76">the message type</doc>
- <type name="RTSPMsgType" c:type="GstRTSPMsgType"/>
- </field>
- <union name="type_data" c:type="type_data">
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="99"/>
- <record name="request" c:type="request">
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="90"/>
- <field name="method" writable="1">
- <type name="RTSPMethod" c:type="GstRTSPMethod"/>
- </field>
- <field name="uri" writable="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="version" writable="1">
- <type name="RTSPVersion" c:type="GstRTSPVersion"/>
- </field>
- </record>
- <record name="response" c:type="response">
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="95"/>
- <field name="code" writable="1">
- <type name="RTSPStatusCode" c:type="GstRTSPStatusCode"/>
- </field>
- <field name="reason" writable="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="version" writable="1">
- <type name="RTSPVersion" c:type="GstRTSPVersion"/>
- </field>
- </record>
- <record name="data" c:type="data">
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="98"/>
- <field name="channel" writable="1">
- <type name="guint8" c:type="guint8"/>
- </field>
- </record>
- </union>
- <field name="hdr_fields" readable="0" private="1">
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="body" readable="0" private="1">
- <type name="guint8" c:type="guint8*"/>
- </field>
- <field name="body_size" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="body_buffer" readable="0" private="1">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="add_header" c:identifier="gst_rtsp_message_add_header">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="628">Add a header with key @field and @value to @msg. This function takes a copy
-of @value.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="193"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="637">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="630">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="631">a #GstRTSPHeaderField</doc>
- <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="632">the value of the header</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_header_by_name"
- c:identifier="gst_rtsp_message_add_header_by_name"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="722">Add a header with key @header and @value to @msg. This function takes a copy
-of @value.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="214"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="731">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="724">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="header" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="725">header string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="726">the value of the header</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="append_headers"
- c:identifier="gst_rtsp_message_append_headers">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="895">Append the currently configured headers in @msg to the #GString @str suitable
-for transmission.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="237"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="903">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="897">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="str" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="898">a string</doc>
- <type name="GLib.String" c:type="GString*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_rtsp_message_copy" version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="539">Allocate a new copy of @msg and store the result in @copy. The value in
-@copy should be release with gst_rtsp_message_free function.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="132"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="547">a #GstRTSPResult</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="541">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="copy"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="542">pointer to new #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
- </parameter>
- </parameters>
- </method>
- <method name="dump" c:identifier="gst_rtsp_message_dump">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1193">Dump the contents of @msg to stdout.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="343"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1199">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1195">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_rtsp_message_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="517">Free the memory used by @msg.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="130"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="523">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="519">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_body" c:identifier="gst_rtsp_message_get_body">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="975">Get the body of @msg. @data remains valid for as long as @msg is valid and
-unchanged.
-
-If the message body was set as a #GstBuffer before this will cause the data
-to be copied and stored in the message. The #GstBuffer will no longer be
-kept in the message.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="253"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="988">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="977">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="978">location for the data</doc>
- <array length="1" zero-terminated="0" c:type="guint8**">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="979">location for the size of @data</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_body_buffer"
- c:identifier="gst_rtsp_message_get_body_buffer"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1099">Get the body of @msg. @buffer remains valid for as long as @msg is valid and
-unchanged.
-
-If body data was set from raw memory instead of a #GstBuffer this function
-will always return %NULL. The caller can check if there is a body buffer by
-calling gst_rtsp_message_has_body_buffer().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="271"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1111">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1101">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1102">location for the buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_header" c:identifier="gst_rtsp_message_get_header">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="683">Get the @indx header value with key @field from @msg. The result in @value
-stays valid as long as it remains present in @msg.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="208"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="693">#GST_RTSP_OK when @field was found, #GST_RTSP_ENOTIMPL if the key
-was not found.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="685">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="686">a #GstRTSPHeaderField</doc>
- <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="687">pointer to hold the result</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- <parameter name="indx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="688">the index of the header</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_header_by_name"
- c:identifier="gst_rtsp_message_get_header_by_name"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="857">Get the @index header value with key @header from @msg. The result in @value
-stays valid as long as it remains present in @msg.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="229"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="867">#GST_RTSP_OK when @field was found, #GST_RTSP_ENOTIMPL if the key
-was not found.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="859">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="header" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="860">a #GstRTSPHeaderField</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="861">pointer to hold the result</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="862">the index of the header</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_type" c:identifier="gst_rtsp_message_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="159">Get the message type of @msg.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="136"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="165">the message type.</doc>
- <type name="RTSPMsgType" c:type="GstRTSPMsgType"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="161">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_body_buffer"
- c:identifier="gst_rtsp_message_has_body_buffer"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1160">Checks if @msg has a body and the body is stored as #GstBuffer.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="279"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1166">%TRUE if @msg has a body and it's stored as #GstBuffer, %FALSE
-otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1162">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_rtsp_message_init">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="137">Initialize @msg. This function is mostly used when @msg is allocated on the
-stack. The reverse operation of this is gst_rtsp_message_unset().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="124"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="144">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="139">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init_data" c:identifier="gst_rtsp_message_init_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="422">Initialize a new data #GstRTSPMessage for @channel.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="183"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="429">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="424">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="425">a channel</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="init_request" c:identifier="gst_rtsp_message_init_request">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="202">Initialize @msg as a request message with @method and @uri. To clear @msg
-again, use gst_rtsp_message_unset().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="146"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="211">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="204">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="205">the request method to use</doc>
- <type name="RTSPMethod" c:type="GstRTSPMethod"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="206">the uri of the request</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="init_response"
- c:identifier="gst_rtsp_message_init_response">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="296">Initialize @msg with @code and @reason.
-
-When @reason is %NULL, the default reason for @code will be used.
-
-When @request is not %NULL, the relevant headers will be copied to the new
-response message.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="165"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="310">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="298">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="code" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="299">the status code</doc>
- <type name="RTSPStatusCode" c:type="GstRTSPStatusCode"/>
- </parameter>
- <parameter name="reason"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="300">the status reason or %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="request"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="301">the request that triggered the response or %NULL</doc>
- <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_auth_credentials"
- c:identifier="gst_rtsp_message_parse_auth_credentials"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1441">Parses the credentials given in a WWW-Authenticate or Authorization header.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="325"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1448">
- %NULL-terminated array of GstRTSPAuthCredential or %NULL.</doc>
- <array c:type="GstRTSPAuthCredential**">
- <type name="RTSPAuthCredential" c:type="GstRTSPAuthCredential*"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1443">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1444">a #GstRTSPHeaderField</doc>
- <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_data" c:identifier="gst_rtsp_message_parse_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="444">Parse the data message @msg and store the channel in @channel.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="187"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="451">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="446">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="channel"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="447">location to hold the channel</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_request"
- c:identifier="gst_rtsp_message_parse_request">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="231">Parse the request message @msg and store the values @method, @uri and
-@version. The result locations can be %NULL if one is not interested in its
-value.
-
-@uri remains valid for as long as @msg is valid and unchanged.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="151"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="244">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="233">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="method"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="234">location to hold the method</doc>
- <type name="RTSPMethod" c:type="GstRTSPMethod*"/>
- </parameter>
- <parameter name="uri"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="235">location to hold the uri</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- <parameter name="version"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="236">location to hold the version</doc>
- <type name="RTSPVersion" c:type="GstRTSPVersion*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_response"
- c:identifier="gst_rtsp_message_parse_response">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="365">Parse the response message @msg and store the values @code, @reason and
-@version. The result locations can be %NULL if one is not interested in its
-value.
-
-@reason remains valid for as long as @msg is valid and unchanged.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="171"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="378">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="367">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="code"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="368">location to hold the status code</doc>
- <type name="RTSPStatusCode" c:type="GstRTSPStatusCode*"/>
- </parameter>
- <parameter name="reason"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="369">location to hold the status reason</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- <parameter name="version"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="370">location to hold the version</doc>
- <type name="RTSPVersion" c:type="GstRTSPVersion*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_header"
- c:identifier="gst_rtsp_message_remove_header">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="646">Remove the @indx header with key @field from @msg. If @indx equals -1, all
-headers will be removed.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="203"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="655">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="648">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="649">a #GstRTSPHeaderField</doc>
- <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
- </parameter>
- <parameter name="indx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="650">the index of the header</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_header_by_name"
- c:identifier="gst_rtsp_message_remove_header_by_name"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="817">Remove the @index header with key @header from @msg. If @index equals -1,
-all matching headers will be removed.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="224"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="826">a #GstRTSPResult</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="819">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="header" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="820">the header string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="index" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="821">the index of the header</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_body" c:identifier="gst_rtsp_message_set_body">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="929">Set the body of @msg to a copy of @data. Any existing body or body buffer
-will be replaced by the new body.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="243"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="938">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="931">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="932">the data</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="933">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_body_buffer"
- c:identifier="gst_rtsp_message_set_body_buffer"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1051">Set the body of @msg to @buffer. Any existing body or body buffer
-will be replaced by the new body.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="263"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1059">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1053">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1054">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="steal_body" c:identifier="gst_rtsp_message_steal_body">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1014">Take the body of @msg and store it in @data and @size. After this method,
-the body and size of @msg will be set to %NULL and 0 respectively.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="258"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1023">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1016">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1017">location for the data</doc>
- <array length="1" zero-terminated="0" c:type="guint8**">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1018">location for the size of @data</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="steal_body_buffer"
- c:identifier="gst_rtsp_message_steal_body_buffer"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1127">Take the body of @msg and store it in @buffer. After this method,
-the body and size of @msg will be set to %NULL and 0 respectively.
-
-If body data was set from raw memory instead of a #GstBuffer this function
-will always return %NULL. The caller can check if there is a body buffer by
-calling gst_rtsp_message_has_body_buffer().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="275"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1139">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1129">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1130">location for the buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </method>
- <method name="take_body" c:identifier="gst_rtsp_message_take_body">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="949">Set the body of @msg to @data and @size. This method takes ownership of
-@data. Any existing body or body buffer will be replaced by the new body.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="248"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="958">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="951">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="952">the data</doc>
- <array length="1" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="953">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="take_body_buffer"
- c:identifier="gst_rtsp_message_take_body_buffer"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1072">Set the body of @msg to @buffer. This method takes ownership of @buffer.
-Any existing body or body buffer will be replaced by the new body.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="267"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1080">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1074">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1075">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="take_header" c:identifier="gst_rtsp_message_take_header">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="599">Add a header with key @field and @value to @msg. This function takes
-ownership of @value.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="198"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="608">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="601">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="602">a #GstRTSPHeaderField</doc>
- <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
- </parameter>
- <parameter name="value" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="603">the value of the header</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="take_header_by_name"
- c:identifier="gst_rtsp_message_take_header_by_name"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="752">Add a header with key @header and @value to @msg. This function takes
-ownership of @value, but not of @header.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="219"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="761">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="754">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- <parameter name="header" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="755">a header string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="756">the value of the header</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="unset" c:identifier="gst_rtsp_message_unset">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="465">Unset the contents of @msg so that it becomes an uninitialized
-#GstRTSPMessage again. This function is mostly used in combination with
-gst_rtsp_message_init_request(), gst_rtsp_message_init_response() and
-gst_rtsp_message_init_data() on stack allocated #GstRTSPMessage structures.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="127"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="474">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="467">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <bitfield name="RTSPMethod"
- glib:type-name="GstRTSPMethod"
- glib:get-type="gst_rtsp_method_get_type"
- c:type="GstRTSPMethod">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="173">The different supported RTSP methods.</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_RTSP_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="175">invalid method</doc>
- </member>
- <member name="describe"
- value="1"
- c:identifier="GST_RTSP_DESCRIBE"
- glib:nick="describe">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="176">the DESCRIBE method</doc>
- </member>
- <member name="announce"
- value="2"
- c:identifier="GST_RTSP_ANNOUNCE"
- glib:nick="announce">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="177">the ANNOUNCE method</doc>
- </member>
- <member name="get_parameter"
- value="4"
- c:identifier="GST_RTSP_GET_PARAMETER"
- glib:nick="get-parameter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="178">the GET_PARAMETER method</doc>
- </member>
- <member name="options"
- value="8"
- c:identifier="GST_RTSP_OPTIONS"
- glib:nick="options">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="179">the OPTIONS method</doc>
- </member>
- <member name="pause"
- value="16"
- c:identifier="GST_RTSP_PAUSE"
- glib:nick="pause">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="180">the PAUSE method</doc>
- </member>
- <member name="play"
- value="32"
- c:identifier="GST_RTSP_PLAY"
- glib:nick="play">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="181">the PLAY method</doc>
- </member>
- <member name="record"
- value="64"
- c:identifier="GST_RTSP_RECORD"
- glib:nick="record">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="182">the RECORD method</doc>
- </member>
- <member name="redirect"
- value="128"
- c:identifier="GST_RTSP_REDIRECT"
- glib:nick="redirect">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="183">the REDIRECT method</doc>
- </member>
- <member name="setup"
- value="256"
- c:identifier="GST_RTSP_SETUP"
- glib:nick="setup">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="184">the SETUP method</doc>
- </member>
- <member name="set_parameter"
- value="512"
- c:identifier="GST_RTSP_SET_PARAMETER"
- glib:nick="set-parameter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="185">the SET_PARAMETER method</doc>
- </member>
- <member name="teardown"
- value="1024"
- c:identifier="GST_RTSP_TEARDOWN"
- glib:nick="teardown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="186">the TEARDOWN method</doc>
- </member>
- <member name="get"
- value="2048"
- c:identifier="GST_RTSP_GET"
- glib:nick="get">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="187">the GET method (HTTP).</doc>
- </member>
- <member name="post"
- value="4096"
- c:identifier="GST_RTSP_POST"
- glib:nick="post">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="188">the POST method (HTTP).</doc>
- </member>
- <function name="as_text" c:identifier="gst_rtsp_method_as_text">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="310">Convert @method to a string.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="409"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="316">a string representation of @method.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="312">a #GstRTSPMethod</doc>
- <type name="RTSPMethod" c:type="GstRTSPMethod"/>
- </parameter>
- </parameters>
- </function>
- </bitfield>
- <enumeration name="RTSPMsgType"
- glib:type-name="GstRTSPMsgType"
- glib:get-type="gst_rtsp_msg_type_get_type"
- c:type="GstRTSPMsgType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="51">The type of a message.</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_RTSP_MESSAGE_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="53">invalid message type</doc>
- </member>
- <member name="request"
- value="1"
- c:identifier="GST_RTSP_MESSAGE_REQUEST"
- glib:nick="request">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="54">RTSP request message</doc>
- </member>
- <member name="response"
- value="2"
- c:identifier="GST_RTSP_MESSAGE_RESPONSE"
- glib:nick="response">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="55">RTSP response message</doc>
- </member>
- <member name="http_request"
- value="3"
- c:identifier="GST_RTSP_MESSAGE_HTTP_REQUEST"
- glib:nick="http-request">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="56">HTTP request message.</doc>
- </member>
- <member name="http_response"
- value="4"
- c:identifier="GST_RTSP_MESSAGE_HTTP_RESPONSE"
- glib:nick="http-response">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="57">HTTP response message.</doc>
- </member>
- <member name="data"
- value="5"
- c:identifier="GST_RTSP_MESSAGE_DATA"
- glib:nick="data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="58">data message</doc>
- </member>
- </enumeration>
- <bitfield name="RTSPProfile"
- glib:type-name="GstRTSPProfile"
- glib:get-type="gst_rtsp_profile_get_type"
- c:type="GstRTSPProfile">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="66">The transfer profile to use.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_RTSP_PROFILE_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="68">invalid profile</doc>
- </member>
- <member name="avp"
- value="1"
- c:identifier="GST_RTSP_PROFILE_AVP"
- glib:nick="avp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="69">the Audio/Visual profile (RFC 3551)</doc>
- </member>
- <member name="savp"
- value="2"
- c:identifier="GST_RTSP_PROFILE_SAVP"
- glib:nick="savp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="70">the secure Audio/Visual profile (RFC 3711)</doc>
- </member>
- <member name="avpf"
- value="4"
- c:identifier="GST_RTSP_PROFILE_AVPF"
- glib:nick="avpf">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="71">the Audio/Visual profile with feedback (RFC 4585)</doc>
- </member>
- <member name="savpf"
- value="8"
- c:identifier="GST_RTSP_PROFILE_SAVPF"
- glib:nick="savpf">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="72">the secure Audio/Visual profile with feedback (RFC 5124)</doc>
- </member>
- </bitfield>
- <record name="RTSPRange" c:type="GstRTSPRange">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="43">Provides helper functions to deal with time ranges.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="120"/>
- <field name="min" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="111">minimum value of the range</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="max" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="112">maximum value of the range</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <function name="convert_units"
- c:identifier="gst_rtsp_range_convert_units">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="664">Converts the range in-place between different types of units.
-Ranges containing the special value #GST_RTSP_TIME_NOW can not be
-converted as these are only valid for #GST_RTSP_RANGE_NPT.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="159"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="673">%TRUE if the range could be converted</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="range" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="666">a #GstRTSPTimeRange</doc>
- <type name="RTSPTimeRange" c:type="GstRTSPTimeRange*"/>
- </parameter>
- <parameter name="unit" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="667">the unit to convert the range into</doc>
- <type name="RTSPRangeUnit" c:type="GstRTSPRangeUnit"/>
- </parameter>
- </parameters>
- </function>
- <function name="free" c:identifier="gst_rtsp_range_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="472">Free the memory allocated by @range.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="152"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="range" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="474">a #GstRTSPTimeRange</doc>
- <type name="RTSPTimeRange" c:type="GstRTSPTimeRange*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_times"
- c:identifier="gst_rtsp_range_get_times"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="565">Retrieve the minimum and maximum values from @range converted to
-#GstClockTime in @min and @max.
-
-A value of %GST_CLOCK_TIME_NONE will be used to signal #GST_RTSP_TIME_NOW
-and #GST_RTSP_TIME_END for @min and @max respectively.
-
-UTC times will be converted to nanoseconds since 1900.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="155"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="579">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="range" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="567">a #GstRTSPTimeRange</doc>
- <type name="RTSPTimeRange" c:type="const GstRTSPTimeRange*"/>
- </parameter>
- <parameter name="min"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="568">result minimum #GstClockTime</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="max"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="569">result maximum #GstClockTime</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </function>
- <function name="parse" c:identifier="gst_rtsp_range_parse">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="257">Parse @rangestr to a #GstRTSPTimeRange.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="146"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="264">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="rangestr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="259">a range string to parse</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="range"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="260">location to hold the #GstRTSPTimeRange result</doc>
- <type name="RTSPTimeRange" c:type="GstRTSPTimeRange**"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_string" c:identifier="gst_rtsp_range_to_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="421">Convert @range into a string representation.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="149"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="427">The string representation of @range. g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="range" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="423">a #GstRTSPTimeRange</doc>
- <type name="RTSPTimeRange" c:type="const GstRTSPTimeRange*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <enumeration name="RTSPRangeUnit"
- glib:type-name="GstRTSPRangeUnit"
- glib:get-type="gst_rtsp_range_unit_get_type"
- c:type="GstRTSPRangeUnit">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="53">Different possible time range units.</doc>
- <member name="smpte"
- value="0"
- c:identifier="GST_RTSP_RANGE_SMPTE"
- glib:nick="smpte">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="55">SMPTE timecode</doc>
- </member>
- <member name="smpte_30_drop"
- value="1"
- c:identifier="GST_RTSP_RANGE_SMPTE_30_DROP"
- glib:nick="smpte-30-drop">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="56">29.97 frames per second</doc>
- </member>
- <member name="smpte_25"
- value="2"
- c:identifier="GST_RTSP_RANGE_SMPTE_25"
- glib:nick="smpte-25">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="57">25 frames per second</doc>
- </member>
- <member name="npt"
- value="3"
- c:identifier="GST_RTSP_RANGE_NPT"
- glib:nick="npt">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="58">Normal play time</doc>
- </member>
- <member name="clock"
- value="4"
- c:identifier="GST_RTSP_RANGE_CLOCK"
- glib:nick="clock">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="59">Absolute time expressed as ISO 8601 timestamps</doc>
- </member>
- </enumeration>
- <enumeration name="RTSPResult"
- glib:type-name="GstRTSPResult"
- glib:get-type="gst_rtsp_result_get_type"
- c:type="GstRTSPResult">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="65">Result codes from the RTSP functions.</doc>
- <member name="ok" value="0" c:identifier="GST_RTSP_OK" glib:nick="ok">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="67">no error</doc>
- </member>
- <member name="error"
- value="-1"
- c:identifier="GST_RTSP_ERROR"
- glib:nick="error">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="68">some unspecified error occurred</doc>
- </member>
- <member name="einval"
- value="-2"
- c:identifier="GST_RTSP_EINVAL"
- glib:nick="einval">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="69">invalid arguments were provided to a function</doc>
- </member>
- <member name="eintr"
- value="-3"
- c:identifier="GST_RTSP_EINTR"
- glib:nick="eintr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="70">an operation was canceled</doc>
- </member>
- <member name="enomem"
- value="-4"
- c:identifier="GST_RTSP_ENOMEM"
- glib:nick="enomem">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="71">no memory was available for the operation</doc>
- </member>
- <member name="eresolv"
- value="-5"
- c:identifier="GST_RTSP_ERESOLV"
- glib:nick="eresolv">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="72">a host resolve error occurred</doc>
- </member>
- <member name="enotimpl"
- value="-6"
- c:identifier="GST_RTSP_ENOTIMPL"
- glib:nick="enotimpl">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="73">function not implemented</doc>
- </member>
- <member name="esys"
- value="-7"
- c:identifier="GST_RTSP_ESYS"
- glib:nick="esys">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="74">a system error occurred, errno contains more details</doc>
- </member>
- <member name="eparse"
- value="-8"
- c:identifier="GST_RTSP_EPARSE"
- glib:nick="eparse">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="75">a parsing error occurred</doc>
- </member>
- <member name="ewsastart"
- value="-9"
- c:identifier="GST_RTSP_EWSASTART"
- glib:nick="ewsastart">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="76">windows networking could not start</doc>
- </member>
- <member name="ewsaversion"
- value="-10"
- c:identifier="GST_RTSP_EWSAVERSION"
- glib:nick="ewsaversion">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="77">windows networking stack has wrong version</doc>
- </member>
- <member name="eeof"
- value="-11"
- c:identifier="GST_RTSP_EEOF"
- glib:nick="eeof">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="78">end-of-file was reached</doc>
- </member>
- <member name="enet"
- value="-12"
- c:identifier="GST_RTSP_ENET"
- glib:nick="enet">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="79">a network problem occurred, h_errno contains more details</doc>
- </member>
- <member name="enotip"
- value="-13"
- c:identifier="GST_RTSP_ENOTIP"
- glib:nick="enotip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="80">the host is not an IP host</doc>
- </member>
- <member name="etimeout"
- value="-14"
- c:identifier="GST_RTSP_ETIMEOUT"
- glib:nick="etimeout">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="81">a timeout occurred</doc>
- </member>
- <member name="etget"
- value="-15"
- c:identifier="GST_RTSP_ETGET"
- glib:nick="etget">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="82">the tunnel GET request has been performed</doc>
- </member>
- <member name="etpost"
- value="-16"
- c:identifier="GST_RTSP_ETPOST"
- glib:nick="etpost">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="83">the tunnel POST request has been performed</doc>
- </member>
- <member name="elast"
- value="-17"
- c:identifier="GST_RTSP_ELAST"
- glib:nick="elast">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="84">last error</doc>
- </member>
- </enumeration>
- <enumeration name="RTSPState"
- glib:type-name="GstRTSPState"
- glib:get-type="gst_rtsp_state_get_type"
- c:type="GstRTSPState">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="137">The different RTSP states.</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_RTSP_STATE_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="139">invalid state</doc>
- </member>
- <member name="init"
- value="1"
- c:identifier="GST_RTSP_STATE_INIT"
- glib:nick="init">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="140">initializing</doc>
- </member>
- <member name="ready"
- value="2"
- c:identifier="GST_RTSP_STATE_READY"
- glib:nick="ready">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="141">ready for operation</doc>
- </member>
- <member name="seeking"
- value="3"
- c:identifier="GST_RTSP_STATE_SEEKING"
- glib:nick="seeking">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="142">seeking in progress</doc>
- </member>
- <member name="playing"
- value="4"
- c:identifier="GST_RTSP_STATE_PLAYING"
- glib:nick="playing">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="143">playing</doc>
- </member>
- <member name="recording"
- value="5"
- c:identifier="GST_RTSP_STATE_RECORDING"
- glib:nick="recording">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="144">recording</doc>
- </member>
- </enumeration>
- <enumeration name="RTSPStatusCode"
- glib:type-name="GstRTSPStatusCode"
- glib:get-type="gst_rtsp_status_code_get_type"
- c:type="GstRTSPStatusCode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="351">Enumeration of rtsp status codes</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_RTSP_STS_INVALID"
- glib:nick="invalid">
- </member>
- <member name="continue"
- value="100"
- c:identifier="GST_RTSP_STS_CONTINUE"
- glib:nick="continue">
- </member>
- <member name="ok"
- value="200"
- c:identifier="GST_RTSP_STS_OK"
- glib:nick="ok">
- </member>
- <member name="created"
- value="201"
- c:identifier="GST_RTSP_STS_CREATED"
- glib:nick="created">
- </member>
- <member name="low_on_storage"
- value="250"
- c:identifier="GST_RTSP_STS_LOW_ON_STORAGE"
- glib:nick="low-on-storage">
- </member>
- <member name="multiple_choices"
- value="300"
- c:identifier="GST_RTSP_STS_MULTIPLE_CHOICES"
- glib:nick="multiple-choices">
- </member>
- <member name="moved_permanently"
- value="301"
- c:identifier="GST_RTSP_STS_MOVED_PERMANENTLY"
- glib:nick="moved-permanently">
- </member>
- <member name="move_temporarily"
- value="302"
- c:identifier="GST_RTSP_STS_MOVE_TEMPORARILY"
- glib:nick="move-temporarily">
- </member>
- <member name="see_other"
- value="303"
- c:identifier="GST_RTSP_STS_SEE_OTHER"
- glib:nick="see-other">
- </member>
- <member name="not_modified"
- value="304"
- c:identifier="GST_RTSP_STS_NOT_MODIFIED"
- glib:nick="not-modified">
- </member>
- <member name="use_proxy"
- value="305"
- c:identifier="GST_RTSP_STS_USE_PROXY"
- glib:nick="use-proxy">
- </member>
- <member name="bad_request"
- value="400"
- c:identifier="GST_RTSP_STS_BAD_REQUEST"
- glib:nick="bad-request">
- </member>
- <member name="unauthorized"
- value="401"
- c:identifier="GST_RTSP_STS_UNAUTHORIZED"
- glib:nick="unauthorized">
- </member>
- <member name="payment_required"
- value="402"
- c:identifier="GST_RTSP_STS_PAYMENT_REQUIRED"
- glib:nick="payment-required">
- </member>
- <member name="forbidden"
- value="403"
- c:identifier="GST_RTSP_STS_FORBIDDEN"
- glib:nick="forbidden">
- </member>
- <member name="not_found"
- value="404"
- c:identifier="GST_RTSP_STS_NOT_FOUND"
- glib:nick="not-found">
- </member>
- <member name="method_not_allowed"
- value="405"
- c:identifier="GST_RTSP_STS_METHOD_NOT_ALLOWED"
- glib:nick="method-not-allowed">
- </member>
- <member name="not_acceptable"
- value="406"
- c:identifier="GST_RTSP_STS_NOT_ACCEPTABLE"
- glib:nick="not-acceptable">
- </member>
- <member name="proxy_auth_required"
- value="407"
- c:identifier="GST_RTSP_STS_PROXY_AUTH_REQUIRED"
- glib:nick="proxy-auth-required">
- </member>
- <member name="request_timeout"
- value="408"
- c:identifier="GST_RTSP_STS_REQUEST_TIMEOUT"
- glib:nick="request-timeout">
- </member>
- <member name="gone"
- value="410"
- c:identifier="GST_RTSP_STS_GONE"
- glib:nick="gone">
- </member>
- <member name="length_required"
- value="411"
- c:identifier="GST_RTSP_STS_LENGTH_REQUIRED"
- glib:nick="length-required">
- </member>
- <member name="precondition_failed"
- value="412"
- c:identifier="GST_RTSP_STS_PRECONDITION_FAILED"
- glib:nick="precondition-failed">
- </member>
- <member name="request_entity_too_large"
- value="413"
- c:identifier="GST_RTSP_STS_REQUEST_ENTITY_TOO_LARGE"
- glib:nick="request-entity-too-large">
- </member>
- <member name="request_uri_too_large"
- value="414"
- c:identifier="GST_RTSP_STS_REQUEST_URI_TOO_LARGE"
- glib:nick="request-uri-too-large">
- </member>
- <member name="unsupported_media_type"
- value="415"
- c:identifier="GST_RTSP_STS_UNSUPPORTED_MEDIA_TYPE"
- glib:nick="unsupported-media-type">
- </member>
- <member name="parameter_not_understood"
- value="451"
- c:identifier="GST_RTSP_STS_PARAMETER_NOT_UNDERSTOOD"
- glib:nick="parameter-not-understood">
- </member>
- <member name="conference_not_found"
- value="452"
- c:identifier="GST_RTSP_STS_CONFERENCE_NOT_FOUND"
- glib:nick="conference-not-found">
- </member>
- <member name="not_enough_bandwidth"
- value="453"
- c:identifier="GST_RTSP_STS_NOT_ENOUGH_BANDWIDTH"
- glib:nick="not-enough-bandwidth">
- </member>
- <member name="session_not_found"
- value="454"
- c:identifier="GST_RTSP_STS_SESSION_NOT_FOUND"
- glib:nick="session-not-found">
- </member>
- <member name="method_not_valid_in_this_state"
- value="455"
- c:identifier="GST_RTSP_STS_METHOD_NOT_VALID_IN_THIS_STATE"
- glib:nick="method-not-valid-in-this-state">
- </member>
- <member name="header_field_not_valid_for_resource"
- value="456"
- c:identifier="GST_RTSP_STS_HEADER_FIELD_NOT_VALID_FOR_RESOURCE"
- glib:nick="header-field-not-valid-for-resource">
- </member>
- <member name="invalid_range"
- value="457"
- c:identifier="GST_RTSP_STS_INVALID_RANGE"
- glib:nick="invalid-range">
- </member>
- <member name="parameter_is_readonly"
- value="458"
- c:identifier="GST_RTSP_STS_PARAMETER_IS_READONLY"
- glib:nick="parameter-is-readonly">
- </member>
- <member name="aggregate_operation_not_allowed"
- value="459"
- c:identifier="GST_RTSP_STS_AGGREGATE_OPERATION_NOT_ALLOWED"
- glib:nick="aggregate-operation-not-allowed">
- </member>
- <member name="only_aggregate_operation_allowed"
- value="460"
- c:identifier="GST_RTSP_STS_ONLY_AGGREGATE_OPERATION_ALLOWED"
- glib:nick="only-aggregate-operation-allowed">
- </member>
- <member name="unsupported_transport"
- value="461"
- c:identifier="GST_RTSP_STS_UNSUPPORTED_TRANSPORT"
- glib:nick="unsupported-transport">
- </member>
- <member name="destination_unreachable"
- value="462"
- c:identifier="GST_RTSP_STS_DESTINATION_UNREACHABLE"
- glib:nick="destination-unreachable">
- </member>
- <member name="key_management_failure"
- value="463"
- c:identifier="GST_RTSP_STS_KEY_MANAGEMENT_FAILURE"
- glib:nick="key-management-failure">
- </member>
- <member name="internal_server_error"
- value="500"
- c:identifier="GST_RTSP_STS_INTERNAL_SERVER_ERROR"
- glib:nick="internal-server-error">
- </member>
- <member name="not_implemented"
- value="501"
- c:identifier="GST_RTSP_STS_NOT_IMPLEMENTED"
- glib:nick="not-implemented">
- </member>
- <member name="bad_gateway"
- value="502"
- c:identifier="GST_RTSP_STS_BAD_GATEWAY"
- glib:nick="bad-gateway">
- </member>
- <member name="service_unavailable"
- value="503"
- c:identifier="GST_RTSP_STS_SERVICE_UNAVAILABLE"
- glib:nick="service-unavailable">
- </member>
- <member name="gateway_timeout"
- value="504"
- c:identifier="GST_RTSP_STS_GATEWAY_TIMEOUT"
- glib:nick="gateway-timeout">
- </member>
- <member name="rtsp_version_not_supported"
- value="505"
- c:identifier="GST_RTSP_STS_RTSP_VERSION_NOT_SUPPORTED"
- glib:nick="rtsp-version-not-supported">
- </member>
- <member name="option_not_supported"
- value="551"
- c:identifier="GST_RTSP_STS_OPTION_NOT_SUPPORTED"
- glib:nick="option-not-supported">
- </member>
- </enumeration>
- <record name="RTSPTime" c:type="GstRTSPTime">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="94">A time indication.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h" line="105"/>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="96">the time of the time</doc>
- <type name="RTSPTimeType" c:type="GstRTSPTimeType"/>
- </field>
- <field name="seconds" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="97">seconds when @type is GST_RTSP_TIME_SECONDS,
- GST_RTSP_TIME_UTC and GST_RTSP_TIME_FRAMES</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- </record>
- <record name="RTSPTime2" c:type="GstRTSPTime2" version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="107">Extra fields for a time indication.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h" line="124"/>
- <field name="frames" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="109">frames and subframes when type in GstRTSPTime is
- GST_RTSP_TIME_FRAMES</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="year" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="111">year when type is GST_RTSP_TIME_UTC</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="month" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="112">month when type is GST_RTSP_TIME_UTC</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="day" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="113">day when type is GST_RTSP_TIME_UTC</doc>
- <type name="guint" c:type="guint"/>
- </field>
- </record>
- <record name="RTSPTimeRange" c:type="GstRTSPTimeRange">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="126">A time range.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h" line="143"/>
- <field name="unit" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="128">the time units used</doc>
- <type name="RTSPRangeUnit" c:type="GstRTSPRangeUnit"/>
- </field>
- <field name="min" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="129">the minimum interval</doc>
- <type name="RTSPTime" c:type="GstRTSPTime"/>
- </field>
- <field name="max" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="130">the maximum interval</doc>
- <type name="RTSPTime" c:type="GstRTSPTime"/>
- </field>
- <field name="min2" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="131">extra fields in the minimum interval (Since: 1.2)</doc>
- <type name="RTSPTime2" c:type="GstRTSPTime2"/>
- </field>
- <field name="max2" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="132">extra fields in the maximum interval (Since: 1.2)</doc>
- <type name="RTSPTime2" c:type="GstRTSPTime2"/>
- </field>
- </record>
- <enumeration name="RTSPTimeType"
- glib:type-name="GstRTSPTimeType"
- glib:get-type="gst_rtsp_time_type_get_type"
- c:type="GstRTSPTimeType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="76">Possible time types.</doc>
- <member name="seconds"
- value="0"
- c:identifier="GST_RTSP_TIME_SECONDS"
- glib:nick="seconds">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="78">seconds</doc>
- </member>
- <member name="now"
- value="1"
- c:identifier="GST_RTSP_TIME_NOW"
- glib:nick="now">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="79">now</doc>
- </member>
- <member name="end"
- value="2"
- c:identifier="GST_RTSP_TIME_END"
- glib:nick="end">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="80">end</doc>
- </member>
- <member name="frames"
- value="3"
- c:identifier="GST_RTSP_TIME_FRAMES"
- glib:nick="frames">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="81">frames and subframes</doc>
- </member>
- <member name="utc"
- value="4"
- c:identifier="GST_RTSP_TIME_UTC"
- glib:nick="utc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.h"
- line="82">UTC time</doc>
- </member>
- </enumeration>
- <bitfield name="RTSPTransMode"
- glib:type-name="GstRTSPTransMode"
- glib:get-type="gst_rtsp_trans_mode_get_type"
- c:type="GstRTSPTransMode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="52">The transfer mode to use.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_RTSP_TRANS_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="54">invalid tansport mode</doc>
- </member>
- <member name="rtp"
- value="1"
- c:identifier="GST_RTSP_TRANS_RTP"
- glib:nick="rtp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="55">transfer RTP data</doc>
- </member>
- <member name="rdt"
- value="2"
- c:identifier="GST_RTSP_TRANS_RDT"
- glib:nick="rdt">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="56">transfer RDT (RealMedia) data</doc>
- </member>
- </bitfield>
- <record name="RTSPTransport" c:type="GstRTSPTransport">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="44">Provides helper functions to deal with RTSP transport strings.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="172"/>
- <field name="trans" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="124">the transport mode</doc>
- <type name="RTSPTransMode" c:type="GstRTSPTransMode"/>
- </field>
- <field name="profile" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="125">the tansport profile</doc>
- <type name="RTSPProfile" c:type="GstRTSPProfile"/>
- </field>
- <field name="lower_transport" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="126">the lower transport</doc>
- <type name="RTSPLowerTrans" c:type="GstRTSPLowerTrans"/>
- </field>
- <field name="destination" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="127">the destination ip/hostname</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="source" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="128">the source ip/hostname</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="layers" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="129">the number of layers</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="mode_play" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="130">if play mode was selected</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="mode_record" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="131">if record mode was selected</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="append" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="132">is append mode was selected</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="interleaved" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="133">the interleave range</doc>
- <type name="RTSPRange" c:type="GstRTSPRange"/>
- </field>
- <field name="ttl" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="134">the time to live for multicast UDP</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="port" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="135">the port pair for multicast sessions</doc>
- <type name="RTSPRange" c:type="GstRTSPRange"/>
- </field>
- <field name="client_port" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="136">the client port pair for receiving data. For TCP
- based transports, applications can use this field to store the
- sender and receiver ports of the client.</doc>
- <type name="RTSPRange" c:type="GstRTSPRange"/>
- </field>
- <field name="server_port" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="139">the server port pair for receiving data. For TCP
- based transports, applications can use this field to store the
- sender and receiver ports of the server.</doc>
- <type name="RTSPRange" c:type="GstRTSPRange"/>
- </field>
- <field name="ssrc" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="142">the ssrc that the sender/receiver will use</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="as_text" c:identifier="gst_rtsp_transport_as_text">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="588">Convert @transport into a string that can be used to signal the transport in
-an RTSP SETUP response.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="184"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="595">a string describing the RTSP transport or %NULL when the transport
-is invalid.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="transport" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="590">a #GstRTSPTransport</doc>
- <type name="RTSPTransport" c:type="GstRTSPTransport*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_rtsp_transport_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="759">Free the memory used by @transport.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="197"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="765">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="transport" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="761">a #GstRTSPTransport</doc>
- <type name="RTSPTransport" c:type="GstRTSPTransport*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_media_type"
- c:identifier="gst_rtsp_transport_get_media_type"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="236">Get the media type of @transport. This media type is typically
-used to generate #GstCaps events.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="193"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="246">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="transport" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="238">a #GstRTSPTransport</doc>
- <type name="RTSPTransport" c:type="GstRTSPTransport*"/>
- </instance-parameter>
- <parameter name="media_type"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="239">media type of @transport</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_rtsp_transport_init">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="169">Initialize @transport so that it can be used.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="178"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="175">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="transport" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="171">a #GstRTSPTransport</doc>
- <type name="RTSPTransport" c:type="GstRTSPTransport*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="get_manager"
- c:identifier="gst_rtsp_transport_get_manager">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="279">Get the #GstElement that can handle the buffers transported over @trans.
-
-It is possible that there are several managers available, use @option to
-selected one.
-
-@manager will contain an element name or %NULL when no manager is
-needed/available for @trans.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="190"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="293">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="281">a #GstRTSPTransMode</doc>
- <type name="RTSPTransMode" c:type="GstRTSPTransMode"/>
- </parameter>
- <parameter name="manager"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="282">location to hold the result</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- <parameter name="option" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="283">option index.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_mime"
- c:identifier="gst_rtsp_transport_get_mime"
- deprecated="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="205">Get the mime type of the transport mode @trans. This mime type is typically
-used to generate #GstCaps events.</doc>
- <doc-deprecated xml:space="preserve">This functions only deals with the GstRTSPTransMode and only
- returns the mime type for #GST_RTSP_PROFILE_AVP. Use
- gst_rtsp_transport_get_media_type() instead.</doc-deprecated>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="187"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="217">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="207">a #GstRTSPTransMode</doc>
- <type name="RTSPTransMode" c:type="GstRTSPTransMode"/>
- </parameter>
- <parameter name="mime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="208">location to hold the result</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- </parameters>
- </function>
- <function name="new" c:identifier="gst_rtsp_transport_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="146">Allocate a new initialized #GstRTSPTransport. Use gst_rtsp_transport_free()
-after usage.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="175"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="153">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="transport" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="148">location to hold the new #GstRTSPTransport</doc>
- <type name="RTSPTransport" c:type="GstRTSPTransport**"/>
- </parameter>
- </parameters>
- </function>
- <function name="parse" c:identifier="gst_rtsp_transport_parse">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="433">Parse the RTSP transport string @str into @transport.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="181"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="440">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="str" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="435">a transport string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="transport" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="436">a #GstRTSPTransport</doc>
- <type name="RTSPTransport" c:type="GstRTSPTransport*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <record name="RTSPUrl"
- c:type="GstRTSPUrl"
- glib:type-name="GstRTSPUrl"
- glib:get-type="gst_rtsp_url_get_type"
- c:symbol-prefix="rtsp_url">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="43">Provides helper functions to handle RTSP urls.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspurl.h" line="87"/>
- <field name="transports" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.h"
- line="67">the transports allowed</doc>
- <type name="RTSPLowerTrans" c:type="GstRTSPLowerTrans"/>
- </field>
- <field name="family" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.h"
- line="68">the family</doc>
- <type name="RTSPFamily" c:type="GstRTSPFamily"/>
- </field>
- <field name="user" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.h"
- line="69">the user</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="passwd" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.h"
- line="70">the password</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="host" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.h"
- line="71">the host</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="port" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.h"
- line="72">the port</doc>
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="abspath" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.h"
- line="73">the absolute path</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="query" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.h"
- line="74">additional query parameters</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <method name="copy" c:identifier="gst_rtsp_url_copy">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="219">Make a copy of @url.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspurl.h" line="96"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="225">a copy of @url. Free with gst_rtsp_url_free () after usage.</doc>
- <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
- </return-value>
- <parameters>
- <instance-parameter name="url" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="221">a #GstRTSPUrl</doc>
- <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="decode_path_components"
- c:identifier="gst_rtsp_url_decode_path_components">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="434">Splits the path of @url on '/' boundaries, decoding the resulting components,
-
-The decoding performed by this routine is "URI decoding", as defined in RFC
-3986, commonly known as percent-decoding. For example, a string "foo\%2fbar"
-will decode to "foo/bar" -- the \%2f being replaced by the corresponding byte
-with hex value 0x2f. Note that there is no guarantee that the resulting byte
-sequence is valid in any given encoding. As a special case, \%00 is not
-unescaped to NUL, as that would prematurely terminate the string.
-
-Also note that since paths usually start with a slash, the first component
-will usually be the empty string.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspurl.h" line="109"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="450">%NULL-terminated array of URL components. Free with
-g_strfreev() when no longer needed.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="url" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="436">a #GstRTSPUrl</doc>
- <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_rtsp_url_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="248">Free the memory used by @url.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspurl.h" line="99"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="url" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="250">a #GstRTSPUrl</doc>
- <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_port" c:identifier="gst_rtsp_url_get_port">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="287">Get the port number of @url.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspurl.h" line="115"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="294">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="url" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="289">a #GstRTSPUrl</doc>
- <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
- </instance-parameter>
- <parameter name="port"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="290">location to hold the port</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_request_uri"
- c:identifier="gst_rtsp_url_get_request_uri">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="311">Get a newly allocated string describing the request URI for @url.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspurl.h" line="102"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="317">a string with the request URI. g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="url" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="313">a #GstRTSPUrl</doc>
- <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_request_uri_with_control"
- c:identifier="gst_rtsp_url_get_request_uri_with_control"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="326">Get a newly allocated string describing the request URI for @url
-combined with the control path for @control_path</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspurl.h" line="105"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="334">a string with the request URI combined with the control path.
-g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="url" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="328">a #GstRTSPUrl</doc>
- <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
- </instance-parameter>
- <parameter name="control_path" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="329">an RTSP aggregate control path</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_port" c:identifier="gst_rtsp_url_set_port">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="268">Set the port number in @url to @port.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspurl.h" line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="275">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="url" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="270">a #GstRTSPUrl</doc>
- <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
- </instance-parameter>
- <parameter name="port" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="271">the port</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </method>
- <function name="parse" c:identifier="gst_rtsp_url_parse">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="90">Parse the RTSP @urlstr into a newly allocated #GstRTSPUrl. Free after usage
-with gst_rtsp_url_free().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspurl.h" line="93"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="98">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="urlstr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="92">the url string to parse</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="url"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="93">location to hold the result.</doc>
- <type name="RTSPUrl" c:type="GstRTSPUrl**"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <enumeration name="RTSPVersion"
- glib:type-name="GstRTSPVersion"
- glib:get-type="gst_rtsp_version_get_type"
- c:type="GstRTSPVersion">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="157">The supported RTSP versions.</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_RTSP_VERSION_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="159">unknown/invalid version</doc>
- </member>
- <member name="1_0"
- value="16"
- c:identifier="GST_RTSP_VERSION_1_0"
- glib:nick="1-0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="160">version 1.0</doc>
- </member>
- <member name="1_1"
- value="17"
- c:identifier="GST_RTSP_VERSION_1_1"
- glib:nick="1-1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="161">version 1.1.</doc>
- </member>
- <member name="2_0"
- value="32"
- c:identifier="GST_RTSP_VERSION_2_0"
- glib:nick="2-0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="162">version 2.0.</doc>
- </member>
- <function name="as_text" c:identifier="gst_rtsp_version_as_text">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="334">Convert @version to a string.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="412"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="340">a string representation of @version.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="336">a #GstRTSPVersion</doc>
- <type name="RTSPVersion" c:type="GstRTSPVersion"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <record name="RTSPWatch" c:type="GstRTSPWatch" disguised="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="240">Opaque RTSP watch object that can be used for asynchronous RTSP
-operations.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="246"/>
- <method name="attach" c:identifier="gst_rtsp_watch_attach">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4277">Adds a #GstRTSPWatch to a context so that it will be executed within that context.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="304"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4284">the ID (greater than 0) for the watch within the GMainContext.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="watch" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4279">a #GstRTSPWatch</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </instance-parameter>
- <parameter name="context" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4280">a GMainContext (if NULL, the default context will be used)</doc>
- <type name="GLib.MainContext" c:type="GMainContext*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_send_backlog"
- c:identifier="gst_rtsp_watch_get_send_backlog"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4340">Get the maximum amount of bytes and messages that will be queued in @watch.
-See gst_rtsp_watch_set_send_backlog().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="312"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="watch" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4342">a #GstRTSPWatch</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </instance-parameter>
- <parameter name="bytes"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4343">maximum bytes</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- <parameter name="messages"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4344">maximum messages</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="reset" c:identifier="gst_rtsp_watch_reset">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4221">Reset @watch, this is usually called after gst_rtsp_connection_do_tunnel()
-when the file descriptors of the connection might have changed.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="298"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="watch" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4223">a #GstRTSPWatch</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="send_message" c:identifier="gst_rtsp_watch_send_message">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4640">Send a @message using the connection of the @watch. If it cannot be sent
-immediately, it will be queued for transmission in @watch. The contents of
-@message will then be serialized and transmitted when the connection of the
-@watch becomes writable. In case the @message is queued, the ID returned in
-@id will be non-zero and used as the ID argument in the message_sent
-callback.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="321"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4653">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="watch" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4642">a #GstRTSPWatch</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </instance-parameter>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4643">a #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="id"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4644">location for a message ID or %NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="send_messages"
- c:identifier="gst_rtsp_watch_send_messages"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4665">Sends @messages using the connection of the @watch. If they cannot be sent
-immediately, they will be queued for transmission in @watch. The contents of
-@messages will then be serialized and transmitted when the connection of the
-@watch becomes writable. In case the @messages are queued, the ID returned in
-@id will be non-zero and used as the ID argument in the message_sent
-callback once the last message is sent. The callback will only be called
-once for the last message.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="326"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4680">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="watch" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4667">a #GstRTSPWatch</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </instance-parameter>
- <parameter name="messages" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4668">the messages to send</doc>
- <array length="1" zero-terminated="0" c:type="GstRTSPMessage*">
- <type name="RTSPMessage" c:type="GstRTSPMessage"/>
- </array>
- </parameter>
- <parameter name="n_messages" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4669">the number of messages to send</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="id"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4670">location for a message ID or %NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_flushing"
- c:identifier="gst_rtsp_watch_set_flushing"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4779">When @flushing is %TRUE, abort a call to gst_rtsp_watch_wait_backlog()
-and make sure gst_rtsp_watch_write_data() returns immediately with
-#GST_RTSP_EINTR. And empty the queue.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="336"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="watch" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4781">a #GstRTSPWatch</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </instance-parameter>
- <parameter name="flushing" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4782">new flushing state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_send_backlog"
- c:identifier="gst_rtsp_watch_set_send_backlog"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4309">Set the maximum amount of bytes and messages that will be queued in @watch.
-When the maximum amounts are exceeded, gst_rtsp_watch_write_data() and
-gst_rtsp_watch_send_message() will return #GST_RTSP_ENOMEM.
-
-A value of 0 for @bytes or @messages means no limits.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="308"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="watch" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4311">a #GstRTSPWatch</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </instance-parameter>
- <parameter name="bytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4312">maximum bytes</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="messages" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4313">maximum messages</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_rtsp_watch_unref">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4294">Decreases the reference count of @watch by one. If the resulting reference
-count is zero the watch and associated memory will be destroyed.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="301"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="watch" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4296">a #GstRTSPWatch</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="wait_backlog"
- c:identifier="gst_rtsp_watch_wait_backlog"
- version="1.4"
- deprecated="1"
- deprecated-version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="5038">Wait until there is place in the backlog queue, @timeout is reached
-or @watch is set to flushing.
-
-If @timeout is %NULL this function can block forever. If @timeout
-contains a valid timeout, this function will return %GST_RTSP_ETIMEOUT
-after the timeout expired.
-
-The typically use of this function is when gst_rtsp_watch_write_data
-returns %GST_RTSP_ENOMEM. The caller then calls this function to wait for
-free space in the backlog queue and try again.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="380"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="5054">%GST_RTSP_OK when if there is room in queue.
- %GST_RTSP_ETIMEOUT when @timeout was reached.
- %GST_RTSP_EINTR when @watch is flushing
- %GST_RTSP_EINVAL when called with invalid parameters.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="watch" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="5040">a #GstRTSPWatch</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="5041">a GTimeVal timeout</doc>
- <type name="GLib.TimeVal" c:type="GTimeVal*"/>
- </parameter>
- </parameters>
- </method>
- <method name="wait_backlog_usec"
- c:identifier="gst_rtsp_watch_wait_backlog_usec"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4714">Wait until there is place in the backlog queue, @timeout is reached
-or @watch is set to flushing.
-
-If @timeout is 0 this function can block forever. If @timeout
-contains a valid timeout, this function will return %GST_RTSP_ETIMEOUT
-after the timeout expired.
-
-The typically use of this function is when gst_rtsp_watch_write_data
-returns %GST_RTSP_ENOMEM. The caller then calls this function to wait for
-free space in the backlog queue and try again.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="332"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4730">%GST_RTSP_OK when if there is room in queue.
- %GST_RTSP_ETIMEOUT when @timeout was reached.
- %GST_RTSP_EINTR when @watch is flushing
- %GST_RTSP_EINVAL when called with invalid parameters.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="watch" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4716">a #GstRTSPWatch</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </instance-parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4717">a timeout in microseconds</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="write_data" c:identifier="gst_rtsp_watch_write_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4602">Write @data using the connection of the @watch. If it cannot be sent
-immediately, it will be queued for transmission in @watch. The contents of
-@message will then be serialized and transmitted when the connection of the
-@watch becomes writable. In case the @message is queued, the ID returned in
-@id will be non-zero and used as the ID argument in the message_sent
-callback.
-
-This function will take ownership of @data and g_free() it after use.
-
-If the amount of queued data exceeds the limits set with
-gst_rtsp_watch_set_send_backlog(), this function will return
-#GST_RTSP_ENOMEM.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="316"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4622">#GST_RTSP_OK on success. #GST_RTSP_ENOMEM when the backlog limits
-are reached. #GST_RTSP_EINTR when @watch was flushing.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="watch" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4604">a #GstRTSPWatch</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4605">the data to queue</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4606">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="id"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4607">location for a message ID or %NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <function name="new"
- c:identifier="gst_rtsp_watch_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4170">Create a watch object for @conn. The functions provided in @funcs will be
-called with @user_data when activity happened on the watch.
-
-The new watch is usually created so that it can be attached to a
-maincontext with gst_rtsp_watch_attach().
-
-@conn must exist for the entire lifetime of the watch.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="292"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4185">a #GstRTSPWatch that can be used for asynchronous RTSP
-communication. Free with gst_rtsp_watch_unref () after usage.</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </return-value>
- <parameters>
- <parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4172">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </parameter>
- <parameter name="funcs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4173">watch functions</doc>
- <type name="RTSPWatchFuncs" c:type="GstRTSPWatchFuncs*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4174">user data to pass to @funcs</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4175">notify when @user_data is not referenced anymore</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <record name="RTSPWatchFuncs" c:type="GstRTSPWatchFuncs">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="248">Callback functions from a #GstRTSPWatch.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="289"/>
- <field name="message_received">
- <callback name="message_received">
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="269"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="watch" transfer-ownership="none">
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </parameter>
- <parameter name="message" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="message_sent">
- <callback name="message_sent">
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="271"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="watch" transfer-ownership="none">
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="closed">
- <callback name="closed">
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="273"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="watch" transfer-ownership="none">
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="error">
- <callback name="error">
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="274"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="watch" transfer-ownership="none">
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </parameter>
- <parameter name="result" transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="tunnel_start">
- <callback name="tunnel_start">
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="276"/>
- <return-value transfer-ownership="none">
- <type name="RTSPStatusCode" c:type="GstRTSPStatusCode"/>
- </return-value>
- <parameters>
- <parameter name="watch" transfer-ownership="none">
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="tunnel_complete">
- <callback name="tunnel_complete">
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="277"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="watch" transfer-ownership="none">
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="error_full">
- <callback name="error_full">
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="278"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="watch" transfer-ownership="none">
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </parameter>
- <parameter name="result" transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </parameter>
- <parameter name="message" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="4">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="tunnel_lost">
- <callback name="tunnel_lost">
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="281"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="watch" transfer-ownership="none">
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="tunnel_http_response">
- <callback name="tunnel_http_response">
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="282"/>
- <return-value transfer-ownership="none">
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="watch" transfer-ownership="none">
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </parameter>
- <parameter name="request" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="response" transfer-ownership="none">
- <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="3">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <function-macro name="RTSP_CHECK"
- c:identifier="GST_RTSP_CHECK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="51">Macro that checks the return value of @stmt and jumps to @label when it does
-not equal #GST_RTSP_OK.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="59"/>
- <parameters>
- <parameter name="stmt">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="53">a statement</doc>
- </parameter>
- <parameter name="label">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.h"
- line="54">a label</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="RTSP_DEFAULT_PORT"
- value="554"
- c:type="GST_RTSP_DEFAULT_PORT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.h"
- line="54">The default RTSP port to connect to.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspurl.h" line="59"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="RTSP_DEPRECATED_FOR"
- c:identifier="GST_RTSP_DEPRECATED_FOR"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtsp/rtsp-prelude.h" line="35"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTSP_EXTENSION"
- c:identifier="GST_RTSP_EXTENSION"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTSP_EXTENSION_GET_INTERFACE"
- c:identifier="GST_RTSP_EXTENSION_GET_INTERFACE"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtsp/gstrtspextension.h"
- line="39"/>
- <parameters>
- <parameter name="inst">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTSP_MESSAGE"
- c:identifier="GST_RTSP_MESSAGE"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="116"/>
- <parameters>
- <parameter name="object">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="RTSP_MESSAGE_CAST"
- c:identifier="GST_RTSP_MESSAGE_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="115"/>
- <parameters>
- <parameter name="object">
- </parameter>
- </parameters>
- </function-macro>
- <docsection name="gstrtspdefs">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="43">Provides common defines for the RTSP library.</doc>
- </docsection>
- <function name="rtsp_auth_credentials_free"
- c:identifier="gst_rtsp_auth_credentials_free"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1543">Free a %NULL-terminated array of credentials returned from
-gst_rtsp_message_parse_auth_credentials().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="328"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="credentials" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="1545">a %NULL-terminated array of #GstRTSPAuthCredential</doc>
- <type name="RTSPAuthCredential" c:type="GstRTSPAuthCredential**"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_connection_accept"
- c:identifier="gst_rtsp_connection_accept"
- moved-to="RTSPConnection.accept">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="485">Accept a new connection on @socket and create a new #GstRTSPConnection for
-handling communication on new socket.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="76"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="494">#GST_RTSP_OK when @conn contains a valid connection.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="socket" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="487">a socket</doc>
- <type name="Gio.Socket" c:type="GSocket*"/>
- </parameter>
- <parameter name="conn"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="488">storage for a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection**"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="489">a #GCancellable to cancel the operation</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_connection_create"
- c:identifier="gst_rtsp_connection_create"
- moved-to="RTSPConnection.create">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="329">Create a newly allocated #GstRTSPConnection from @url and store it in @conn.
-The connection will not yet attempt to connect to @url, use
-gst_rtsp_connection_connect().
-
-A copy of @url will be made.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="66"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="340">#GST_RTSP_OK when @conn contains a valid connection.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="url" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="331">a #GstRTSPUrl</doc>
- <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
- </parameter>
- <parameter name="conn"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="332">storage for a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection**"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_connection_create_from_socket"
- c:identifier="gst_rtsp_connection_create_from_socket"
- moved-to="RTSPConnection.create_from_socket">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="408">Create a new #GstRTSPConnection for handling communication on the existing
-socket @socket. The @initial_buffer contains zero terminated data already
-read from @socket which should be used before starting to read new data.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="420">#GST_RTSP_OK when @conn contains a valid connection.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="socket" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="410">a #GSocket</doc>
- <type name="Gio.Socket" c:type="GSocket*"/>
- </parameter>
- <parameter name="ip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="411">the IP address of the other end</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="port" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="412">the port used by the other end</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="initial_buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="413">data already read from @fd</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="conn"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="414">storage for a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection**"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_find_header_field"
- c:identifier="gst_rtsp_find_header_field">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="397">Convert @header to a #GstRTSPHeaderField.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="427"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="403">a #GstRTSPHeaderField for @header or #GST_RTSP_HDR_INVALID if the
-header field is unknown.</doc>
- <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
- </return-value>
- <parameters>
- <parameter name="header" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="399">a header string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_find_method" c:identifier="gst_rtsp_find_method">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="419">Convert @method to a #GstRTSPMethod.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="430"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="425">a #GstRTSPMethod for @method or #GST_RTSP_INVALID if the
-method is unknown.</doc>
- <type name="RTSPMethod" c:type="GstRTSPMethod"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="421">a method</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_generate_digest_auth_response"
- c:identifier="gst_rtsp_generate_digest_auth_response"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="603">Calculates the digest auth response from the values given by the server and
-the username and password. See RFC2069 for details.
-
-Currently only supported algorithm "md5".</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="436"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="618">Authentication response or %NULL if unsupported</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="algorithm"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="605">Hash algorithm to use, or %NULL for MD5</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="606">Request method, e.g. PLAY</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="realm" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="607">Realm</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="username" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="608">Username</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="password" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="609">Password</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="610">Original request URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="nonce" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="611">Nonce</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_generate_digest_auth_response_from_md5"
- c:identifier="gst_rtsp_generate_digest_auth_response_from_md5"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="644">Calculates the digest auth response from the values given by the server and
-the md5sum. See RFC2069 for details.
-
-This function is useful when the passwords are not stored in clear text,
-but instead in the same format as the .htdigest file.
-
-Currently only supported algorithm "md5".</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="445"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="660">Authentication response or %NULL if unsupported</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="algorithm"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="646">Hash algorithm to use, or %NULL for MD5</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="647">Request method, e.g. PLAY</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="md5" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="648">The md5 sum of username:realm:password</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="649">Original request URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="nonce" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="650">Nonce</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_header_allow_multiple"
- c:identifier="gst_rtsp_header_allow_multiple">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="526">Check whether @field may appear multiple times in a message.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="433"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="532">%TRUE if multiple headers are allowed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="528">a #GstRTSPHeaderField</doc>
- <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_header_as_text"
- c:identifier="gst_rtsp_header_as_text">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="361">Convert @field to a string.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="415"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="367">a string representation of @field.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="363">a #GstRTSPHeaderField</doc>
- <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_message_new" c:identifier="gst_rtsp_message_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="115">Create a new initialized #GstRTSPMessage. Free with gst_rtsp_message_free().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="121"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="121">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="msg"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="117">a location for the new #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_message_new_data"
- c:identifier="gst_rtsp_message_new_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="398">Create a new data #GstRTSPMessage with @channel and store the
-result message in @msg. Free with gst_rtsp_message_free().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="179"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="406">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="msg"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="400">a location for the new #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
- </parameter>
- <parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="401">the channel</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_message_new_request"
- c:identifier="gst_rtsp_message_new_request">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="175">Create a new #GstRTSPMessage with @method and @uri and store the result
-request message in @msg. Free with gst_rtsp_message_free().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="141"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="184">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="msg"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="177">a location for the new #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
- </parameter>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="178">the request method to use</doc>
- <type name="RTSPMethod" c:type="GstRTSPMethod"/>
- </parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="179">the uri of the request</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_message_new_response"
- c:identifier="gst_rtsp_message_new_response">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="264">Create a new response #GstRTSPMessage with @code and @reason and store the
-result message in @msg. Free with gst_rtsp_message_free().
-
-When @reason is %NULL, the default reason for @code will be used.
-
-When @request is not %NULL, the relevant headers will be copied to the new
-response message.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspmessage.h"
- line="159"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="279">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="msg"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="266">a location for the new #GstRTSPMessage</doc>
- <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
- </parameter>
- <parameter name="code" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="267">the status code</doc>
- <type name="RTSPStatusCode" c:type="GstRTSPStatusCode"/>
- </parameter>
- <parameter name="reason"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="268">the status reason or %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="request"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspmessage.c"
- line="269">the request that triggered the response or %NULL</doc>
- <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_method_as_text"
- c:identifier="gst_rtsp_method_as_text"
- moved-to="RTSPMethod.as_text">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="310">Convert @method to a string.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="409"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="316">a string representation of @method.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="312">a #GstRTSPMethod</doc>
- <type name="RTSPMethod" c:type="GstRTSPMethod"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_options_as_text"
- c:identifier="gst_rtsp_options_as_text">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="441">Convert @options to a string.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="421"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="447">a new string of @options. g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="options" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="443">one or more #GstRTSPMethod</doc>
- <type name="RTSPMethod" c:type="GstRTSPMethod"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_options_from_text"
- c:identifier="gst_rtsp_options_from_text"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="486">Convert the comma separated list @options to a #GstRTSPMethod bitwise or
-of methods. This functions is the reverse of gst_rtsp_options_as_text().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="424"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="493">a #GstRTSPMethod</doc>
- <type name="RTSPMethod" c:type="GstRTSPMethod"/>
- </return-value>
- <parameters>
- <parameter name="options" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="488">a comma separated list of options</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_range_convert_units"
- c:identifier="gst_rtsp_range_convert_units"
- moved-to="RTSPRange.convert_units">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="664">Converts the range in-place between different types of units.
-Ranges containing the special value #GST_RTSP_TIME_NOW can not be
-converted as these are only valid for #GST_RTSP_RANGE_NPT.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h" line="159"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="673">%TRUE if the range could be converted</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="range" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="666">a #GstRTSPTimeRange</doc>
- <type name="RTSPTimeRange" c:type="GstRTSPTimeRange*"/>
- </parameter>
- <parameter name="unit" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="667">the unit to convert the range into</doc>
- <type name="RTSPRangeUnit" c:type="GstRTSPRangeUnit"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_range_free"
- c:identifier="gst_rtsp_range_free"
- moved-to="RTSPRange.free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="472">Free the memory allocated by @range.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h" line="152"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="range" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="474">a #GstRTSPTimeRange</doc>
- <type name="RTSPTimeRange" c:type="GstRTSPTimeRange*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_range_get_times"
- c:identifier="gst_rtsp_range_get_times"
- moved-to="RTSPRange.get_times"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="565">Retrieve the minimum and maximum values from @range converted to
-#GstClockTime in @min and @max.
-
-A value of %GST_CLOCK_TIME_NONE will be used to signal #GST_RTSP_TIME_NOW
-and #GST_RTSP_TIME_END for @min and @max respectively.
-
-UTC times will be converted to nanoseconds since 1900.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h" line="155"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="579">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="range" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="567">a #GstRTSPTimeRange</doc>
- <type name="RTSPTimeRange" c:type="const GstRTSPTimeRange*"/>
- </parameter>
- <parameter name="min"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="568">result minimum #GstClockTime</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="max"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="569">result maximum #GstClockTime</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_range_parse"
- c:identifier="gst_rtsp_range_parse"
- moved-to="RTSPRange.parse">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="257">Parse @rangestr to a #GstRTSPTimeRange.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h" line="146"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="264">#GST_RTSP_OK on success.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="rangestr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="259">a range string to parse</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="range"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="260">location to hold the #GstRTSPTimeRange result</doc>
- <type name="RTSPTimeRange" c:type="GstRTSPTimeRange**"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_range_to_string"
- c:identifier="gst_rtsp_range_to_string"
- moved-to="RTSPRange.to_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="421">Convert @range into a string representation.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsprange.h" line="149"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="427">The string representation of @range. g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="range" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsprange.c"
- line="423">a #GstRTSPTimeRange</doc>
- <type name="RTSPTimeRange" c:type="const GstRTSPTimeRange*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_status_as_text"
- c:identifier="gst_rtsp_status_as_text">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="378">Convert @code to a string.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="418"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="384">a string representation of @code.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="code" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="380">a #GstRTSPStatusCode</doc>
- <type name="RTSPStatusCode" c:type="GstRTSPStatusCode"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_strresult" c:identifier="gst_rtsp_strresult">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="258">Convert @result in a human readable string.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="406"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="264">a newly allocated string. g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="result" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="260">a #GstRTSPResult</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_transport_get_manager"
- c:identifier="gst_rtsp_transport_get_manager"
- moved-to="RTSPTransport.get_manager">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="279">Get the #GstElement that can handle the buffers transported over @trans.
-
-It is possible that there are several managers available, use @option to
-selected one.
-
-@manager will contain an element name or %NULL when no manager is
-needed/available for @trans.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="190"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="293">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="281">a #GstRTSPTransMode</doc>
- <type name="RTSPTransMode" c:type="GstRTSPTransMode"/>
- </parameter>
- <parameter name="manager"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="282">location to hold the result</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- <parameter name="option" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="283">option index.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_transport_get_mime"
- c:identifier="gst_rtsp_transport_get_mime"
- moved-to="RTSPTransport.get_mime"
- deprecated="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="205">Get the mime type of the transport mode @trans. This mime type is typically
-used to generate #GstCaps events.</doc>
- <doc-deprecated xml:space="preserve">This functions only deals with the GstRTSPTransMode and only
- returns the mime type for #GST_RTSP_PROFILE_AVP. Use
- gst_rtsp_transport_get_media_type() instead.</doc-deprecated>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="187"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="217">#GST_RTSP_OK.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="207">a #GstRTSPTransMode</doc>
- <type name="RTSPTransMode" c:type="GstRTSPTransMode"/>
- </parameter>
- <parameter name="mime" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="208">location to hold the result</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_transport_new"
- c:identifier="gst_rtsp_transport_new"
- moved-to="RTSPTransport.new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="146">Allocate a new initialized #GstRTSPTransport. Use gst_rtsp_transport_free()
-after usage.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="175"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="153">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="transport" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="148">location to hold the new #GstRTSPTransport</doc>
- <type name="RTSPTransport" c:type="GstRTSPTransport**"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_transport_parse"
- c:identifier="gst_rtsp_transport_parse"
- moved-to="RTSPTransport.parse">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="433">Parse the RTSP transport string @str into @transport.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtsptransport.h"
- line="181"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="440">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="str" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="435">a transport string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="transport" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtsptransport.c"
- line="436">a #GstRTSPTransport</doc>
- <type name="RTSPTransport" c:type="GstRTSPTransport*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_url_parse"
- c:identifier="gst_rtsp_url_parse"
- moved-to="RTSPUrl.parse">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="90">Parse the RTSP @urlstr into a newly allocated #GstRTSPUrl. Free after usage
-with gst_rtsp_url_free().</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspurl.h" line="93"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="98">a #GstRTSPResult.</doc>
- <type name="RTSPResult" c:type="GstRTSPResult"/>
- </return-value>
- <parameters>
- <parameter name="urlstr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="92">the url string to parse</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="url"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspurl.c"
- line="93">location to hold the result.</doc>
- <type name="RTSPUrl" c:type="GstRTSPUrl**"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_version_as_text"
- c:identifier="gst_rtsp_version_as_text"
- moved-to="RTSPVersion.as_text">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="334">Convert @version to a string.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="412"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="340">a string representation of @version.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspdefs.c"
- line="336">a #GstRTSPVersion</doc>
- <type name="RTSPVersion" c:type="GstRTSPVersion"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtsp_watch_new"
- c:identifier="gst_rtsp_watch_new"
- moved-to="RTSPWatch.new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4170">Create a watch object for @conn. The functions provided in @funcs will be
-called with @user_data when activity happened on the watch.
-
-The new watch is usually created so that it can be attached to a
-maincontext with gst_rtsp_watch_attach().
-
-@conn must exist for the entire lifetime of the watch.</doc>
- <source-position filename="gst-libs/gst/rtsp/gstrtspconnection.h"
- line="292"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4185">a #GstRTSPWatch that can be used for asynchronous RTSP
-communication. Free with gst_rtsp_watch_unref () after usage.</doc>
- <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
- </return-value>
- <parameters>
- <parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4172">a #GstRTSPConnection</doc>
- <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
- </parameter>
- <parameter name="funcs" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4173">watch functions</doc>
- <type name="RTSPWatchFuncs" c:type="GstRTSPWatchFuncs*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4174">user data to pass to @funcs</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify" transfer-ownership="none" scope="async">
- <doc xml:space="preserve"
- filename="gst-libs/gst/rtsp/gstrtspconnection.c"
- line="4175">notify when @user_data is not referenced anymore</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </function>
- </namespace>
-</repository>
diff --git a/girs/GstSdp-1.0.gir b/girs/GstSdp-1.0.gir
deleted file mode 100644
index a3ce4c518c..0000000000
--- a/girs/GstSdp-1.0.gir
+++ /dev/null
@@ -1,6619 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="Gst" version="1.0"/>
- <package name="gstreamer-sdp-1.0"/>
- <c:include name="gst/sdp/sdp.h"/>
- <namespace name="GstSdp"
- version="1.0"
- shared-library="libgstsdp-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <enumeration name="MIKEYCacheType" c:type="GstMIKEYCacheType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="282">The different cache types</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="296"/>
- <member name="none" value="0" c:identifier="GST_MIKEY_CACHE_NONE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="284">The envelope key MUST NOT be cached</doc>
- </member>
- <member name="always" value="1" c:identifier="GST_MIKEY_CACHE_ALWAYS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="285">The envelope key MUST be cached</doc>
- </member>
- <member name="for_csb" value="2" c:identifier="GST_MIKEY_CACHE_FOR_CSB">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="286">The envelope key MUST be cached, but only
- to be used for the specific CSB.</doc>
- </member>
- </enumeration>
- <record name="MIKEYDecryptInfo" c:type="GstMIKEYDecryptInfo" disguised="1">
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="36"/>
- </record>
- <enumeration name="MIKEYEncAlg" c:type="GstMIKEYEncAlg">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="217">The encryption algorithm used to encrypt the Encr data field</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="232"/>
- <member name="null" value="0" c:identifier="GST_MIKEY_ENC_NULL">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="219">no encryption</doc>
- </member>
- <member name="aes_cm_128"
- value="1"
- c:identifier="GST_MIKEY_ENC_AES_CM_128">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="220">AES-CM using a 128-bit key</doc>
- </member>
- <member name="aes_kw_128"
- value="2"
- c:identifier="GST_MIKEY_ENC_AES_KW_128">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="221">AES Key Wrap using a 128-bit key</doc>
- </member>
- <member name="aes_gcm_128"
- value="6"
- c:identifier="GST_MIKEY_ENC_AES_GCM_128">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="222">AES-GCM using a 128-bit key (Since: 1.16)</doc>
- </member>
- </enumeration>
- <record name="MIKEYEncryptInfo" c:type="GstMIKEYEncryptInfo" disguised="1">
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="35"/>
- </record>
- <enumeration name="MIKEYKVType" c:type="GstMIKEYKVType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="487">The key validity type</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="500"/>
- <member name="null" value="0" c:identifier="GST_MIKEY_KV_NULL">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="489">No specific usage rule</doc>
- </member>
- <member name="spi" value="1" c:identifier="GST_MIKEY_KV_SPI">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="490">The key is associated with the SPI/MKI</doc>
- </member>
- <member name="interval" value="2" c:identifier="GST_MIKEY_KV_INTERVAL">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="491">The key has a start and expiration time</doc>
- </member>
- </enumeration>
- <enumeration name="MIKEYKeyDataType" c:type="GstMIKEYKeyDataType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="474">The type of key.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="485"/>
- <member name="tgk" value="0" c:identifier="GST_MIKEY_KD_TGK">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="476">a TEK Generation Key</doc>
- </member>
- <member name="tek" value="2" c:identifier="GST_MIKEY_KD_TEK">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="477">Traffic-Encrypting Key</doc>
- </member>
- </enumeration>
- <enumeration name="MIKEYMacAlg" c:type="GstMIKEYMacAlg">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="234">Specifies the authentication algorithm used</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="245"/>
- <member name="null" value="0" c:identifier="GST_MIKEY_MAC_NULL">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="236">no authentication</doc>
- </member>
- <member name="hmac_sha_1_160"
- value="1"
- c:identifier="GST_MIKEY_MAC_HMAC_SHA_1_160">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="237">HMAC-SHA-1-160</doc>
- </member>
- </enumeration>
- <record name="MIKEYMapSRTP" c:type="GstMIKEYMapSRTP">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="132">The Security policy Map item for SRTP</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="144"/>
- <field name="policy" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="134">The security policy applied for the stream with @ssrc</doc>
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="ssrc" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="135">the SSRC that must be used for the stream</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="roc" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="136">current rollover counter</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- </record>
- <enumeration name="MIKEYMapType" c:type="GstMIKEYMapType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="120">Specifies the method of uniquely mapping Crypto Sessions to the security
-protocol sessions.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="130"/>
- <member name="mikey_map_type_srtp"
- value="0"
- c:identifier="GST_MIKEY_MAP_TYPE_SRTP">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="122">SRTP</doc>
- </member>
- </enumeration>
- <record name="MIKEYMessage"
- c:type="GstMIKEYMessage"
- glib:type-name="GstMIKEYMessage"
- glib:get-type="gst_mikey_message_get_type"
- c:symbol-prefix="mikey_message">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="548">Structure holding the information of the MIKEY message</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="575"/>
- <field name="mini_object" readable="0" private="1">
- <type name="Gst.MiniObject" c:type="GstMiniObject"/>
- </field>
- <field name="version" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="550">the version</doc>
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="551">the #GstMIKEYType message type</doc>
- <type name="MIKEYType" c:type="GstMIKEYType"/>
- </field>
- <field name="V" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="552">verify flag</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="prf_func" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="553">a #GstMIKEYPRFFunc</doc>
- <type name="MIKEYPRFFunc" c:type="GstMIKEYPRFFunc"/>
- </field>
- <field name="CSB_id" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="554">Identifies the Crypto Session Bundle</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="map_type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="555">a #GstMIKEYMapType</doc>
- <type name="MIKEYMapType" c:type="GstMIKEYMapType"/>
- </field>
- <field name="map_info" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="556">map info array of type depending on @map_type</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="payloads" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="557">the payload array of #GstMIKEYPayload</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <constructor name="new"
- c:identifier="gst_mikey_message_new"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="868">Make a new MIKEY message.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="579"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="873">a new #GstMIKEYMessage on success</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </return-value>
- </constructor>
- <constructor name="new_from_bytes"
- c:identifier="gst_mikey_message_new_from_bytes"
- version="1.4"
- throws="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="894">Make a new #GstMIKEYMessage from @bytes.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="586"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="902">a new #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </return-value>
- <parameters>
- <parameter name="bytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="896">a #GBytes</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="897">a #GstMIKEYDecryptInfo</doc>
- <type name="MIKEYDecryptInfo" c:type="GstMIKEYDecryptInfo*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_caps"
- c:identifier="gst_mikey_message_new_from_caps"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2232">Makes mikey message including:
- - Security Policy Payload
- - Key Data Transport Payload
- - Key Data Sub-Payload</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="594"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2241">a #GstMIKEYMessage,
-or %NULL if there is no srtp information in the caps.</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2234">a #GstCaps, including SRTP parameters (srtp/srtcp cipher, authorization, key data)</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_data"
- c:identifier="gst_mikey_message_new_from_data"
- version="1.4"
- throws="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2046">Parse @size bytes from @data into a #GstMIKEYMessage. @info contains the
-parameters to decrypt and verify the data.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="582"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2056">a #GstMIKEYMessage on success or %NULL when parsing failed and
-@error will be set.</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2048">bytes to read</doc>
- <array length="1" zero-terminated="0" c:type="gconstpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2049">length of @data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2050">#GstMIKEYDecryptInfo</doc>
- <type name="MIKEYDecryptInfo" c:type="GstMIKEYDecryptInfo*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="add_cs_srtp"
- c:identifier="gst_mikey_message_add_cs_srtp"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1073">Add a Crypto policy for SRTP to @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="675"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1082">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1075">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="policy" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1076">The security policy applied for the stream with @ssrc</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1077">the SSRC that must be used for the stream</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="roc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1078">current rollover counter</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_payload"
- c:identifier="gst_mikey_message_add_payload"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1229">Add a new payload to @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="698"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1236">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1231">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="payload" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1232">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_pke"
- c:identifier="gst_mikey_message_add_pke"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1275">Add a new PKE payload to @msg with the given parameters.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="710"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1284">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1277">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="C" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1278">envelope key cache indicator</doc>
- <type name="MIKEYCacheType" c:type="GstMIKEYCacheType"/>
- </parameter>
- <parameter name="data_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1279">the length of @data</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1280">the encrypted envelope key</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="add_rand"
- c:identifier="gst_mikey_message_add_rand"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1365">Add a new RAND payload to @msg with the given parameters.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="732"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1373">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1367">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1368">the length of @rand</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="rand" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1369">random data</doc>
- <array length="0" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="add_rand_len"
- c:identifier="gst_mikey_message_add_rand_len"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1395">Add a new RAND payload to @msg with @len random bytes.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="736"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1402">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1397">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1398">length</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_t"
- c:identifier="gst_mikey_message_add_t"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1305">Add a new T payload to @msg with the given parameters.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="719"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1313">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1307">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1308">specifies the timestamp type used</doc>
- <type name="MIKEYTSType" c:type="GstMIKEYTSType"/>
- </parameter>
- <parameter name="ts_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1309">The timestamp value of the specified @type</doc>
- <array zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="add_t_now_ntp_utc"
- c:identifier="gst_mikey_message_add_t_now_ntp_utc"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1334">Add a new T payload to @msg that contains the current time
-in NTP-UTC format.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="723"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1341">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1336">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="base64_encode"
- c:identifier="gst_mikey_message_base64_encode"
- version="1.8">
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="600"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2516">a #gchar, base64-encoded data</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2514">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="find_payload"
- c:identifier="gst_mikey_message_find_payload"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1144">Find the @nth occurrence of the payload with @type in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="687"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1152">the @nth #GstMIKEYPayload of @type.</doc>
- <type name="MIKEYPayload" c:type="const GstMIKEYPayload*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1146">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="const GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1147">a #GstMIKEYPayloadType</doc>
- <type name="MIKEYPayloadType" c:type="GstMIKEYPayloadType"/>
- </parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1148">payload to find</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_cs_srtp"
- c:identifier="gst_mikey_message_get_cs_srtp"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="970">Get the policy information of @msg at @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="661"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="977">a #GstMIKEYMapSRTP</doc>
- <type name="MIKEYMapSRTP" c:type="const GstMIKEYMapSRTP*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="972">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="const GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="973">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_n_cs"
- c:identifier="gst_mikey_message_get_n_cs"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="952">Get the number of crypto sessions in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="656"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="958">the number of crypto sessions</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="954">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="const GstMIKEYMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_n_payloads"
- c:identifier="gst_mikey_message_get_n_payloads"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1103">Get the number of payloads in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="681"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1109">the number of payloads in @msg</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1105">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="const GstMIKEYMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_payload"
- c:identifier="gst_mikey_message_get_payload"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1121">Get the #GstMIKEYPayload at @idx in @msg</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="684"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1128">the #GstMIKEYPayload at @idx. The payload
-remains valid for as long as it is part of @msg.</doc>
- <type name="MIKEYPayload" c:type="const GstMIKEYPayload*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1123">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="const GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1124">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert_cs_srtp"
- c:identifier="gst_mikey_message_insert_cs_srtp"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="993">Insert a Crypto Session map for SRTP in @msg at @idx
-
-When @idx is -1, the policy will be appended.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="664"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1003">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="995">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="996">the index to insert at</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="map" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="997">the map info</doc>
- <type name="MIKEYMapSRTP" c:type="const GstMIKEYMapSRTP*"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert_payload"
- c:identifier="gst_mikey_message_insert_payload"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1200">Insert the @payload at index @idx in @msg. If @idx is -1, the payload
-will be appended to @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="694"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1209">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1202">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1203">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="payload" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1204">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_cs_srtp"
- c:identifier="gst_mikey_message_remove_cs_srtp"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1050">Remove the SRTP policy at @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="672"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1057">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1052">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1053">the index to remove</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_payload"
- c:identifier="gst_mikey_message_remove_payload"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1178">Remove the payload in @msg at @idx</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="691"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1185">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1180">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1181">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_cs_srtp"
- c:identifier="gst_mikey_message_replace_cs_srtp"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1024">Replace a Crypto Session map for SRTP in @msg at @idx with @map.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="668"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1032">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1026">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1027">the index to insert at</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="map" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1028">the map info</doc>
- <type name="MIKEYMapSRTP" c:type="const GstMIKEYMapSRTP*"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_payload"
- c:identifier="gst_mikey_message_replace_payload"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1246">Replace the payload at @idx in @msg with @payload.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="702"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1254">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1248">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1249">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="payload" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1250">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_info"
- c:identifier="gst_mikey_message_set_info"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="919">Set the information in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="650"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="931">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="921">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="922">a version</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="923">a #GstMIKEYType</doc>
- <type name="MIKEYType" c:type="GstMIKEYType"/>
- </parameter>
- <parameter name="V" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="924">verify flag</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="prf_func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="925">the #GstMIKEYPRFFunc function to use</doc>
- <type name="MIKEYPRFFunc" c:type="GstMIKEYPRFFunc"/>
- </parameter>
- <parameter name="CSB_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="926">the Crypto Session Bundle id</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="map_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="927">the #GstMIKEYMapType</doc>
- <type name="MIKEYMapType" c:type="GstMIKEYMapType"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_bytes"
- c:identifier="gst_mikey_message_to_bytes"
- version="1.4"
- throws="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1662">Convert @msg to a #GBytes.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="590"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1670">a new #GBytes for @msg.</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1664">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="1665">a #GstMIKEYEncryptInfo</doc>
- <type name="MIKEYEncryptInfo" c:type="GstMIKEYEncryptInfo*"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_caps"
- c:identifier="gst_mikey_message_to_caps"
- version="1.8.1">
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="597"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2372">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2369">a #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="const GstMIKEYMessage*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="2370">a #GstCaps to be filled with SRTP parameters (srtp/srtcp cipher, authorization, key data)</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <enumeration name="MIKEYPRFFunc" c:type="GstMIKEYPRFFunc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="109">The PRF function that has been/will be used for key derivation</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="118"/>
- <member name="mikey_prf_mikey_1"
- value="0"
- c:identifier="GST_MIKEY_PRF_MIKEY_1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="111">MIKEY-1 PRF function</doc>
- </member>
- </enumeration>
- <record name="MIKEYPayload"
- c:type="GstMIKEYPayload"
- glib:type-name="GstMIKEYPayload"
- glib:get-type="gst_mikey_payload_get_type"
- c:symbol-prefix="mikey_payload">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="152">Hold the common fields for all payloads</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="166"/>
- <field name="mini_object" readable="0" private="1">
- <type name="Gst.MiniObject" c:type="GstMiniObject"/>
- </field>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="154">the payload type</doc>
- <type name="MIKEYPayloadType" c:type="GstMIKEYPayloadType"/>
- </field>
- <field name="len" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="155">length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <constructor name="new"
- c:identifier="gst_mikey_payload_new"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="760">Make a new #GstMIKEYPayload with @type.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="169"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="766">a new #GstMIKEYPayload or %NULL on failure.</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="762">a #GstMIKEYPayloadType</doc>
- <type name="MIKEYPayloadType" c:type="GstMIKEYPayloadType"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="kemac_add_sub"
- c:identifier="gst_mikey_payload_kemac_add_sub"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="223">Add a new sub payload to @payload.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="279"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="230">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="225">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="newpay" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="226">a #GstMIKEYPayload to add</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </parameter>
- </parameters>
- </method>
- <method name="kemac_get_n_sub"
- c:identifier="gst_mikey_payload_kemac_get_n_sub"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="150">Get the number of sub payloads of @payload. @payload should be of type
-%GST_MIKEY_PT_KEMAC.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="270"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="157">the number of sub payloads in @payload</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="152">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="const GstMIKEYPayload*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="kemac_get_sub"
- c:identifier="gst_mikey_payload_kemac_get_sub"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="172">Get the sub payload of @payload at @idx. @payload should be of type
-%GST_MIKEY_PT_KEMAC.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="273"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="180">the #GstMIKEYPayload at @idx.</doc>
- <type name="MIKEYPayload" c:type="const GstMIKEYPayload*"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="174">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="const GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="175">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="kemac_remove_sub"
- c:identifier="gst_mikey_payload_kemac_remove_sub"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="198">Remove the sub payload at @idx in @payload.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="276"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="205">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="200">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="201">the index to remove</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="kemac_set"
- c:identifier="gst_mikey_payload_kemac_set"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="98">Set the KEMAC parameters. @payload should point to a %GST_MIKEY_PT_KEMAC
-payload.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="265"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="107">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="100">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="enc_alg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="101">the #GstMIKEYEncAlg</doc>
- <type name="MIKEYEncAlg" c:type="GstMIKEYEncAlg"/>
- </parameter>
- <parameter name="mac_alg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="102">a #GstMIKEYMacAlg</doc>
- <type name="MIKEYMacAlg" c:type="GstMIKEYMacAlg"/>
- </parameter>
- </parameters>
- </method>
- <method name="key_data_set_interval"
- c:identifier="gst_mikey_payload_key_data_set_interval"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="682">Set the key validity period in the %GST_MIKEY_PT_KEY_DATA @payload.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="544"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="692">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="684">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="vf_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="685">the length of @vf_data</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="vf_data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="686">the Valid From data</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="vt_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="687">the length of @vt_data</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="vt_data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="688">the Valid To data</doc>
- <array length="2" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="key_data_set_key"
- c:identifier="gst_mikey_payload_key_data_set_key"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="587">Set @key_len bytes of @key_data of type @key_type as the key for the
-%GST_MIKEY_PT_KEY_DATA @payload.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="531"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="597">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="589">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="key_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="590">a #GstMIKEYKeyDataType</doc>
- <type name="MIKEYKeyDataType" c:type="GstMIKEYKeyDataType"/>
- </parameter>
- <parameter name="key_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="591">the length of @key_data</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="key_data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="592">the key of type @key_type</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="key_data_set_salt"
- c:identifier="gst_mikey_payload_key_data_set_salt"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="618">Set the salt key data. If @salt_len is 0 and @salt_data is %NULL, the
-salt data will be removed.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="536"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="627">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="620">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="salt_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="621">the length of @salt_data</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="salt_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="622">the salt</doc>
- <array length="0" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="key_data_set_spi"
- c:identifier="gst_mikey_payload_key_data_set_spi"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="650">Set the SPI/MKI validity in the %GST_MIKEY_PT_KEY_DATA @payload.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="540"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="658">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="652">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="spi_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="653">the length of @spi_data</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="spi_data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="654">the SPI/MKI data</doc>
- <array length="0" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="pke_set"
- c:identifier="gst_mikey_payload_pke_set"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="249">Set the PKE values in @payload. @payload must be of type
-%GST_MIKEY_PT_PKE.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="319"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="259">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="251">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="C" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="252">envelope key cache indicator</doc>
- <type name="MIKEYCacheType" c:type="GstMIKEYCacheType"/>
- </parameter>
- <parameter name="data_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="253">the length of @data</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="254">the encrypted envelope key</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="rand_set"
- c:identifier="gst_mikey_payload_rand_set"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="539">Set the random values in a %GST_MIKEY_PT_RAND @payload.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="471"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="547">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="541">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="542">the length of @rand</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="rand" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="543">random values</doc>
- <array length="0" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="sp_add_param"
- c:identifier="gst_mikey_payload_sp_add_param"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="505">Add a new parameter to the %GST_MIKEY_PT_SP @payload with @type, @len
-and @val.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="452"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="515">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="507">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="508">a type</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="509">a length</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="510">@len bytes of data</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="sp_get_n_params"
- c:identifier="gst_mikey_payload_sp_get_n_params"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="430">Get the number of security policy parameters in a %GST_MIKEY_PT_SP
-@payload.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="442"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="437">the number of parameters in @payload</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="432">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="const GstMIKEYPayload*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="sp_get_param"
- c:identifier="gst_mikey_payload_sp_get_param"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="453">Get the Security Policy parameter in a %GST_MIKEY_PT_SP @payload
-at @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="446"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="461">the #GstMIKEYPayloadSPParam at @idx in @payload</doc>
- <type name="MIKEYPayloadSPParam"
- c:type="const GstMIKEYPayloadSPParam*"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="455">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="const GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="456">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="sp_remove_param"
- c:identifier="gst_mikey_payload_sp_remove_param"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="479">Remove the Security Policy parameters from a %GST_MIKEY_PT_SP
-@payload at @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="449"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="487">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="481">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="482">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="sp_set"
- c:identifier="gst_mikey_payload_sp_set"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="378">Set the Security Policy parameters for @payload.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="439"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="386">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="380">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="policy" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="381">the policy number</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="proto" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="382">a #GstMIKEYSecProto</doc>
- <type name="MIKEYSecProto" c:type="GstMIKEYSecProto"/>
- </parameter>
- </parameters>
- </method>
- <method name="t_set"
- c:identifier="gst_mikey_payload_t_set"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="320">Set the timestamp in a %GST_MIKEY_PT_T @payload.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="355"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="328">%TRUE on success</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="322">a #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="323">the #GstMIKEYTSType</doc>
- <type name="MIKEYTSType" c:type="GstMIKEYTSType"/>
- </parameter>
- <parameter name="ts_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="324">the timestamp value</doc>
- <array zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- </record>
- <record name="MIKEYPayloadKEMAC" c:type="GstMIKEYPayloadKEMAC">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="247">A structure holding the KEMAC payload</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="262"/>
- <field name="pt" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="249">the common #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload"/>
- </field>
- <field name="enc_alg" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="250">the #GstMIKEYEncAlg</doc>
- <type name="MIKEYEncAlg" c:type="GstMIKEYEncAlg"/>
- </field>
- <field name="mac_alg" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="251">the #GstMIKEYMacAlg</doc>
- <type name="MIKEYMacAlg" c:type="GstMIKEYMacAlg"/>
- </field>
- <field name="subpayloads" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="252">the subpayloads</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="MIKEYPayloadKeyData" c:type="GstMIKEYPayloadKeyData">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="502">The Key data payload contains key material. It should be added as sub
-payload to the KEMAC.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="528"/>
- <field name="pt" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="504">the payload header</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload"/>
- </field>
- <field name="key_type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="505">the #GstMIKEYKeyDataType of @key_data</doc>
- <type name="MIKEYKeyDataType" c:type="GstMIKEYKeyDataType"/>
- </field>
- <field name="key_len" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="506">length of @key_data</doc>
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="key_data" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="507">the key data</doc>
- <type name="guint8" c:type="guint8*"/>
- </field>
- <field name="salt_len" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="508">the length of @salt_data, can be 0</doc>
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="salt_data" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="509">salt data</doc>
- <type name="guint8" c:type="guint8*"/>
- </field>
- <field name="kv_type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="510">the Key Validity type</doc>
- <type name="MIKEYKVType" c:type="GstMIKEYKVType"/>
- </field>
- <field name="kv_len" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="511">length of @kv_data</doc>
- <array zero-terminated="0" fixed-size="2">
- <type name="guint8" c:type="guint8"/>
- </array>
- </field>
- <field name="kv_data" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="512">key validity data</doc>
- <array zero-terminated="0" fixed-size="2">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </field>
- </record>
- <record name="MIKEYPayloadPKE" c:type="GstMIKEYPayloadPKE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="298">The Envelope data payload contains the encrypted envelope key that is
-used in the public-key transport to protect the data in the Key data
-transport payload. The encryption algorithm used is implicit from
-the certificate/public key used.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="316"/>
- <field name="pt" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="300">the common #GstMIKEYPayload</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload"/>
- </field>
- <field name="C" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="301">envelope key cache indicator</doc>
- <type name="MIKEYCacheType" c:type="GstMIKEYCacheType"/>
- </field>
- <field name="data_len" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="302">length of @data</doc>
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="data" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="303">the encrypted envelope key</doc>
- <type name="guint8" c:type="guint8*"/>
- </field>
- </record>
- <record name="MIKEYPayloadRAND" c:type="GstMIKEYPayloadRAND">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="455">The RAND payload consists of a (pseudo-)random bit-string</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="468"/>
- <field name="pt" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="457">the payload header</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload"/>
- </field>
- <field name="len" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="458">the length of @rand</doc>
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="rand" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="459">random values</doc>
- <type name="guint8" c:type="guint8*"/>
- </field>
- </record>
- <record name="MIKEYPayloadSP" c:type="GstMIKEYPayloadSP">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="420">The Security Policy payload defines a set of policies that apply to a
-specific security protocol</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="436"/>
- <field name="pt" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="422">the payload header</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload"/>
- </field>
- <field name="policy" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="423">the policy number</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="proto" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="424">the security protocol</doc>
- <type name="MIKEYSecProto" c:type="GstMIKEYSecProto"/>
- </field>
- <field name="params" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="425">array of #GstMIKEYPayloadSPParam</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="MIKEYPayloadSPParam" c:type="GstMIKEYPayloadSPParam">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="358">A Type/Length/Value field for security parameters</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="370"/>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="360">specifies the type of the parameter</doc>
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="len" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="361">specifies the length of @val</doc>
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="val" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="362">specifies the value of the parameter</doc>
- <type name="guint8" c:type="guint8*"/>
- </field>
- </record>
- <record name="MIKEYPayloadT" c:type="GstMIKEYPayloadT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="339">The timestamp payload carries the timestamp information</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="352"/>
- <field name="pt" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="341">the payload header</doc>
- <type name="MIKEYPayload" c:type="GstMIKEYPayload"/>
- </field>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="342">a #GstMIKEYTSType</doc>
- <type name="MIKEYTSType" c:type="GstMIKEYTSType"/>
- </field>
- <field name="ts_value" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="343">the timestamp value</doc>
- <type name="guint8" c:type="guint8*"/>
- </field>
- </record>
- <enumeration name="MIKEYPayloadType" c:type="GstMIKEYPayloadType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="70">Different MIKEY Payload types.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="107"/>
- <member name="last" value="0" c:identifier="GST_MIKEY_PT_LAST">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="72">Last payload</doc>
- </member>
- <member name="kemac" value="1" c:identifier="GST_MIKEY_PT_KEMAC">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="73">Key data transport payload</doc>
- </member>
- <member name="pke" value="2" c:identifier="GST_MIKEY_PT_PKE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="74">Envelope data payload</doc>
- </member>
- <member name="dh" value="3" c:identifier="GST_MIKEY_PT_DH">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="75">DH data payload</doc>
- </member>
- <member name="sign" value="4" c:identifier="GST_MIKEY_PT_SIGN">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="76">Signature payload</doc>
- </member>
- <member name="t" value="5" c:identifier="GST_MIKEY_PT_T">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="77">Timestamp payload</doc>
- </member>
- <member name="id" value="6" c:identifier="GST_MIKEY_PT_ID">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="78">ID payload</doc>
- </member>
- <member name="cert" value="7" c:identifier="GST_MIKEY_PT_CERT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="79">Certificate Payload</doc>
- </member>
- <member name="chash" value="8" c:identifier="GST_MIKEY_PT_CHASH">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="80">Cert hash payload</doc>
- </member>
- <member name="v" value="9" c:identifier="GST_MIKEY_PT_V">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="81">Verification message payload</doc>
- </member>
- <member name="sp" value="10" c:identifier="GST_MIKEY_PT_SP">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="82">Security Policy payload</doc>
- </member>
- <member name="rand" value="11" c:identifier="GST_MIKEY_PT_RAND">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="83">RAND payload</doc>
- </member>
- <member name="err" value="12" c:identifier="GST_MIKEY_PT_ERR">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="84">Error payload</doc>
- </member>
- <member name="key_data" value="20" c:identifier="GST_MIKEY_PT_KEY_DATA">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="85">Key data sub-payload</doc>
- </member>
- <member name="gen_ext" value="21" c:identifier="GST_MIKEY_PT_GEN_EXT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="86">General Extension Payload</doc>
- </member>
- </enumeration>
- <enumeration name="MIKEYSecProto" c:type="GstMIKEYSecProto">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="372">Specifies the security protocol</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="381"/>
- <member name="mikey_sec_proto_srtp"
- value="0"
- c:identifier="GST_MIKEY_SEC_PROTO_SRTP">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="374">SRTP</doc>
- </member>
- </enumeration>
- <enumeration name="MIKEYSecSRTP" c:type="GstMIKEYSecSRTP">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="383">This policy specifies the parameters for SRTP and SRTCP</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="418"/>
- <member name="enc_alg"
- value="0"
- c:identifier="GST_MIKEY_SP_SRTP_ENC_ALG">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="385">Encryption algorithm</doc>
- </member>
- <member name="enc_key_len"
- value="1"
- c:identifier="GST_MIKEY_SP_SRTP_ENC_KEY_LEN">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="386">Session Encr. key length</doc>
- </member>
- <member name="auth_alg"
- value="2"
- c:identifier="GST_MIKEY_SP_SRTP_AUTH_ALG">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="387">Authentication algorithm</doc>
- </member>
- <member name="auth_key_len"
- value="3"
- c:identifier="GST_MIKEY_SP_SRTP_AUTH_KEY_LEN">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="388">Session Auth. key length</doc>
- </member>
- <member name="salt_key_len"
- value="4"
- c:identifier="GST_MIKEY_SP_SRTP_SALT_KEY_LEN">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="389">Session Salt key length</doc>
- </member>
- <member name="prf" value="5" c:identifier="GST_MIKEY_SP_SRTP_PRF">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="390">SRTP Pseudo Random Function</doc>
- </member>
- <member name="key_deriv_rate"
- value="6"
- c:identifier="GST_MIKEY_SP_SRTP_KEY_DERIV_RATE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="391">Key derivation rate</doc>
- </member>
- <member name="srtp_enc"
- value="7"
- c:identifier="GST_MIKEY_SP_SRTP_SRTP_ENC">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="392">SRTP encryption off/on, 0 if off, 1 if on</doc>
- </member>
- <member name="srtcp_enc"
- value="8"
- c:identifier="GST_MIKEY_SP_SRTP_SRTCP_ENC">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="393">SRTCP encryption off/on, 0 if off, 1 if on</doc>
- </member>
- <member name="fec_order"
- value="9"
- c:identifier="GST_MIKEY_SP_SRTP_FEC_ORDER">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="394">sender's FEC order</doc>
- </member>
- <member name="srtp_auth"
- value="10"
- c:identifier="GST_MIKEY_SP_SRTP_SRTP_AUTH">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="395">SRTP authentication off/on, 0 if off, 1 if on</doc>
- </member>
- <member name="auth_tag_len"
- value="11"
- c:identifier="GST_MIKEY_SP_SRTP_AUTH_TAG_LEN">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="396">Authentication tag length</doc>
- </member>
- <member name="srtp_prefix_len"
- value="12"
- c:identifier="GST_MIKEY_SP_SRTP_SRTP_PREFIX_LEN">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="397">SRTP prefix length</doc>
- </member>
- <member name="aead_auth_tag_len"
- value="20"
- c:identifier="GST_MIKEY_SP_SRTP_AEAD_AUTH_TAG_LEN">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="398">AEAD authentication tag length (Since: 1.16)</doc>
- </member>
- </enumeration>
- <enumeration name="MIKEYTSType" c:type="GstMIKEYTSType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="324">Specifies the timestamp type.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="337"/>
- <member name="ntp_utc"
- value="0"
- c:identifier="GST_MIKEY_TS_TYPE_NTP_UTC">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="326">an NTP time in UTC timezone</doc>
- </member>
- <member name="ntp" value="1" c:identifier="GST_MIKEY_TS_TYPE_NTP">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="327">an NTP time</doc>
- </member>
- <member name="counter"
- value="2"
- c:identifier="GST_MIKEY_TS_TYPE_COUNTER">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="328">a counter</doc>
- </member>
- </enumeration>
- <enumeration name="MIKEYType" c:type="GstMIKEYType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="45">Different MIKEY data types.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="68"/>
- <member name="invalid" value="-1" c:identifier="GST_MIKEY_TYPE_INVALID">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="47">Invalid type</doc>
- </member>
- <member name="psk_init" value="0" c:identifier="GST_MIKEY_TYPE_PSK_INIT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="48">Initiator's pre-shared key message</doc>
- </member>
- <member name="psk_verify"
- value="1"
- c:identifier="GST_MIKEY_TYPE_PSK_VERIFY">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="49">Verification message of a Pre-shared key message</doc>
- </member>
- <member name="pk_init" value="2" c:identifier="GST_MIKEY_TYPE_PK_INIT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="50">Initiator's public-key transport message</doc>
- </member>
- <member name="pk_verify"
- value="3"
- c:identifier="GST_MIKEY_TYPE_PK_VERIFY">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="51">Verification message of a public-key message</doc>
- </member>
- <member name="dh_init" value="4" c:identifier="GST_MIKEY_TYPE_DH_INIT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="52">Initiator's DH exchange message</doc>
- </member>
- <member name="dh_resp" value="5" c:identifier="GST_MIKEY_TYPE_DH_RESP">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="53">Responder's DH exchange message</doc>
- </member>
- <member name="error" value="6" c:identifier="GST_MIKEY_TYPE_ERROR">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="54">Error message</doc>
- </member>
- </enumeration>
- <constant name="MIKEY_VERSION" value="1" c:type="GST_MIKEY_VERSION">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.h"
- line="38">The supported MIKEY version 1.</doc>
- <source-position filename="gst-libs/gst/sdp/gstmikey.h" line="43"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <record name="SDPAttribute" c:type="GstSDPAttribute">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="229">The contents of the SDP "a=" field which contains a key/value pair.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="239"/>
- <field name="key" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="231">the attribute key</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="value" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="232">the attribute value or NULL when it was a property attribute</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <method name="clear"
- c:identifier="gst_sdp_attribute_clear"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1584">Clear the attribute.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="246"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1590">@GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="attr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1586">a #GstSDPAttribute</doc>
- <type name="SDPAttribute" c:type="GstSDPAttribute*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set" c:identifier="gst_sdp_attribute_set" version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1560">Set the attribute with @key and @value.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="242"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1568">@GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="attr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1562">a #GstSDPAttribute</doc>
- <type name="SDPAttribute" c:type="GstSDPAttribute*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1563">the key</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1564">the value</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <record name="SDPBandwidth" c:type="GstSDPBandwidth">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="150">The contents of the SDP "b=" field which specifies the proposed bandwidth to
-be used by the session or media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="161"/>
- <field name="bwtype" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="152">the bandwidth modifier type</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="bandwidth" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="153">the bandwidth in kilobits per second</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <method name="clear"
- c:identifier="gst_sdp_bandwidth_clear"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1128">Reset the bandwidth information in @bw.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="168"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1134">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="bw" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1130">a #GstSDPBandwidth</doc>
- <type name="SDPBandwidth" c:type="GstSDPBandwidth*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set" c:identifier="gst_sdp_bandwidth_set" version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1105">Set bandwidth information in @bw.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="164"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1113">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="bw" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1107">a #GstSDPBandwidth</doc>
- <type name="SDPBandwidth" c:type="GstSDPBandwidth*"/>
- </instance-parameter>
- <parameter name="bwtype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1108">the bandwidth modifier type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="bandwidth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1109">the bandwidth in kilobits per second</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <record name="SDPConnection" c:type="GstSDPConnection">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="81">The contents of the SDP "c=" field which contains connection data.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="98"/>
- <field name="nettype" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="83">the type of network. "IN" is defined to have the meaning
- "Internet".</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="addrtype" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="85">the type of @address.</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="address" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="86">the address</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="ttl" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="87">the time to live of the address</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="addr_number" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="88">the number of layers</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <method name="clear"
- c:identifier="gst_sdp_connection_clear"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2382">Clear the connection.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2388">@GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2384">a #GstSDPConnection</doc>
- <type name="SDPConnection" c:type="GstSDPConnection*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set" c:identifier="gst_sdp_connection_set" version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2349">Set the connection with the given parameters.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="101"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2361">@GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2351">a #GstSDPConnection</doc>
- <type name="SDPConnection" c:type="GstSDPConnection*"/>
- </instance-parameter>
- <parameter name="nettype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2352">the type of network. "IN" is defined to have the meaning
-"Internet".</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="addrtype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2354">the type of address.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="address" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2355">the address</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="ttl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2356">the time to live of the address</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="addr_number" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2357">the number of layers</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <record name="SDPKey" c:type="GstSDPKey">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="216">The contents of the SDP "k=" field which is used to convey encryption
-keys.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="227"/>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="218">the encryption type</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="data" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="219">the encryption data</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- </record>
- <record name="SDPMedia" c:type="GstSDPMedia">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="248">The contents of the SDP "m=" field with all related fields.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="274"/>
- <field name="media" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="250">the media type</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="port" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="251">the transport port to which the media stream will be sent</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="num_ports" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="252">the number of ports or -1 if only one port was specified</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="proto" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="253">the transport protocol</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="fmts" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="254">an array of #gchar formats</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="information" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="255">the media title</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="connections" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="256">array of #GstSDPConnection with media connection information</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="bandwidths" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="257">array of #GstSDPBandwidth with media bandwidth information</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="key" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="258">the encryption key</doc>
- <type name="SDPKey" c:type="GstSDPKey"/>
- </field>
- <field name="attributes" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="259">array of #GstSDPAttribute with the additional media attributes</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="add_attribute" c:identifier="gst_sdp_media_add_attribute">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2754">Add the attribute with @key and @value to @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="734"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2762">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2756">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2757">a key</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2758">a value</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_bandwidth" c:identifier="gst_sdp_media_add_bandwidth">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2673">Add the bandwidth information with @bwtype and @bandwidth to @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="696"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2681">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2675">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="bwtype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2676">the bandwidth modifier type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="bandwidth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2677">the bandwidth in kilobits per second</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_connection"
- c:identifier="gst_sdp_media_add_connection">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2525">Add the given connection parameters to @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="670"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2537">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2527">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="nettype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2528">the type of network. "IN" is defined to have the meaning
-"Internet".</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="addrtype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2530">the type of address.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="address" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2531">the address</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="ttl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2532">the time to live of the address</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="addr_number" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2533">the number of layers</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_format" c:identifier="gst_sdp_media_add_format">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2289">Add the format information to @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="640"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2296">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2291">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2292">the format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="as_text" c:identifier="gst_sdp_media_as_text">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1962">Convert the contents of @media to a text string.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="596"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1968">A dynamically allocated string representing the media.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1964">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="attributes_len"
- c:identifier="gst_sdp_media_attributes_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2738">Get the number of attribute fields in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="710"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2744">the number of attributes in @media.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2740">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="attributes_to_caps"
- c:identifier="gst_sdp_media_attributes_to_caps"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4288">Mapping of attributes of #GstSDPMedia to #GstCaps</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="756"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4295">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4290">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4291">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="bandwidths_len"
- c:identifier="gst_sdp_media_bandwidths_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2556">Get the number of bandwidth fields in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="679"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2562">the number of bandwidths in @media.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2558">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="connections_len"
- c:identifier="gst_sdp_media_connections_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2406">Get the number of connection fields in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="653"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2412">the number of connections in @media.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2408">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_sdp_media_copy" version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1897">Allocate a new copy of @media and store the result in @copy. The value in
-@copy should be release with gst_sdp_media_free function.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="593"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1905">a #GstSDPResult</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1899">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="copy"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1900">pointer to new #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia**"/>
- </parameter>
- </parameters>
- </method>
- <method name="formats_len" c:identifier="gst_sdp_media_formats_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2169">Get the number of formats in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="623"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2175">the number of formats in @media.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2171">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_sdp_media_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1876">Free all resources allocated by @media. @media should not be used anymore after
-this function. This function should be used when @media was dynamically
-allocated with gst_sdp_media_new().</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="590"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1884">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1878">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_attribute" c:identifier="gst_sdp_media_get_attribute">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2779">Get the attribute at position @idx in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="713"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2786">the #GstSDPAttribute at position @idx.</doc>
- <type name="SDPAttribute" c:type="const GstSDPAttribute*"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2781">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2782">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_attribute_val"
- c:identifier="gst_sdp_media_get_attribute_val">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2830">Get the first attribute value for @key in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="716"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2837">the first attribute value for @key.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2832">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2833">a key</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_attribute_val_n"
- c:identifier="gst_sdp_media_get_attribute_val_n">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2797">Get the @nth attribute value for @key in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="719"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2805">the @nth attribute value.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2799">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2800">a key</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2801">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_bandwidth" c:identifier="gst_sdp_media_get_bandwidth">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2572">Get the bandwidth at position @idx in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="682"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2579">the #GstSDPBandwidth at position @idx.</doc>
- <type name="SDPBandwidth" c:type="const GstSDPBandwidth*"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2574">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2575">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_caps_from_media"
- c:identifier="gst_sdp_media_get_caps_from_media"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3543">Mapping of caps from SDP fields:
-
-a=rtpmap:(payload) (encoding_name)/(clock_rate)[/(encoding_params)]
-
-a=framesize:(payload) (width)-(height)
-
-a=fmtp:(payload) (param)[=(value)];...
-
-Note that the extmap attribute is set only by gst_sdp_media_attributes_to_caps().</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="738"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3558">a #GstCaps, or %NULL if an error happened</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3545">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="pt" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3546">a payload type</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_connection"
- c:identifier="gst_sdp_media_get_connection">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2422">Get the connection at position @idx in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="656"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2429">the #GstSDPConnection at position @idx.</doc>
- <type name="SDPConnection" c:type="const GstSDPConnection*"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2424">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2425">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_format" c:identifier="gst_sdp_media_get_format">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2185">Get the format information at position @idx in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="626"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2192">the format at position @idx.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2187">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2188">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_information"
- c:identifier="gst_sdp_media_get_information">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2313">Get the information of @media</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="645"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2319">the information of @media.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2315">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_key" c:identifier="gst_sdp_media_get_key">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2722">Get the encryption information from @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="702"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2728">a #GstSDPKey.</doc>
- <type name="SDPKey" c:type="const GstSDPKey*"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2724">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_media" c:identifier="gst_sdp_media_get_media">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2043">Get the media description of @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="601"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2049">the media description.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2045">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_num_ports" c:identifier="gst_sdp_media_get_num_ports">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2096">Get the number of ports for @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="610"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2102">the number of ports for @media.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2098">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_port" c:identifier="gst_sdp_media_get_port">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2080">Get the port number for @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="607"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2086">the port number of @media.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2082">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_proto" c:identifier="gst_sdp_media_get_proto">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2133">Get the transport protocol of @media</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="617"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2139">the transport protocol of @media.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2135">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_sdp_media_init">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1820">Initialize @media so that its contents are as if it was freshly allocated
-with gst_sdp_media_new(). This function is mostly used to initialize a media
-allocated on the stack. gst_sdp_media_uninit() undoes this operation.
-
-When this function is invoked on newly allocated data (with malloc or on the
-stack), its contents should be set to 0 before calling this function.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="584"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1831">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1822">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="insert_attribute"
- c:identifier="gst_sdp_media_insert_attribute"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2848">Insert the attribute to @media at @idx. When @idx is -1,
-the attribute is appended.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="723"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2857">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2850">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2851">an index</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="attr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2852">a #GstSDPAttribute</doc>
- <type name="SDPAttribute" c:type="GstSDPAttribute*"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert_bandwidth"
- c:identifier="gst_sdp_media_insert_bandwidth"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2589">Insert the bandwidth information to @media at @idx. When @idx is -1,
-the bandwidth is appended.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="685"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2598">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2591">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2592">an index</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="bw" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2593">a #GstSDPBandwidth</doc>
- <type name="SDPBandwidth" c:type="GstSDPBandwidth*"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert_connection"
- c:identifier="gst_sdp_media_insert_connection"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2440">Insert the connection information to @media at @idx. When @idx is -1,
-the connection is appended.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="659"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2449">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2442">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2443">an index</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2444">a #GstSDPConnection</doc>
- <type name="SDPConnection" c:type="GstSDPConnection*"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert_format"
- c:identifier="gst_sdp_media_insert_format"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2204">Insert the format information to @media at @idx. When @idx is -1,
-the format is appended.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="629"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2213">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2206">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2207">an index</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2208">the format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="parse_keymgmt"
- c:identifier="gst_sdp_media_parse_keymgmt"
- version="1.8.1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4071">Creates a new #GstMIKEYMessage after parsing the key-mgmt attribute
-from a #GstSDPMedia.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="750"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4079">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4073">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="mikey"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4074">pointer to new #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage**"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_attribute"
- c:identifier="gst_sdp_media_remove_attribute"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2907">Remove the attribute in @media at @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="731"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2914">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2909">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2910">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_bandwidth"
- c:identifier="gst_sdp_media_remove_bandwidth"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2647">Remove the bandwidth information in @media at @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="693"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2654">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2649">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2650">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_connection"
- c:identifier="gst_sdp_media_remove_connection"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2499">Remove the connection information in @media at @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="667"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2506">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2501">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2502">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_format"
- c:identifier="gst_sdp_media_remove_format"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2264">Remove the format information in @media at @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="637"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2271">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2266">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2267">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_attribute"
- c:identifier="gst_sdp_media_replace_attribute"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2878">Replace the attribute in @media at @idx with @attr.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="727"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2886">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2880">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2881">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="attr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2882">a #GstSDPAttribute</doc>
- <type name="SDPAttribute" c:type="GstSDPAttribute*"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_bandwidth"
- c:identifier="gst_sdp_media_replace_bandwidth"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2619">Replace the bandwidth information in @media at @idx with @bw.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="689"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2627">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2621">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2622">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="bw" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2623">a #GstSDPBandwidth</doc>
- <type name="SDPBandwidth" c:type="GstSDPBandwidth*"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_connection"
- c:identifier="gst_sdp_media_replace_connection"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2470">Replace the connection information in @media at @idx with @conn.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="663"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2478">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2472">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2473">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="conn" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2474">a #GstSDPConnection</doc>
- <type name="SDPConnection" c:type="GstSDPConnection*"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_format"
- c:identifier="gst_sdp_media_replace_format"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2236">Replace the format information in @media at @idx with @format.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="633"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2244">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2238">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2239">an index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2240">the format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_information"
- c:identifier="gst_sdp_media_set_information">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2329">Set the media information of @media to @information.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="648"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2336">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2331">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="information" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2332">the media information</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_key" c:identifier="gst_sdp_media_set_key">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2698">Adds the encryption information to @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="705"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2706">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2700">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2701">the encryption type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2702">the encryption data</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_media" c:identifier="gst_sdp_media_set_media">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2059">Set the media description of @media to @med.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="604"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2066">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2061">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="med" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2062">the media description</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_port_info" c:identifier="gst_sdp_media_set_port_info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2112">Set the port information in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="613"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2120">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2114">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="port" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2115">the port number</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="num_ports" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2116">the number of ports</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_proto" c:identifier="gst_sdp_media_set_proto">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2149">Set the media transport protocol of @media to @proto.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="620"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2156">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2151">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- <parameter name="proto" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="2152">the media transport protocol</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="uninit" c:identifier="gst_sdp_media_uninit">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1852">Free all resources allocated in @media. @media should not be used anymore after
-this function. This function should be used when @media was allocated on the
-stack and initialized with gst_sdp_media_init().</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="587"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1860">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1854">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="new" c:identifier="gst_sdp_media_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1798">Allocate a new GstSDPMedia and store the result in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="581"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1804">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <parameter name="media"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1800">pointer to new #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia**"/>
- </parameter>
- </parameters>
- </function>
- <function name="set_media_from_caps"
- c:identifier="gst_sdp_media_set_media_from_caps"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3742">Mapping of caps to SDP fields:
-
-a=rtpmap:(payload) (encoding_name) or (clock_rate)[or (encoding_params)]
-
-a=framesize:(payload) (width)-(height)
-
-a=fmtp:(payload) (param)[=(value)];...
-
-a=rtcp-fb:(payload) (param1) [param2]...
-
-a=extmap:(id)[/direction] (extensionname) (extensionattributes)</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="741"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3759">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3744">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- <parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3745">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <record name="SDPMessage"
- c:type="GstSDPMessage"
- glib:type-name="GstSDPMessage"
- glib:get-type="gst_sdp_message_get_type"
- c:symbol-prefix="sdp_message">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="43">The GstSDPMessage helper functions makes it easy to parse and create SDP
-messages.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="310"/>
- <field name="version" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="278">the protocol version</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="origin" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="279">owner/creator and session identifier</doc>
- <type name="SDPOrigin" c:type="GstSDPOrigin"/>
- </field>
- <field name="session_name" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="280">session name</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="information" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="281">session information</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="uri" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="282">URI of description</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="emails" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="283">array of #gchar with email addresses</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="phones" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="284">array of #gchar with phone numbers</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="connection" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="285">connection information for the session</doc>
- <type name="SDPConnection" c:type="GstSDPConnection"/>
- </field>
- <field name="bandwidths" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="286">array of #GstSDPBandwidth with bandwidth information</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="times" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="287">array of #GstSDPTime with time descriptions</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="zones" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="288">array of #GstSDPZone with time zone adjustments</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="key" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="289">encryption key</doc>
- <type name="SDPKey" c:type="GstSDPKey"/>
- </field>
- <field name="attributes" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="290">array of #GstSDPAttribute with session attributes</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="medias" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="291">array of #GstSDPMedia with media descriptions</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="add_attribute"
- c:identifier="gst_sdp_message_add_attribute">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1721">Add the attribute with @key and @value to @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="561"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1729">@GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1723">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1724">the key</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1725">the value</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_bandwidth"
- c:identifier="gst_sdp_message_add_bandwidth">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1216">Add the specified bandwidth information to @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="475"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1224">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1218">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="bwtype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1219">the bandwidth modifier type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="bandwidth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1220">the bandwidth in kilobits per second</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_email" c:identifier="gst_sdp_message_add_email">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="975">Add @email to the list of emails in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="422"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="982">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="977">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="email" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="978">an email</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_media" c:identifier="gst_sdp_message_add_media">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1766">Adds @media to the array of medias in @msg. This function takes ownership of
-the contents of @media so that @media will have to be reinitialized with
-gst_sdp_media_init() before it can be used again.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="573"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1775">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1768">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1769">a #GstSDPMedia to add</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_phone" c:identifier="gst_sdp_message_add_phone">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1048">Add @phone to the list of phones in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="444"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1055">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1050">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="phone" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1051">a phone</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_time" c:identifier="gst_sdp_message_add_time">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1363">Add time information @start and @stop to @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="499"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1372">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1365">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1366">the start time</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="stop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1367">the stop time</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="repeat" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1368">the repeat times</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="add_zone" c:identifier="gst_sdp_message_add_zone">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1498">Add time zone information to @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="522"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1506">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1500">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="adj_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1501">the NTP time that a time zone adjustment happens</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="typed_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1502">the offset from the time when the session was first scheduled</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="as_text" c:identifier="gst_sdp_message_as_text">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="485">Convert the contents of @msg to a text string.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="341"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="491">A dynamically allocated string representing the SDP description.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="487">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="attributes_len"
- c:identifier="gst_sdp_message_attributes_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1604">Get the number of attributes in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="536"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1610">the number of attributes in @msg.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1606">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="attributes_to_caps"
- c:identifier="gst_sdp_message_attributes_to_caps"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4247">Mapping of attributes of #GstSDPMessage to #GstCaps</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="753"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4254">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4249">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4250">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="bandwidths_len"
- c:identifier="gst_sdp_message_bandwidths_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1148">Get the number of bandwidth information in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="458"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1154">the number of bandwidth information in @msg.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1150">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_sdp_message_copy" version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="327">Allocate a new copy of @msg and store the result in @copy. The value in
-@copy should be release with gst_sdp_message_free function.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="335"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="335">a #GstSDPResult</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="329">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="copy"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="330">pointer to new #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage**"/>
- </parameter>
- </parameters>
- </method>
- <method name="dump" c:identifier="gst_sdp_message_dump">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3275">Dump the parsed contents of @msg to stdout.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="576"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3281">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3277">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="emails_len" c:identifier="gst_sdp_message_emails_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="913">Get the number of emails in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="405"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="919">the number of emails in @msg.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="915">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_sdp_message_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="431">Free all resources allocated by @msg. @msg should not be used anymore after
-this function. This function should be used when @msg was dynamically
-allocated with gst_sdp_message_new().</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="332"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="439">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="433">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_attribute"
- c:identifier="gst_sdp_message_get_attribute">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1614">Get the attribute at position @idx in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="539"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1621">the #GstSDPAttribute at position @idx.</doc>
- <type name="SDPAttribute" c:type="const GstSDPAttribute*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1616">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1617">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_attribute_val"
- c:identifier="gst_sdp_message_get_attribute_val">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1658">Get the first attribute with key @key in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="542"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1665">the attribute value of the first attribute with @key.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1660">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1661">the key</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_attribute_val_n"
- c:identifier="gst_sdp_message_get_attribute_val_n">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1625">Get the @nth attribute with key @key in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="546"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1633">the attribute value of the @nth attribute with @key.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1627">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1628">the key</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1629">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_bandwidth"
- c:identifier="gst_sdp_message_get_bandwidth">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1157">Get the bandwidth at index @idx from @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="461"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1164">a #GstSDPBandwidth.</doc>
- <type name="SDPBandwidth" c:type="const GstSDPBandwidth*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1159">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1160">the bandwidth index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_connection"
- c:identifier="gst_sdp_message_get_connection">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1089">Get the connection of @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="449"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1095">a #GstSDPConnection. The result remains valid as long as @msg is valid.</doc>
- <type name="SDPConnection" c:type="const GstSDPConnection*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1091">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_email" c:identifier="gst_sdp_message_get_email">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="922">Get the email with number @idx from @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="408"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="929">the email at position @idx.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="924">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="925">an email index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_information"
- c:identifier="gst_sdp_message_get_information">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="884">Get the information in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="389"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="890">a #GstSDPResult.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="886">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_key" c:identifier="gst_sdp_message_get_key">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1544">Get the encryption information from @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="528"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1550">a #GstSDPKey.</doc>
- <type name="SDPKey" c:type="const GstSDPKey*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1546">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_media" c:identifier="gst_sdp_message_get_media">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1755">Get the media description at index @idx in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="570"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1762">a #GstSDPMedia.</doc>
- <type name="SDPMedia" c:type="const GstSDPMedia*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1757">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1758">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_origin" c:identifier="gst_sdp_message_get_origin">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="839">Get the origin of @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="370"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="845">a #GstSDPOrigin. The result remains valid as long as @msg is valid.</doc>
- <type name="SDPOrigin" c:type="const GstSDPOrigin*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="841">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_phone" c:identifier="gst_sdp_message_get_phone">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="995">Get the phone with number @idx from @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="430"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1002">the phone at position @idx.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="997">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="998">a phone index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_session_name"
- c:identifier="gst_sdp_message_get_session_name">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="865">Get the session name in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="381"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="871">a #GstSDPResult.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="867">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_time" c:identifier="gst_sdp_message_get_time">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1305">Get time information with index @idx from @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="485"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1312">a #GstSDPTime.</doc>
- <type name="SDPTime" c:type="const GstSDPTime*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1307">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1308">the time index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_uri" c:identifier="gst_sdp_message_get_uri">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="903">Get the URI in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="397"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="909">a #GstSDPResult.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="905">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_version" c:identifier="gst_sdp_message_get_version">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="798">Get the version in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="362"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="804">a #GstSDPResult.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="800">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_zone" c:identifier="gst_sdp_message_get_zone">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1440">Get time zone information with index @idx from @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="508"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1447">a #GstSDPZone.</doc>
- <type name="SDPZone" c:type="const GstSDPZone*"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1442">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1443">the zone index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_sdp_message_init">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="263">Initialize @msg so that its contents are as if it was freshly allocated
-with gst_sdp_message_new(). This function is mostly used to initialize a message
-allocated on the stack. gst_sdp_message_uninit() undoes this operation.
-
-When this function is invoked on newly allocated data (with malloc or on the
-stack), its contents should be set to 0 before calling this function.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="326"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="274">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="265">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="insert_attribute"
- c:identifier="gst_sdp_message_insert_attribute"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1676">Insert attribute into the array of attributes in @msg
-at index @idx.
-When -1 is given as @idx, the attribute is inserted at the end.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="550"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1686">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1678">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1679">an index</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="attr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1680">a #GstSDPAttribute</doc>
- <type name="SDPAttribute" c:type="GstSDPAttribute*"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert_bandwidth"
- c:identifier="gst_sdp_message_insert_bandwidth"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1171">Insert bandwidth parameters into the array of bandwidths in @msg
-at index @idx.
-When -1 is given as @idx, the bandwidth is inserted at the end.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="464"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1181">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1173">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1174">an index</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="bw" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1175">the bandwidth</doc>
- <type name="SDPBandwidth" c:type="GstSDPBandwidth*"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert_email"
- c:identifier="gst_sdp_message_insert_email"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="933">Insert @email into the array of emails in @msg at index @idx.
-When -1 is given as @idx, the email is inserted at the end.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="411"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="942">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="935">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="936">an index</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="email" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="937">an email</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert_phone"
- c:identifier="gst_sdp_message_insert_phone"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1006">Insert @phone into the array of phone numbers in @msg at index @idx.
-When -1 is given as @idx, the phone is inserted at the end.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="433"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1015">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1008">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1009">a phone index</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="phone" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1010">a phone</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert_time"
- c:identifier="gst_sdp_message_insert_time"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1319">Insert time parameters into the array of times in @msg
-at index @idx.
-When -1 is given as @idx, the times are inserted at the end.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="488"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1329">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1321">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1322">an index</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="t" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1323">a #GstSDPTime</doc>
- <type name="SDPTime" c:type="GstSDPTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="insert_zone"
- c:identifier="gst_sdp_message_insert_zone"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1454">Insert zone parameters into the array of zones in @msg
-at index @idx.
-When -1 is given as @idx, the zone is inserted at the end.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="511"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1464">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1456">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1457">an index</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="zone" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1458">a #GstSDPZone</doc>
- <type name="SDPZone" c:type="GstSDPZone*"/>
- </parameter>
- </parameters>
- </method>
- <method name="medias_len" c:identifier="gst_sdp_message_medias_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1746">Get the number of media descriptions in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="567"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1752">the number of media descriptions in @msg.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1748">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="parse_keymgmt"
- c:identifier="gst_sdp_message_parse_keymgmt"
- version="1.8.1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4050">Creates a new #GstMIKEYMessage after parsing the key-mgmt attribute
-from a #GstSDPMessage.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="747"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4058">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4052">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="mikey"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="4053">pointer to new #GstMIKEYMessage</doc>
- <type name="MIKEYMessage" c:type="GstMIKEYMessage**"/>
- </parameter>
- </parameters>
- </method>
- <method name="phones_len" c:identifier="gst_sdp_message_phones_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="986">Get the number of phones in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="427"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="992">the number of phones in @msg.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="988">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_attribute"
- c:identifier="gst_sdp_message_remove_attribute"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1708">Remove the attribute in @msg at index @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="558"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1715">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1710">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1711">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_bandwidth"
- c:identifier="gst_sdp_message_remove_bandwidth"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1203">Remove the bandwidth information in @msg at index @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="472"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1210">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1205">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1206">the bandwidth index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_email"
- c:identifier="gst_sdp_message_remove_email"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="962">Remove the email in @msg at index @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="419"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="969">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="964">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="965">an email index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_phone"
- c:identifier="gst_sdp_message_remove_phone"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1035">Remove the phone number in @msg at index @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="441"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1042">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1037">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1038">a phone index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_time"
- c:identifier="gst_sdp_message_remove_time"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1350">Remove the time information in @msg at index @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="496"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1357">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1352">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1353">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_zone"
- c:identifier="gst_sdp_message_remove_zone"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1485">Remove the zone information in @msg at index @idx.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="519"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1492">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1487">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1488">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_attribute"
- c:identifier="gst_sdp_message_replace_attribute"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1693">Replace the attribute in @msg at index @idx with @attr.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="554"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1701">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1695">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1696">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="attr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1697">a #GstSDPAttribute</doc>
- <type name="SDPAttribute" c:type="GstSDPAttribute*"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_bandwidth"
- c:identifier="gst_sdp_message_replace_bandwidth"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1188">Replace the bandwidth information in @msg at index @idx with @bw.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="468"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1196">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1190">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1191">the bandwidth index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="bw" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1192">the bandwidth</doc>
- <type name="SDPBandwidth" c:type="GstSDPBandwidth*"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_email"
- c:identifier="gst_sdp_message_replace_email"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="948">Replace the email in @msg at index @idx with @email.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="415"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="956">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="950">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="951">an email index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="email" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="952">an email</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_phone"
- c:identifier="gst_sdp_message_replace_phone"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1021">Replace the phone number in @msg at index @idx with @phone.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="437"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1029">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1023">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1024">a phone index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="phone" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1025">a phone</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_time"
- c:identifier="gst_sdp_message_replace_time"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1335">Replace the time information in @msg at index @idx with @t.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="492"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1343">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1337">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1338">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="t" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1339">a #GstSDPTime</doc>
- <type name="SDPTime" c:type="GstSDPTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="replace_zone"
- c:identifier="gst_sdp_message_replace_zone"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1470">Replace the zone information in @msg at index @idx with @zone.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="515"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1478">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1472">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1473">the index</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="zone" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1474">a #GstSDPZone</doc>
- <type name="SDPZone" c:type="GstSDPZone*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_connection"
- c:identifier="gst_sdp_message_set_connection">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1060">Configure the SDP connection in @msg with the given parameters.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="452"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1072">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1062">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="nettype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1063">the type of network. "IN" is defined to have the meaning
-"Internet".</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="addrtype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1065">the type of address.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="address" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1066">the address</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="ttl" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1067">the time to live of the address</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="addr_number" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1068">the number of layers</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_information"
- c:identifier="gst_sdp_message_set_information">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="874">Set the information in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="392"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="881">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="876">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="information" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="877">the information</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_key" c:identifier="gst_sdp_message_set_key">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1522">Adds the encryption information to @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="531"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1530">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1524">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1525">the encryption type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1526">the encryption data</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_origin" c:identifier="gst_sdp_message_set_origin">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="808">Configure the SDP origin in @msg with the given parameters.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="373"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="820">#GST_SDP_OK.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="810">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="username" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="811">the user name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="sess_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="812">a session id</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="sess_version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="813">a session version</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="nettype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="814">a network type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="addrtype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="815">an address type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="addr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="816">an address</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_session_name"
- c:identifier="gst_sdp_message_set_session_name">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="855">Set the session name in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="384"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="862">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="857">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="session_name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="858">the session name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_uri" c:identifier="gst_sdp_message_set_uri">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="893">Set the URI in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="400"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="900">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="895">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="896">the URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_version" c:identifier="gst_sdp_message_set_version">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="788">Set the version in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="365"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="795">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="790">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- <parameter name="version" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="791">the version</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="times_len" c:identifier="gst_sdp_message_times_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1295">Get the number of time information entries in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="482"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1301">the number of time information entries in @msg.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1297">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="uninit" c:identifier="gst_sdp_message_uninit">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="299">Free all resources allocated in @msg. @msg should not be used anymore after
-this function. This function should be used when @msg was allocated on the
-stack and initialized with gst_sdp_message_init().</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="329"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="307">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="301">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="zones_len" c:identifier="gst_sdp_message_zones_len">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1431">Get the number of time zone information entries in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="505"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1437">the number of time zone information entries in @msg.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1433">a #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="as_uri" c:identifier="gst_sdp_message_as_uri">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="727">Creates a uri from @msg with the given @scheme. The uri has the format:
-
- \@scheme:///[#type=value *[&amp;type=value]]
-
- Where each value is url encoded.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="352"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="738">a uri for @msg.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="scheme" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="729">the uri scheme</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="730">the #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="new" c:identifier="gst_sdp_message_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="217">Allocate a new GstSDPMessage and store the result in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="323"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="223">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <parameter name="msg"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="219">pointer to new #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage**"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_from_text"
- c:identifier="gst_sdp_message_new_from_text"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="239">Parse @text and create a new SDPMessage from these.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="344"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="246">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <parameter name="text" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="241">A dynamically allocated string representing the SDP description</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="msg"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="242">pointer to new #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage**"/>
- </parameter>
- </parameters>
- </function>
- <function name="parse_buffer"
- c:identifier="gst_sdp_message_parse_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3127">Parse the contents of @size bytes pointed to by @data and store the result in
-@msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="338"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3136">#GST_SDP_OK on success.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3129">the start of the buffer</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3130">the size of the buffer</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3131">the result #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="parse_uri" c:identifier="gst_sdp_message_parse_uri">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="623">Parse the null-terminated @uri and store the result in @msg.
-
-The uri should be of the form:
-
- scheme://[address[:ttl=ttl][:noa=noa]]/[sessionname]
- [#type=value *[&amp;type=value]]
-
- where value is url encoded. This looslely resembles
- http://tools.ietf.org/html/draft-fujikawa-sdp-url-01</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="349"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="638">#GST_SDP_OK on success.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="625">the start of the uri</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="626">the result #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <record name="SDPOrigin" c:type="GstSDPOrigin">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="54">The contents of the SDP "o=" field which gives the originator of the session
-(their username and the address of the user's host) plus a session id and
-session version number.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="79"/>
- <field name="username" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="56">the user's login on the originating host, or it is "-"
- if the originating host does not support the concept of user ids.</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="sess_id" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="58">is a numeric string such that the tuple of @username, @sess_id,
- @nettype, @addrtype and @addr form a globally unique identifier for the
- session.</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="sess_version" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="61">a version number for this announcement</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="nettype" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="62">the type of network. "IN" is defined to have the meaning
- "Internet".</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="addrtype" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="64">the type of @addr.</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="addr" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="65">the globally unique address of the machine from which the session was
- created.</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- </record>
- <enumeration name="SDPResult" c:type="GstSDPResult">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdp.h"
- line="46">Return values for the SDP functions.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdp.h" line="56"/>
- <member name="ok" value="0" c:identifier="GST_SDP_OK">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdp.h"
- line="48">A successful return value</doc>
- </member>
- <member name="einval" value="-1" c:identifier="GST_SDP_EINVAL">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdp.h"
- line="49">a function was given invalid parameters</doc>
- </member>
- </enumeration>
- <record name="SDPTime" c:type="GstSDPTime">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="170">The contents of the SDP "t=" field which specify the start and stop times for
-a conference session.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="185"/>
- <field name="start" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="172">start time for the conference. The value is the decimal
- representation of Network Time Protocol (NTP) time values in seconds</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="stop" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="174">stop time for the conference. The value is the decimal
- representation of Network Time Protocol (NTP) time values in seconds</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="repeat" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="176">repeat times for a session</doc>
- <array name="GLib.Array" c:type="GArray*">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="clear" c:identifier="gst_sdp_time_clear" version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1272">Reset the time information in @t.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="192"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1278">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="t" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1274">a #GstSDPTime</doc>
- <type name="SDPTime" c:type="GstSDPTime*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set" c:identifier="gst_sdp_time_set" version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1238">Set time information @start, @stop and @repeat in @t.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="188"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1247">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="t" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1240">a #GstSDPTime</doc>
- <type name="SDPTime" c:type="GstSDPTime*"/>
- </instance-parameter>
- <parameter name="start" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1241">the start time</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="stop" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1242">the stop time</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="repeat" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1243">the repeat times</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- </record>
- <record name="SDPZone" c:type="GstSDPZone">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="194">The contents of the SDP "z=" field which allows the sender to
-specify a list of time zone adjustments and offsets from the base
-time.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="206"/>
- <field name="time" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="196">the NTP time that a time zone adjustment happens</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="typed_time" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="197">the offset from the time when the session was first scheduled</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <method name="clear" c:identifier="gst_sdp_zone_clear" version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1411">Reset the zone information in @zone.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="213"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1417">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="zone" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1413">a #GstSDPZone</doc>
- <type name="SDPZone" c:type="GstSDPZone*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set" c:identifier="gst_sdp_zone_set" version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1388">Set zone information in @zone.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="209"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1396">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="zone" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1390">a #GstSDPZone</doc>
- <type name="SDPZone" c:type="GstSDPZone*"/>
- </instance-parameter>
- <parameter name="adj_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1391">the NTP time that a time zone adjustment happens</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="typed_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1392">the offset from the time when the session was first scheduled</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <constant name="SDP_BWTYPE_AS" value="AS" c:type="GST_SDP_BWTYPE_AS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="117">The Application-Specific Maximum bandwidth modifier.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="122"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="SDP_BWTYPE_CT" value="CT" c:type="GST_SDP_BWTYPE_CT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="111">The Conference Total bandwidth modifier.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="116"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="SDP_BWTYPE_EXT_PREFIX"
- value="X-"
- c:type="GST_SDP_BWTYPE_EXT_PREFIX">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="123">The extension prefix bandwidth modifier.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="128"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="SDP_BWTYPE_RR" value="RR" c:type="GST_SDP_BWTYPE_RR">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="136">RTCP bandwidth allocated to data receivers (RFC 3556).</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="141"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="SDP_BWTYPE_RS" value="RS" c:type="GST_SDP_BWTYPE_RS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="130">RTCP bandwidth allocated to active data senders (RFC 3556).</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="135"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="SDP_BWTYPE_TIAS" value="TIAS" c:type="GST_SDP_BWTYPE_TIAS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.h"
- line="142">Transport Independent Application Specific Maximum bandwidth (RFC 3890).</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="147"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="SDP_MESSAGE"
- c:identifier="GST_SDP_MESSAGE"
- introspectable="0">
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="318"/>
- <parameters>
- <parameter name="object">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="SDP_MESSAGE_CAST"
- c:identifier="GST_SDP_MESSAGE_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="317"/>
- <parameters>
- <parameter name="object">
- </parameter>
- </parameters>
- </function-macro>
- <docsection name="gstmikey">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstmikey.c"
- line="22">The GstMIKEY helper functions makes it easy to parse and create MIKEY
-messages.</doc>
- </docsection>
- <function name="sdp_address_is_multicast"
- c:identifier="gst_sdp_address_is_multicast">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="452">Check if the given @addr is a multicast address.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="357"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="460">TRUE when @addr is multicast.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="nettype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="454">a network type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="addrtype" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="455">an address type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="addr" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="456">an address</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="sdp_make_keymgmt"
- c:identifier="gst_sdp_make_keymgmt"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3977">Makes key management data</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="744"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3984">a #gchar key-mgmt data,</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3979">a #gchar URI</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="base64" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3980">a #gchar base64-encoded key data</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="sdp_media_new"
- c:identifier="gst_sdp_media_new"
- moved-to="SDPMedia.new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1798">Allocate a new GstSDPMedia and store the result in @media.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="581"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1804">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <parameter name="media"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="1800">pointer to new #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia**"/>
- </parameter>
- </parameters>
- </function>
- <function name="sdp_media_set_media_from_caps"
- c:identifier="gst_sdp_media_set_media_from_caps"
- moved-to="SDPMedia.set_media_from_caps"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3742">Mapping of caps to SDP fields:
-
-a=rtpmap:(payload) (encoding_name) or (clock_rate)[or (encoding_params)]
-
-a=framesize:(payload) (width)-(height)
-
-a=fmtp:(payload) (param)[=(value)];...
-
-a=rtcp-fb:(payload) (param1) [param2]...
-
-a=extmap:(id)[/direction] (extensionname) (extensionattributes)</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="741"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3759">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3744">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- <parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3745">a #GstSDPMedia</doc>
- <type name="SDPMedia" c:type="GstSDPMedia*"/>
- </parameter>
- </parameters>
- </function>
- <function name="sdp_message_as_uri"
- c:identifier="gst_sdp_message_as_uri"
- moved-to="SDPMessage.as_uri">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="727">Creates a uri from @msg with the given @scheme. The uri has the format:
-
- \@scheme:///[#type=value *[&amp;type=value]]
-
- Where each value is url encoded.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="352"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="738">a uri for @msg.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="scheme" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="729">the uri scheme</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="730">the #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="const GstSDPMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="sdp_message_new"
- c:identifier="gst_sdp_message_new"
- moved-to="SDPMessage.new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="217">Allocate a new GstSDPMessage and store the result in @msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="323"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="223">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <parameter name="msg"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="219">pointer to new #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage**"/>
- </parameter>
- </parameters>
- </function>
- <function name="sdp_message_new_from_text"
- c:identifier="gst_sdp_message_new_from_text"
- moved-to="SDPMessage.new_from_text"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="239">Parse @text and create a new SDPMessage from these.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="344"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="246">a #GstSDPResult.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <parameter name="text" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="241">A dynamically allocated string representing the SDP description</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="msg"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="242">pointer to new #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage**"/>
- </parameter>
- </parameters>
- </function>
- <function name="sdp_message_parse_buffer"
- c:identifier="gst_sdp_message_parse_buffer"
- moved-to="SDPMessage.parse_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3127">Parse the contents of @size bytes pointed to by @data and store the result in
-@msg.</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="338"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3136">#GST_SDP_OK on success.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3129">the start of the buffer</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3130">the size of the buffer</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="3131">the result #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="sdp_message_parse_uri"
- c:identifier="gst_sdp_message_parse_uri"
- moved-to="SDPMessage.parse_uri">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="623">Parse the null-terminated @uri and store the result in @msg.
-
-The uri should be of the form:
-
- scheme://[address[:ttl=ttl][:noa=noa]]/[sessionname]
- [#type=value *[&amp;type=value]]
-
- where value is url encoded. This looslely resembles
- http://tools.ietf.org/html/draft-fujikawa-sdp-url-01</doc>
- <source-position filename="gst-libs/gst/sdp/gstsdpmessage.h" line="349"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="638">#GST_SDP_OK on success.</doc>
- <type name="SDPResult" c:type="GstSDPResult"/>
- </return-value>
- <parameters>
- <parameter name="uri" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="625">the start of the uri</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/sdp/gstsdpmessage.c"
- line="626">the result #GstSDPMessage</doc>
- <type name="SDPMessage" c:type="GstSDPMessage*"/>
- </parameter>
- </parameters>
- </function>
- </namespace>
-</repository>
diff --git a/girs/GstTag-1.0.gir b/girs/GstTag-1.0.gir
deleted file mode 100644
index eb10e2ba3f..0000000000
--- a/girs/GstTag-1.0.gir
+++ /dev/null
@@ -1,2639 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="Gst" version="1.0"/>
- <include name="GstBase" version="1.0"/>
- <package name="gstreamer-tag-1.0"/>
- <c:include name="gst/tag/tag.h"/>
- <namespace name="GstTag"
- version="1.0"
- shared-library="libgsttag-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <function-macro name="IS_TAG_DEMUX"
- c:identifier="GST_IS_TAG_DEMUX"
- introspectable="0">
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TAG_DEMUX_CLASS"
- c:identifier="GST_IS_TAG_DEMUX_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h" line="33"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TAG_MUX"
- c:identifier="GST_IS_TAG_MUX"
- introspectable="0">
- <source-position filename="gst-libs/gst/tag/gsttagmux.h" line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TAG_MUX_CLASS"
- c:identifier="GST_IS_TAG_MUX_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/tag/gsttagmux.h" line="37"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_TAG_XMP_WRITER"
- c:identifier="GST_IS_TAG_XMP_WRITER"
- introspectable="0">
- <source-position filename="gst-libs/gst/tag/xmpwriter.h" line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="TAG_ACOUSTID_FINGERPRINT"
- value="chromaprint-fingerprint"
- c:type="GST_TAG_ACOUSTID_FINGERPRINT"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="92">AcoustID Fingerprint (Chromaprint)</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="104"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_ACOUSTID_ID"
- value="acoustid-id"
- c:type="GST_TAG_ACOUSTID_ID"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="83">AcoustID Identifier</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="90"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_CONTRAST"
- value="capturing-contrast"
- c:type="GST_TAG_CAPTURING_CONTRAST">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="299">Direction of contrast processing applied when capturing an image. (string)
-
-The allowed values are:
- "normal"
- "soft"
- "hard"</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="309"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_DIGITAL_ZOOM_RATIO"
- value="capturing-digital-zoom-ratio"
- c:type="GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="204">Digital zoom ratio used when capturing an image. (double)</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="209"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_EXPOSURE_COMPENSATION"
- value="capturing-exposure-compensation"
- c:type="GST_TAG_CAPTURING_EXPOSURE_COMPENSATION">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="248">Exposure compensation using when capturing an image in EV. (double)</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="253"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_EXPOSURE_MODE"
- value="capturing-exposure-mode"
- c:type="GST_TAG_CAPTURING_EXPOSURE_MODE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="236">Exposure mode used when capturing an image. (string)
-
-The allowed values are:
- "auto-exposure"
- "manual-exposure"
- "auto-bracket"</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="246"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_EXPOSURE_PROGRAM"
- value="capturing-exposure-program"
- c:type="GST_TAG_CAPTURING_EXPOSURE_PROGRAM">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="218">Type of exposure control used when capturing an image. (string)
-
-The allowed values are:
- "undefined"
- "manual"
- "normal" - automatically controlled
- "aperture-priority" - user selects aperture value
- "shutter-priority" - user selects shutter speed
- "creative" - biased towards depth of field
- "action" - biased towards fast shutter speed
- "portrait" - closeup, leaving background out of focus
- "landscape" - landscape photos, background in focus</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="234"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_FLASH_FIRED"
- value="capturing-flash-fired"
- c:type="GST_TAG_CAPTURING_FLASH_FIRED">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="335">If flash was fired during the capture of an image. (boolean)
-
-Note that if this tag isn't present, it should not be assumed that
-the flash did not fire. It should be treated as unknown.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="343"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_FLASH_MODE"
- value="capturing-flash-mode"
- c:type="GST_TAG_CAPTURING_FLASH_MODE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="345">The flash mode selected during the capture of an image. (string)
-
-The allowed values are:
- "auto"
- "always"
- "never"</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="355"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_FOCAL_LENGTH"
- value="capturing-focal-length"
- c:type="GST_TAG_CAPTURING_FOCAL_LENGTH">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="188">Focal length used when capturing an image, in mm. (double)</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="193"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_FOCAL_LENGTH_35_MM"
- value="capturing-focal-length-35mm"
- c:type="GST_TAG_CAPTURING_FOCAL_LENGTH_35_MM"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="195">35 mm equivalent focal length used when capturing an image, in mm. (double)</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="202"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_FOCAL_RATIO"
- value="capturing-focal-ratio"
- c:type="GST_TAG_CAPTURING_FOCAL_RATIO">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="178">Focal ratio (f-number) used when capturing an image. (double)
-
-The value stored is the denominator of the focal ratio (f-number).
-For example, if this tag value is 2, the focal ratio is f/2.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="186"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_GAIN_ADJUSTMENT"
- value="capturing-gain-adjustment"
- c:type="GST_TAG_CAPTURING_GAIN_ADJUSTMENT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="268">Gain adjustment applied to an image. (string)
-
-The allowed values are:
- "none"
- "low-gain-up"
- "high-gain-up"
- "low-gain-down"
- "high-gain-down"</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="280"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_ISO_SPEED"
- value="capturing-iso-speed"
- c:type="GST_TAG_CAPTURING_ISO_SPEED">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="211">ISO speed used when capturing an image. (integer)</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="216"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_METERING_MODE"
- value="capturing-metering-mode"
- c:type="GST_TAG_CAPTURING_METERING_MODE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="357">Defines the way a camera determines the exposure. (string)
-
-The allowed values are:
- "unknown"
- "average"
- "center-weighted-average"
- "spot"
- "multi-spot"
- "pattern"
- "partial"
- "other"</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="372"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_SATURATION"
- value="capturing-saturation"
- c:type="GST_TAG_CAPTURING_SATURATION">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="311">Direction of saturation processing applied when capturing an image. (string)
-
-The allowed values are:
- "normal"
- "low-saturation"
- "high-saturation"</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="321"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_SCENE_CAPTURE_TYPE"
- value="capturing-scene-capture-type"
- c:type="GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="255">Scene mode used when capturing an image. (string)
-
-The allowed values are:
- "standard"
- "landscape"
- "portrait"
- "night-scene"</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="266"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_SHARPNESS"
- value="capturing-sharpness"
- c:type="GST_TAG_CAPTURING_SHARPNESS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="323">Direction of sharpness processing applied when capturing an image. (string)
-
-The allowed values are:
- "normal"
- "soft"
- "hard"</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="333"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_SHUTTER_SPEED"
- value="capturing-shutter-speed"
- c:type="GST_TAG_CAPTURING_SHUTTER_SPEED">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="171">Shutter speed used when capturing an image, in seconds. (fraction)</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="176"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_SOURCE"
- value="capturing-source"
- c:type="GST_TAG_CAPTURING_SOURCE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="374">Indicates the source of capture. The device/medium used to do the
-capture. (string)
-
-Allowed values are:
- "dsc" (= digital still camera)
- "transparent-scanner"
- "reflex-scanner"
- "other"</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="386"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CAPTURING_WHITE_BALANCE"
- value="capturing-white-balance"
- c:type="GST_TAG_CAPTURING_WHITE_BALANCE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="282">White balance mode used when capturing an image. (string)
-
-The allowed values are:
- "auto"
- "manual"
- "daylight"
- "cloudy"
- "tungsten"
- "fluorescent"
- "fluorescent h" (newer daylight-calibrated fluorescents)
- "flash"</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="297"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CDDA_CDDB_DISCID"
- value="discid"
- c:type="GST_TAG_CDDA_CDDB_DISCID">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="143">CDDB disc id in its short form (e.g. 'aa063d0f')</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="148"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CDDA_CDDB_DISCID_FULL"
- value="discid-full"
- c:type="GST_TAG_CDDA_CDDB_DISCID_FULL">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="150">CDDB disc id including all details</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="155"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CDDA_MUSICBRAINZ_DISCID"
- value="musicbrainz-discid"
- c:type="GST_TAG_CDDA_MUSICBRAINZ_DISCID">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="157">Musicbrainz disc id (e.g. 'ahg7JUcfR3vCYBphSDIogOOWrr0-')</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="162"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CDDA_MUSICBRAINZ_DISCID_FULL"
- value="musicbrainz-discid-full"
- c:type="GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="164">Musicbrainz disc id details</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="169"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CMML_CLIP"
- value="cmml-clip"
- c:type="GST_TAG_CMML_CLIP">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="119">Annodex CMML clip element tag</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="124"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CMML_HEAD"
- value="cmml-head"
- c:type="GST_TAG_CMML_HEAD">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="112">Annodex CMML head element tag</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="118"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_CMML_STREAM"
- value="cmml-stream"
- c:type="GST_TAG_CMML_STREAM">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="106">Annodex CMML stream element tag</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="111"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="TAG_DEMUX"
- c:identifier="GST_TAG_DEMUX"
- introspectable="0">
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h" line="30"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TAG_DEMUX_CLASS"
- c:identifier="GST_TAG_DEMUX_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h" line="31"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="TAG_ID3V2_HEADER_SIZE"
- value="10"
- c:type="GST_TAG_ID3V2_HEADER_SIZE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="456">ID3V2 header size considered minimum input for some functions such as
-gst_tag_list_from_id3v2_tag() and gst_tag_get_id3v2_tag_size() for example.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="462"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="TAG_IMAGE_HORIZONTAL_PPI"
- value="image-horizontal-ppi"
- c:type="GST_TAG_IMAGE_HORIZONTAL_PPI">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="388">Media (image/video) intended horizontal pixel density in ppi. (double)</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="393"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_IMAGE_VERTICAL_PPI"
- value="image-vertical-ppi"
- c:type="GST_TAG_IMAGE_VERTICAL_PPI">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="394">Media (image/video) intended vertical pixel density in ppi. (double)</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="399"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_MUSICAL_KEY"
- value="musical-key"
- c:type="GST_TAG_MUSICAL_KEY"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="125">Musical key in which the sound starts. It is represented as a string
-with a maximum length of three characters. The ground keys are
-represented with "A","B","C","D","E", "F" and "G" and halfkeys
-represented with "b" and "#". Minor is represented as "m" (e.g. "Dbm").
-Off key is represented with an "o" only.
-This notation might be extended in the future to support non-minor/major
-keys.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="138"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_MUSICBRAINZ_ALBUMARTISTID"
- value="musicbrainz-albumartistid"
- c:type="GST_TAG_MUSICBRAINZ_ALBUMARTISTID">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="54">MusicBrainz album artist ID</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="59"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_MUSICBRAINZ_ALBUMID"
- value="musicbrainz-albumid"
- c:type="GST_TAG_MUSICBRAINZ_ALBUMID">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="48">MusicBrainz album ID</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="53"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_MUSICBRAINZ_ARTISTID"
- value="musicbrainz-artistid"
- c:type="GST_TAG_MUSICBRAINZ_ARTISTID">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="42">MusicBrainz artist ID</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="47"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_MUSICBRAINZ_RELEASEGROUPID"
- value="musicbrainz-releasegroupid"
- c:type="GST_TAG_MUSICBRAINZ_RELEASEGROUPID"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="60">MusicBrainz Release Group ID</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="67"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_MUSICBRAINZ_RELEASETRACKID"
- value="musicbrainz-releasetrackid"
- c:type="GST_TAG_MUSICBRAINZ_RELEASETRACKID"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="68">MusicBrainz Release Track ID</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="75"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_MUSICBRAINZ_TRACKID"
- value="musicbrainz-trackid"
- c:type="GST_TAG_MUSICBRAINZ_TRACKID">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="36">MusicBrainz track ID</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="41"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="TAG_MUSICBRAINZ_TRMID"
- value="musicbrainz-trmid"
- c:type="GST_TAG_MUSICBRAINZ_TRMID">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="76">MusicBrainz track TRM ID</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="81"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="TAG_MUX"
- c:identifier="GST_TAG_MUX"
- introspectable="0">
- <source-position filename="gst-libs/gst/tag/gsttagmux.h" line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TAG_MUX_CLASS"
- c:identifier="GST_TAG_MUX_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/tag/gsttagmux.h" line="33"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TAG_XMP_WRITER"
- c:identifier="GST_TAG_XMP_WRITER"
- introspectable="0">
- <source-position filename="gst-libs/gst/tag/xmpwriter.h" line="29"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="TAG_XMP_WRITER_GET_INTERFACE"
- c:identifier="GST_TAG_XMP_WRITER_GET_INTERFACE"
- introspectable="0">
- <source-position filename="gst-libs/gst/tag/xmpwriter.h" line="33"/>
- <parameters>
- <parameter name="inst">
- </parameter>
- </parameters>
- </function-macro>
- <class name="TagDemux"
- c:symbol-prefix="tag_demux"
- c:type="GstTagDemux"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstTagDemux"
- glib:get-type="gst_tag_demux_get_type"
- glib:type-struct="TagDemuxClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagdemux.c"
- line="21">Provides a base class for demuxing tags at the beginning or end of a
-stream and handles things like typefinding, querying, seeking, and
-different modes of operation (chain-based, pull_range-based, and providing
-downstream elements with random access if upstream supports that). The tag
-is stripped from the output, and all offsets are adjusted for the tag
-sizes, so that to the downstream element the stream will appear as if
-there was no tag at all. Also, once the tag has been parsed, GstTagDemux
-will try to determine the media type of the resulting stream and add a
-source pad with the appropriate caps in order to facilitate auto-plugging.
-
-## Deriving from GstTagDemux
-
-Subclasses have to do four things:
-
- * In their base init function, they must add a pad template for the sink
- pad to the element class, describing the media type they can parse in
- the caps of the pad template.
- * In their class init function, they must override
- GST_TAG_DEMUX_CLASS(demux_klass)-&gt;identify_tag with their own identify
- function.
- * In their class init function, they must override
- GST_TAG_DEMUX_CLASS(demux_klass)-&gt;parse_tag with their own parse
- function.
- * In their class init function, they must also set
- GST_TAG_DEMUX_CLASS(demux_klass)-&gt;min_start_size and/or
- GST_TAG_DEMUX_CLASS(demux_klass)-&gt;min_end_size to the minimum size required
- for the identify function to decide whether the stream has a supported tag
- or not. A class parsing ID3v1 tags, for example, would set min_end_size to
- 128 bytes.</doc>
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h" line="129"/>
- <virtual-method name="identify_tag">
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h" line="110"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="demux" transfer-ownership="none">
- <type name="TagDemux" c:type="GstTagDemux*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="start_tag" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="tag_size" transfer-ownership="none">
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="merge_tags">
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h" line="123"/>
- <return-value transfer-ownership="full">
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <instance-parameter name="demux" transfer-ownership="none">
- <type name="TagDemux" c:type="GstTagDemux*"/>
- </instance-parameter>
- <parameter name="start_tags" transfer-ownership="none">
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="end_tags" transfer-ownership="none">
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="parse_tag">
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h" line="116"/>
- <return-value transfer-ownership="none">
- <type name="TagDemuxResult" c:type="GstTagDemuxResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="demux" transfer-ownership="none">
- <type name="TagDemux" c:type="GstTagDemux*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="start_tag" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="tag_size" transfer-ownership="none">
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="tags" transfer-ownership="none">
- <type name="Gst.TagList" c:type="GstTagList**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <field name="element">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagdemux.h"
- line="55">parent element</doc>
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TagDemuxPrivate" c:type="GstTagDemuxPrivate*"/>
- </field>
- <field name="reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TagDemuxClass"
- c:type="GstTagDemuxClass"
- glib:is-gtype-struct-for="TagDemux">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagdemux.h"
- line="69">The #GstTagDemuxClass structure. See documentation at beginning of section
-for details about what subclasses need to override and do.</doc>
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h" line="129"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagdemux.h"
- line="71">the parent class.</doc>
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="min_start_size">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagdemux.h"
- line="72">minimum size required to identify a tag at the start and
-determine its total size. Set to 0 if not interested in start tags.
-Subclasses should set this in their class_init function.</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="min_end_size">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagdemux.h"
- line="75">minimum size required to identify a tag at the end and
-determine its total size. Set to 0 if not interested in end tags.
-Subclasses should set this in their class_init function.</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="identify_tag">
- <callback name="identify_tag">
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h"
- line="110"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="demux" transfer-ownership="none">
- <type name="TagDemux" c:type="GstTagDemux*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="start_tag" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="tag_size" transfer-ownership="none">
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="parse_tag">
- <callback name="parse_tag">
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h"
- line="116"/>
- <return-value transfer-ownership="none">
- <type name="TagDemuxResult" c:type="GstTagDemuxResult"/>
- </return-value>
- <parameters>
- <parameter name="demux" transfer-ownership="none">
- <type name="TagDemux" c:type="GstTagDemux*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="start_tag" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="tag_size" transfer-ownership="none">
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="tags" transfer-ownership="none">
- <type name="Gst.TagList" c:type="GstTagList**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="merge_tags">
- <callback name="merge_tags">
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h"
- line="123"/>
- <return-value transfer-ownership="full">
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <parameter name="demux" transfer-ownership="none">
- <type name="TagDemux" c:type="GstTagDemux*"/>
- </parameter>
- <parameter name="start_tags" transfer-ownership="none">
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="end_tags" transfer-ownership="none">
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="TagDemuxPrivate" c:type="GstTagDemuxPrivate" disguised="1">
- <source-position filename="gst-libs/gst/tag/gsttagdemux.h" line="37"/>
- </record>
- <enumeration name="TagDemuxResult"
- glib:type-name="GstTagDemuxResult"
- glib:get-type="gst_tag_demux_result_get_type"
- c:type="GstTagDemuxResult">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagdemux.h"
- line="39">Result values from the parse_tag virtual function.</doc>
- <member name="broken_tag"
- value="0"
- c:identifier="GST_TAG_DEMUX_RESULT_BROKEN_TAG"
- glib:nick="broken-tag">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagdemux.h"
- line="41">cannot parse tag, just skip it</doc>
- </member>
- <member name="again"
- value="1"
- c:identifier="GST_TAG_DEMUX_RESULT_AGAIN"
- glib:nick="again">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagdemux.h"
- line="42">call again with less or more data</doc>
- </member>
- <member name="ok"
- value="2"
- c:identifier="GST_TAG_DEMUX_RESULT_OK"
- glib:nick="ok">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagdemux.h"
- line="43">parsed tag successfully</doc>
- </member>
- </enumeration>
- <enumeration name="TagImageType"
- glib:type-name="GstTagImageType"
- glib:get-type="gst_tag_image_type_get_type"
- c:type="GstTagImageType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="404">Type of image contained in an image tag (specified as "image-type" field in
-the info structure in the image's #GstSample)</doc>
- <member name="none"
- value="-1"
- c:identifier="GST_TAG_IMAGE_TYPE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="406">No image type. Can be used to
- tell functions such as gst_tag_image_data_to_image_sample() that no
- image type should be set.</doc>
- </member>
- <member name="undefined"
- value="0"
- c:identifier="GST_TAG_IMAGE_TYPE_UNDEFINED"
- glib:nick="undefined">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="409">Undefined/other image type</doc>
- </member>
- <member name="front_cover"
- value="1"
- c:identifier="GST_TAG_IMAGE_TYPE_FRONT_COVER"
- glib:nick="front-cover">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="410">Cover (front)</doc>
- </member>
- <member name="back_cover"
- value="2"
- c:identifier="GST_TAG_IMAGE_TYPE_BACK_COVER"
- glib:nick="back-cover">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="411">Cover (back)</doc>
- </member>
- <member name="leaflet_page"
- value="3"
- c:identifier="GST_TAG_IMAGE_TYPE_LEAFLET_PAGE"
- glib:nick="leaflet-page">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="412">Leaflet page</doc>
- </member>
- <member name="medium"
- value="4"
- c:identifier="GST_TAG_IMAGE_TYPE_MEDIUM"
- glib:nick="medium">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="413">Medium (e.g. label side of CD)</doc>
- </member>
- <member name="lead_artist"
- value="5"
- c:identifier="GST_TAG_IMAGE_TYPE_LEAD_ARTIST"
- glib:nick="lead-artist">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="414">Lead artist/lead performer/soloist</doc>
- </member>
- <member name="artist"
- value="6"
- c:identifier="GST_TAG_IMAGE_TYPE_ARTIST"
- glib:nick="artist">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="415">Artist/performer</doc>
- </member>
- <member name="conductor"
- value="7"
- c:identifier="GST_TAG_IMAGE_TYPE_CONDUCTOR"
- glib:nick="conductor">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="416">Conductor</doc>
- </member>
- <member name="band_orchestra"
- value="8"
- c:identifier="GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA"
- glib:nick="band-orchestra">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="417">Band/orchestra</doc>
- </member>
- <member name="composer"
- value="9"
- c:identifier="GST_TAG_IMAGE_TYPE_COMPOSER"
- glib:nick="composer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="418">Composer</doc>
- </member>
- <member name="lyricist"
- value="10"
- c:identifier="GST_TAG_IMAGE_TYPE_LYRICIST"
- glib:nick="lyricist">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="419">Lyricist/text writer</doc>
- </member>
- <member name="recording_location"
- value="11"
- c:identifier="GST_TAG_IMAGE_TYPE_RECORDING_LOCATION"
- glib:nick="recording-location">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="420">Recording location</doc>
- </member>
- <member name="during_recording"
- value="12"
- c:identifier="GST_TAG_IMAGE_TYPE_DURING_RECORDING"
- glib:nick="during-recording">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="421">During recording</doc>
- </member>
- <member name="during_performance"
- value="13"
- c:identifier="GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE"
- glib:nick="during-performance">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="422">During performance</doc>
- </member>
- <member name="video_capture"
- value="14"
- c:identifier="GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE"
- glib:nick="video-capture">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="423">Movie/video screen capture</doc>
- </member>
- <member name="fish"
- value="15"
- c:identifier="GST_TAG_IMAGE_TYPE_FISH"
- glib:nick="fish">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="424">A fish as funny as the ID3v2 spec</doc>
- </member>
- <member name="illustration"
- value="16"
- c:identifier="GST_TAG_IMAGE_TYPE_ILLUSTRATION"
- glib:nick="illustration">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="425">Illustration</doc>
- </member>
- <member name="band_artist_logo"
- value="17"
- c:identifier="GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO"
- glib:nick="band-artist-logo">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="426">Band/artist logotype</doc>
- </member>
- <member name="publisher_studio_logo"
- value="18"
- c:identifier="GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO"
- glib:nick="publisher-studio-logo">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="427">Publisher/studio logotype</doc>
- </member>
- </enumeration>
- <bitfield name="TagLicenseFlags"
- glib:type-name="GstTagLicenseFlags"
- glib:get-type="gst_tag_license_flags_get_type"
- c:type="GstTagLicenseFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="628">See http://creativecommons.org/ns for more information.</doc>
- <member name="permits_reproduction"
- value="1"
- c:identifier="GST_TAG_LICENSE_PERMITS_REPRODUCTION"
- glib:nick="permits-reproduction">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="630">making multiple copies
- is allowed</doc>
- </member>
- <member name="permits_distribution"
- value="2"
- c:identifier="GST_TAG_LICENSE_PERMITS_DISTRIBUTION"
- glib:nick="permits-distribution">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="632">distribution, public display
- and public performance are allowed</doc>
- </member>
- <member name="permits_derivative_works"
- value="4"
- c:identifier="GST_TAG_LICENSE_PERMITS_DERIVATIVE_WORKS"
- glib:nick="permits-derivative-works">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="634">distribution of derivative
- works is allowed</doc>
- </member>
- <member name="permits_sharing"
- value="8"
- c:identifier="GST_TAG_LICENSE_PERMITS_SHARING"
- glib:nick="permits-sharing">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="636">commercial derivatives are allowed,
- but only non-commercial distribution is allowed</doc>
- </member>
- <member name="requires_notice"
- value="256"
- c:identifier="GST_TAG_LICENSE_REQUIRES_NOTICE"
- glib:nick="requires-notice">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="638">copyright and license notices
- must be kept intact</doc>
- </member>
- <member name="requires_attribution"
- value="512"
- c:identifier="GST_TAG_LICENSE_REQUIRES_ATTRIBUTION"
- glib:nick="requires-attribution">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="640">credit must be given to
- copyright holder and/or author</doc>
- </member>
- <member name="requires_share_alike"
- value="1024"
- c:identifier="GST_TAG_LICENSE_REQUIRES_SHARE_ALIKE"
- glib:nick="requires-share-alike">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="642">derivative works must be
- licensed under the same terms or compatible terms as the original work</doc>
- </member>
- <member name="requires_source_code"
- value="2048"
- c:identifier="GST_TAG_LICENSE_REQUIRES_SOURCE_CODE"
- glib:nick="requires-source-code">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="644">source code (the preferred
- form for making modifications) must be provided when exercising some
- rights granted by the license</doc>
- </member>
- <member name="requires_copyleft"
- value="4096"
- c:identifier="GST_TAG_LICENSE_REQUIRES_COPYLEFT"
- glib:nick="requires-copyleft">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="647">derivative and combined works
- must be licensed under specified terms, similar to those of the original
- work</doc>
- </member>
- <member name="requires_lesser_copyleft"
- value="8192"
- c:identifier="GST_TAG_LICENSE_REQUIRES_LESSER_COPYLEFT"
- glib:nick="requires-lesser-copyleft">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="650">derivative works must be
- licensed under specified terms, with at least the same conditions as
- the original work; combinations with the work may be licensed under
- different terms</doc>
- </member>
- <member name="prohibits_commercial_use"
- value="65536"
- c:identifier="GST_TAG_LICENSE_PROHIBITS_COMMERCIAL_USE"
- glib:nick="prohibits-commercial-use">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="654">exercising rights for
- commercial purposes is prohibited</doc>
- </member>
- <member name="prohibits_high_income_nation_use"
- value="131072"
- c:identifier="GST_TAG_LICENSE_PROHIBITS_HIGH_INCOME_NATION_USE"
- glib:nick="prohibits-high-income-nation-use">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="656">use in a
- non-developing country is prohibited</doc>
- </member>
- <member name="creative_commons_license"
- value="16777216"
- c:identifier="GST_TAG_LICENSE_CREATIVE_COMMONS_LICENSE"
- glib:nick="creative-commons-license">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="658">this license was created
- by the Creative Commons project</doc>
- </member>
- <member name="free_software_foundation_license"
- value="33554432"
- c:identifier="GST_TAG_LICENSE_FREE_SOFTWARE_FOUNDATION_LICENSE"
- glib:nick="free-software-foundation-license">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="660">this license was
- created by the Free Software Foundation (FSF)</doc>
- </member>
- </bitfield>
- <class name="TagMux"
- c:symbol-prefix="tag_mux"
- c:type="GstTagMux"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstTagMux"
- glib:get-type="gst_tag_mux_get_type"
- glib:type-struct="TagMuxClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagmux.c"
- line="23">Provides a base class for adding tags at the beginning or end of a
-stream.
-
-## Deriving from GstTagMux
-
-Subclasses have to do the following things:
-
- * In their base init function, they must add pad templates for the sink
- pad and the source pad to the element class, describing the media type
- they accept and output in the caps of the pad template.
- * In their class init function, they must override the
- GST_TAG_MUX_CLASS(mux_klass)-&gt;render_start_tag and/or
- GST_TAG_MUX_CLASS(mux_klass)-&gt;render_end_tag vfuncs and set up a render
- function.</doc>
- <source-position filename="gst-libs/gst/tag/gsttagmux.h" line="80"/>
- <implements name="Gst.TagSetter"/>
- <virtual-method name="render_end_tag">
- <source-position filename="gst-libs/gst/tag/gsttagmux.h" line="76"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="mux" transfer-ownership="none">
- <type name="TagMux" c:type="GstTagMux*"/>
- </instance-parameter>
- <parameter name="tag_list" transfer-ownership="none">
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="render_start_tag">
- <source-position filename="gst-libs/gst/tag/gsttagmux.h" line="75"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="mux" transfer-ownership="none">
- <type name="TagMux" c:type="GstTagMux*"/>
- </instance-parameter>
- <parameter name="tag_list" transfer-ownership="none">
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <field name="element">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagmux.h"
- line="47">parent element</doc>
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="TagMuxPrivate" c:type="GstTagMuxPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="TagMuxClass"
- c:type="GstTagMuxClass"
- glib:is-gtype-struct-for="TagMux">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagmux.h"
- line="60">The #GstTagMuxClass structure. Subclasses need to override at least one
-of the two render vfuncs.</doc>
- <source-position filename="gst-libs/gst/tag/gsttagmux.h" line="80"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gsttagmux.h"
- line="62">the parent class.</doc>
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="render_start_tag">
- <callback name="render_start_tag">
- <source-position filename="gst-libs/gst/tag/gsttagmux.h" line="75"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="mux" transfer-ownership="none">
- <type name="TagMux" c:type="GstTagMux*"/>
- </parameter>
- <parameter name="tag_list" transfer-ownership="none">
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="render_end_tag">
- <callback name="render_end_tag">
- <source-position filename="gst-libs/gst/tag/gsttagmux.h" line="76"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="mux" transfer-ownership="none">
- <type name="TagMux" c:type="GstTagMux*"/>
- </parameter>
- <parameter name="tag_list" transfer-ownership="none">
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="TagMuxPrivate" c:type="GstTagMuxPrivate" disguised="1">
- <source-position filename="gst-libs/gst/tag/gsttagmux.h" line="43"/>
- </record>
- <interface name="TagXmpWriter"
- c:symbol-prefix="tag_xmp_writer"
- c:type="GstTagXmpWriter"
- glib:type-name="GstTagXmpWriter"
- glib:get-type="gst_tag_xmp_writer_get_type"
- glib:type-struct="TagXmpWriterInterface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="20">This interface is implemented by elements that are able to do XMP serialization. Examples for
-such elements are #jifmux and #qtmux.
-
-Applications can use this interface to configure which XMP schemas should be used when serializing
-tags into XMP. Schemas are represented by their names, a full list of the supported schemas can be
-obtained from gst_tag_xmp_list_schemas(). By default, all schemas are used.</doc>
- <source-position filename="gst-libs/gst/tag/xmpwriter.h" line="42"/>
- <prerequisite name="Gst.Element"/>
- <method name="add_all_schemas"
- c:identifier="gst_tag_xmp_writer_add_all_schemas">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="153">Adds all available XMP schemas to the configuration. Meaning that
-all will be used.</doc>
- <source-position filename="gst-libs/gst/tag/xmpwriter.h" line="48"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="155">a #GstTagXmpWriter</doc>
- <type name="TagXmpWriter" c:type="GstTagXmpWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="add_schema" c:identifier="gst_tag_xmp_writer_add_schema">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="174">Adds @schema to the list schemas</doc>
- <source-position filename="gst-libs/gst/tag/xmpwriter.h" line="51"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="176">a #GstTagXmpWriter</doc>
- <type name="TagXmpWriter" c:type="GstTagXmpWriter*"/>
- </instance-parameter>
- <parameter name="schema" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="177">the schema to be added</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="has_schema" c:identifier="gst_tag_xmp_writer_has_schema">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="195">Checks if @schema is going to be used</doc>
- <source-position filename="gst-libs/gst/tag/xmpwriter.h" line="55"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="202">%TRUE if it is going to be used</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="197">a #GstTagXmpWriter</doc>
- <type name="TagXmpWriter" c:type="GstTagXmpWriter*"/>
- </instance-parameter>
- <parameter name="schema" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="198">the schema to test</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="remove_all_schemas"
- c:identifier="gst_tag_xmp_writer_remove_all_schemas">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="257">Removes all schemas from the list of schemas to use. Meaning that no
-XMP will be generated.</doc>
- <source-position filename="gst-libs/gst/tag/xmpwriter.h" line="63"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="259">a #GstTagXmpWriter</doc>
- <type name="TagXmpWriter" c:type="GstTagXmpWriter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove_schema"
- c:identifier="gst_tag_xmp_writer_remove_schema">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="227">Removes a schema from the list of schemas to use. Nothing is done if
-the schema wasn't in the list</doc>
- <source-position filename="gst-libs/gst/tag/xmpwriter.h" line="59"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="229">a #GstTagXmpWriter</doc>
- <type name="TagXmpWriter" c:type="GstTagXmpWriter*"/>
- </instance-parameter>
- <parameter name="schema" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/xmpwriter.c"
- line="230">the schema to remove</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="tag_list_to_xmp_buffer"
- c:identifier="gst_tag_xmp_writer_tag_list_to_xmp_buffer">
- <source-position filename="gst-libs/gst/tag/xmpwriter.h" line="66"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="config" transfer-ownership="none">
- <type name="TagXmpWriter" c:type="GstTagXmpWriter*"/>
- </instance-parameter>
- <parameter name="taglist" transfer-ownership="none">
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="read_only" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- </interface>
- <record name="TagXmpWriterInterface"
- c:type="GstTagXmpWriterInterface"
- glib:is-gtype-struct-for="TagXmpWriter">
- <source-position filename="gst-libs/gst/tag/xmpwriter.h" line="42"/>
- <field name="parent">
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- </record>
- <docsection name="gsttag">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="33">Contains additional standardized GStreamer tag definitions for plugins
-and applications, and functions to register them with the GStreamer
-tag system.</doc>
- </docsection>
- <docsection name="gsttagexif">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="22">Contains utility function to parse #GstTagList&lt;!-- --&gt;s from exif
-buffers and to create exif buffers from #GstTagList&lt;!-- --&gt;s
-
-Note that next IFD fields on the created exif buffers are set to 0.</doc>
- </docsection>
- <docsection name="gsttagid3">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="22">Contains various utility functions for plugins to parse or create
-ID3 tags and map ID3v2 identifiers to and from GStreamer identifiers.</doc>
- </docsection>
- <docsection name="gsttaglanguagecodes">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="20">Provides helper functions to convert between the various ISO-639 language
-codes, and to map language codes to language names.</doc>
- </docsection>
- <docsection name="gsttaglicenses">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="20">Provides information about Creative Commons media licenses, which are
-often expressed in media files as a license URI in tags. Also useful
-for applications creating media files, in case the user wants to license
-the content under a Creative Commons license.</doc>
- </docsection>
- <docsection name="gsttagvorbis">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="22">Contains various utility functions for plugins to parse or create
-vorbiscomments and map them to and from #GstTagList&lt;!-- --&gt;s.</doc>
- </docsection>
- <docsection name="gsttagxmp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstxmptag.c"
- line="23">Contains various utility functions for plugins to parse or create
-xmp packets and map them to and from #GstTagList&lt;!-- --&gt;s.
-
-Please note that the xmp parser is very lightweight and not strict at all.</doc>
- </docsection>
- <function name="tag_check_language_code"
- c:identifier="gst_tag_check_language_code">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="486">Check if a given string contains a known ISO 639 language code.
-
-This is useful in situations where it's not clear whether a given
-string is a language code (which should be put into a #GST_TAG_LANGUAGE_CODE
-tag) or a free-form language name descriptor (which should be put into a
-#GST_TAG_LANGUAGE_NAME tag instead).</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="614"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="497">TRUE if the two- or three-letter language code in @lang_code
- is a valid ISO-639 language code.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="lang_code" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="488">ISO-639 language code (e.g. "deu" or "ger" or "de")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_freeform_string_to_utf8"
- c:identifier="gst_tag_freeform_string_to_utf8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="317">Convenience function to read a string with unknown character encoding. If
-the string is already in UTF-8 encoding, it will be returned right away.
-If not it tries to detect byte-order-mark for UTF-16/32 cases and use that.
-Otherwise, the environment will be searched for a number of environment
-variables (whose names are specified in the NULL-terminated string array
-@env_vars) containing a list of character encodings to try/use. If none
-are specified, the current locale will be tried. If that also doesn't work,
-WINDOWS-1252/ISO-8859-1 is assumed (which will almost always succeed).</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="581"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="333">a newly-allocated string in UTF-8 encoding, or NULL</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="319">string data</doc>
- <array length="1" zero-terminated="0" c:type="const gchar*">
- <type name="gchar"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="320">length of string data, or -1 if the string is NUL-terminated</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="env_vars" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="321">
- a NULL-terminated string array of environment variable names, or NULL</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="tag_from_id3_tag" c:identifier="gst_tag_from_id3_tag">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="119">Looks up the GStreamer tag for a ID3v2 tag.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="518"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="125">The corresponding GStreamer tag or NULL if none exists.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="id3_tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="121">ID3v2 tag to convert to GStreamer tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_from_id3_user_tag"
- c:identifier="gst_tag_from_id3_user_tag">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="185">Looks up the GStreamer tag for an ID3v2 user tag (e.g. description in
-TXXX frame or owner in UFID frame).</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="521"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="193">The corresponding GStreamer tag or NULL if none exists.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="187">the type of ID3v2 user tag (e.g. "TXXX" or "UDIF")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="id3_user_tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="188">ID3v2 user tag to convert to GStreamer tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_from_vorbis_tag"
- c:identifier="gst_tag_from_vorbis_tag">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="114">Looks up the GStreamer tag for a vorbiscomment tag.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="467"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="120">The corresponding GStreamer tag or NULL if none exists.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="vorbis_tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="116">vorbiscomment tag to convert to GStreamer tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_id3v2_tag_size"
- c:identifier="gst_tag_get_id3v2_tag_size">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/id3v2.c"
- line="85">Determines size of an ID3v2 tag on buffer containing at least ID3v2 header,
-i.e. at least #GST_TAG_ID3V2_HEADER_SIZE (10) bytes;</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="537"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/id3v2.c"
- line="92">Size of tag, or 0 if header is invalid or too small.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/id3v2.c"
- line="87">buffer holding ID3v2 tag (or at least the start of one)</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="tag_get_language_code"
- c:identifier="gst_tag_get_language_code"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="616">Convenience macro wrapping gst_tag_get_language_code_iso_639_1().</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="622"/>
- <parameters>
- <parameter name="lang_code">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tag.h"
- line="618">ISO-639 language code (e.g. "deu" or "ger" or "de")</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function name="tag_get_language_code_iso_639_1"
- c:identifier="gst_tag_get_language_code_iso_639_1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="338">Returns two-letter ISO-639-1 language code given a three-letter ISO-639-2
-language code or two-letter ISO-639-1 language code (both are accepted for
-convenience).
-
-Language codes are case-sensitive and expected to be lower case.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="605"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="348">two-letter ISO-639-1 language code string that maps to @lang_code,
- or NULL if no mapping is known. The returned string must not be
- modified or freed.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="lang_code" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="340">ISO-639 language code (e.g. "deu" or "ger" or "de")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_language_code_iso_639_2B"
- c:identifier="gst_tag_get_language_code_iso_639_2B">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="452">Returns three-letter ISO-639-2 "bibliographic" language code given a
-two-letter ISO-639-1 language code or a three-letter ISO-639-2 language
-code (both are accepted for convenience).
-
-The "bibliographic" code is derived from the English name of the language
-(e.g. "ger" for German instead of "de" or "deu"). In most scenarios, the
-"terminological" codes are preferred.
-
-Language codes are case-sensitive and expected to be lower case.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="608"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="466">three-letter ISO-639-2 language code string that maps to @lang_code,
- or NULL if no mapping is known. The returned string must not be
- modified or freed.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="lang_code" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="454">ISO-639 language code (e.g. "deu" or "ger" or "de")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_language_code_iso_639_2T"
- c:identifier="gst_tag_get_language_code_iso_639_2T">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="418">Returns three-letter ISO-639-2 "terminological" language code given a
-two-letter ISO-639-1 language code or a three-letter ISO-639-2 language
-code (both are accepted for convenience).
-
-The "terminological" code is derived from the local name of the language
-(e.g. "deu" for German instead of "ger"). In most scenarios, the
-"terminological" codes are preferred over the "bibliographic" ones.
-
-Language codes are case-sensitive and expected to be lower case.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="611"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="432">three-letter ISO-639-2 language code string that maps to @lang_code,
- or NULL if no mapping is known. The returned string must not be
- modified or freed.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="lang_code" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="420">ISO-639 language code (e.g. "deu" or "ger" or "de")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_language_codes"
- c:identifier="gst_tag_get_language_codes">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="259">Returns a list of known language codes (in form of two-letter ISO-639-1
-codes). This is useful for UIs to build a list of available languages for
-tagging purposes (e.g. to tag an audio track appropriately in a video or
-audio editor).</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="599"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="267">NULL-terminated string array with two-letter
- language codes. Free with g_strfreev() when no longer needed.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- </function>
- <function name="tag_get_language_name"
- c:identifier="gst_tag_get_language_name">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="304">Returns the name of the language given an ISO-639 language code as
-found in a GST_TAG_LANGUAGE_CODE tag. The name will be translated
-according to the current locale (if the library was built against the
-iso-codes package, otherwise the English name will be returned).
-
-Language codes are case-sensitive and expected to be lower case.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="602"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="315">language name in UTF-8 format, or NULL if @language_code could
- not be mapped to a language name. The returned string must not be
- modified and does not need to freed; it will stay valid until the
- application is terminated.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="language_code" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/lang.c"
- line="306">two or three-letter ISO-639 language code</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_license_description"
- c:identifier="gst_tag_get_license_description">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="412">Get the description of a license, which is a translated description
-of the license's main features.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="701"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="420">the description of the license, or NULL if the license is unknown
- or a description is not available.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="license_ref" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="414">a license reference string in form of a URI,
- e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_license_flags"
- c:identifier="gst_tag_get_license_flags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="320">Get the flags of a license, which describe most of the features of
-a license in their most general form.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="689"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="328">the flags of the license, or 0 if the license is unknown</doc>
- <type name="TagLicenseFlags" c:type="GstTagLicenseFlags"/>
- </return-value>
- <parameters>
- <parameter name="license_ref" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="322">a license reference string in form of a URI,
- e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_license_jurisdiction"
- c:identifier="gst_tag_get_license_jurisdiction">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="438">Get the jurisdiction code of a license. This is usually a two-letter
-ISO 3166-1 alpha-2 code, but there is also the special case of Scotland,
-for which no code exists and which is thus represented as "scotland".
-
-Known jurisdictions: ar, at, au, be, bg, br, ca, ch, cl, cn, co, de,
-dk, es, fi, fr, hr, hu, il, in, it, jp, kr, mk, mt, mx, my, nl, pe, pl,
-pt, scotland, se, si, tw, uk, us, za.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="704"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="451">the jurisdiction code of the license, or NULL if the license is
- unknown or is not specific to a particular jurisdiction.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="license_ref" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="440">a license reference string in form of a URI,
- e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_license_nick"
- c:identifier="gst_tag_get_license_nick">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="341">Get the nick name of a license, which is a short (untranslated) string
-such as e.g. "CC BY-NC-ND 2.0 UK".</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="692"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="349">the nick name of the license, or NULL if the license is unknown</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="license_ref" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="343">a license reference string in form of a URI,
- e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_license_title"
- c:identifier="gst_tag_get_license_title">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="386">Get the title of a license, which is a short translated description
-of the license's features (generally not very pretty though).</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="695"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="394">the title of the license, or NULL if the license is unknown or
- no title is available.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="license_ref" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="388">a license reference string in form of a URI,
- e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_license_version"
- c:identifier="gst_tag_get_license_version">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="466">Get the version of a license.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="698"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="473">the version of the license, or NULL if the license is not known or
- has no version</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="license_ref" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="468">a license reference string in form of a URI,
- e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_get_licenses" c:identifier="gst_tag_get_licenses">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="197">Returns a list of known license references (in form of URIs). This is
-useful for UIs to build a list of available licenses for tagging purposes
-(e.g. to tag an audio track appropriately in a video or audio editor, or
-an image in a camera application).</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="686"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/licenses.c"
- line="205">NULL-terminated array of license strings. Free
- with g_strfreev() when no longer needed.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- </function>
- <function name="tag_id3_genre_count"
- c:identifier="gst_tag_id3_genre_count">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="311">Gets the number of ID3v1 genres that can be identified. Winamp genres are
-included.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="509"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="317">the number of ID3v1 genres that can be identified</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- </function>
- <function name="tag_id3_genre_get" c:identifier="gst_tag_id3_genre_get">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="325">Gets the ID3v1 genre name for a given ID.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="512"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="331">the genre or NULL if no genre is associated with that ID.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="327">ID of genre to query</doc>
- <type name="guint" c:type="const guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_image_data_to_image_sample"
- c:identifier="gst_tag_image_data_to_image_sample">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="488">Helper function for tag-reading plugins to create a #GstSample suitable to
-add to a #GstTagList as an image tag (such as #GST_TAG_IMAGE or
-#GST_TAG_PREVIEW_IMAGE) from the encoded image data and an (optional) image
-type.
-
-Background: cover art and other images in tags are usually stored as a
-blob of binary image data, often accompanied by a MIME type or some other
-content type string (e.g. 'png', 'jpeg', 'jpg'). Sometimes there is also an
-'image type' to indicate what kind of image this is (e.g. front cover,
-back cover, artist, etc.). The image data may also be an URI to the image
-rather than the image itself.
-
-In GStreamer, image tags are #GstSample&lt;!-- --&gt;s containing the raw image
-data, with the sample caps describing the content type of the image
-(e.g. image/jpeg, image/png, text/uri-list). The sample info may contain
-an additional 'image-type' field of #GstTagImageType to describe
-the type of image (front cover, back cover etc.). #GST_TAG_PREVIEW_IMAGE
-tags should not carry an image type, their type is already indicated via
-the special tag name.
-
-This function will do various checks and typefind the encoded image
-data (we can't trust the declared mime type).</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="586"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="519">a newly-allocated image sample for use in tag lists, or NULL</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <parameter name="image_data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="490">the (encoded) image</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="image_data_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="491">the length of the encoded image data at @image_data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="image_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="492">type of the image, or #GST_TAG_IMAGE_TYPE_UNDEFINED. Pass
- #GST_TAG_IMAGE_TYPE_NONE if no image type should be set at all (e.g.
- for preview images)</doc>
- <type name="TagImageType" c:type="GstTagImageType"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_add_id3_image"
- c:identifier="gst_tag_list_add_id3_image">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="345">Adds an image from an ID3 APIC frame (or similar, such as used in FLAC)
-to the given tag list. Also see gst_tag_image_data_to_image_sample() for
-more information on image tags in GStreamer.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="528"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="357">%TRUE if the image was processed, otherwise %FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="tag_list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="347">a tag list</doc>
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </parameter>
- <parameter name="image_data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="348">the (encoded) image</doc>
- <array length="2" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="image_data_len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="349">the length of the encoded image data at @image_data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="id3_picture_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="350">picture type as per the ID3 (v2.4.0) specification for
- the APIC frame (0 = unknown/other)</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_from_exif_buffer"
- c:identifier="gst_tag_list_from_exif_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1941">Parses the IFD and IFD tags data contained in the buffer and puts it
-on a taglist. The base_offset is used to subtract from the offset in
-the tag entries and be able to get the offset relative to the buffer
-start</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="563"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1952">The parsed taglist</doc>
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1943">The exif buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="byte_order" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1944">byte order of the data</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="base_offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1945">Offset from the tiff header to this buffer</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_from_exif_buffer_with_tiff_header"
- c:identifier="gst_tag_list_from_exif_buffer_with_tiff_header">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1977">Parses the exif tags starting with a tiff header structure.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="568"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1983">The taglist</doc>
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1979">The exif buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_from_id3v2_tag"
- c:identifier="gst_tag_list_from_id3v2_tag">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/id3v2.c"
- line="179">Creates a new tag list that contains the information parsed out of a
-ID3 tag.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="534"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/id3v2.c"
- line="186">A new #GstTagList with all tags that could be extracted from the
- given vorbiscomment buffer or NULL on error.</doc>
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/id3v2.c"
- line="181">buffer to convert</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_from_vorbiscomment"
- c:identifier="gst_tag_list_from_vorbiscomment">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="408">Creates a new tag list that contains the information parsed out of a
-vorbiscomment packet.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="484"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="420">A new #GstTagList with all tags that could be extracted from the
- given vorbiscomment buffer or NULL on error.</doc>
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="410">data to convert</doc>
- <array length="1" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="411">size of @data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="id_data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="412">identification data at start of stream</doc>
- <array length="3" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="id_data_length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="413">length of identification data</doc>
- <type name="guint" c:type="const guint"/>
- </parameter>
- <parameter name="vendor_string"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="414">pointer to a string that should take the
- vendor string of this vorbis comment or NULL if you don't need it.</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_from_vorbiscomment_buffer"
- c:identifier="gst_tag_list_from_vorbiscomment_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="505">Creates a new tag list that contains the information parsed out of a
-vorbiscomment packet.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="491"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="516">A new #GstTagList with all tags that could be extracted from the
- given vorbiscomment buffer or NULL on error.</doc>
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="507">buffer to convert</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="id_data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="508">identification data at start of stream</doc>
- <array length="2" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="id_data_length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="509">length of identification data</doc>
- <type name="guint" c:type="const guint"/>
- </parameter>
- <parameter name="vendor_string"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="510">pointer to a string that should take the
- vendor string of this vorbis comment or NULL if you don't need it.</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_from_xmp_buffer"
- c:identifier="gst_tag_list_from_xmp_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstxmptag.c"
- line="1170">Parse a xmp packet into a taglist.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="542"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstxmptag.c"
- line="1176">new taglist or %NULL, free the list when done</doc>
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstxmptag.c"
- line="1172">buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_new_from_id3v1"
- c:identifier="gst_tag_list_new_from_id3v1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="261">Parses the data containing an ID3v1 tag and returns a #GstTagList from the
-parsed data.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="515"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="268">A new tag list or NULL if the data was not an ID3v1 tag.</doc>
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="263">128 bytes of data containing the ID3v1 tag</doc>
- <array zero-terminated="0" c:type="const guint8*" fixed-size="128">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_to_exif_buffer"
- c:identifier="gst_tag_list_to_exif_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1858">Formats the tags in taglist on exif format. The resulting buffer contains
-the tags IFD and is followed by the data pointed by the tag entries.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="555"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1867">A GstBuffer containing the tag entries followed by the tag data</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="taglist" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1860">The taglist</doc>
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="byte_order" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1861">byte order used in writing (G_LITTLE_ENDIAN or G_BIG_ENDIAN)</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="base_offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1862">Offset from the tiff header first byte</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_to_exif_buffer_with_tiff_header"
- c:identifier="gst_tag_list_to_exif_buffer_with_tiff_header">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1876">Formats the tags in taglist into exif structure, a tiff header
-is put in the beginning of the buffer.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="560"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1883">A GstBuffer containing the data</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="taglist" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstexiftag.c"
- line="1878">The taglist</doc>
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_to_vorbiscomment_buffer"
- c:identifier="gst_tag_list_to_vorbiscomment_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="781">Creates a new vorbiscomment buffer from a tag list.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="497"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="790">A new #GstBuffer containing a vorbiscomment buffer with all tags
- that could be converted from the given tag list.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="783">tag list to convert</doc>
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="id_data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="784">identification data at start of stream</doc>
- <array length="2" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="id_data_length" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="785">length of identification data, may be 0 if @id_data is NULL</doc>
- <type name="guint" c:type="const guint"/>
- </parameter>
- <parameter name="vendor_string"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="786">string that describes the vendor string or NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_list_to_xmp_buffer"
- c:identifier="gst_tag_list_to_xmp_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstxmptag.c"
- line="1697">Formats a taglist as a xmp packet using only the selected
-schemas. An empty list (%NULL) means that all schemas should
-be used</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="545"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstxmptag.c"
- line="1708">new buffer or %NULL, unref the buffer when done</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstxmptag.c"
- line="1699">tags</doc>
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="read_only" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstxmptag.c"
- line="1700">does the container forbid inplace editing</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="schemas" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstxmptag.c"
- line="1701">
- %NULL terminated array of schemas to be used on serialization</doc>
- <array c:type="const gchar**">
- <type name="utf8" c:type="gchar*"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="tag_parse_extended_comment"
- c:identifier="gst_tag_parse_extended_comment">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="253">Convenience function to parse a GST_TAG_EXTENDED_COMMENT string and
-separate it into its components.
-
-If successful, @key, @lang and/or @value will be set to newly allocated
-strings that you need to free with g_free() when done. @key and @lang
-may also be set to NULL by this function if there is no key or no language
-code in the extended comment string.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="574"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="271">TRUE if the string could be parsed, otherwise FALSE</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="ext_comment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="255">an extended comment string, see #GST_TAG_EXTENDED_COMMENT</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="key"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="256">
- return location for the comment description key, or NULL</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- <parameter name="lang"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="258">
- return location for the comment ISO-639 language code, or NULL</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- <parameter name="value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="260">return location for the actual comment string, or NULL</doc>
- <type name="utf8" c:type="gchar**"/>
- </parameter>
- <parameter name="fail_if_no_key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="261">whether to fail if strings are not in key=value form</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_register_musicbrainz_tags"
- c:identifier="gst_tag_register_musicbrainz_tags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/tags.c"
- line="224">Registers additional musicbrainz-specific tags with the GStreamer tag
-system. Plugins and applications that use these tags should call this
-function before using them. Can be called multiple times.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="593"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </function>
- <function name="tag_to_id3_tag" c:identifier="gst_tag_to_id3_tag">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="219">Looks up the ID3v2 tag for a GStreamer tag.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="525"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="225">The corresponding ID3v2 tag or NULL if none exists.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="gst_tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstid3tag.c"
- line="221">GStreamer tag to convert to vorbiscomment tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_to_vorbis_comments"
- c:identifier="gst_tag_to_vorbis_comments">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="644">Creates a new tag list that contains the information parsed out of a
-vorbiscomment packet.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="478"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="652">A #GList of newly-allocated
- key=value strings. Free with g_list_foreach (list, (GFunc) g_free, NULL)
- plus g_list_free (list)</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="utf8"/>
- </type>
- </return-value>
- <parameters>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="646">a #GstTagList</doc>
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="647">a GStreamer tag identifier, such as #GST_TAG_ARTIST</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_to_vorbis_tag" c:identifier="gst_tag_to_vorbis_tag">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="143">Looks up the vorbiscomment tag for a GStreamer tag.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="470"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="149">The corresponding vorbiscomment tag or NULL if none exists.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="gst_tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="145">GStreamer tag to convert to vorbiscomment tag</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="tag_xmp_list_schemas"
- c:identifier="gst_tag_xmp_list_schemas">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstxmptag.c"
- line="77">Gets the list of supported schemas in the xmp lib</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="550"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstxmptag.c"
- line="82">a %NULL terminated array of strings with the
- schema names</doc>
- <array c:type="const gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- </function>
- <function name="vorbis_tag_add" c:identifier="gst_vorbis_tag_add">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="170">Convenience function using gst_tag_from_vorbis_tag(), parsing
-a vorbis comment string into the right type and adding it to the
-given taglist @list.
-
-Unknown vorbiscomment tags will be added to the tag list in form
-of a #GST_TAG_EXTENDED_COMMENT.</doc>
- <source-position filename="gst-libs/gst/tag/tag.h" line="473"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="172">a #GstTagList</doc>
- <type name="Gst.TagList" c:type="GstTagList*"/>
- </parameter>
- <parameter name="tag" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="173">a vorbiscomment tag string (key in key=value), must be valid UTF-8</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/tag/gstvorbistag.c"
- line="174">a vorbiscomment value string (value in key=value), must be valid UTF-8</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- </namespace>
-</repository>
diff --git a/girs/GstVideo-1.0.gir b/girs/GstVideo-1.0.gir
deleted file mode 100644
index 1a579da007..0000000000
--- a/girs/GstVideo-1.0.gir
+++ /dev/null
@@ -1,25578 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="Gst" version="1.0"/>
- <include name="GstBase" version="1.0"/>
- <package name="gstreamer-video-1.0"/>
- <c:include name="gst/video/video.h"/>
- <namespace name="GstVideo"
- version="1.0"
- shared-library="libgstvideo-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <constant name="BUFFER_POOL_OPTION_VIDEO_AFFINE_TRANSFORMATION_META"
- value="GstBufferPoolOptionVideoAffineTransformation"
- c:type="GST_BUFFER_POOL_OPTION_VIDEO_AFFINE_TRANSFORMATION_META">
- <source-position filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="37"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="BUFFER_POOL_OPTION_VIDEO_ALIGNMENT"
- value="GstBufferPoolOptionVideoAlignment"
- c:type="GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideopool.h"
- line="37">A bufferpool option to enable extra padding. When a bufferpool supports this
-option, gst_buffer_pool_config_set_video_alignment() can be called.
-
-When this option is enabled on the bufferpool,
-#GST_BUFFER_POOL_OPTION_VIDEO_META should also be enabled.</doc>
- <source-position filename="gst-libs/gst/video/gstvideopool.h" line="46"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="BUFFER_POOL_OPTION_VIDEO_GL_TEXTURE_UPLOAD_META"
- value="GstBufferPoolOptionVideoGLTextureUploadMeta"
- c:type="GST_BUFFER_POOL_OPTION_VIDEO_GL_TEXTURE_UPLOAD_META"
- version="1.2.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="238">An option that can be activated on a bufferpool to request gl texture upload
-meta on buffers from the pool.
-
-When this option is enabled on the bufferpool,
-@GST_BUFFER_POOL_OPTION_VIDEO_META should also be enabled.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="249"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="BUFFER_POOL_OPTION_VIDEO_META"
- value="GstBufferPoolOptionVideoMeta"
- c:type="GST_BUFFER_POOL_OPTION_VIDEO_META">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideopool.h"
- line="29">An option that can be activated on bufferpool to request video metadata
-on buffers from the pool.</doc>
- <source-position filename="gst-libs/gst/video/gstvideopool.h" line="35"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="CAPS_FEATURE_FORMAT_INTERLACED"
- value="format:Interlaced"
- c:type="GST_CAPS_FEATURE_FORMAT_INTERLACED"
- version="1.16.">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="33">Name of the caps feature indicating that the stream is interlaced.
-
-Currently it is only used for video with 'interlace-mode=alternate'
-to ensure backwards compatibility for this new mode.
-In this mode each buffer carries a single field of interlaced video.
-@GST_VIDEO_BUFFER_FLAG_TOP_FIELD and @GST_VIDEO_BUFFER_FLAG_BOTTOM_FIELD
-indicate whether the buffer carries a top or bottom field. The order of
-buffers/fields in the stream and the timestamps on the buffers indicate the
-temporal order of the fields.
-Top and bottom fields are expected to alternate in this mode.
-The frame rate in the caps still signals the frame rate, so the notional field
-rate will be twice the frame rate from the caps
-(see @GST_VIDEO_INFO_FIELD_RATE_N).</doc>
- <source-position filename="gst-libs/gst/video/video-info.h" line="52"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="CAPS_FEATURE_META_GST_VIDEO_AFFINE_TRANSFORMATION_META"
- value="meta:GstVideoAffineTransformation"
- c:type="GST_CAPS_FEATURE_META_GST_VIDEO_AFFINE_TRANSFORMATION_META">
- <source-position filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="36"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="CAPS_FEATURE_META_GST_VIDEO_GL_TEXTURE_UPLOAD_META"
- value="meta:GstVideoGLTextureUploadMeta"
- c:type="GST_CAPS_FEATURE_META_GST_VIDEO_GL_TEXTURE_UPLOAD_META">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="236"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="CAPS_FEATURE_META_GST_VIDEO_META"
- value="meta:GstVideoMeta"
- c:type="GST_CAPS_FEATURE_META_GST_VIDEO_META">
- <source-position filename="gst-libs/gst/video/gstvideometa.h" line="34"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="CAPS_FEATURE_META_GST_VIDEO_OVERLAY_COMPOSITION"
- value="meta:GstVideoOverlayComposition"
- c:type="GST_CAPS_FEATURE_META_GST_VIDEO_OVERLAY_COMPOSITION">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="93"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="COLOR_BALANCE"
- c:identifier="GST_COLOR_BALANCE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/colorbalance.h" line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLOR_BALANCE_CHANNEL"
- c:identifier="GST_COLOR_BALANCE_CHANNEL"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/colorbalancechannel.h"
- line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLOR_BALANCE_CHANNEL_CLASS"
- c:identifier="GST_COLOR_BALANCE_CHANNEL_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/colorbalancechannel.h"
- line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="COLOR_BALANCE_GET_INTERFACE"
- c:identifier="GST_COLOR_BALANCE_GET_INTERFACE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/colorbalance.h" line="35"/>
- <parameters>
- <parameter name="inst">
- </parameter>
- </parameters>
- </function-macro>
- <interface name="ColorBalance"
- c:symbol-prefix="color_balance"
- c:type="GstColorBalance"
- glib:type-name="GstColorBalance"
- glib:get-type="gst_color_balance_get_type"
- glib:type-struct="ColorBalanceInterface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="29">This interface is implemented by elements which can perform some color
-balance operation on video frames they process. For example, modifying
-the brightness, contrast, hue or saturation.
-
-Example elements are 'xvimagesink' and 'colorbalance'</doc>
- <source-position filename="gst-libs/gst/video/colorbalance.h" line="91"/>
- <virtual-method name="get_balance_type" invoker="get_balance_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="195">Get the #GstColorBalanceType of this implementation.</doc>
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="82"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="201">A the #GstColorBalanceType.</doc>
- <type name="ColorBalanceType" c:type="GstColorBalanceType"/>
- </return-value>
- <parameters>
- <instance-parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="197">The #GstColorBalance implementation</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_value" invoker="get_value">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="164">Retrieve the current value of the indicated channel, between min_value
-and max_value.
-
-See Also: The #GstColorBalanceChannel.min_value and
- #GstColorBalanceChannel.max_value members of the
- #GstColorBalanceChannel object.</doc>
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="80"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="176">The current value of the channel.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="166">A #GstColorBalance instance</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </instance-parameter>
- <parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="167">A #GstColorBalanceChannel instance</doc>
- <type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="list_channels" invoker="list_channels">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="113">Retrieve a list of the available channels.</doc>
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="75"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="119">A
- GList containing pointers to #GstColorBalanceChannel
- objects. The list is owned by the #GstColorBalance
- instance and must not be freed.</doc>
- <type name="GLib.List" c:type="const GList*">
- <type name="ColorBalanceChannel"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="115">A #GstColorBalance instance</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_value" invoker="set_value">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="140">Sets the current value of the channel to the passed value, which must
-be between min_value and max_value.
-
-See Also: The #GstColorBalanceChannel.min_value and
- #GstColorBalanceChannel.max_value members of the
- #GstColorBalanceChannel object.</doc>
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="77"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="142">A #GstColorBalance instance</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </instance-parameter>
- <parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="143">A #GstColorBalanceChannel instance</doc>
- <type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="144">The new value for the channel.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="value_changed" invoker="value_changed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="219">A helper function called by implementations of the GstColorBalance
-interface. It fires the #GstColorBalance::value-changed signal on the
-instance, and the #GstColorBalanceChannel::value-changed signal on the
-channel object.</doc>
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="85"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="221">A #GstColorBalance instance</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </instance-parameter>
- <parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="222">A #GstColorBalanceChannel whose value has changed</doc>
- <type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="223">The new value of the channel</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="get_balance_type"
- c:identifier="gst_color_balance_get_balance_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="195">Get the #GstColorBalanceType of this implementation.</doc>
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="113"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="201">A the #GstColorBalanceType.</doc>
- <type name="ColorBalanceType" c:type="GstColorBalanceType"/>
- </return-value>
- <parameters>
- <instance-parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="197">The #GstColorBalance implementation</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_value" c:identifier="gst_color_balance_get_value">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="164">Retrieve the current value of the indicated channel, between min_value
-and max_value.
-
-See Also: The #GstColorBalanceChannel.min_value and
- #GstColorBalanceChannel.max_value members of the
- #GstColorBalanceChannel object.</doc>
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="176">The current value of the channel.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="166">A #GstColorBalance instance</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </instance-parameter>
- <parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="167">A #GstColorBalanceChannel instance</doc>
- <type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
- </parameter>
- </parameters>
- </method>
- <method name="list_channels"
- c:identifier="gst_color_balance_list_channels">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="113">Retrieve a list of the available channels.</doc>
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="100"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="119">A
- GList containing pointers to #GstColorBalanceChannel
- objects. The list is owned by the #GstColorBalance
- instance and must not be freed.</doc>
- <type name="GLib.List" c:type="const GList*">
- <type name="ColorBalanceChannel"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="115">A #GstColorBalance instance</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_value" c:identifier="gst_color_balance_set_value">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="140">Sets the current value of the channel to the passed value, which must
-be between min_value and max_value.
-
-See Also: The #GstColorBalanceChannel.min_value and
- #GstColorBalanceChannel.max_value members of the
- #GstColorBalanceChannel object.</doc>
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="103"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="142">A #GstColorBalance instance</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </instance-parameter>
- <parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="143">A #GstColorBalanceChannel instance</doc>
- <type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="144">The new value for the channel.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="value_changed"
- c:identifier="gst_color_balance_value_changed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="219">A helper function called by implementations of the GstColorBalance
-interface. It fires the #GstColorBalance::value-changed signal on the
-instance, and the #GstColorBalanceChannel::value-changed signal on the
-channel object.</doc>
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="118"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="221">A #GstColorBalance instance</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </instance-parameter>
- <parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="222">A #GstColorBalanceChannel whose value has changed</doc>
- <type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="223">The new value of the channel</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <glib:signal name="value-changed" when="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="88">Fired when the value of the indicated channel has changed.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="91">The #GstColorBalanceChannel</doc>
- <type name="ColorBalanceChannel"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="92">The new value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </glib:signal>
- </interface>
- <class name="ColorBalanceChannel"
- c:symbol-prefix="color_balance_channel"
- c:type="GstColorBalanceChannel"
- parent="GObject.Object"
- glib:type-name="GstColorBalanceChannel"
- glib:get-type="gst_color_balance_channel_get_type"
- glib:type-struct="ColorBalanceChannelClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalancechannel.c"
- line="28">The #GstColorBalanceChannel object represents a parameter
-for modifying the color balance implemented by an element providing the
-#GstColorBalance interface. For example, Hue or Saturation.</doc>
- <source-position filename="gst-libs/gst/video/colorbalancechannel.h"
- line="80"/>
- <virtual-method name="value_changed">
- <source-position filename="gst-libs/gst/video/colorbalancechannel.h"
- line="75"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="channel" transfer-ownership="none">
- <type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
- </instance-parameter>
- <parameter name="value" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </virtual-method>
- <field name="parent">
- <type name="GObject.Object" c:type="GObject"/>
- </field>
- <field name="label">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalancechannel.h"
- line="48">A string containing a descriptive name for this channel</doc>
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="min_value">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalancechannel.h"
- line="49">The minimum valid value for this channel.</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="max_value">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalancechannel.h"
- line="50">The maximum valid value for this channel.</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <glib:signal name="value-changed" when="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalancechannel.c"
- line="89">Fired when the value of the indicated channel has changed.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalancechannel.c"
- line="92">The new value</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="ColorBalanceChannelClass"
- c:type="GstColorBalanceChannelClass"
- glib:is-gtype-struct-for="ColorBalanceChannel">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalancechannel.h"
- line="64">Color-balance channel class.</doc>
- <source-position filename="gst-libs/gst/video/colorbalancechannel.h"
- line="80"/>
- <field name="parent">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalancechannel.h"
- line="66">the parent class</doc>
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </field>
- <field name="value_changed">
- <callback name="value_changed">
- <source-position filename="gst-libs/gst/video/colorbalancechannel.h"
- line="75"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="channel" transfer-ownership="none">
- <type name="ColorBalanceChannel"
- c:type="GstColorBalanceChannel*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="ColorBalanceInterface"
- c:type="GstColorBalanceInterface"
- glib:is-gtype-struct-for="ColorBalance">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.h"
- line="60">Color-balance interface.</doc>
- <source-position filename="gst-libs/gst/video/colorbalance.h" line="91"/>
- <field name="iface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.h"
- line="62">the parent interface</doc>
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- <field name="list_channels">
- <callback name="list_channels">
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="75"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="119">A
- GList containing pointers to #GstColorBalanceChannel
- objects. The list is owned by the #GstColorBalance
- instance and must not be freed.</doc>
- <type name="GLib.List" c:type="const GList*">
- <type name="ColorBalanceChannel"/>
- </type>
- </return-value>
- <parameters>
- <parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="115">A #GstColorBalance instance</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_value">
- <callback name="set_value">
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="77"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="142">A #GstColorBalance instance</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </parameter>
- <parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="143">A #GstColorBalanceChannel instance</doc>
- <type name="ColorBalanceChannel"
- c:type="GstColorBalanceChannel*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="144">The new value for the channel.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_value">
- <callback name="get_value">
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="80"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="176">The current value of the channel.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="166">A #GstColorBalance instance</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </parameter>
- <parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="167">A #GstColorBalanceChannel instance</doc>
- <type name="ColorBalanceChannel"
- c:type="GstColorBalanceChannel*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_balance_type">
- <callback name="get_balance_type">
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="82"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="201">A the #GstColorBalanceType.</doc>
- <type name="ColorBalanceType" c:type="GstColorBalanceType"/>
- </return-value>
- <parameters>
- <parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="197">The #GstColorBalance implementation</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="value_changed">
- <callback name="value_changed">
- <source-position filename="gst-libs/gst/video/colorbalance.h"
- line="85"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="balance" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="221">A #GstColorBalance instance</doc>
- <type name="ColorBalance" c:type="GstColorBalance*"/>
- </parameter>
- <parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="222">A #GstColorBalanceChannel whose value has changed</doc>
- <type name="ColorBalanceChannel"
- c:type="GstColorBalanceChannel*"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.c"
- line="223">The new value of the channel</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <enumeration name="ColorBalanceType"
- glib:type-name="GstColorBalanceType"
- glib:get-type="gst_color_balance_type_get_type"
- c:type="GstColorBalanceType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.h"
- line="42">An enumeration indicating whether an element implements color balancing
-operations in software or in dedicated hardware. In general, dedicated
-hardware implementations (such as those provided by xvimagesink) are
-preferred.</doc>
- <member name="hardware"
- value="0"
- c:identifier="GST_COLOR_BALANCE_HARDWARE"
- glib:nick="hardware">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.h"
- line="44">Color balance is implemented with dedicated
- hardware.</doc>
- </member>
- <member name="software"
- value="1"
- c:identifier="GST_COLOR_BALANCE_SOFTWARE"
- glib:nick="software">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/colorbalance.h"
- line="46">Color balance is implemented via software
- processing.</doc>
- </member>
- </enumeration>
- <function-macro name="IS_COLOR_BALANCE"
- c:identifier="GST_IS_COLOR_BALANCE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/colorbalance.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_COLOR_BALANCE_CHANNEL"
- c:identifier="GST_IS_COLOR_BALANCE_CHANNEL"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/colorbalancechannel.h"
- line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_COLOR_BALANCE_CHANNEL_CLASS"
- c:identifier="GST_IS_COLOR_BALANCE_CHANNEL_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/colorbalancechannel.h"
- line="39"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_NAVIGATION"
- c:identifier="GST_IS_NAVIGATION"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/navigation.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_AGGREGATOR"
- c:identifier="GST_IS_VIDEO_AGGREGATOR"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="180"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_AGGREGATOR_CLASS"
- c:identifier="GST_IS_VIDEO_AGGREGATOR_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="182"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_AGGREGATOR_CONVERT_PAD"
- c:identifier="GST_IS_VIDEO_AGGREGATOR_CONVERT_PAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="123"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_AGGREGATOR_CONVERT_PAD_CLASS"
- c:identifier="GST_IS_VIDEO_AGGREGATOR_CONVERT_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="124"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_AGGREGATOR_PAD"
- c:identifier="GST_IS_VIDEO_AGGREGATOR_PAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="43"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_AGGREGATOR_PAD_CLASS"
- c:identifier="GST_IS_VIDEO_AGGREGATOR_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="45"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_BUFFER_POOL"
- c:identifier="GST_IS_VIDEO_BUFFER_POOL"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideopool.h" line="62"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_DECODER"
- c:identifier="GST_IS_VIDEO_DECODER"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="40"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_DECODER_CLASS"
- c:identifier="GST_IS_VIDEO_DECODER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="42"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_DIRECTION"
- c:identifier="GST_IS_VIDEO_DIRECTION"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/videodirection.h"
- line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_ENCODER"
- c:identifier="GST_IS_VIDEO_ENCODER"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_ENCODER_CLASS"
- c:identifier="GST_IS_VIDEO_ENCODER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="41"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_FILTER"
- c:identifier="GST_IS_VIDEO_FILTER"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_FILTER_CLASS"
- c:identifier="GST_IS_VIDEO_FILTER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="41"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_ORIENTATION"
- c:identifier="GST_IS_VIDEO_ORIENTATION"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_OVERLAY"
- c:identifier="GST_IS_VIDEO_OVERLAY"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/videooverlay.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_OVERLAY_COMPOSITION"
- c:identifier="GST_IS_VIDEO_OVERLAY_COMPOSITION"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="197"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_OVERLAY_RECTANGLE"
- c:identifier="GST_IS_VIDEO_OVERLAY_RECTANGLE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="41"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_SINK"
- c:identifier="GST_IS_VIDEO_SINK"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideosink.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_VIDEO_SINK_CLASS"
- c:identifier="GST_IS_VIDEO_SINK_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideosink.h" line="39"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="META_TAG_VIDEO_COLORSPACE_STR"
- value="colorspace"
- c:type="GST_META_TAG_VIDEO_COLORSPACE_STR"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="117">This metadata stays relevant as long as video colorspace is unchanged.</doc>
- <source-position filename="gst-libs/gst/video/video.h" line="124"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_TAG_VIDEO_ORIENTATION_STR"
- value="orientation"
- c:type="GST_META_TAG_VIDEO_ORIENTATION_STR"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="101">This metadata stays relevant as long as video orientation is unchanged.</doc>
- <source-position filename="gst-libs/gst/video/video.h" line="108"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_TAG_VIDEO_SIZE_STR"
- value="size"
- c:type="GST_META_TAG_VIDEO_SIZE_STR"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="109">This metadata stays relevant as long as video size is unchanged.</doc>
- <source-position filename="gst-libs/gst/video/video.h" line="116"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="META_TAG_VIDEO_STR"
- value="video"
- c:type="GST_META_TAG_VIDEO_STR"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="93">This metadata is relevant for video streams.</doc>
- <source-position filename="gst-libs/gst/video/video.h" line="100"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="NAVIGATION"
- c:identifier="GST_NAVIGATION"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/navigation.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="NAVIGATION_GET_INTERFACE"
- c:identifier="GST_NAVIGATION_GET_INTERFACE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/navigation.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <interface name="Navigation"
- c:symbol-prefix="navigation"
- c:type="GstNavigation"
- glib:type-name="GstNavigation"
- glib:get-type="gst_navigation_get_type"
- glib:type-struct="NavigationInterface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="23">The Navigation interface is used for creating and injecting navigation related
-events such as mouse button presses, cursor motion and key presses. The associated
-library also provides methods for parsing received events, and for sending and
-receiving navigation related bus events. One main usecase is DVD menu navigation.
-
-The main parts of the API are:
-
-* The GstNavigation interface, implemented by elements which provide an application
- with the ability to create and inject navigation events into the pipeline.
-* GstNavigation event handling API. GstNavigation events are created in response to
- calls on a GstNavigation interface implementation, and sent in the pipeline. Upstream
- elements can use the navigation event API functions to parse the contents of received
- messages.
-
-* GstNavigation message handling API. GstNavigation messages may be sent on the message
- bus to inform applications of navigation related changes in the pipeline, such as the
- mouse moving over a clickable region, or the set of available angles changing.
-
-The GstNavigation message functions provide functions for creating and parsing
-custom bus messages for signaling GstNavigation changes.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="55"/>
- <function name="event_get_type"
- c:identifier="gst_navigation_event_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="706">Inspect a #GstEvent and return the #GstNavigationEventType of the event, or
-#GST_NAVIGATION_EVENT_INVALID if the event is not a #GstNavigation event.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="282"/>
- <return-value transfer-ownership="none">
- <type name="NavigationEventType" c:type="GstNavigationEventType"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="708">A #GstEvent to inspect.</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </function>
- <function name="event_parse_command"
- c:identifier="gst_navigation_event_parse_command">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="895">Inspect a #GstNavigation command event and retrieve the enum value of the
-associated command.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="302"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="904">TRUE if the navigation command could be extracted, otherwise FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="897">A #GstEvent to inspect.</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="command"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="898">Pointer to GstNavigationCommand to receive the
- type of the navigation event.</doc>
- <type name="NavigationCommand" c:type="GstNavigationCommand*"/>
- </parameter>
- </parameters>
- </function>
- <function name="event_parse_key_event"
- c:identifier="gst_navigation_event_parse_key_event">
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="285"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="750">A #GstEvent to inspect.</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="key"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="751">A pointer to a location to receive
- the string identifying the key press. The returned string is owned by the
- event, and valid only until the event is unreffed.</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- </parameters>
- </function>
- <function name="event_parse_mouse_button_event"
- c:identifier="gst_navigation_event_parse_mouse_button_event">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="775">Retrieve the details of either a #GstNavigation mouse button press event or
-a mouse button release event. Determine which type the event is using
-gst_navigation_event_get_type() to retrieve the #GstNavigationEventType.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="289"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="789">TRUE if the button number and both coordinates could be extracted,
- otherwise FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="777">A #GstEvent to inspect.</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="button"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="778">Pointer to a gint that will receive the button
- number associated with the event.</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="x"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="780">Pointer to a gdouble to receive the x coordinate of the
- mouse button event.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="y"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="782">Pointer to a gdouble to receive the y coordinate of the
- mouse button event.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </function>
- <function name="event_parse_mouse_move_event"
- c:identifier="gst_navigation_event_parse_mouse_move_event">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="817">Inspect a #GstNavigation mouse movement event and extract the coordinates
-of the event.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="293"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="828">TRUE if both coordinates could be extracted, otherwise FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="819">A #GstEvent to inspect.</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="x"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="820">Pointer to a gdouble to receive the x coordinate of the
- mouse movement.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="y"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="822">Pointer to a gdouble to receive the y coordinate of the
- mouse movement.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </function>
- <function name="event_parse_mouse_scroll_event"
- c:identifier="gst_navigation_event_parse_mouse_scroll_event"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="851">Inspect a #GstNavigation mouse scroll event and extract the coordinates
-of the event.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="297"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="866">TRUE if all coordinates could be extracted, otherwise FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="853">A #GstEvent to inspect.</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="x"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="854">Pointer to a gdouble to receive the x coordinate of the
- mouse movement.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="y"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="856">Pointer to a gdouble to receive the y coordinate of the
- mouse movement.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="delta_x"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="858">Pointer to a gdouble to receive the delta_x coordinate of the
- mouse movement.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="delta_y"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="860">Pointer to a gdouble to receive the delta_y coordinate of the
- mouse movement.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </function>
- <function name="message_get_type"
- c:identifier="gst_navigation_message_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="467">Check a bus message to see if it is a #GstNavigation event, and return
-the #GstNavigationMessageType identifying the type of the message if so.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="213"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="474">The type of the #GstMessage, or
-#GST_NAVIGATION_MESSAGE_INVALID if the message is not a #GstNavigation
-notification.</doc>
- <type name="NavigationMessageType"
- c:type="GstNavigationMessageType"/>
- </return-value>
- <parameters>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="469">A #GstMessage to inspect.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="message_new_angles_changed"
- c:identifier="gst_navigation_message_new_angles_changed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="639">Creates a new #GstNavigation message with type
-#GST_NAVIGATION_MESSAGE_ANGLES_CHANGED for notifying an application
-that the current angle, or current number of angles available in a
-multiangle video has changed.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="227"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="650">The new #GstMessage.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="641">A #GstObject to set as source of the new message.</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="cur_angle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="642">The currently selected angle.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="n_angles" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="643">The number of viewing angles now available.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="message_new_commands_changed"
- c:identifier="gst_navigation_message_new_commands_changed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="616">Creates a new #GstNavigation message with type
-#GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="224"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="623">The new #GstMessage.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="618">A #GstObject to set as source of the new message.</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </function>
- <function name="message_new_event"
- c:identifier="gst_navigation_message_new_event"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="561">Creates a new #GstNavigation message with type
-#GST_NAVIGATION_MESSAGE_EVENT.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="237"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="569">The new #GstMessage.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="563">A #GstObject to set as source of the new message.</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="564">A navigation #GstEvent</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </function>
- <function name="message_new_mouse_over"
- c:identifier="gst_navigation_message_new_mouse_over">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="507">Creates a new #GstNavigation message with type
-#GST_NAVIGATION_MESSAGE_MOUSE_OVER.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="216"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="516">The new #GstMessage.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="509">A #GstObject to set as source of the new message.</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="510">%TRUE if the mouse has entered a clickable area of the display.
-%FALSE if it over a non-clickable area.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="message_parse_angles_changed"
- c:identifier="gst_navigation_message_parse_angles_changed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="668">Parse a #GstNavigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED
-and extract the @cur_angle and @n_angles parameters.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="232"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="679">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="670">A #GstMessage to inspect.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </parameter>
- <parameter name="cur_angle"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="671">A pointer to a #guint to receive the new
- current angle number, or NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="n_angles"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="673">A pointer to a #guint to receive the new angle
- count, or NULL.</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="message_parse_event"
- c:identifier="gst_navigation_message_parse_event"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="587">Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_EVENT
-and extract contained #GstEvent. The caller must unref the @event when done
-with it.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="241"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="597">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="589">A #GstMessage to inspect.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </parameter>
- <parameter name="event"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="590">a pointer to a #GstEvent to receive
- the contained navigation event.</doc>
- <type name="Gst.Event" c:type="GstEvent**"/>
- </parameter>
- </parameters>
- </function>
- <function name="message_parse_mouse_over"
- c:identifier="gst_navigation_message_parse_mouse_over">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="533">Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_MOUSE_OVER
-and extract the active/inactive flag. If the mouse over event is marked
-active, it indicates that the mouse is over a clickable area.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="220"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="543">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="535">A #GstMessage to inspect.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </parameter>
- <parameter name="active"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="536">A pointer to a gboolean to receive the
- active/inactive state, or NULL.</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </function>
- <function name="query_get_type"
- c:identifier="gst_navigation_query_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="187">Inspect a #GstQuery and return the #GstNavigationQueryType associated with
-it if it is a #GstNavigation query.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="154"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="194">The #GstNavigationQueryType of the query, or
-#GST_NAVIGATION_QUERY_INVALID</doc>
- <type name="NavigationQueryType" c:type="GstNavigationQueryType"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="189">The query to inspect</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </function>
- <function name="query_new_angles"
- c:identifier="gst_navigation_query_new_angles">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="383">Create a new #GstNavigation angles query. When executed, it will
-query the pipeline for the set of currently available angles, which may be
-greater than one in a multiangle video.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="175"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="390">The new query.</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </return-value>
- </function>
- <function name="query_new_commands"
- c:identifier="gst_navigation_query_new_commands">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="222">Create a new #GstNavigation commands query. When executed, it will
-query the pipeline for the set of currently available commands.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="157"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="228">The new query.</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </return-value>
- </function>
- <function name="query_parse_angles"
- c:identifier="gst_navigation_query_parse_angles">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="426">Parse the current angle number in the #GstNavigation angles @query into the
-#guint pointed to by the @cur_angle variable, and the number of available
-angles into the #guint pointed to by the @n_angles variable.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="182"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="438">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="428">a #GstQuery</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="cur_angle"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="429">Pointer to a #guint into which to store the
- currently selected angle value from the query, or NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="n_angles"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="431">Pointer to a #guint into which to store the
- number of angles value from the query, or NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="query_parse_commands_length"
- c:identifier="gst_navigation_query_parse_commands_length">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="314">Parse the number of commands in the #GstNavigation commands @query.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="167"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="321">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="316">a #GstQuery</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="n_cmds"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="317">the number of commands in this query.</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="query_parse_commands_nth"
- c:identifier="gst_navigation_query_parse_commands_nth">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="344">Parse the #GstNavigation command query and retrieve the @nth command from
-it into @cmd. If the list contains less elements than @nth, @cmd will be
-set to #GST_NAVIGATION_COMMAND_INVALID.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="171"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="354">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="346">a #GstQuery</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="347">the nth command to retrieve.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="cmd"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="348">a pointer to store the nth command into.</doc>
- <type name="NavigationCommand" c:type="GstNavigationCommand*"/>
- </parameter>
- </parameters>
- </function>
- <function name="query_set_angles"
- c:identifier="gst_navigation_query_set_angles">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="405">Set the #GstNavigation angles query result field in @query.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="178"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="407">a #GstQuery</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="cur_angle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="408">the current viewing angle to set.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="n_angles" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="409">the number of viewing angles to set.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="query_set_commands"
- c:identifier="gst_navigation_query_set_commands"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="254">Set the #GstNavigation command query result fields in @query. The number
-of commands passed must be equal to @n_commands.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="160"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="256">a #GstQuery</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="n_cmds" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="257">the number of commands to set.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="258">A list of @GstNavigationCommand values, @n_cmds entries long.</doc>
- <varargs/>
- </parameter>
- </parameters>
- </function>
- <function name="query_set_commandsv"
- c:identifier="gst_navigation_query_set_commandsv">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="286">Set the #GstNavigation command query result fields in @query. The number
-of commands passed must be equal to @n_commands.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="163"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="288">a #GstQuery</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="n_cmds" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="289">the number of commands to set.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="cmds" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="290">An array containing @n_cmds
- @GstNavigationCommand values.</doc>
- <array length="1"
- zero-terminated="0"
- c:type="GstNavigationCommand*">
- <type name="NavigationCommand" c:type="GstNavigationCommand"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="send_event" invoker="send_event">
- <source-position filename="gst-libs/gst/video/navigation.h" line="54"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="navigation" transfer-ownership="none">
- <type name="Navigation" c:type="GstNavigation*"/>
- </instance-parameter>
- <parameter name="structure" transfer-ownership="none">
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="send_command" c:identifier="gst_navigation_send_command">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="166">Sends the indicated command to the navigation interface.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="324"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="navigation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="168">The navigation interface instance</doc>
- <type name="Navigation" c:type="GstNavigation*"/>
- </instance-parameter>
- <parameter name="command" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="169">The command to issue</doc>
- <type name="NavigationCommand" c:type="GstNavigationCommand"/>
- </parameter>
- </parameters>
- </method>
- <method name="send_event" c:identifier="gst_navigation_send_event">
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="308"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="navigation" transfer-ownership="none">
- <type name="Navigation" c:type="GstNavigation*"/>
- </instance-parameter>
- <parameter name="structure" transfer-ownership="none">
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="send_key_event"
- c:identifier="gst_navigation_send_key_event">
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="312"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="navigation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="90">The navigation interface instance</doc>
- <type name="Navigation" c:type="GstNavigation*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="91">The type of the key event. Recognised values are "key-press" and
-"key-release"</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="93">Character representation of the key. This is typically as produced
-by XKeysymToString.</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- </parameters>
- </method>
- <method name="send_mouse_event"
- c:identifier="gst_navigation_send_mouse_event">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="108">Sends a mouse event to the navigation interface. Mouse event coordinates
-are sent relative to the display space of the related output area. This is
-usually the size in pixels of the window associated with the element
-implementing the #GstNavigation interface.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="316"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="navigation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="110">The navigation interface instance</doc>
- <type name="Navigation" c:type="GstNavigation*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="111">The type of mouse event, as a text string. Recognised values are
-"mouse-button-press", "mouse-button-release" and "mouse-move".</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="button" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="113">The button number of the button being pressed or released. Pass 0
-for mouse-move events.</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="115">The x coordinate of the mouse event.</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="116">The y coordinate of the mouse event.</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- </parameters>
- </method>
- <method name="send_mouse_scroll_event"
- c:identifier="gst_navigation_send_mouse_scroll_event"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="138">Sends a mouse scroll event to the navigation interface. Mouse event coordinates
-are sent relative to the display space of the related output area. This is
-usually the size in pixels of the window associated with the element
-implementing the #GstNavigation interface.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="320"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="navigation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="140">The navigation interface instance</doc>
- <type name="Navigation" c:type="GstNavigation*"/>
- </instance-parameter>
- <parameter name="x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="141">The x coordinate of the mouse event.</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="142">The y coordinate of the mouse event.</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="delta_x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="143">The delta_x coordinate of the mouse event.</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="delta_y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="144">The delta_y coordinate of the mouse event.</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- </parameters>
- </method>
- </interface>
- <enumeration name="NavigationCommand"
- glib:type-name="GstNavigationCommand"
- glib:get-type="gst_navigation_command_get_type"
- c:type="GstNavigationCommand">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="62">A set of commands that may be issued to an element providing the
-#GstNavigation interface. The available commands can be queried via
-the gst_navigation_query_new_commands() query.
-
-For convenience in handling DVD navigation, the MENU commands are aliased as:
- GST_NAVIGATION_COMMAND_DVD_MENU = @GST_NAVIGATION_COMMAND_MENU1
- GST_NAVIGATION_COMMAND_DVD_TITLE_MENU = @GST_NAVIGATION_COMMAND_MENU2
- GST_NAVIGATION_COMMAND_DVD_ROOT_MENU = @GST_NAVIGATION_COMMAND_MENU3
- GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU = @GST_NAVIGATION_COMMAND_MENU4
- GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU = @GST_NAVIGATION_COMMAND_MENU5
- GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU = @GST_NAVIGATION_COMMAND_MENU6
- GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU = @GST_NAVIGATION_COMMAND_MENU7</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_NAVIGATION_COMMAND_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="64">An invalid command entry</doc>
- </member>
- <member name="menu1"
- value="1"
- c:identifier="GST_NAVIGATION_COMMAND_MENU1"
- glib:nick="menu1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="65">Execute navigation menu command 1. For DVD,
-this enters the DVD root menu, or exits back to the title from the menu.</doc>
- </member>
- <member name="menu2"
- value="2"
- c:identifier="GST_NAVIGATION_COMMAND_MENU2"
- glib:nick="menu2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="67">Execute navigation menu command 2. For DVD,
-this jumps to the DVD title menu.</doc>
- </member>
- <member name="menu3"
- value="3"
- c:identifier="GST_NAVIGATION_COMMAND_MENU3"
- glib:nick="menu3">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="69">Execute navigation menu command 3. For DVD,
-this jumps into the DVD root menu.</doc>
- </member>
- <member name="menu4"
- value="4"
- c:identifier="GST_NAVIGATION_COMMAND_MENU4"
- glib:nick="menu4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="71">Execute navigation menu command 4. For DVD,
-this jumps to the Subpicture menu.</doc>
- </member>
- <member name="menu5"
- value="5"
- c:identifier="GST_NAVIGATION_COMMAND_MENU5"
- glib:nick="menu5">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="73">Execute navigation menu command 5. For DVD,
-the jumps to the audio menu.</doc>
- </member>
- <member name="menu6"
- value="6"
- c:identifier="GST_NAVIGATION_COMMAND_MENU6"
- glib:nick="menu6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="75">Execute navigation menu command 6. For DVD,
-this jumps to the angles menu.</doc>
- </member>
- <member name="menu7"
- value="7"
- c:identifier="GST_NAVIGATION_COMMAND_MENU7"
- glib:nick="menu7">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="77">Execute navigation menu command 7. For DVD,
-this jumps to the chapter menu.</doc>
- </member>
- <member name="left"
- value="20"
- c:identifier="GST_NAVIGATION_COMMAND_LEFT"
- glib:nick="left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="79">Select the next button to the left in a menu,
-if such a button exists.</doc>
- </member>
- <member name="right"
- value="21"
- c:identifier="GST_NAVIGATION_COMMAND_RIGHT"
- glib:nick="right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="81">Select the next button to the right in a menu,
-if such a button exists.</doc>
- </member>
- <member name="up"
- value="22"
- c:identifier="GST_NAVIGATION_COMMAND_UP"
- glib:nick="up">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="83">Select the button above the current one in a
-menu, if such a button exists.</doc>
- </member>
- <member name="down"
- value="23"
- c:identifier="GST_NAVIGATION_COMMAND_DOWN"
- glib:nick="down">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="85">Select the button below the current one in a
-menu, if such a button exists.</doc>
- </member>
- <member name="activate"
- value="24"
- c:identifier="GST_NAVIGATION_COMMAND_ACTIVATE"
- glib:nick="activate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="87">Activate (click) the currently selected
-button in a menu, if such a button exists.</doc>
- </member>
- <member name="prev_angle"
- value="30"
- c:identifier="GST_NAVIGATION_COMMAND_PREV_ANGLE"
- glib:nick="prev-angle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="89">Switch to the previous angle in a
-multiangle feature.</doc>
- </member>
- <member name="next_angle"
- value="31"
- c:identifier="GST_NAVIGATION_COMMAND_NEXT_ANGLE"
- glib:nick="next-angle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="91">Switch to the next angle in a multiangle
-feature.</doc>
- </member>
- </enumeration>
- <enumeration name="NavigationEventType"
- glib:type-name="GstNavigationEventType"
- glib:get-type="gst_navigation_event_type_get_type"
- c:type="GstNavigationEventType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="244">Enum values for the various events that an element implementing the
-GstNavigation interface might send up the pipeline.</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_NAVIGATION_EVENT_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="246">Returned from
-gst_navigation_event_get_type() when the passed event is not a navigation event.</doc>
- </member>
- <member name="key_press"
- value="1"
- c:identifier="GST_NAVIGATION_EVENT_KEY_PRESS"
- glib:nick="key-press">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="248">A key press event. Use
-gst_navigation_event_parse_key_event() to extract the details from the event.</doc>
- </member>
- <member name="key_release"
- value="2"
- c:identifier="GST_NAVIGATION_EVENT_KEY_RELEASE"
- glib:nick="key-release">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="250">A key release event. Use
-gst_navigation_event_parse_key_event() to extract the details from the event.</doc>
- </member>
- <member name="mouse_button_press"
- value="3"
- c:identifier="GST_NAVIGATION_EVENT_MOUSE_BUTTON_PRESS"
- glib:nick="mouse-button-press">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="252">A mouse button press event. Use
-gst_navigation_event_parse_mouse_button_event() to extract the details from the
-event.</doc>
- </member>
- <member name="mouse_button_release"
- value="4"
- c:identifier="GST_NAVIGATION_EVENT_MOUSE_BUTTON_RELEASE"
- glib:nick="mouse-button-release">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="255">A mouse button release event. Use
-gst_navigation_event_parse_mouse_button_event() to extract the details from the
-event.</doc>
- </member>
- <member name="mouse_move"
- value="5"
- c:identifier="GST_NAVIGATION_EVENT_MOUSE_MOVE"
- glib:nick="mouse-move">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="258">A mouse movement event. Use
-gst_navigation_event_parse_mouse_move_event() to extract the details from the
-event.</doc>
- </member>
- <member name="command"
- value="6"
- c:identifier="GST_NAVIGATION_EVENT_COMMAND"
- glib:nick="command">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="261">A navigation command event. Use
-gst_navigation_event_parse_command() to extract the details from the event.</doc>
- </member>
- <member name="mouse_scroll"
- value="7"
- c:identifier="GST_NAVIGATION_EVENT_MOUSE_SCROLL"
- glib:nick="mouse-scroll">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="263">A mouse scroll event. Use
-gst_navigation_event_parse_mouse_scroll_event() to extract the details from
-the event. (Since: 1.18)</doc>
- </member>
- </enumeration>
- <record name="NavigationInterface"
- c:type="GstNavigationInterface"
- glib:is-gtype-struct-for="Navigation">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="43">Navigation interface.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="55"/>
- <field name="iface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="45">the parent interface</doc>
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- <field name="send_event">
- <callback name="send_event">
- <source-position filename="gst-libs/gst/video/navigation.h"
- line="54"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="navigation" transfer-ownership="none">
- <type name="Navigation" c:type="GstNavigation*"/>
- </parameter>
- <parameter name="structure" transfer-ownership="none">
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- </record>
- <enumeration name="NavigationMessageType"
- glib:type-name="GstNavigationMessageType"
- glib:get-type="gst_navigation_message_type_get_type"
- c:type="GstNavigationMessageType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="186">A set of notifications that may be received on the bus when navigation
-related status changes.</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_NAVIGATION_MESSAGE_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="188">Returned from
-gst_navigation_message_get_type() when the passed message is not a
-navigation message.</doc>
- </member>
- <member name="mouse_over"
- value="1"
- c:identifier="GST_NAVIGATION_MESSAGE_MOUSE_OVER"
- glib:nick="mouse-over">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="191">Sent when the mouse moves over or leaves a
-clickable region of the output, such as a DVD menu button.</doc>
- </member>
- <member name="commands_changed"
- value="2"
- c:identifier="GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED"
- glib:nick="commands-changed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="193">Sent when the set of available commands
-changes and should re-queried by interested applications.</doc>
- </member>
- <member name="angles_changed"
- value="3"
- c:identifier="GST_NAVIGATION_MESSAGE_ANGLES_CHANGED"
- glib:nick="angles-changed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="195">Sent when display angles in a multi-angle
-feature (such as a multiangle DVD) change - either angles have appeared or
-disappeared.</doc>
- </member>
- <member name="event"
- value="4"
- c:identifier="GST_NAVIGATION_MESSAGE_EVENT"
- glib:nick="event">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="198">Sent when a navigation event was not handled
-by any element in the pipeline (Since: 1.6)</doc>
- </member>
- </enumeration>
- <enumeration name="NavigationQueryType"
- glib:type-name="GstNavigationQueryType"
- glib:get-type="gst_navigation_query_type_get_type"
- c:type="GstNavigationQueryType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="138">Types of navigation interface queries.</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_NAVIGATION_QUERY_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="140">invalid query</doc>
- </member>
- <member name="commands"
- value="1"
- c:identifier="GST_NAVIGATION_QUERY_COMMANDS"
- glib:nick="commands">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="141">command query</doc>
- </member>
- <member name="angles"
- value="2"
- c:identifier="GST_NAVIGATION_QUERY_ANGLES"
- glib:nick="angles">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.h"
- line="142">viewing angle query</doc>
- </member>
- </enumeration>
- <function-macro name="VIDEO_AGGREGATOR"
- c:identifier="GST_VIDEO_AGGREGATOR"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="175"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_AGGREGATOR_CAST"
- c:identifier="GST_VIDEO_AGGREGATOR_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="177"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_AGGREGATOR_CLASS"
- c:identifier="GST_VIDEO_AGGREGATOR_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="178"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_AGGREGATOR_CONVERT_PAD"
- c:identifier="GST_VIDEO_AGGREGATOR_CONVERT_PAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="120"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_AGGREGATOR_CONVERT_PAD_CLASS"
- c:identifier="GST_VIDEO_AGGREGATOR_CONVERT_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="121"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_AGGREGATOR_CONVERT_PAD_GET_CLASS"
- c:identifier="GST_VIDEO_AGGREGATOR_CONVERT_PAD_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="122"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_AGGREGATOR_GET_CLASS"
- c:identifier="GST_VIDEO_AGGREGATOR_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="184"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_AGGREGATOR_PAD"
- c:identifier="GST_VIDEO_AGGREGATOR_PAD"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_AGGREGATOR_PAD_CAST"
- c:identifier="GST_VIDEO_AGGREGATOR_PAD_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="40"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_AGGREGATOR_PAD_CLASS"
- c:identifier="GST_VIDEO_AGGREGATOR_PAD_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="41"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_AGGREGATOR_PAD_GET_CLASS"
- c:identifier="GST_VIDEO_AGGREGATOR_PAD_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="47"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_ANCILLARY_DID16"
- c:identifier="GST_VIDEO_ANCILLARY_DID16"
- version="1.16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="78">Returns the #GstVideoAncillaryDID16 of the ancillary data.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="88"/>
- <parameters>
- <parameter name="anc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="80">a #GstVideoAncillary</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_BUFFER_IS_BOTTOM_FIELD"
- c:identifier="GST_VIDEO_BUFFER_IS_BOTTOM_FIELD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="226">Check if GST_VIDEO_BUFFER_FLAG_BOTTOM_FIELD is set on @buf (Since: 1.18).</doc>
- <source-position filename="gst-libs/gst/video/video-frame.h" line="232"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="228">a #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_BUFFER_IS_TOP_FIELD"
- c:identifier="GST_VIDEO_BUFFER_IS_TOP_FIELD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="218">Check if GST_VIDEO_BUFFER_FLAG_TOP_FIELD is set on @buf (Since: 1.18).</doc>
- <source-position filename="gst-libs/gst/video/video-frame.h" line="224"/>
- <parameters>
- <parameter name="buf">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="220">a #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_BUFFER_POOL"
- c:identifier="GST_VIDEO_BUFFER_POOL"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideopool.h" line="63"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_BUFFER_POOL_CAST"
- c:identifier="GST_VIDEO_BUFFER_POOL_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideopool.h" line="64"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CAPS_MAKE"
- c:identifier="GST_VIDEO_CAPS_MAKE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="648">Generic caps string for video, for use in pad templates.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="635"/>
- <parameters>
- <parameter name="format">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="650">string format that describes the pixel layout, as string
- (e.g. "I420", "RGB", "YV12", "YUY2", "AYUV", etc.)</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CAPS_MAKE_WITH_FEATURES"
- c:identifier="GST_VIDEO_CAPS_MAKE_WITH_FEATURES"
- version="1.2"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="662">Generic caps string for video, for use in pad templates.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="653"/>
- <parameters>
- <parameter name="features">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="666">Requires caps features as a string, e.g.
- "memory:SystemMemory".</doc>
- </parameter>
- <parameter name="format">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="664">string format that describes the pixel layout, as string
- (e.g. "I420", "RGB", "YV12", "YUY2", "AYUV", etc.)</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_FLAGS"
- c:identifier="GST_VIDEO_CODEC_FRAME_FLAGS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="105">The entire set of flags for the @frame</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="109"/>
- <parameters>
- <parameter name="frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="107">a #GstVideoCodecFrame</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_FLAG_IS_SET"
- c:identifier="GST_VIDEO_CODEC_FRAME_FLAG_IS_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="113">Checks whether the given @flag is set</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="118"/>
- <parameters>
- <parameter name="frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="115">a #GstVideoCodecFrame</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="116">a flag to check for</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_FLAG_SET"
- c:identifier="GST_VIDEO_CODEC_FRAME_FLAG_SET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="122">This macro sets the given bits</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="127"/>
- <parameters>
- <parameter name="frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="124">a #GstVideoCodecFrame</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="125">Flag to set, can be any number of bits in guint32.</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_FLAG_UNSET"
- c:identifier="GST_VIDEO_CODEC_FRAME_FLAG_UNSET"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="131">This macro usets the given bits.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="136"/>
- <parameters>
- <parameter name="frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="133">a #GstVideoCodecFrame</doc>
- </parameter>
- <parameter name="flag">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="134">Flag to unset</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_IS_DECODE_ONLY"
- c:identifier="GST_VIDEO_CODEC_FRAME_IS_DECODE_ONLY"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="140">Tests if the buffer should only be decoded but not sent downstream.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="144"/>
- <parameters>
- <parameter name="frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="142">a #GstVideoCodecFrame</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_IS_FORCE_KEYFRAME"
- c:identifier="GST_VIDEO_CODEC_FRAME_IS_FORCE_KEYFRAME"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="186">Tests if the frame must be encoded as a keyframe. Applies only to
-frames provided to encoders. Decoders can safely ignore this field.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="191"/>
- <parameters>
- <parameter name="frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="188">a #GstVideoCodecFrame</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_IS_FORCE_KEYFRAME_HEADERS"
- c:identifier="GST_VIDEO_CODEC_FRAME_IS_FORCE_KEYFRAME_HEADERS"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="197">Tests if encoder should output stream headers before outputting the
-resulting encoded buffer for the given frame.
-
-Applies only to frames provided to encoders. Decoders can safely
-ignore this field.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="205"/>
- <parameters>
- <parameter name="frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="199">a #GstVideoCodecFrame</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_IS_SYNC_POINT"
- c:identifier="GST_VIDEO_CODEC_FRAME_IS_SYNC_POINT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="161">Tests if the frame is a synchronization point (like a keyframe).
-
-Decoder implementations can use this to detect keyframes.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="167"/>
- <parameters>
- <parameter name="frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="163">a #GstVideoCodecFrame</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_SET_DECODE_ONLY"
- c:identifier="GST_VIDEO_CODEC_FRAME_SET_DECODE_ONLY"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="148">Sets the buffer to not be sent downstream.
-
-Decoder implementation can use this if they have frames that
-are not meant to be displayed.
-
-Encoder implementation can safely ignore this field.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="157"/>
- <parameters>
- <parameter name="frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="150">a #GstVideoCodecFrame</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_SET_FORCE_KEYFRAME"
- c:identifier="GST_VIDEO_CODEC_FRAME_SET_FORCE_KEYFRAME"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="192"/>
- <parameters>
- <parameter name="frame">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_SET_FORCE_KEYFRAME_HEADERS"
- c:identifier="GST_VIDEO_CODEC_FRAME_SET_FORCE_KEYFRAME_HEADERS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="206"/>
- <parameters>
- <parameter name="frame">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_SET_SYNC_POINT"
- c:identifier="GST_VIDEO_CODEC_FRAME_SET_SYNC_POINT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="171">Sets the frame to be a synchronization point (like a keyframe).
-
-Encoder implementations should set this accordingly.
-
-Decoder implementing parsing features should set this when they
-detect such a synchronization point.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="180"/>
- <parameters>
- <parameter name="frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="173">a #GstVideoCodecFrame</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_UNSET_FORCE_KEYFRAME"
- c:identifier="GST_VIDEO_CODEC_FRAME_UNSET_FORCE_KEYFRAME"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="193"/>
- <parameters>
- <parameter name="frame">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_UNSET_FORCE_KEYFRAME_HEADERS"
- c:identifier="GST_VIDEO_CODEC_FRAME_UNSET_FORCE_KEYFRAME_HEADERS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="207"/>
- <parameters>
- <parameter name="frame">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_CODEC_FRAME_UNSET_SYNC_POINT"
- c:identifier="GST_VIDEO_CODEC_FRAME_UNSET_SYNC_POINT"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="181"/>
- <parameters>
- <parameter name="frame">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_COLORIMETRY_BT2020"
- value="bt2020"
- c:type="GST_VIDEO_COLORIMETRY_BT2020">
- <source-position filename="gst-libs/gst/video/video-color.h" line="248"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_COLORIMETRY_BT2020_10"
- value="bt2020-10"
- c:type="GST_VIDEO_COLORIMETRY_BT2020_10">
- <source-position filename="gst-libs/gst/video/video-color.h" line="249"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_COLORIMETRY_BT2100_HLG"
- value="bt2100-hlg"
- c:type="GST_VIDEO_COLORIMETRY_BT2100_HLG">
- <source-position filename="gst-libs/gst/video/video-color.h" line="251"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_COLORIMETRY_BT2100_PQ"
- value="bt2100-pq"
- c:type="GST_VIDEO_COLORIMETRY_BT2100_PQ">
- <source-position filename="gst-libs/gst/video/video-color.h" line="250"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_COLORIMETRY_BT601"
- value="bt601"
- c:type="GST_VIDEO_COLORIMETRY_BT601">
- <source-position filename="gst-libs/gst/video/video-color.h" line="244"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_COLORIMETRY_BT709"
- value="bt709"
- c:type="GST_VIDEO_COLORIMETRY_BT709">
- <source-position filename="gst-libs/gst/video/video-color.h" line="245"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_COLORIMETRY_SMPTE240M"
- value="smpte240m"
- c:type="GST_VIDEO_COLORIMETRY_SMPTE240M">
- <source-position filename="gst-libs/gst/video/video-color.h" line="246"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_COLORIMETRY_SRGB"
- value="sRGB"
- c:type="GST_VIDEO_COLORIMETRY_SRGB">
- <source-position filename="gst-libs/gst/video/video-color.h" line="247"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_COMP_A" value="3" c:type="GST_VIDEO_COMP_A">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="309"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VIDEO_COMP_B" value="2" c:type="GST_VIDEO_COMP_B">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="306"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VIDEO_COMP_G" value="1" c:type="GST_VIDEO_COMP_G">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="305"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VIDEO_COMP_INDEX" value="0" c:type="GST_VIDEO_COMP_INDEX">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="312"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VIDEO_COMP_PALETTE"
- value="1"
- c:type="GST_VIDEO_COMP_PALETTE">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="313"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VIDEO_COMP_R" value="0" c:type="GST_VIDEO_COMP_R">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="304"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VIDEO_COMP_U" value="1" c:type="GST_VIDEO_COMP_U">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="300"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VIDEO_COMP_V" value="2" c:type="GST_VIDEO_COMP_V">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="301"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VIDEO_COMP_Y" value="0" c:type="GST_VIDEO_COMP_Y">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="299"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_ALPHA_MODE"
- value="GstVideoConverter.alpha-mode"
- c:type="GST_VIDEO_CONVERTER_OPT_ALPHA_MODE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="156">#GstVideoAlphaMode, the alpha mode to use.
-Default is #GST_VIDEO_ALPHA_MODE_COPY.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="162"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_ALPHA_VALUE"
- value="GstVideoConverter.alpha-value"
- c:type="GST_VIDEO_CONVERTER_OPT_ALPHA_VALUE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="128">#G_TYPE_DOUBLE, the alpha color value to use.
-Default to 1.0</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="134"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_BORDER_ARGB"
- value="GstVideoConverter.border-argb"
- c:type="GST_VIDEO_CONVERTER_OPT_BORDER_ARGB">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="163">#G_TYPE_UINT, the border color to use if #GST_VIDEO_CONVERTER_OPT_FILL_BORDER
-is set to %TRUE. The color is in ARGB format.
-Default 0xff000000</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="170"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_CHROMA_MODE"
- value="GstVideoConverter.chroma-mode"
- c:type="GST_VIDEO_CONVERTER_OPT_CHROMA_MODE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="190">#GstVideoChromaMode, set the chroma resample mode subsampled
-formats. Default is #GST_VIDEO_CHROMA_MODE_FULL.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="196"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_CHROMA_RESAMPLER_METHOD"
- value="GstVideoConverter.chroma-resampler-method"
- c:type="GST_VIDEO_CONVERTER_OPT_CHROMA_RESAMPLER_METHOD">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="35">#GstVideoChromaMethod, The resampler method to use for
-chroma resampling. Other options for the resampler can be used, see
-the #GstVideoResampler. Default is #GST_VIDEO_RESAMPLER_METHOD_LINEAR</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="42"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_DEST_HEIGHT"
- value="GstVideoConverter.dest-height"
- c:type="GST_VIDEO_CONVERTER_OPT_DEST_HEIGHT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="112">#G_TYPE_INT, height in the destination frame, default destination height</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="117"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_DEST_WIDTH"
- value="GstVideoConverter.dest-width"
- c:type="GST_VIDEO_CONVERTER_OPT_DEST_WIDTH">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="106">#G_TYPE_INT, width in the destination frame, default destination width</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="111"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_DEST_X"
- value="GstVideoConverter.dest-x"
- c:type="GST_VIDEO_CONVERTER_OPT_DEST_X">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="94">#G_TYPE_INT, x position in the destination frame, default 0</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="99"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_DEST_Y"
- value="GstVideoConverter.dest-y"
- c:type="GST_VIDEO_CONVERTER_OPT_DEST_Y">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="100">#G_TYPE_INT, y position in the destination frame, default 0</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="105"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_DITHER_METHOD"
- value="GstVideoConverter.dither-method"
- c:type="GST_VIDEO_CONVERTER_OPT_DITHER_METHOD">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="51">#GstVideoDitherMethod, The dither method to use when
-changing bit depth.
-Default is #GST_VIDEO_DITHER_BAYER.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="58"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_DITHER_QUANTIZATION"
- value="GstVideoConverter.dither-quantization"
- c:type="GST_VIDEO_CONVERTER_OPT_DITHER_QUANTIZATION">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="60">#G_TYPE_UINT, The quantization amount to dither to. Components will be
-quantized to multiples of this value.
-Default is 1</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="67"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_FILL_BORDER"
- value="GstVideoConverter.fill-border"
- c:type="GST_VIDEO_CONVERTER_OPT_FILL_BORDER">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="119">#G_TYPE_BOOLEAN, if the destination rectangle does not fill the complete
-destination image, render a border with
-#GST_VIDEO_CONVERTER_OPT_BORDER_ARGB. Otherwise the unusded pixels in the
-destination are untouched. Default %TRUE.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="127"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_GAMMA_MODE"
- value="GstVideoConverter.gamma-mode"
- c:type="GST_VIDEO_CONVERTER_OPT_GAMMA_MODE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="237">#GstVideoGammaMode, set the gamma mode.
-Default is #GST_VIDEO_GAMMA_MODE_NONE.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="243"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_MATRIX_MODE"
- value="GstVideoConverter.matrix-mode"
- c:type="GST_VIDEO_CONVERTER_OPT_MATRIX_MODE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="217">#GstVideoMatrixMode, set the color matrix conversion mode for
-converting between Y'PbPr and non-linear RGB (R'G'B').
-Default is #GST_VIDEO_MATRIX_MODE_FULL.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="224"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_PRIMARIES_MODE"
- value="GstVideoConverter.primaries-mode"
- c:type="GST_VIDEO_CONVERTER_OPT_PRIMARIES_MODE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="260">#GstVideoPrimariesMode, set the primaries conversion mode.
-Default is #GST_VIDEO_PRIMARIES_MODE_NONE.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="266"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_RESAMPLER_METHOD"
- value="GstVideoConverter.resampler-method"
- c:type="GST_VIDEO_CONVERTER_OPT_RESAMPLER_METHOD">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="27">#GstVideoResamplerMethod, The resampler method to use for
-resampling. Other options for the resampler can be used, see
-the #GstVideoResampler. Default is #GST_VIDEO_RESAMPLER_METHOD_CUBIC</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="34"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_RESAMPLER_TAPS"
- value="GstVideoConverter.resampler-taps"
- c:type="GST_VIDEO_CONVERTER_OPT_RESAMPLER_TAPS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="43">#G_TYPE_UINT, The number of taps for the resampler.
-Default is 0: let the resampler choose a good value.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="49"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_SRC_HEIGHT"
- value="GstVideoConverter.src-height"
- c:type="GST_VIDEO_CONVERTER_OPT_SRC_HEIGHT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="87">#G_TYPE_INT, source height to convert, default source height</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="92"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_SRC_WIDTH"
- value="GstVideoConverter.src-width"
- c:type="GST_VIDEO_CONVERTER_OPT_SRC_WIDTH">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="81">#G_TYPE_INT, source width to convert, default source width</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="86"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_SRC_X"
- value="GstVideoConverter.src-x"
- c:type="GST_VIDEO_CONVERTER_OPT_SRC_X">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="69">#G_TYPE_INT, source x position to start conversion, default 0</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="74"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_SRC_Y"
- value="GstVideoConverter.src-y"
- c:type="GST_VIDEO_CONVERTER_OPT_SRC_Y">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="75">#G_TYPE_INT, source y position to start conversion, default 0</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="80"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_CONVERTER_OPT_THREADS"
- value="GstVideoConverter.threads"
- c:type="GST_VIDEO_CONVERTER_OPT_THREADS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="268">#G_TYPE_UINT, maximum number of threads to use. Default 1, 0 for the number
-of cores.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="274"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="VIDEO_DECODER"
- c:identifier="GST_VIDEO_DECODER"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_DECODER_CAST"
- c:identifier="GST_VIDEO_DECODER_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="44"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_DECODER_CLASS"
- c:identifier="GST_VIDEO_DECODER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="36"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_DECODER_ERROR"
- c:identifier="GST_VIDEO_DECODER_ERROR"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="128">Utility function that video decoder elements can use in case they encountered
-a data processing error that may be fatal for the current "data unit" but
-need not prevent subsequent decoding. Such errors are counted and if there
-are too many, as configured in the context's max_errors, the pipeline will
-post an error message and the application will be requested to stop further
-media processing. Otherwise, it is considered a "glitch" and only a warning
-is logged. In either case, @ret is set to the proper value to
-return to upstream/caller (indicating either GST_FLOW_ERROR or GST_FLOW_OK).</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="148"/>
- <parameters>
- <parameter name="el">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="130">the base video decoder element that generates the error</doc>
- </parameter>
- <parameter name="w">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="131">element defined weight of the error, added to error count</doc>
- </parameter>
- <parameter name="domain">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="132">like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)</doc>
- </parameter>
- <parameter name="code">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="133">error code defined for that domain (see #gstreamer-GstGError)</doc>
- </parameter>
- <parameter name="text">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="134">the message to display (format string and args enclosed in
- parentheses)</doc>
- </parameter>
- <parameter name="debug">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="136">debugging information for the message (format string and args
- enclosed in parentheses)</doc>
- </parameter>
- <parameter name="ret">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="138">variable to receive return value</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_DECODER_GET_CLASS"
- c:identifier="GST_VIDEO_DECODER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="38"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_DECODER_INPUT_SEGMENT"
- c:identifier="GST_VIDEO_DECODER_INPUT_SEGMENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="82">Gives the segment of the element.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="87"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="84">base decoder instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_DECODER_MAX_ERRORS"
- value="10"
- c:type="GST_VIDEO_DECODER_MAX_ERRORS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="159">Default maximum number of errors tolerated before signaling error.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="163"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="VIDEO_DECODER_OUTPUT_SEGMENT"
- c:identifier="GST_VIDEO_DECODER_OUTPUT_SEGMENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="90">Gives the segment of the element.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="95"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="92">base decoder instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_DECODER_SINK_NAME"
- value="sink"
- c:type="GST_VIDEO_DECODER_SINK_NAME">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="47">The name of the templates for the sink pad.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="51"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="VIDEO_DECODER_SINK_PAD"
- c:identifier="GST_VIDEO_DECODER_SINK_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="68">Gives the pointer to the sink #GstPad object of the element.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="73"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="70">a #GstVideoDecoder</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_DECODER_SRC_NAME"
- value="src"
- c:type="GST_VIDEO_DECODER_SRC_NAME">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="53">The name of the templates for the source pad.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="57"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="VIDEO_DECODER_SRC_PAD"
- c:identifier="GST_VIDEO_DECODER_SRC_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="60">Gives the pointer to the source #GstPad object of the element.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="65"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="62">a #GstVideoDecoder</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_DECODER_STREAM_LOCK"
- c:identifier="GST_VIDEO_DECODER_STREAM_LOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="98">Obtain a lock to protect the decoder function from concurrent access.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="103"/>
- <parameters>
- <parameter name="decoder">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="100">video decoder instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_DECODER_STREAM_UNLOCK"
- c:identifier="GST_VIDEO_DECODER_STREAM_UNLOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="106">Release the lock that protects the decoder function from concurrent access.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="111"/>
- <parameters>
- <parameter name="decoder">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="108">video decoder instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_DEPRECATED_FOR"
- c:identifier="GST_VIDEO_DEPRECATED_FOR"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-prelude.h"
- line="35"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_DIRECTION"
- c:identifier="GST_VIDEO_DIRECTION"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/videodirection.h"
- line="30"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_DIRECTION_GET_INTERFACE"
- c:identifier="GST_VIDEO_DIRECTION_GET_INTERFACE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/videodirection.h"
- line="34"/>
- <parameters>
- <parameter name="inst">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_ENCODER"
- c:identifier="GST_VIDEO_ENCODER"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_ENCODER_CAST"
- c:identifier="GST_VIDEO_ENCODER_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="43"/>
- <parameters>
- <parameter name="enc">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_ENCODER_CLASS"
- c:identifier="GST_VIDEO_ENCODER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_ENCODER_GET_CLASS"
- c:identifier="GST_VIDEO_ENCODER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_ENCODER_INPUT_SEGMENT"
- c:identifier="GST_VIDEO_ENCODER_INPUT_SEGMENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="94">Gives the segment of the element.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="99"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="96">base parse instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_ENCODER_OUTPUT_SEGMENT"
- c:identifier="GST_VIDEO_ENCODER_OUTPUT_SEGMENT"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="102">Gives the segment of the element.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="107"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="104">base parse instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_ENCODER_SINK_NAME"
- value="sink"
- c:type="GST_VIDEO_ENCODER_SINK_NAME">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="46">The name of the templates for the sink pad.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="50"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="VIDEO_ENCODER_SINK_PAD"
- c:identifier="GST_VIDEO_ENCODER_SINK_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="67">Gives the pointer to the sink #GstPad object of the element.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="72"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="69">a #GstVideoEncoder</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_ENCODER_SRC_NAME"
- value="src"
- c:type="GST_VIDEO_ENCODER_SRC_NAME">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="52">The name of the templates for the source pad.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="56"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="VIDEO_ENCODER_SRC_PAD"
- c:identifier="GST_VIDEO_ENCODER_SRC_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="59">Gives the pointer to the source #GstPad object of the element.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="64"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="61">a #GstVideoEncoder</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_ENCODER_STREAM_LOCK"
- c:identifier="GST_VIDEO_ENCODER_STREAM_LOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="110">Obtain a lock to protect the encoder function from concurrent access.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="115"/>
- <parameters>
- <parameter name="encoder">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="112">video encoder instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_ENCODER_STREAM_UNLOCK"
- c:identifier="GST_VIDEO_ENCODER_STREAM_UNLOCK"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="118">Release the lock that protects the encoder function from concurrent access.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="123"/>
- <parameters>
- <parameter name="encoder">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="120">video encoder instance</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FILTER"
- c:identifier="GST_VIDEO_FILTER"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FILTER_CAST"
- c:identifier="GST_VIDEO_FILTER_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="43"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FILTER_CLASS"
- c:identifier="GST_VIDEO_FILTER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FILTER_GET_CLASS"
- c:identifier="GST_VIDEO_FILTER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_FORMATS_ALL"
- value="{ AYUV64, ARGB64, GBRA_12BE, GBRA_12LE, Y412_BE, Y412_LE, A444_10BE, GBRA_10BE, A444_10LE, GBRA_10LE, A422_10BE, A422_10LE, A420_10BE, A420_10LE, Y410, RGB10A2_LE, BGR10A2_LE, GBRA, ABGR, VUYA, BGRA, AYUV, ARGB, RGBA, A420, Y444_16BE, Y444_16LE, v216, P016_BE, P016_LE, Y444_12BE, GBR_12BE, Y444_12LE, GBR_12LE, I422_12BE, I422_12LE, Y212_BE, Y212_LE, I420_12BE, I420_12LE, P012_BE, P012_LE, Y444_10BE, GBR_10BE, Y444_10LE, GBR_10LE, r210, I422_10BE, I422_10LE, NV16_10LE32, Y210, v210, UYVP, I420_10BE, I420_10LE, P010_10BE, P010_10LE, NV12_10LE32, NV12_10LE40, Y444, GBR, NV24, xBGR, BGRx, xRGB, RGBx, BGR, IYU2, v308, RGB, Y42B, NV61, NV16, VYUY, UYVY, YVYU, YUY2, I420, YV12, NV21, NV12, NV12_64Z32, NV12_4L4, NV12_32L32, Y41B, IYU1, YVU9, YUV9, RGB16, BGR16, RGB15, BGR15, RGB8P, GRAY16_BE, GRAY16_LE, GRAY10_LE32, GRAY8 }"
- c:type="GST_VIDEO_FORMATS_ALL">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="600">List of all video formats, for use in template caps strings.
-
-Formats are sorted by decreasing "quality", using these criteria by priority:
- - number of components
- - depth
- - subsampling factor of the width
- - subsampling factor of the height
- - number of planes
- - native endianness preferred
- - pixel stride
- - poffset
- - prefer non-complex formats
- - prefer YUV formats over RGB ones
- - prefer I420 over YV12
- - format name</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="620"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="VIDEO_FORMAT_INFO_BITS"
- c:identifier="GST_VIDEO_FORMAT_INFO_BITS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="488"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_DATA"
- c:identifier="GST_VIDEO_FORMAT_INFO_DATA"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="539"/>
- <parameters>
- <parameter name="info">
- </parameter>
- <parameter name="planes">
- </parameter>
- <parameter name="comp">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_DEPTH"
- c:identifier="GST_VIDEO_FORMAT_INFO_DEPTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="491"/>
- <parameters>
- <parameter name="info">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_FLAGS"
- c:identifier="GST_VIDEO_FORMAT_INFO_FLAGS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="477"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_FORMAT"
- c:identifier="GST_VIDEO_FORMAT_INFO_FORMAT"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="475"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_HAS_ALPHA"
- c:identifier="GST_VIDEO_FORMAT_INFO_HAS_ALPHA"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="482"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_HAS_PALETTE"
- c:identifier="GST_VIDEO_FORMAT_INFO_HAS_PALETTE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="484"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_H_SUB"
- c:identifier="GST_VIDEO_FORMAT_INFO_H_SUB"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="531"/>
- <parameters>
- <parameter name="info">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_IS_COMPLEX"
- c:identifier="GST_VIDEO_FORMAT_INFO_IS_COMPLEX"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="485"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_IS_GRAY"
- c:identifier="GST_VIDEO_FORMAT_INFO_IS_GRAY"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="481"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_IS_LE"
- c:identifier="GST_VIDEO_FORMAT_INFO_IS_LE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="483"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_IS_RGB"
- c:identifier="GST_VIDEO_FORMAT_INFO_IS_RGB"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="480"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_IS_TILED"
- c:identifier="GST_VIDEO_FORMAT_INFO_IS_TILED"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="486"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_IS_YUV"
- c:identifier="GST_VIDEO_FORMAT_INFO_IS_YUV"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="479"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_NAME"
- c:identifier="GST_VIDEO_FORMAT_INFO_NAME"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="476"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_N_COMPONENTS"
- c:identifier="GST_VIDEO_FORMAT_INFO_N_COMPONENTS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="489"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_N_PLANES"
- c:identifier="GST_VIDEO_FORMAT_INFO_N_PLANES"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="507">Number of planes. This is the number of planes the pixel layout is
-organized in in memory. The number of planes can be less than the
-number of components (e.g. Y,U,V,A or R, G, B, A) when multiple
-components are packed into one plane.
-
-Examples: RGB/RGBx/RGBA: 1 plane, 3/3/4 components;
-I420: 3 planes, 3 components; NV21/NV12: 2 planes, 3 components.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="519"/>
- <parameters>
- <parameter name="info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="509">a #GstVideoFormatInfo</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_OFFSET"
- c:identifier="GST_VIDEO_FORMAT_INFO_OFFSET"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="553"/>
- <parameters>
- <parameter name="info">
- </parameter>
- <parameter name="offsets">
- </parameter>
- <parameter name="comp">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_PLANE"
- c:identifier="GST_VIDEO_FORMAT_INFO_PLANE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="520">Plane number where the given component can be found. A plane may
-contain data for multiple components.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="528"/>
- <parameters>
- <parameter name="info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="522">a #GstVideoFormatInfo</doc>
- </parameter>
- <parameter name="c">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="523">the component index</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_POFFSET"
- c:identifier="GST_VIDEO_FORMAT_INFO_POFFSET"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="529"/>
- <parameters>
- <parameter name="info">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_PSTRIDE"
- c:identifier="GST_VIDEO_FORMAT_INFO_PSTRIDE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="492">pixel stride for the given component. This is the amount of bytes to the
-pixel immediately to the right, so basically bytes from one pixel to the
-next. When bits &lt; 8, the stride is expressed in bits.
-
-Examples: for 24-bit RGB, the pixel stride would be 3 bytes, while it
-would be 4 bytes for RGBx or ARGB, and 8 bytes for ARGB64 or AYUV64.
-For planar formats such as I420 the pixel stride is usually 1. For
-YUY2 it would be 2 bytes.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="506"/>
- <parameters>
- <parameter name="info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="494">a #GstVideoFormatInfo</doc>
- </parameter>
- <parameter name="c">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="495">the component index</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_SCALE_HEIGHT"
- c:identifier="GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="537"/>
- <parameters>
- <parameter name="info">
- </parameter>
- <parameter name="c">
- </parameter>
- <parameter name="h">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_SCALE_WIDTH"
- c:identifier="GST_VIDEO_FORMAT_INFO_SCALE_WIDTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="536"/>
- <parameters>
- <parameter name="info">
- </parameter>
- <parameter name="c">
- </parameter>
- <parameter name="w">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_SHIFT"
- c:identifier="GST_VIDEO_FORMAT_INFO_SHIFT"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="490"/>
- <parameters>
- <parameter name="info">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_STRIDE"
- c:identifier="GST_VIDEO_FORMAT_INFO_STRIDE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="541">Row stride in bytes, that is number of bytes from the first pixel component
-of a row to the first pixel component in the next row. This might include
-some row padding (memory not actually used for anything, to make sure the
-beginning of the next row is aligned in a particular way).</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="552"/>
- <parameters>
- <parameter name="info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="543">a #GstVideoFormatInfo</doc>
- </parameter>
- <parameter name="strides">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="544">an array of strides</doc>
- </parameter>
- <parameter name="comp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="545">the component index</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_TILE_HS"
- c:identifier="GST_VIDEO_FORMAT_INFO_TILE_HS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="558"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_TILE_MODE"
- c:identifier="GST_VIDEO_FORMAT_INFO_TILE_MODE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="556"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_TILE_WS"
- c:identifier="GST_VIDEO_FORMAT_INFO_TILE_WS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="557"/>
- <parameters>
- <parameter name="info">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FORMAT_INFO_W_SUB"
- c:identifier="GST_VIDEO_FORMAT_INFO_W_SUB"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="530"/>
- <parameters>
- <parameter name="info">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_FPS_RANGE"
- value="(fraction) [ 0, max ]"
- c:type="GST_VIDEO_FPS_RANGE">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="590"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="VIDEO_FRAME_COMP_DATA"
- c:identifier="GST_VIDEO_FRAME_COMP_DATA"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="144"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_COMP_DEPTH"
- c:identifier="GST_VIDEO_FRAME_COMP_DEPTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="143"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_COMP_HEIGHT"
- c:identifier="GST_VIDEO_FRAME_COMP_HEIGHT"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="148"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_COMP_OFFSET"
- c:identifier="GST_VIDEO_FRAME_COMP_OFFSET"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="146"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_COMP_PLANE"
- c:identifier="GST_VIDEO_FRAME_COMP_PLANE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="149"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_COMP_POFFSET"
- c:identifier="GST_VIDEO_FRAME_COMP_POFFSET"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="151"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_COMP_PSTRIDE"
- c:identifier="GST_VIDEO_FRAME_COMP_PSTRIDE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="150"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_COMP_STRIDE"
- c:identifier="GST_VIDEO_FRAME_COMP_STRIDE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="145"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_COMP_WIDTH"
- c:identifier="GST_VIDEO_FRAME_COMP_WIDTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="147"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_FLAGS"
- c:identifier="GST_VIDEO_FRAME_FLAGS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="121"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_FLAG_IS_SET"
- c:identifier="GST_VIDEO_FRAME_FLAG_IS_SET"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="122"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="fl">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_FORMAT"
- c:identifier="GST_VIDEO_FRAME_FORMAT"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="115"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_HEIGHT"
- c:identifier="GST_VIDEO_FRAME_HEIGHT"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="117"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_IS_BOTTOM_FIELD"
- c:identifier="GST_VIDEO_FRAME_IS_BOTTOM_FIELD"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="133"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_IS_INTERLACED"
- c:identifier="GST_VIDEO_FRAME_IS_INTERLACED"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="123"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_IS_ONEFIELD"
- c:identifier="GST_VIDEO_FRAME_IS_ONEFIELD"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="126"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_IS_RFF"
- c:identifier="GST_VIDEO_FRAME_IS_RFF"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="125"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_IS_TFF"
- c:identifier="GST_VIDEO_FRAME_IS_TFF"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="124"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_IS_TOP_FIELD"
- c:identifier="GST_VIDEO_FRAME_IS_TOP_FIELD"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="127"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_N_COMPONENTS"
- c:identifier="GST_VIDEO_FRAME_N_COMPONENTS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="142"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_N_PLANES"
- c:identifier="GST_VIDEO_FRAME_N_PLANES"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="136"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_PLANE_DATA"
- c:identifier="GST_VIDEO_FRAME_PLANE_DATA"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="137"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="p">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_PLANE_OFFSET"
- c:identifier="GST_VIDEO_FRAME_PLANE_OFFSET"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="138"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="p">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_PLANE_STRIDE"
- c:identifier="GST_VIDEO_FRAME_PLANE_STRIDE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="139"/>
- <parameters>
- <parameter name="f">
- </parameter>
- <parameter name="p">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_SIZE"
- c:identifier="GST_VIDEO_FRAME_SIZE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="118"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_FRAME_WIDTH"
- c:identifier="GST_VIDEO_FRAME_WIDTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-frame.h" line="116"/>
- <parameters>
- <parameter name="f">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_CHROMA_SITE"
- c:identifier="GST_VIDEO_INFO_CHROMA_SITE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="385"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_COLORIMETRY"
- c:identifier="GST_VIDEO_INFO_COLORIMETRY"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="384"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_COMP_DATA"
- c:identifier="GST_VIDEO_INFO_COMP_DATA"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="418"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="d">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_COMP_DEPTH"
- c:identifier="GST_VIDEO_INFO_COMP_DEPTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="417"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_COMP_HEIGHT"
- c:identifier="GST_VIDEO_INFO_COMP_HEIGHT"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="422"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_COMP_OFFSET"
- c:identifier="GST_VIDEO_INFO_COMP_OFFSET"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="419"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_COMP_PLANE"
- c:identifier="GST_VIDEO_INFO_COMP_PLANE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="423"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_COMP_POFFSET"
- c:identifier="GST_VIDEO_INFO_COMP_POFFSET"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="425"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_COMP_PSTRIDE"
- c:identifier="GST_VIDEO_INFO_COMP_PSTRIDE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="424"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_COMP_STRIDE"
- c:identifier="GST_VIDEO_INFO_COMP_STRIDE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="420"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_COMP_WIDTH"
- c:identifier="GST_VIDEO_INFO_COMP_WIDTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="421"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="c">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_FIELD_HEIGHT"
- c:identifier="GST_VIDEO_INFO_FIELD_HEIGHT"
- version="1.16."
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="365">The height of a field. It's the height of the full frame unless split-field
-(alternate) interlacing is in use.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h" line="373"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_FIELD_ORDER"
- c:identifier="GST_VIDEO_INFO_FIELD_ORDER"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="361"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_FIELD_RATE_N"
- c:identifier="GST_VIDEO_INFO_FIELD_RATE_N"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="379"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_FLAGS"
- c:identifier="GST_VIDEO_INFO_FLAGS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="362"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_FLAG_IS_SET"
- c:identifier="GST_VIDEO_INFO_FLAG_IS_SET"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="391"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="flag">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_FLAG_SET"
- c:identifier="GST_VIDEO_INFO_FLAG_SET"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="392"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="flag">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_FLAG_UNSET"
- c:identifier="GST_VIDEO_INFO_FLAG_UNSET"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="393"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="flag">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_FORMAT"
- c:identifier="GST_VIDEO_INFO_FORMAT"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="352"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_FPS_D"
- c:identifier="GST_VIDEO_INFO_FPS_D"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="382"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_FPS_N"
- c:identifier="GST_VIDEO_INFO_FPS_N"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="378"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_HAS_ALPHA"
- c:identifier="GST_VIDEO_INFO_HAS_ALPHA"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="357"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_HEIGHT"
- c:identifier="GST_VIDEO_INFO_HEIGHT"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="364"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_INTERLACE_MODE"
- c:identifier="GST_VIDEO_INFO_INTERLACE_MODE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="359"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_IS_GRAY"
- c:identifier="GST_VIDEO_INFO_IS_GRAY"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="356"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_IS_INTERLACED"
- c:identifier="GST_VIDEO_INFO_IS_INTERLACED"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="360"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_IS_RGB"
- c:identifier="GST_VIDEO_INFO_IS_RGB"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="355"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_IS_YUV"
- c:identifier="GST_VIDEO_INFO_IS_YUV"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="354"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_MULTIVIEW_FLAGS"
- c:identifier="GST_VIDEO_INFO_MULTIVIEW_FLAGS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="388"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_MULTIVIEW_MODE"
- c:identifier="GST_VIDEO_INFO_MULTIVIEW_MODE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="387"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_NAME"
- c:identifier="GST_VIDEO_INFO_NAME"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="353"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_N_COMPONENTS"
- c:identifier="GST_VIDEO_INFO_N_COMPONENTS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="416"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_N_PLANES"
- c:identifier="GST_VIDEO_INFO_N_PLANES"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="396"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_PAR_D"
- c:identifier="GST_VIDEO_INFO_PAR_D"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="377"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_PAR_N"
- c:identifier="GST_VIDEO_INFO_PAR_N"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="376"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_PLANE_HEIGHT"
- c:identifier="GST_VIDEO_INFO_PLANE_HEIGHT"
- version="1.18"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="399">The padded height in pixels of a plane (padded size divided by the plane stride).
-In case of GST_VIDEO_INTERLACE_MODE_ALTERNATE info, this macro returns the
-plane heights used to hold a single field, not the full frame.
-
-The size passed as third argument is the size of the pixel data and should
-not contain any extra metadata padding.
-
-It is not valid to use this macro with a TILED format.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h" line="413"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="p">
- </parameter>
- <parameter name="sizes">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_PLANE_OFFSET"
- c:identifier="GST_VIDEO_INFO_PLANE_OFFSET"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="397"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="p">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_PLANE_STRIDE"
- c:identifier="GST_VIDEO_INFO_PLANE_STRIDE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="398"/>
- <parameters>
- <parameter name="i">
- </parameter>
- <parameter name="p">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_SIZE"
- c:identifier="GST_VIDEO_INFO_SIZE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="374"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_VIEWS"
- c:identifier="GST_VIDEO_INFO_VIEWS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="375"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_INFO_WIDTH"
- c:identifier="GST_VIDEO_INFO_WIDTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-info.h" line="363"/>
- <parameters>
- <parameter name="i">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_MAX_COMPONENTS"
- value="4"
- c:type="GST_VIDEO_MAX_COMPONENTS">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="258"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VIDEO_MAX_PLANES" value="4" c:type="GST_VIDEO_MAX_PLANES">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="257"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="VIDEO_META_TRANSFORM_IS_SCALE"
- c:identifier="GST_VIDEO_META_TRANSFORM_IS_SCALE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="175"/>
- <parameters>
- <parameter name="type">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_NE"
- c:identifier="GST_VIDEO_NE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="593"/>
- <parameters>
- <parameter name="s">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_OE"
- c:identifier="GST_VIDEO_OE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="594"/>
- <parameters>
- <parameter name="s">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_ORIENTATION"
- c:identifier="GST_VIDEO_ORIENTATION"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_ORIENTATION_GET_INTERFACE"
- c:identifier="GST_VIDEO_ORIENTATION_GET_INTERFACE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="35"/>
- <parameters>
- <parameter name="inst">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_OVERLAY"
- c:identifier="GST_VIDEO_OVERLAY"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/videooverlay.h" line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_OVERLAY_COMPOSITION"
- c:identifier="GST_VIDEO_OVERLAY_COMPOSITION"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="195"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_OVERLAY_COMPOSITION_CAST"
- c:identifier="GST_VIDEO_OVERLAY_COMPOSITION_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="193"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_OVERLAY_GET_INTERFACE"
- c:identifier="GST_VIDEO_OVERLAY_GET_INTERFACE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/videooverlay.h" line="35"/>
- <parameters>
- <parameter name="inst">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_OVERLAY_RECTANGLE"
- c:identifier="GST_VIDEO_OVERLAY_RECTANGLE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="39"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_OVERLAY_RECTANGLE_CAST"
- c:identifier="GST_VIDEO_OVERLAY_RECTANGLE_CAST"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_RESAMPLER_OPT_CUBIC_B"
- value="GstVideoResampler.cubic-b"
- c:type="GST_VIDEO_RESAMPLER_OPT_CUBIC_B">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="52">G_TYPE_DOUBLE, B parameter of the cubic filter. The B
-parameter controls the bluriness. Values between 0.0 and
-2.0 are accepted. 1/3 is the default.
-
-Below are some values of popular filters:
- B C
-Hermite 0.0 0.0
-Spline 1.0 0.0
-Catmull-Rom 0.0 1/2
-Mitchell 1/3 1/3
-Robidoux 0.3782 0.3109
-Robidoux
- Sharp 0.2620 0.3690
-Robidoux
- Soft 0.6796 0.1602</doc>
- <source-position filename="gst-libs/gst/video/video-resampler.h"
- line="71"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_RESAMPLER_OPT_CUBIC_C"
- value="GstVideoResampler.cubic-c"
- c:type="GST_VIDEO_RESAMPLER_OPT_CUBIC_C">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="72">G_TYPE_DOUBLE, C parameter of the cubic filter. The C
-parameter controls the Keys alpha value. Values between 0.0 and
-2.0 are accepted. 1/3 is the default.
-
-See #GST_VIDEO_RESAMPLER_OPT_CUBIC_B for some more common values</doc>
- <source-position filename="gst-libs/gst/video/video-resampler.h"
- line="81"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_RESAMPLER_OPT_ENVELOPE"
- value="GstVideoResampler.envelope"
- c:type="GST_VIDEO_RESAMPLER_OPT_ENVELOPE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="83">G_TYPE_DOUBLE, specifies the size of filter envelope for
-@GST_VIDEO_RESAMPLER_METHOD_LANCZOS. values are clamped between
-1.0 and 5.0. 2.0 is the default.</doc>
- <source-position filename="gst-libs/gst/video/video-resampler.h"
- line="90"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_RESAMPLER_OPT_MAX_TAPS"
- value="GstVideoResampler.max-taps"
- c:type="GST_VIDEO_RESAMPLER_OPT_MAX_TAPS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="109">G_TYPE_INT, limits the maximum number of taps to use.
-16 is the default.</doc>
- <source-position filename="gst-libs/gst/video/video-resampler.h"
- line="115"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_RESAMPLER_OPT_SHARPEN"
- value="GstVideoResampler.sharpen"
- c:type="GST_VIDEO_RESAMPLER_OPT_SHARPEN">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="101">G_TYPE_DOUBLE, specifies sharpening of the filter for
-@GST_VIDEO_RESAMPLER_METHOD_LANCZOS. values are clamped between
-0.0 and 1.0. 0.0 is the default.</doc>
- <source-position filename="gst-libs/gst/video/video-resampler.h"
- line="108"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_RESAMPLER_OPT_SHARPNESS"
- value="GstVideoResampler.sharpness"
- c:type="GST_VIDEO_RESAMPLER_OPT_SHARPNESS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="92">G_TYPE_DOUBLE, specifies sharpness of the filter for
-@GST_VIDEO_RESAMPLER_METHOD_LANCZOS. values are clamped between
-0.5 and 1.5. 1.0 is the default.</doc>
- <source-position filename="gst-libs/gst/video/video-resampler.h"
- line="99"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="VIDEO_SCALER_OPT_DITHER_METHOD"
- value="GstVideoScaler.dither-method"
- c:type="GST_VIDEO_SCALER_OPT_DITHER_METHOD">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.h"
- line="31">#GstVideoDitherMethod, The dither method to use for propagating
-quatization errors.</doc>
- <source-position filename="gst-libs/gst/video/video-scaler.h" line="37"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="VIDEO_SINK"
- c:identifier="GST_VIDEO_SINK"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideosink.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_SINK_CAST"
- c:identifier="GST_VIDEO_SINK_CAST"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="44">Cast @obj to a #GstVideoSink without runtime type check.</doc>
- <source-position filename="gst-libs/gst/video/gstvideosink.h" line="50"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="46">a #GstVideoSink or derived object</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_SINK_CLASS"
- c:identifier="GST_VIDEO_SINK_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideosink.h" line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_SINK_GET_CLASS"
- c:identifier="GST_VIDEO_SINK_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideosink.h" line="41"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_SINK_HEIGHT"
- c:identifier="GST_VIDEO_SINK_HEIGHT"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideosink.h" line="61"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_SINK_PAD"
- c:identifier="GST_VIDEO_SINK_PAD"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="52">Get the sink #GstPad of @obj.</doc>
- <source-position filename="gst-libs/gst/video/gstvideosink.h" line="58"/>
- <parameters>
- <parameter name="obj">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="54">a #GstVideoSink</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_SINK_WIDTH"
- c:identifier="GST_VIDEO_SINK_WIDTH"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideosink.h" line="60"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_SIZE_RANGE"
- value="(int) [ 1, max ]"
- c:type="GST_VIDEO_SIZE_RANGE">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="589"/>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <function-macro name="VIDEO_SUB_SCALE"
- c:identifier="GST_VIDEO_SUB_SCALE"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="534"/>
- <parameters>
- <parameter name="scale">
- </parameter>
- <parameter name="val">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_TILE_MAKE_MODE"
- c:identifier="GST_VIDEO_TILE_MAKE_MODE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="48">use this macro to create new tile modes.</doc>
- <source-position filename="gst-libs/gst/video/video-tile.h" line="55"/>
- <parameters>
- <parameter name="num">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="50">the mode number to create</doc>
- </parameter>
- <parameter name="type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="51">the tile mode type</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_TILE_MAKE_STRIDE"
- c:identifier="GST_VIDEO_TILE_MAKE_STRIDE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="82">Encode the number of tile in X and Y into the stride.</doc>
- <source-position filename="gst-libs/gst/video/video-tile.h" line="89"/>
- <parameters>
- <parameter name="x_tiles">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="84">number of tiles in X</doc>
- </parameter>
- <parameter name="y_tiles">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="85">number of tiles in Y</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_TILE_MODE_IS_INDEXED"
- c:identifier="GST_VIDEO_TILE_MODE_IS_INDEXED"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="66">Check if @mode is an indexed tile type</doc>
- <source-position filename="gst-libs/gst/video/video-tile.h" line="72"/>
- <parameters>
- <parameter name="mode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="68">a tile mode</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="VIDEO_TILE_MODE_TYPE"
- c:identifier="GST_VIDEO_TILE_MODE_TYPE"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="58">Get the tile mode type of @mode</doc>
- <source-position filename="gst-libs/gst/video/video-tile.h" line="64"/>
- <parameters>
- <parameter name="mode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="60">the tile mode</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_TILE_TYPE_MASK"
- value="65535"
- c:type="GST_VIDEO_TILE_TYPE_MASK">
- <source-position filename="gst-libs/gst/video/video-tile.h" line="46"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="VIDEO_TILE_TYPE_SHIFT"
- value="16"
- c:type="GST_VIDEO_TILE_TYPE_SHIFT">
- <source-position filename="gst-libs/gst/video/video-tile.h" line="41"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="VIDEO_TILE_X_TILES"
- c:identifier="GST_VIDEO_TILE_X_TILES"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="92">Extract the number of tiles in X from the stride value.</doc>
- <source-position filename="gst-libs/gst/video/video-tile.h" line="98"/>
- <parameters>
- <parameter name="stride">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="94">plane stride</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_TILE_X_TILES_MASK"
- value="65535"
- c:type="GST_VIDEO_TILE_X_TILES_MASK">
- <source-position filename="gst-libs/gst/video/video-tile.h" line="80"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <function-macro name="VIDEO_TILE_Y_TILES"
- c:identifier="GST_VIDEO_TILE_Y_TILES"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="100">Extract the number of tiles in Y from the stride value.</doc>
- <source-position filename="gst-libs/gst/video/video-tile.h" line="106"/>
- <parameters>
- <parameter name="stride">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="102">plane stride</doc>
- </parameter>
- </parameters>
- </function-macro>
- <constant name="VIDEO_TILE_Y_TILES_SHIFT"
- value="16"
- c:type="GST_VIDEO_TILE_Y_TILES_SHIFT">
- <source-position filename="gst-libs/gst/video/video-tile.h" line="75"/>
- <type name="gint" c:type="gint"/>
- </constant>
- <record name="VideoAFDMeta" c:type="GstVideoAFDMeta" version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="210">Active Format Description (AFD)
-
-For details, see Table 6.14 Active Format in:
-
-ATSC Digital Television Standard:
-Part 4 – MPEG-2 Video System Characteristics
-
-https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf
-
-and Active Format Description in Complete list of AFD codes
-
-https://en.wikipedia.org/wiki/Active_Format_Description#Complete_list_of_AFD_codes
-
-and SMPTE ST2016-1</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="240"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="212">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="field" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="213">0 for progressive or field 1 and 1 for field 2</doc>
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="spec" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="214">#GstVideoAFDSpec that applies to @afd</doc>
- <type name="VideoAFDSpec" c:type="GstVideoAFDSpec"/>
- </field>
- <field name="afd" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="215">#GstVideoAFDValue AFD value</doc>
- <type name="VideoAFDValue" c:type="GstVideoAFDValue"/>
- </field>
- <function name="get_info" c:identifier="gst_video_afd_meta_get_info">
- <source-position filename="gst-libs/gst/video/video-anc.h" line="245"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <enumeration name="VideoAFDSpec"
- version="1.18"
- glib:type-name="GstVideoAFDSpec"
- glib:get-type="gst_video_afd_spec_get_type"
- c:type="GstVideoAFDSpec">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="186">Enumeration of the different standards that may apply to AFD data:
-
-0) ETSI/DVB:
-https://www.etsi.org/deliver/etsi_ts/101100_101199/101154/02.01.01_60/ts_101154v020101p.pdf
-
-1) ATSC A/53:
-https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf
-
-2) SMPTE ST2016-1:</doc>
- <member name="dvb_etsi"
- value="0"
- c:identifier="GST_VIDEO_AFD_SPEC_DVB_ETSI"
- glib:nick="dvb-etsi">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="188">AFD value is from DVB/ETSI standard</doc>
- </member>
- <member name="atsc_a53"
- value="1"
- c:identifier="GST_VIDEO_AFD_SPEC_ATSC_A53"
- glib:nick="atsc-a53">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="189">AFD value is from ATSC A/53 standard</doc>
- </member>
- <member name="smpte_st2016_1"
- value="2"
- c:identifier="GST_VIDEO_AFD_SPEC_SMPTE_ST2016_1"
- glib:nick="smpte-st2016-1">
- </member>
- </enumeration>
- <enumeration name="VideoAFDValue"
- version="1.18"
- glib:type-name="GstVideoAFDValue"
- glib:get-type="gst_video_afd_value_get_type"
- c:type="GstVideoAFDValue">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="106">Enumeration of the various values for Active Format Description (AFD)
-
-AFD should be included in video user data whenever the rectangular
-picture area containing useful information does not extend to the full height or width of the coded
-frame. AFD data may also be included in user data when the rectangular picture area containing
-useful information extends to the full height and width of the coded frame.
-
-For details, see Table 6.14 Active Format in:
-
-ATSC Digital Television Standard:
-Part 4 – MPEG-2 Video System Characteristics
-
-https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf
-
-and Active Format Description in Complete list of AFD codes
-
-https://en.wikipedia.org/wiki/Active_Format_Description#Complete_list_of_AFD_codes
-
-and SMPTE ST2016-1
-
-Notes:
-
-1) AFD 0 is undefined for ATSC and SMPTE ST2016-1, indicating that AFD data is not available:
-If Bar Data is not present, AFD '0000' indicates that exact information
-is not available and the active image should be assumed to be the same as the coded frame. AFD '0000'.
-AFD '0000' accompanied by Bar Data signals that the active image’s aspect ratio is narrower than 16:9,
-but is not 4:3 or 14:9. As the exact aspect ratio cannot be conveyed by AFD alone, wherever possible,
-AFD ‘0000’ should be accompanied by Bar Data to define the exact vertical or horizontal extent
-of the active image.
-2) AFD 0 is reserved for DVB/ETSI
-3) values 1, 5, 6, 7, and 12 are reserved for both ATSC and DVB/ETSI
-4) values 2 and 3 are not recommended for ATSC, but are valid for DVB/ETSI</doc>
- <member name="unavailable"
- value="0"
- c:identifier="GST_VIDEO_AFD_UNAVAILABLE"
- glib:nick="unavailable">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="108">Unavailable (see note 0 below).</doc>
- </member>
- <member name="16_9_top_aligned"
- value="2"
- c:identifier="GST_VIDEO_AFD_16_9_TOP_ALIGNED"
- glib:nick="16-9-top-aligned">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="109">For 4:3 coded frame, letterbox 16:9 image,
- at top of the coded frame. For 16:9 coded frame, full frame 16:9 image,
- the same as the coded frame.</doc>
- </member>
- <member name="14_9_top_aligned"
- value="3"
- c:identifier="GST_VIDEO_AFD_14_9_TOP_ALIGNED"
- glib:nick="14-9-top-aligned">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="112">For 4:3 coded frame, letterbox 14:9 image,
- at top of the coded frame. For 16:9 coded frame, pillarbox 14:9 image,
- horizontally centered in the coded frame.</doc>
- </member>
- <member name="greater_than_16_9"
- value="4"
- c:identifier="GST_VIDEO_AFD_GREATER_THAN_16_9"
- glib:nick="greater-than-16-9">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="115">For 4:3 coded frame, letterbox image with an aspect ratio
- greater than 16:9, vertically centered in the coded frame. For 16:9 coded frame,
- letterbox image with an aspect ratio greater than 16:9.</doc>
- </member>
- <member name="4_3_full_16_9_full"
- value="8"
- c:identifier="GST_VIDEO_AFD_4_3_FULL_16_9_FULL"
- glib:nick="4-3-full-16-9-full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="118">For 4:3 coded frame, full frame 4:3 image,
- the same as the coded frame. For 16:9 coded frame, full frame 16:9 image, the same as
- the coded frame.</doc>
- </member>
- <member name="4_3_full_4_3_pillar"
- value="9"
- c:identifier="GST_VIDEO_AFD_4_3_FULL_4_3_PILLAR"
- glib:nick="4-3-full-4-3-pillar">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="121">For 4:3 coded frame, full frame 4:3 image, the same as
- the coded frame. For 16:9 coded frame, pillarbox 4:3 image, horizontally centered in the
- coded frame.</doc>
- </member>
- <member name="16_9_letter_16_9_full"
- value="10"
- c:identifier="GST_VIDEO_AFD_16_9_LETTER_16_9_FULL"
- glib:nick="16-9-letter-16-9-full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="124">For 4:3 coded frame, letterbox 16:9 image, vertically centered in
- the coded frame with all image areas protected. For 16:9 coded frame, full frame 16:9 image,
- with all image areas protected.</doc>
- </member>
- <member name="14_9_letter_14_9_pillar"
- value="11"
- c:identifier="GST_VIDEO_AFD_14_9_LETTER_14_9_PILLAR"
- glib:nick="14-9-letter-14-9-pillar">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="127">For 4:3 coded frame, letterbox 14:9 image, vertically centered in
- the coded frame. For 16:9 coded frame, pillarbox 14:9 image, horizontally centered in the
- coded frame.</doc>
- </member>
- <member name="4_3_full_14_9_center"
- value="13"
- c:identifier="GST_VIDEO_AFD_4_3_FULL_14_9_CENTER"
- glib:nick="4-3-full-14-9-center">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="130">For 4:3 coded frame, full frame 4:3 image, with alternative 14:9
- center. For 16:9 coded frame, pillarbox 4:3 image, with alternative 14:9 center.</doc>
- </member>
- <member name="16_9_letter_14_9_center"
- value="14"
- c:identifier="GST_VIDEO_AFD_16_9_LETTER_14_9_CENTER"
- glib:nick="16-9-letter-14-9-center">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="132">For 4:3 coded frame, letterbox 16:9 image, with alternative 14:9
- center. For 16:9 coded frame, full frame 16:9 image, with alternative 14:9 center.</doc>
- </member>
- <member name="16_9_letter_4_3_center"
- value="15"
- c:identifier="GST_VIDEO_AFD_16_9_LETTER_4_3_CENTER"
- glib:nick="16-9-letter-4-3-center">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="134">For 4:3 coded frame, letterbox 16:9 image, with alternative 4:3
- center. For 16:9 coded frame, full frame 16:9 image, with alternative 4:3 center.</doc>
- </member>
- </enumeration>
- <callback name="VideoAffineTransformationGetMatrix"
- c:type="GstVideoAffineTransformationGetMatrix">
- <source-position filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="34"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="meta" transfer-ownership="none">
- <type name="VideoAffineTransformationMeta"
- c:type="GstVideoAffineTransformationMeta*"/>
- </parameter>
- <parameter name="matrix" transfer-ownership="none">
- <type name="gfloat" c:type="gfloat*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="VideoAffineTransformationMeta"
- c:type="GstVideoAffineTransformationMeta"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="39">Extra buffer metadata for performing an affine transformation using a 4x4
-matrix. The transformation matrix can be composed with
-gst_video_affine_transformation_meta_apply_matrix().
-
-The vertices operated on are all in the range 0 to 1, not in
-Normalized Device Coordinates (-1 to +1). Transforming points in this space
-are assumed to have an origin at (0.5, 0.5, 0.5) in a left-handed coordinate
-system with the x-axis moving horizontally (positive values to the right),
-the y-axis moving vertically (positive values up the screen) and the z-axis
-perpendicular to the screen (positive values into the screen).</doc>
- <source-position filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="62"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="41">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="matrix" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="42">the column-major 4x4 transformation matrix</doc>
- <array zero-terminated="0" fixed-size="16">
- <type name="gfloat" c:type="gfloat"/>
- </array>
- </field>
- <method name="apply_matrix"
- c:identifier="gst_video_affine_transformation_meta_apply_matrix"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.c"
- line="138">Apply a transformation using the given 4x4 transformation matrix.
-Performs the multiplication, meta-&gt;matrix X matrix.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="76"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.c"
- line="140">a #GstVideoAffineTransformationMeta</doc>
- <type name="VideoAffineTransformationMeta"
- c:type="GstVideoAffineTransformationMeta*"/>
- </instance-parameter>
- <parameter name="matrix" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.c"
- line="141">a 4x4 transformation matrix to be applied</doc>
- <array zero-terminated="0" c:type="const gfloat*" fixed-size="16">
- <type name="gfloat" c:type="gfloat"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <function name="get_info"
- c:identifier="gst_video_affine_transformation_meta_get_info">
- <source-position filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="68"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <class name="VideoAggregator"
- c:symbol-prefix="video_aggregator"
- c:type="GstVideoAggregator"
- version="1.16"
- parent="GstBase.Aggregator"
- abstract="1"
- glib:type-name="GstVideoAggregator"
- glib:get-type="gst_video_aggregator_get_type"
- glib:type-struct="VideoAggregatorClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="21">VideoAggregator can accept AYUV, ARGB and BGRA video streams. For each of the requested
-sink pads it will compare the incoming geometry and framerate to define the
-output parameters. Indeed output video frames will have the geometry of the
-biggest incoming video stream and the framerate of the fastest incoming one.
-
-VideoAggregator will do colorspace conversion.
-
-Zorder for each input stream can be configured on the
-#GstVideoAggregatorPad.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="245"/>
- <virtual-method name="aggregate_frames">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="234"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="videoaggregator" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </instance-parameter>
- <parameter name="outbuffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="create_output_buffer">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="236"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="videoaggregator" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </instance-parameter>
- <parameter name="outbuffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="find_best_format">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="238"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="vagg" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </instance-parameter>
- <parameter name="downstream_caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="best_info" transfer-ownership="none">
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="at_least_one_alpha" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="update_caps">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="232"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="videoaggregator" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <field name="aggregator">
- <type name="GstBase.Aggregator" c:type="GstAggregator"/>
- </field>
- <field name="info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="189">The #GstVideoInfo representing the currently set
-srcpad caps.</doc>
- <type name="VideoInfo" c:type="GstVideoInfo"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="VideoAggregatorPrivate"
- c:type="GstVideoAggregatorPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="VideoAggregatorClass"
- c:type="GstVideoAggregatorClass"
- glib:is-gtype-struct-for="VideoAggregator"
- version="1.16">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="245"/>
- <field name="parent_class" readable="0" private="1">
- <type name="GstBase.AggregatorClass" c:type="GstAggregatorClass"/>
- </field>
- <field name="update_caps">
- <callback name="update_caps">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="232"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="videoaggregator" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="aggregate_frames">
- <callback name="aggregate_frames">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="234"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="videoaggregator" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </parameter>
- <parameter name="outbuffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="create_output_buffer">
- <callback name="create_output_buffer">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="236"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="videoaggregator" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </parameter>
- <parameter name="outbuffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="find_best_format">
- <callback name="find_best_format">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="238"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="vagg" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </parameter>
- <parameter name="downstream_caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="best_info" transfer-ownership="none">
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="at_least_one_alpha" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <class name="VideoAggregatorConvertPad"
- c:symbol-prefix="video_aggregator_convert_pad"
- c:type="GstVideoAggregatorConvertPad"
- version="1.16"
- parent="VideoAggregatorPad"
- glib:type-name="GstVideoAggregatorConvertPad"
- glib:get-type="gst_video_aggregator_convert_pad_get_type"
- glib:type-struct="VideoAggregatorConvertPadClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="130">An implementation of GstPad that can be used with #GstVideoAggregator.
-
-See #GstVideoAggregator for more details.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="162"/>
- <virtual-method name="create_conversion_info">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="158"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <type name="VideoAggregatorConvertPad"
- c:type="GstVideoAggregatorConvertPad*"/>
- </instance-parameter>
- <parameter name="agg" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </parameter>
- <parameter name="conversion_info" transfer-ownership="none">
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="update_conversion_info"
- c:identifier="gst_video_aggregator_convert_pad_update_conversion_info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="725">Requests the pad to check and update the converter before the next usage to
-update for any changes that have happened.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="168"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="727">a #GstVideoAggregatorPad</doc>
- <type name="VideoAggregatorConvertPad"
- c:type="GstVideoAggregatorConvertPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <property name="converter-config" writable="1" transfer-ownership="none">
- <type name="Gst.Structure"/>
- </property>
- <field name="parent" readable="0" private="1">
- <type name="VideoAggregatorPad" c:type="GstVideoAggregatorPad"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="VideoAggregatorConvertPadPrivate"
- c:type="GstVideoAggregatorConvertPadPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="VideoAggregatorConvertPadClass"
- c:type="GstVideoAggregatorConvertPadClass"
- glib:is-gtype-struct-for="VideoAggregatorConvertPad"
- version="1.16">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="162"/>
- <field name="parent_class">
- <type name="VideoAggregatorPadClass"
- c:type="GstVideoAggregatorPadClass"/>
- </field>
- <field name="create_conversion_info">
- <callback name="create_conversion_info">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="158"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <type name="VideoAggregatorConvertPad"
- c:type="GstVideoAggregatorConvertPad*"/>
- </parameter>
- <parameter name="agg" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </parameter>
- <parameter name="conversion_info" transfer-ownership="none">
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="VideoAggregatorConvertPadPrivate"
- c:type="GstVideoAggregatorConvertPadPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="128"/>
- </record>
- <class name="VideoAggregatorPad"
- c:symbol-prefix="video_aggregator_pad"
- c:type="GstVideoAggregatorPad"
- version="1.16"
- parent="GstBase.AggregatorPad"
- glib:type-name="GstVideoAggregatorPad"
- glib:get-type="gst_video_aggregator_pad_get_type"
- glib:type-struct="VideoAggregatorPadClass">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="98"/>
- <virtual-method name="clean_frame">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="93"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <type name="VideoAggregatorPad" c:type="GstVideoAggregatorPad*"/>
- </instance-parameter>
- <parameter name="videoaggregator" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </parameter>
- <parameter name="prepared_frame" transfer-ownership="none">
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="prepare_frame">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="88"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <type name="VideoAggregatorPad" c:type="GstVideoAggregatorPad*"/>
- </instance-parameter>
- <parameter name="videoaggregator" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="prepared_frame" transfer-ownership="none">
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="update_conversion_info">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="86"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <type name="VideoAggregatorPad" c:type="GstVideoAggregatorPad*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <method name="get_current_buffer"
- c:identifier="gst_video_aggregator_pad_get_current_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="321">Returns the currently queued buffer that is going to be used
-for the current output frame.
-
-This must only be called from the #GstVideoAggregatorClass::aggregate_frames virtual method,
-or from the #GstVideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.
-
-The return value is only valid until #GstVideoAggregatorClass::aggregate_frames or #GstVideoAggregatorPadClass::prepare_frame
-returns.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="107"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="334">The currently queued buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="323">a #GstVideoAggregatorPad</doc>
- <type name="VideoAggregatorPad" c:type="GstVideoAggregatorPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_prepared_frame"
- c:identifier="gst_video_aggregator_pad_get_prepared_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="344">Returns the currently prepared video frame that has to be aggregated into
-the current output frame.
-
-This must only be called from the #GstVideoAggregatorClass::aggregate_frames virtual method,
-or from the #GstVideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.
-
-The return value is only valid until #GstVideoAggregatorClass::aggregate_frames or #GstVideoAggregatorPadClass::prepare_frame
-returns.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="110"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="357">The currently prepared video frame</doc>
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="346">a #GstVideoAggregatorPad</doc>
- <type name="VideoAggregatorPad" c:type="GstVideoAggregatorPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="has_current_buffer"
- c:identifier="gst_video_aggregator_pad_has_current_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="301">Checks if the pad currently has a buffer queued that is going to be used
-for the current output frame.
-
-This must only be called from the #GstVideoAggregatorClass::aggregate_frames virtual method,
-or from the #GstVideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="104"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="311">%TRUE if the pad has currently a buffer queued</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="303">a #GstVideoAggregatorPad</doc>
- <type name="VideoAggregatorPad" c:type="GstVideoAggregatorPad*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_needs_alpha"
- c:identifier="gst_video_aggregator_pad_set_needs_alpha">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="367">Allows selecting that this pad requires an output format with alpha</doc>
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="113"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pad" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="369">a #GstVideoAggregatorPad</doc>
- <type name="VideoAggregatorPad" c:type="GstVideoAggregatorPad*"/>
- </instance-parameter>
- <parameter name="needs_alpha" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.c"
- line="370">%TRUE if this pad requires alpha output</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <property name="max-last-buffer-repeat"
- writable="1"
- transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="repeat-after-eos" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="zorder" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <field name="parent">
- <type name="GstBase.AggregatorPad" c:type="GstAggregatorPad"/>
- </field>
- <field name="info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="56">The #GstVideoInfo currently set on the pad</doc>
- <type name="VideoInfo" c:type="GstVideoInfo"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="VideoAggregatorPadPrivate"
- c:type="GstVideoAggregatorPadPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="VideoAggregatorPadClass"
- c:type="GstVideoAggregatorPadClass"
- glib:is-gtype-struct-for="VideoAggregatorPad"
- version="1.16">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="98"/>
- <field name="parent_class">
- <type name="GstBase.AggregatorPadClass"
- c:type="GstAggregatorPadClass"/>
- </field>
- <field name="update_conversion_info">
- <callback name="update_conversion_info">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="86"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <type name="VideoAggregatorPad" c:type="GstVideoAggregatorPad*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="prepare_frame">
- <callback name="prepare_frame">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="88"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <type name="VideoAggregatorPad" c:type="GstVideoAggregatorPad*"/>
- </parameter>
- <parameter name="videoaggregator" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="prepared_frame" transfer-ownership="none">
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="clean_frame">
- <callback name="clean_frame">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="93"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pad" transfer-ownership="none">
- <type name="VideoAggregatorPad" c:type="GstVideoAggregatorPad*"/>
- </parameter>
- <parameter name="videoaggregator" transfer-ownership="none">
- <type name="VideoAggregator" c:type="GstVideoAggregator*"/>
- </parameter>
- <parameter name="prepared_frame" transfer-ownership="none">
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="VideoAggregatorPadPrivate"
- c:type="GstVideoAggregatorPadPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="52"/>
- </record>
- <record name="VideoAggregatorPrivate"
- c:type="GstVideoAggregatorPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/video/gstvideoaggregator.h"
- line="31"/>
- </record>
- <record name="VideoAlignment" c:type="GstVideoAlignment">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="41">Extra alignment parameters for the memory of video buffers. This
-structure is usually used to configure the bufferpool if it supports the
-#GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT.</doc>
- <source-position filename="gst-libs/gst/video/video.h" line="60"/>
- <field name="padding_top" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="45">extra pixels on the top</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="padding_bottom" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="46">extra pixels on the bottom</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="padding_left" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="43">extra pixels on the left side</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="padding_right" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="44">extra pixels on the right side</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="stride_align" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="47">array with extra alignment requirements for the strides</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="guint" c:type="guint"/>
- </array>
- </field>
- <method name="reset" c:identifier="gst_video_alignment_reset">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="187">Set @align to its default values with no padding and no alignment.</doc>
- <source-position filename="gst-libs/gst/video/video.h" line="127"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="189">a #GstVideoAlignment</doc>
- <type name="VideoAlignment" c:type="GstVideoAlignment*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <enumeration name="VideoAlphaMode"
- version="1.6"
- glib:type-name="GstVideoAlphaMode"
- glib:get-type="gst_video_alpha_mode_get_type"
- c:type="GstVideoAlphaMode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="135">Different alpha modes.</doc>
- <member name="copy"
- value="0"
- c:identifier="GST_VIDEO_ALPHA_MODE_COPY"
- glib:nick="copy">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="137">When input and output have alpha, it will be copied.
- When the input has no alpha, alpha will be set to
- #GST_VIDEO_CONVERTER_OPT_ALPHA_VALUE</doc>
- </member>
- <member name="set"
- value="1"
- c:identifier="GST_VIDEO_ALPHA_MODE_SET"
- glib:nick="set">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="140">set all alpha to
- #GST_VIDEO_CONVERTER_OPT_ALPHA_VALUE</doc>
- </member>
- <member name="mult"
- value="2"
- c:identifier="GST_VIDEO_ALPHA_MODE_MULT"
- glib:nick="mult">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="142">multiply all alpha with
- #GST_VIDEO_CONVERTER_OPT_ALPHA_VALUE.
- When the input format has no alpha but the output format has, the
- alpha value will be set to #GST_VIDEO_CONVERTER_OPT_ALPHA_VALUE</doc>
- </member>
- </enumeration>
- <record name="VideoAncillary" c:type="GstVideoAncillary" version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="31">Video Ancillary data, according to SMPTE-291M specification.
-
-Note that the contents of the data are always stored as 8bit data (i.e. do not contain
-the parity check bits).</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="56"/>
- <field name="DID" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="33">The Data Identifier</doc>
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="SDID_block_number" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="34">The Secondary Data Identifier (if type 2) or the Data
- Block Number (if type 1)</doc>
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="data_count" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="36">The amount of data (in bytes) in @data (max 255 bytes)</doc>
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="data" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="37">The user data content of the Ancillary packet.
- Does not contain the ADF, DID, SDID nor CS.</doc>
- <array length="2" zero-terminated="0">
- <type name="guint8" c:type="guint8"/>
- </array>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <enumeration name="VideoAncillaryDID"
- version="1.16"
- glib:type-name="GstVideoAncillaryDID"
- glib:get-type="gst_video_ancillary_did_get_type"
- c:type="GstVideoAncillaryDID">
- <member name="undefined"
- value="0"
- c:identifier="GST_VIDEO_ANCILLARY_DID_UNDEFINED"
- glib:nick="undefined">
- </member>
- <member name="deletion"
- value="128"
- c:identifier="GST_VIDEO_ANCILLARY_DID_DELETION"
- glib:nick="deletion">
- </member>
- <member name="hanc_3g_audio_data_first"
- value="160"
- c:identifier="GST_VIDEO_ANCILLARY_DID_HANC_3G_AUDIO_DATA_FIRST"
- glib:nick="hanc-3g-audio-data-first">
- </member>
- <member name="hanc_3g_audio_data_last"
- value="167"
- c:identifier="GST_VIDEO_ANCILLARY_DID_HANC_3G_AUDIO_DATA_LAST"
- glib:nick="hanc-3g-audio-data-last">
- </member>
- <member name="hanc_hdtv_audio_data_first"
- value="224"
- c:identifier="GST_VIDEO_ANCILLARY_DID_HANC_HDTV_AUDIO_DATA_FIRST"
- glib:nick="hanc-hdtv-audio-data-first">
- </member>
- <member name="hanc_hdtv_audio_data_last"
- value="231"
- c:identifier="GST_VIDEO_ANCILLARY_DID_HANC_HDTV_AUDIO_DATA_LAST"
- glib:nick="hanc-hdtv-audio-data-last">
- </member>
- <member name="hanc_sdtv_audio_data_1_first"
- value="236"
- c:identifier="GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_1_FIRST"
- glib:nick="hanc-sdtv-audio-data-1-first">
- </member>
- <member name="hanc_sdtv_audio_data_1_last"
- value="239"
- c:identifier="GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_1_LAST"
- glib:nick="hanc-sdtv-audio-data-1-last">
- </member>
- <member name="camera_position"
- value="240"
- c:identifier="GST_VIDEO_ANCILLARY_DID_CAMERA_POSITION"
- glib:nick="camera-position">
- </member>
- <member name="hanc_error_detection"
- value="244"
- c:identifier="GST_VIDEO_ANCILLARY_DID_HANC_ERROR_DETECTION"
- glib:nick="hanc-error-detection">
- </member>
- <member name="hanc_sdtv_audio_data_2_first"
- value="248"
- c:identifier="GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_2_FIRST"
- glib:nick="hanc-sdtv-audio-data-2-first">
- </member>
- <member name="hanc_sdtv_audio_data_2_last"
- value="255"
- c:identifier="GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_2_LAST"
- glib:nick="hanc-sdtv-audio-data-2-last">
- </member>
- </enumeration>
- <enumeration name="VideoAncillaryDID16"
- version="1.16"
- glib:type-name="GstVideoAncillaryDID16"
- glib:get-type="gst_video_ancillary_di_d16_get_type"
- c:type="GstVideoAncillaryDID16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="90">Some know types of Ancillary Data identifiers.</doc>
- <member name="s334_eia_708"
- value="24833"
- c:identifier="GST_VIDEO_ANCILLARY_DID16_S334_EIA_708"
- glib:nick="s334-eia-708">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="92">CEA 708 Ancillary data according to SMPTE 334</doc>
- </member>
- <member name="s334_eia_608"
- value="24834"
- c:identifier="GST_VIDEO_ANCILLARY_DID16_S334_EIA_608"
- glib:nick="s334-eia-608">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="93">CEA 608 Ancillary data according to SMPTE 334</doc>
- </member>
- <member name="s2016_3_afd_bar"
- value="16645"
- c:identifier="GST_VIDEO_ANCILLARY_DID16_S2016_3_AFD_BAR"
- glib:nick="s2016-3-afd-bar">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="94">AFD/Bar Ancillary data according to SMPTE 2016-3 (Since: 1.18)</doc>
- </member>
- </enumeration>
- <record name="VideoBarMeta" c:type="GstVideoBarMeta" version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="268">Bar data should be included in video user data
-whenever the rectangular picture area containing useful information
-does not extend to the full height or width of the coded frame
-and AFD alone is insufficient to describe the extent of the image.
-
-Note: either vertical or horizontal bars are specified, but not both.
-
-For more details, see:
-
-https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf
-
-and SMPTE ST2016-1</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="304"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="270">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="field" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="271">0 for progressive or field 1 and 1 for field 2</doc>
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="is_letterbox" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="272">if true then bar data specifies letterbox, otherwise pillarbox</doc>
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="bar_data1" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="273">If @is_letterbox is true, then the value specifies the
- last line of a horizontal letterbox bar area at top of reconstructed frame.
- Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox
- bar area at the left side of the reconstructed frame</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="bar_data2" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="277">If @is_letterbox is true, then the value specifies the
- first line of a horizontal letterbox bar area at bottom of reconstructed frame.
- Otherwise, it specifies the first horizontal
- luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame.</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <function name="get_info" c:identifier="gst_video_bar_meta_get_info">
- <source-position filename="gst-libs/gst/video/video-anc.h" line="309"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <bitfield name="VideoBufferFlags"
- glib:type-name="GstVideoBufferFlags"
- glib:get-type="gst_video_buffer_flags_get_type"
- c:type="GstVideoBufferFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="155">Additional video buffer flags. These flags can potentially be used on any
-buffers carrying closed caption data, or video data - even encoded data.
-
-Note that these are only valid for #GstCaps of type: video/... and caption/...
-They can conflict with other extended buffer flags.</doc>
- <member name="interlaced"
- value="1048576"
- c:identifier="GST_VIDEO_BUFFER_FLAG_INTERLACED"
- glib:nick="interlaced">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="157">If the #GstBuffer is interlaced. In mixed
- interlace-mode, this flags specifies if the frame is
- interlaced or progressive.</doc>
- </member>
- <member name="tff"
- value="2097152"
- c:identifier="GST_VIDEO_BUFFER_FLAG_TFF"
- glib:nick="tff">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="160">If the #GstBuffer is interlaced, then the first field
- in the video frame is the top field. If unset, the
- bottom field is first.</doc>
- </member>
- <member name="rff"
- value="4194304"
- c:identifier="GST_VIDEO_BUFFER_FLAG_RFF"
- glib:nick="rff">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="163">If the #GstBuffer is interlaced, then the first field
- (as defined by the %GST_VIDEO_BUFFER_FLAG_TFF flag setting)
- is repeated.</doc>
- </member>
- <member name="onefield"
- value="8388608"
- c:identifier="GST_VIDEO_BUFFER_FLAG_ONEFIELD"
- glib:nick="onefield">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="166">If the #GstBuffer is interlaced, then only the
- first field (as defined by the %GST_VIDEO_BUFFER_FLAG_TFF
- flag setting) is to be displayed (Since: 1.16).</doc>
- </member>
- <member name="multiple_view"
- value="16777216"
- c:identifier="GST_VIDEO_BUFFER_FLAG_MULTIPLE_VIEW"
- glib:nick="multiple-view">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="169">The #GstBuffer contains one or more specific views,
- such as left or right eye view. This flags is set on
- any buffer that contains non-mono content - even for
- streams that contain only a single viewpoint. In mixed
- mono / non-mono streams, the absence of the flag marks
- mono buffers.</doc>
- </member>
- <member name="first_in_bundle"
- value="33554432"
- c:identifier="GST_VIDEO_BUFFER_FLAG_FIRST_IN_BUNDLE"
- glib:nick="first-in-bundle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="175">When conveying stereo/multiview content with
- frame-by-frame methods, this flag marks the first buffer
- in a bundle of frames that belong together.</doc>
- </member>
- <member name="top_field"
- value="10485760"
- c:identifier="GST_VIDEO_BUFFER_FLAG_TOP_FIELD"
- glib:nick="top-field">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="178">The video frame has the top field only. This is the
- same as GST_VIDEO_BUFFER_FLAG_TFF |
- GST_VIDEO_BUFFER_FLAG_ONEFIELD (Since: 1.16).
- Use GST_VIDEO_BUFFER_IS_TOP_FIELD() to check for this flag.</doc>
- </member>
- <member name="onefield"
- value="8388608"
- c:identifier="GST_VIDEO_BUFFER_FLAG_ONEFIELD"
- glib:nick="onefield">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="166">If the #GstBuffer is interlaced, then only the
- first field (as defined by the %GST_VIDEO_BUFFER_FLAG_TFF
- flag setting) is to be displayed (Since: 1.16).</doc>
- </member>
- <member name="bottom_field"
- value="8388608"
- c:identifier="GST_VIDEO_BUFFER_FLAG_BOTTOM_FIELD"
- glib:nick="bottom-field">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="182">The video frame has the bottom field only. This is
- the same as GST_VIDEO_BUFFER_FLAG_ONEFIELD
- (GST_VIDEO_BUFFER_FLAG_TFF flag unset) (Since: 1.16).
- Use GST_VIDEO_BUFFER_IS_BOTTOM_FIELD() to check for this flag.</doc>
- </member>
- <member name="marker"
- value="512"
- c:identifier="GST_VIDEO_BUFFER_FLAG_MARKER"
- glib:nick="marker">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="186">The #GstBuffer contains the end of a video field or frame
- boundary such as the last subframe or packet (Since: 1.18).</doc>
- </member>
- <member name="last"
- value="268435456"
- c:identifier="GST_VIDEO_BUFFER_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="188">Offset to define more flags</doc>
- </member>
- </bitfield>
- <class name="VideoBufferPool"
- c:symbol-prefix="video_buffer_pool"
- c:type="GstVideoBufferPool"
- parent="Gst.BufferPool"
- glib:type-name="GstVideoBufferPool"
- glib:get-type="gst_video_buffer_pool_get_type"
- glib:type-struct="VideoBufferPoolClass">
- <source-position filename="gst-libs/gst/video/gstvideopool.h" line="76"/>
- <constructor name="new" c:identifier="gst_video_buffer_pool_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideopool.c"
- line="274">Create a new bufferpool that can allocate video frames. This bufferpool
-supports all the video bufferpool options.</doc>
- <source-position filename="gst-libs/gst/video/gstvideopool.h"
- line="82"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideopool.c"
- line="280">a new #GstBufferPool to allocate video frames</doc>
- <type name="Gst.BufferPool" c:type="GstBufferPool*"/>
- </return-value>
- </constructor>
- <field name="bufferpool">
- <type name="Gst.BufferPool" c:type="GstBufferPool"/>
- </field>
- <field name="priv">
- <type name="VideoBufferPoolPrivate"
- c:type="GstVideoBufferPoolPrivate*"/>
- </field>
- </class>
- <record name="VideoBufferPoolClass"
- c:type="GstVideoBufferPoolClass"
- glib:is-gtype-struct-for="VideoBufferPool">
- <source-position filename="gst-libs/gst/video/gstvideopool.h" line="76"/>
- <field name="parent_class">
- <type name="Gst.BufferPoolClass" c:type="GstBufferPoolClass"/>
- </field>
- </record>
- <record name="VideoBufferPoolPrivate"
- c:type="GstVideoBufferPoolPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/video/gstvideopool.h" line="59"/>
- </record>
- <record name="VideoCaptionMeta"
- c:type="GstVideoCaptionMeta"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="375">Extra buffer metadata providing Closed Caption.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="392"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="377">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="caption_type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="378">The type of Closed Caption contained in the meta.</doc>
- <type name="VideoCaptionType" c:type="GstVideoCaptionType"/>
- </field>
- <field name="data" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="379">The Closed Caption data.</doc>
- <array length="3" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="380">The size in bytes of @data</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <function name="get_info" c:identifier="gst_video_caption_meta_get_info">
- <source-position filename="gst-libs/gst/video/video-anc.h" line="399"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <enumeration name="VideoCaptionType"
- version="1.16"
- glib:type-name="GstVideoCaptionType"
- glib:get-type="gst_video_caption_type_get_type"
- c:type="GstVideoCaptionType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="330">The various known types of Closed Caption (CC).</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_VIDEO_CAPTION_TYPE_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="332">Unknown type of CC</doc>
- </member>
- <member name="cea608_raw"
- value="1"
- c:identifier="GST_VIDEO_CAPTION_TYPE_CEA608_RAW"
- glib:nick="cea608-raw">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="333">CEA-608 as byte pairs. Note that
- this format is not recommended since is does not specify to
- which field the caption comes from and therefore assumes
- it comes from the first field (and that there is no information
- on the second field). Use @GST_VIDEO_CAPTION_TYPE_CEA708_RAW
- if you wish to store CEA-608 from two fields and prefix each byte pair
- with 0xFC for the first field and 0xFD for the second field.</doc>
- </member>
- <member name="cea608_s334_1a"
- value="2"
- c:identifier="GST_VIDEO_CAPTION_TYPE_CEA608_S334_1A"
- glib:nick="cea608-s334-1a">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="340">CEA-608 as byte triplets as defined
- in SMPTE S334-1 Annex A. The second and third byte of the byte triplet
- is the raw CEA608 data, the first byte is a bitfield: The top/7th bit is
- 0 for the second field, 1 for the first field, bit 6 and 5 are 0 and
- bits 4 to 0 are a 5 bit unsigned integer that represents the line
- offset relative to the base-line of the original image format (line 9
- for 525-line field 1, line 272 for 525-line field 2, line 5 for
- 625-line field 1 and line 318 for 625-line field 2).</doc>
- </member>
- <member name="cea708_raw"
- value="3"
- c:identifier="GST_VIDEO_CAPTION_TYPE_CEA708_RAW"
- glib:nick="cea708-raw">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="348">CEA-708 as cc_data byte triplets. They
- can also contain 608-in-708 and the first byte of each triplet has to
- be inspected for detecting the type.</doc>
- </member>
- <member name="cea708_cdp"
- value="4"
- c:identifier="GST_VIDEO_CAPTION_TYPE_CEA708_CDP"
- glib:nick="cea708-cdp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="351">CEA-708 (and optionally CEA-608) in
- a CDP (Caption Distribution Packet) defined by SMPTE S-334-2.
- Contains the whole CDP (starting with 0x9669).</doc>
- </member>
- <function name="from_caps"
- c:identifier="gst_video_caption_type_from_caps"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1040">Parses fixed Closed Caption #GstCaps and returns the corresponding caption
-type, or %GST_VIDEO_CAPTION_TYPE_UNKNOWN.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="369"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1047">#GstVideoCaptionType.</doc>
- <type name="VideoCaptionType" c:type="GstVideoCaptionType"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1042">Fixed #GstCaps to parse</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_caps"
- c:identifier="gst_video_caption_type_to_caps"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1080">Creates new caps corresponding to @type.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="373"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1086">new #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1082">#GstVideoCaptionType</doc>
- <type name="VideoCaptionType" c:type="GstVideoCaptionType"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <bitfield name="VideoChromaFlags"
- glib:type-name="GstVideoChromaFlags"
- glib:get-type="gst_video_chroma_flags_get_type"
- c:type="GstVideoChromaFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="75">Extra flags that influence the result from gst_video_chroma_resample_new().</doc>
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_CHROMA_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="77">no flags</doc>
- </member>
- <member name="interlaced"
- value="1"
- c:identifier="GST_VIDEO_CHROMA_FLAG_INTERLACED"
- glib:nick="interlaced">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="78">the input is interlaced</doc>
- </member>
- </bitfield>
- <enumeration name="VideoChromaMethod"
- glib:type-name="GstVideoChromaMethod"
- glib:get-type="gst_video_chroma_method_get_type"
- c:type="GstVideoChromaMethod">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="61">Different subsampling and upsampling methods</doc>
- <member name="nearest"
- value="0"
- c:identifier="GST_VIDEO_CHROMA_METHOD_NEAREST"
- glib:nick="nearest">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="63">Duplicates the chroma samples when
- upsampling and drops when subsampling</doc>
- </member>
- <member name="linear"
- value="1"
- c:identifier="GST_VIDEO_CHROMA_METHOD_LINEAR"
- glib:nick="linear">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="65">Uses linear interpolation to reconstruct
- missing chroma and averaging to subsample</doc>
- </member>
- </enumeration>
- <enumeration name="VideoChromaMode"
- version="1.6"
- glib:type-name="GstVideoChromaMode"
- glib:get-type="gst_video_chroma_mode_get_type"
- c:type="GstVideoChromaMode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="172">Different chroma downsampling and upsampling modes</doc>
- <member name="full"
- value="0"
- c:identifier="GST_VIDEO_CHROMA_MODE_FULL"
- glib:nick="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="174">do full chroma up and down sampling</doc>
- </member>
- <member name="upsample_only"
- value="1"
- c:identifier="GST_VIDEO_CHROMA_MODE_UPSAMPLE_ONLY"
- glib:nick="upsample-only">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="175">only perform chroma upsampling</doc>
- </member>
- <member name="downsample_only"
- value="2"
- c:identifier="GST_VIDEO_CHROMA_MODE_DOWNSAMPLE_ONLY"
- glib:nick="downsample-only">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="176">only perform chroma downsampling</doc>
- </member>
- <member name="none"
- value="3"
- c:identifier="GST_VIDEO_CHROMA_MODE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="177">disable chroma resampling</doc>
- </member>
- </enumeration>
- <record name="VideoChromaResample"
- c:type="GstVideoChromaResample"
- disguised="1">
- <source-position filename="gst-libs/gst/video/video-chroma.h" line="87"/>
- <method name=""
- c:identifier="gst_video_chroma_resample"
- moved-to="video_chroma_resample">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1040">Perform resampling of @width chroma pixels in @lines.</doc>
- <source-position filename="gst-libs/gst/video/video-chroma.h"
- line="107"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="resample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1042">a #GstVideoChromaResample</doc>
- <type name="VideoChromaResample" c:type="GstVideoChromaResample*"/>
- </instance-parameter>
- <parameter name="lines"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1043">pixel lines</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1044">the number of pixels on one line</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_video_chroma_resample_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1026">Free @resample</doc>
- <source-position filename="gst-libs/gst/video/video-chroma.h"
- line="100"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="resample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1028">a #GstVideoChromaResample</doc>
- <type name="VideoChromaResample" c:type="GstVideoChromaResample*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_info"
- c:identifier="gst_video_chroma_resample_get_info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1005">The resampler must be fed @n_lines at a time. The first line should be
-at @offset.</doc>
- <source-position filename="gst-libs/gst/video/video-chroma.h"
- line="103"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="resample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1007">a #GstVideoChromaResample</doc>
- <type name="VideoChromaResample" c:type="GstVideoChromaResample*"/>
- </instance-parameter>
- <parameter name="n_lines" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1008">the number of input lines</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1009">the first line</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <function name="new"
- c:identifier="gst_video_chroma_resample_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="929">Create a new resampler object for the given parameters. When @h_factor or
-@v_factor is &gt; 0, upsampling will be used, otherwise subsampling is
-performed.</doc>
- <source-position filename="gst-libs/gst/video/video-chroma.h"
- line="93"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="942">a new #GstVideoChromaResample that should be freed with
- gst_video_chroma_resample_free() after usage.</doc>
- <type name="VideoChromaResample" c:type="GstVideoChromaResample*"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="931">a #GstVideoChromaMethod</doc>
- <type name="VideoChromaMethod" c:type="GstVideoChromaMethod"/>
- </parameter>
- <parameter name="site" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="932">a #GstVideoChromaSite</doc>
- <type name="VideoChromaSite" c:type="GstVideoChromaSite"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="933">#GstVideoChromaFlags</doc>
- <type name="VideoChromaFlags" c:type="GstVideoChromaFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="934">the #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="h_factor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="935">horizontal resampling factor</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="v_factor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="936">vertical resampling factor</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <bitfield name="VideoChromaSite"
- glib:type-name="GstVideoChromaSite"
- glib:get-type="gst_video_chroma_site_get_type"
- c:type="GstVideoChromaSite">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="28">Various Chroma sitings.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_VIDEO_CHROMA_SITE_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="30">unknown cositing</doc>
- </member>
- <member name="none"
- value="1"
- c:identifier="GST_VIDEO_CHROMA_SITE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="31">no cositing</doc>
- </member>
- <member name="h_cosited"
- value="2"
- c:identifier="GST_VIDEO_CHROMA_SITE_H_COSITED"
- glib:nick="h-cosited">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="32">chroma is horizontally cosited</doc>
- </member>
- <member name="v_cosited"
- value="4"
- c:identifier="GST_VIDEO_CHROMA_SITE_V_COSITED"
- glib:nick="v-cosited">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="33">chroma is vertically cosited</doc>
- </member>
- <member name="alt_line"
- value="8"
- c:identifier="GST_VIDEO_CHROMA_SITE_ALT_LINE"
- glib:nick="alt-line">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="34">choma samples are sited on alternate lines</doc>
- </member>
- <member name="cosited"
- value="6"
- c:identifier="GST_VIDEO_CHROMA_SITE_COSITED"
- glib:nick="cosited">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="35">chroma samples cosited with luma samples</doc>
- </member>
- <member name="jpeg"
- value="1"
- c:identifier="GST_VIDEO_CHROMA_SITE_JPEG"
- glib:nick="jpeg">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="36">jpeg style cositing, also for mpeg1 and mjpeg</doc>
- </member>
- <member name="mpeg2"
- value="2"
- c:identifier="GST_VIDEO_CHROMA_SITE_MPEG2"
- glib:nick="mpeg2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="37">mpeg2 style cositing</doc>
- </member>
- <member name="dv"
- value="14"
- c:identifier="GST_VIDEO_CHROMA_SITE_DV"
- glib:nick="dv">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.h"
- line="38">DV style cositing</doc>
- </member>
- </bitfield>
- <record name="VideoCodecFrame"
- c:type="GstVideoCodecFrame"
- glib:type-name="GstVideoCodecFrame"
- glib:get-type="gst_video_codec_frame_get_type"
- c:symbol-prefix="video_codec_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="211">A #GstVideoCodecFrame represents a video frame both in raw and
-encoded form.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="278"/>
- <field name="ref_count" readable="0" private="1">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="flags" readable="0" private="1">
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="system_frame_number" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="216">Unique identifier for the frame. Use this if you need
- to get hold of the frame later (like when data is being decoded).
- Typical usage in decoders is to set this on the opaque value provided
- to the library and get back the frame using gst_video_decoder_get_frame()</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="decode_frame_number" readable="0" private="1">
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="presentation_frame_number" readable="0" private="1">
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="dts" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="214">Decoding timestamp</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="pts" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="213">Presentation timestamp</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="duration" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="215">Duration of the frame</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="distance_from_sync" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="220">Distance in frames from the last synchronization point.</doc>
- <type name="gint" c:type="int"/>
- </field>
- <field name="input_buffer" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="221">the input #GstBuffer that created this frame. The buffer is owned
- by the frame and references to the frame instead of the buffer should
- be kept.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="output_buffer" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="224">the output #GstBuffer. Implementations should set this either
- directly, or by using the
- @gst_video_decoder_allocate_output_frame() or
- @gst_video_decoder_allocate_output_buffer() methods. The buffer is
- owned by the frame and references to the frame instead of the
- buffer should be kept.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="deadline" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="230">Running time when the frame will be used.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="events" readable="0" private="1">
- <type name="GLib.List" c:type="GList*">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </field>
- <field name="user_data" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="user_data_destroy_notify" readable="0" private="1">
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </field>
- <union name="abidata" c:type="abidata">
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="277"/>
- <record name="ABI" c:type="ABI">
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="275"/>
- <field name="ts" writable="1">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="ts2" writable="1">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="num_subframes" writable="1">
- <type name="guint" c:type="guint"/>
- </field>
- </record>
- <field name="padding" writable="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </union>
- <method name="get_user_data"
- c:identifier="gst_video_codec_frame_get_user_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="87">Gets private data set on the frame by the subclass via
-gst_video_codec_frame_set_user_data() previously.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="309"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="94">The previously set user_data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="89">a #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="ref" c:identifier="gst_video_codec_frame_ref">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="102">Increases the refcount of the given frame by one.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="298"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="108">@buf</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </return-value>
- <parameters>
- <instance-parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="104">a #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_user_data"
- c:identifier="gst_video_codec_frame_set_user_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="64">Sets @user_data on the frame and the #GDestroyNotify that will be called when
-the frame is freed. Allows to attach private data by the subclass to frames.
-
-If a @user_data was previously set, then the previous set @notify will be called
-before the @user_data is replaced.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="304"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="66">a #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </instance-parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="67">private data</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="notify"
- transfer-ownership="none"
- scope="async"
- closure="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="68">a #GDestroyNotify</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_video_codec_frame_unref">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="122">Decreases the refcount of the frame. If the refcount reaches 0, the frame
-will be freed.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="301"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="124">a #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <bitfield name="VideoCodecFrameFlags" c:type="GstVideoCodecFrameFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="79">Flags for #GstVideoCodecFrame</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="103"/>
- <member name="decode_only"
- value="1"
- c:identifier="GST_VIDEO_CODEC_FRAME_FLAG_DECODE_ONLY">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="81">is the frame only meant to be decoded</doc>
- </member>
- <member name="sync_point"
- value="2"
- c:identifier="GST_VIDEO_CODEC_FRAME_FLAG_SYNC_POINT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="82">is the frame a synchronization point (keyframe)</doc>
- </member>
- <member name="force_keyframe"
- value="4"
- c:identifier="GST_VIDEO_CODEC_FRAME_FLAG_FORCE_KEYFRAME">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="83">should the output frame be made a keyframe</doc>
- </member>
- <member name="force_keyframe_headers"
- value="8"
- c:identifier="GST_VIDEO_CODEC_FRAME_FLAG_FORCE_KEYFRAME_HEADERS">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="84">should the encoder output stream headers</doc>
- </member>
- <member name="corrupted"
- value="16"
- c:identifier="GST_VIDEO_CODEC_FRAME_FLAG_CORRUPTED"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="95">The buffer data is corrupted.</doc>
- </member>
- </bitfield>
- <record name="VideoCodecState"
- c:type="GstVideoCodecState"
- glib:type-name="GstVideoCodecState"
- glib:get-type="gst_video_codec_state_get_type"
- c:symbol-prefix="video_codec_state">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="42">Structure representing the state of an incoming or outgoing video
-stream for encoders and decoders.
-
-Decoders and encoders will receive such a state through their
-respective @set_format vmethods.
-
-Decoders and encoders can set the downstream state, by using the
-@gst_video_decoder_set_output_state() or
-@gst_video_encoder_set_output_state() methods.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="77"/>
- <field name="ref_count" readable="0" private="1">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="info" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="44">The #GstVideoInfo describing the stream</doc>
- <type name="VideoInfo" c:type="GstVideoInfo"/>
- </field>
- <field name="caps" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="45">The #GstCaps used in the caps negotiation of the pad.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </field>
- <field name="codec_data" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="46">a #GstBuffer corresponding to the
- 'codec_data' field of a stream, or NULL.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="allocation_caps" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.h"
- line="48">The #GstCaps for allocation query and pool
- negotiation. Since: 1.10</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </field>
- <field name="padding" readable="0" private="1">
- <array zero-terminated="0" fixed-size="19">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="ref" c:identifier="gst_video_codec_state_ref">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="143">Increases the refcount of the given state by one.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="286"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="149">@buf</doc>
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </return-value>
- <parameters>
- <instance-parameter name="state" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="145">a #GstVideoCodecState</doc>
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unref" c:identifier="gst_video_codec_state_unref">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="177">Decreases the refcount of the state. If the refcount reaches 0, the state
-will be freed.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoutils.h"
- line="289"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="state" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoutils.c"
- line="179">a #GstVideoCodecState</doc>
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <enumeration name="VideoColorMatrix"
- glib:type-name="GstVideoColorMatrix"
- glib:get-type="gst_video_color_matrix_get_type"
- c:type="GstVideoColorMatrix">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="45">The color matrix is used to convert between Y'PbPr and
-non-linear RGB (R'G'B')</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_VIDEO_COLOR_MATRIX_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="47">unknown matrix</doc>
- </member>
- <member name="rgb"
- value="1"
- c:identifier="GST_VIDEO_COLOR_MATRIX_RGB"
- glib:nick="rgb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="48">identity matrix. Order of coefficients is
-actually GBR, also IEC 61966-2-1 (sRGB)</doc>
- </member>
- <member name="fcc"
- value="2"
- c:identifier="GST_VIDEO_COLOR_MATRIX_FCC"
- glib:nick="fcc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="50">FCC Title 47 Code of Federal Regulations 73.682 (a)(20)</doc>
- </member>
- <member name="bt709"
- value="3"
- c:identifier="GST_VIDEO_COLOR_MATRIX_BT709"
- glib:nick="bt709">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="51">ITU-R BT.709 color matrix, also ITU-R BT1361
-/ IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B</doc>
- </member>
- <member name="bt601"
- value="4"
- c:identifier="GST_VIDEO_COLOR_MATRIX_BT601"
- glib:nick="bt601">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="53">ITU-R BT.601 color matrix, also SMPTE170M / ITU-R BT1358 525 / ITU-R BT1700 NTSC</doc>
- </member>
- <member name="smpte240m"
- value="5"
- c:identifier="GST_VIDEO_COLOR_MATRIX_SMPTE240M"
- glib:nick="smpte240m">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="54">SMPTE 240M color matrix</doc>
- </member>
- <member name="bt2020"
- value="6"
- c:identifier="GST_VIDEO_COLOR_MATRIX_BT2020"
- glib:nick="bt2020">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="55">ITU-R BT.2020 color matrix. Since: 1.6</doc>
- </member>
- <function name="from_iso"
- c:identifier="gst_video_color_matrix_from_iso"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="799">Converts the @value to the #GstVideoColorMatrix
-The matrix coefficients (MatrixCoefficients) value is
-defined by "ISO/IEC 23001-8 Section 7.3 Table 4"
-and "ITU-T H.273 Table 4".
-"H.264 Table E-5" and "H.265 Table E.5" share the identical values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="288"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="809">the matched #GstVideoColorMatrix</doc>
- <type name="VideoColorMatrix" c:type="GstVideoColorMatrix"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="801">a ITU-T H.273 matrix coefficients value</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_Kr_Kb"
- c:identifier="gst_video_color_matrix_get_Kr_Kb"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="322">Get the coefficients used to convert between Y'PbPr and R'G'B' using @matrix.
-
-When:
-
-|[
- 0.0 &lt;= [Y',R',G',B'] &lt;= 1.0)
- (-0.5 &lt;= [Pb,Pr] &lt;= 0.5)
-]|
-
-the general conversion is given by:
-
-|[
- Y' = Kr*R' + (1-Kr-Kb)*G' + Kb*B'
- Pb = (B'-Y')/(2*(1-Kb))
- Pr = (R'-Y')/(2*(1-Kr))
-]|
-
-and the other way around:
-
-|[
- R' = Y' + Cr*2*(1-Kr)
- G' = Y' - Cb*2*(1-Kb)*Kb/(1-Kr-Kb) - Cr*2*(1-Kr)*Kr/(1-Kr-Kb)
- B' = Y' + Cb*2*(1-Kb)
-]|</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="71"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="353">TRUE if @matrix was a YUV color format and @Kr and @Kb contain valid
- values.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="matrix" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="324">a #GstVideoColorMatrix</doc>
- <type name="VideoColorMatrix" c:type="GstVideoColorMatrix"/>
- </parameter>
- <parameter name="Kr"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="325">result red channel coefficient</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="Kb"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="326">result blue channel coefficient</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_iso"
- c:identifier="gst_video_color_matrix_to_iso"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="666">Converts #GstVideoColorMatrix to the "matrix coefficients"
-(MatrixCoefficients) value defined by "ISO/IEC 23001-8 Section 7.3 Table 4"
-and "ITU-T H.273 Table 4".
-"H.264 Table E-5" and "H.265 Table E.5" share the identical values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="279"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="675">The value of ISO/IEC 23001-8 matrix coefficients.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="matrix" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="668">a #GstVideoColorMatrix</doc>
- <type name="VideoColorMatrix" c:type="GstVideoColorMatrix"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <enumeration name="VideoColorPrimaries"
- glib:type-name="GstVideoColorPrimaries"
- glib:get-type="gst_video_color_primaries_get_type"
- c:type="GstVideoColorPrimaries">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="151">The color primaries define the how to transform linear RGB values to and from
-the CIE XYZ colorspace.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="153">unknown color primaries</doc>
- </member>
- <member name="bt709"
- value="1"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_BT709"
- glib:nick="bt709">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="154">BT709 primaries, also ITU-R BT1361 / IEC
-61966-2-4 / SMPTE RP177 Annex B</doc>
- </member>
- <member name="bt470m"
- value="2"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_BT470M"
- glib:nick="bt470m">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="156">BT470M primaries, also FCC Title 47 Code
-of Federal Regulations 73.682 (a)(20)</doc>
- </member>
- <member name="bt470bg"
- value="3"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_BT470BG"
- glib:nick="bt470bg">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="158">BT470BG primaries, also ITU-R BT601-6
-625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL &amp; SECAM</doc>
- </member>
- <member name="smpte170m"
- value="4"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_SMPTE170M"
- glib:nick="smpte170m">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="160">SMPTE170M primaries, also ITU-R
-BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC</doc>
- </member>
- <member name="smpte240m"
- value="5"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_SMPTE240M"
- glib:nick="smpte240m">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="162">SMPTE240M primaries</doc>
- </member>
- <member name="film"
- value="6"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_FILM"
- glib:nick="film">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="163">Generic film (colour filters using
-Illuminant C)</doc>
- </member>
- <member name="bt2020"
- value="7"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_BT2020"
- glib:nick="bt2020">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="165">ITU-R BT2020 primaries. Since: 1.6</doc>
- </member>
- <member name="adobergb"
- value="8"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_ADOBERGB"
- glib:nick="adobergb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="166">Adobe RGB primaries. Since: 1.8</doc>
- </member>
- <member name="smptest428"
- value="9"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_SMPTEST428"
- glib:nick="smptest428">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="167">SMPTE ST 428 primaries (CIE 1931
-XYZ). Since: 1.16</doc>
- </member>
- <member name="smpterp431"
- value="10"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_SMPTERP431"
- glib:nick="smpterp431">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="169">SMPTE RP 431 primaries (ST 431-2
-(2011) / DCI P3). Since: 1.16</doc>
- </member>
- <member name="smpteeg432"
- value="11"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_SMPTEEG432"
- glib:nick="smpteeg432">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="171">SMPTE EG 432 primaries (ST 432-1
-(2010) / P3 D65). Since: 1.16</doc>
- </member>
- <member name="ebu3213"
- value="12"
- c:identifier="GST_VIDEO_COLOR_PRIMARIES_EBU3213"
- glib:nick="ebu3213">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="173">EBU 3213 primaries (JEDEC P22
-phosphors). Since: 1.16</doc>
- </member>
- <function name="from_iso"
- c:identifier="gst_video_color_primaries_from_iso"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="886">Converts the @value to the #GstVideoColorPrimaries
-The colour primaries (ColourPrimaries) value is
-defined by "ISO/IEC 23001-8 Section 7.1 Table 2" and "ITU-T H.273 Table 2".
-"H.264 Table E-3" and "H.265 Table E.3" share the identical values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="294"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="895">the matched #GstVideoColorPrimaries</doc>
- <type name="VideoColorPrimaries" c:type="GstVideoColorPrimaries"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="888">a ITU-T H.273 colour primaries value</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_info"
- c:identifier="gst_video_color_primaries_get_info"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="303">Get information about the chromaticity coordinates of @primaries.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="223"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="309">a #GstVideoColorPrimariesInfo for @primaries.</doc>
- <type name="VideoColorPrimariesInfo"
- c:type="const GstVideoColorPrimariesInfo*"/>
- </return-value>
- <parameters>
- <parameter name="primaries" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="305">a #GstVideoColorPrimaries</doc>
- <type name="VideoColorPrimaries" c:type="GstVideoColorPrimaries"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_iso"
- c:identifier="gst_video_color_primaries_to_iso"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="753">Converts #GstVideoColorPrimaries to the "colour primaries" (ColourPrimaries)
-value defined by "ISO/IEC 23001-8 Section 7.1 Table 2"
-and "ITU-T H.273 Table 2".
-"H.264 Table E-3" and "H.265 Table E.3" share the identical values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="285"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="762">The value of ISO/IEC 23001-8 colour primaries.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="primaries" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="755">a #GstVideoColorPrimaries</doc>
- <type name="VideoColorPrimaries" c:type="GstVideoColorPrimaries"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <record name="VideoColorPrimariesInfo"
- c:type="GstVideoColorPrimariesInfo"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="195">Structure describing the chromaticity coordinates of an RGB system. These
-values can be used to construct a matrix to transform RGB to and from the
-XYZ colorspace.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="219"/>
- <field name="primaries" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="197">a #GstVideoColorPrimaries</doc>
- <type name="VideoColorPrimaries" c:type="GstVideoColorPrimaries"/>
- </field>
- <field name="Wx" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="198">reference white x coordinate</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="Wy" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="199">reference white y coordinate</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="Rx" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="200">red x coordinate</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="Ry" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="201">red y coordinate</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="Gx" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="202">green x coordinate</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="Gy" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="203">green y coordinate</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="Bx" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="204">blue x coordinate</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- <field name="By" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="205">blue y coordinate</doc>
- <type name="gdouble" c:type="gdouble"/>
- </field>
- </record>
- <enumeration name="VideoColorRange"
- glib:type-name="GstVideoColorRange"
- glib:get-type="gst_video_color_range_get_type"
- c:type="GstVideoColorRange">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="29">Possible color range values. These constants are defined for 8 bit color
-values and can be scaled for other bit depths.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_VIDEO_COLOR_RANGE_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="31">unknown range</doc>
- </member>
- <member name="0_255"
- value="1"
- c:identifier="GST_VIDEO_COLOR_RANGE_0_255"
- glib:nick="0-255">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="32">[0..255] for 8 bit components</doc>
- </member>
- <member name="16_235"
- value="2"
- c:identifier="GST_VIDEO_COLOR_RANGE_16_235"
- glib:nick="16-235">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="33">[16..235] for 8 bit components. Chroma has
- [16..240] range.</doc>
- </member>
- <function name="offsets" c:identifier="gst_video_color_range_offsets">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="188">Compute the offset and scale values for each component of @info. For each
-component, (c[i] - offset[i]) / scale[i] will scale the component c[i] to the
-range [0.0 .. 1.0].
-
-The reverse operation (c[i] * scale[i]) + offset[i] can be used to convert
-the component values in range [0.0 .. 1.0] back to their representation in
-@info and @range.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="268"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="range" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="190">a #GstVideoColorRange</doc>
- <type name="VideoColorRange" c:type="GstVideoColorRange"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="191">a #GstVideoFormatInfo</doc>
- <type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
- </parameter>
- <parameter name="offset"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="192">output offsets</doc>
- <array zero-terminated="0" c:type="gint*" fixed-size="4">
- <type name="gint" c:type="gint"/>
- </array>
- </parameter>
- <parameter name="scale"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="193">output scale</doc>
- <array zero-terminated="0" c:type="gint*" fixed-size="4">
- <type name="gint" c:type="gint"/>
- </array>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <record name="VideoColorimetry" c:type="GstVideoColorimetry">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="225">Structure describing the color info.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="241"/>
- <field name="range" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="227">the color range. This is the valid range for the samples.
- It is used to convert the samples to Y'PbPr values.</doc>
- <type name="VideoColorRange" c:type="GstVideoColorRange"/>
- </field>
- <field name="matrix" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="229">the color matrix. Used to convert between Y'PbPr and
- non-linear RGB (R'G'B')</doc>
- <type name="VideoColorMatrix" c:type="GstVideoColorMatrix"/>
- </field>
- <field name="transfer" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="231">the transfer function. used to convert between R'G'B' and RGB</doc>
- <type name="VideoTransferFunction" c:type="GstVideoTransferFunction"/>
- </field>
- <field name="primaries" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="232">color primaries. used to convert between R'G'B' and CIE XYZ</doc>
- <type name="VideoColorPrimaries" c:type="GstVideoColorPrimaries"/>
- </field>
- <method name="from_string"
- c:identifier="gst_video_colorimetry_from_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="102">Parse the colorimetry string and update @cinfo with the parsed
-values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="257"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="110">%TRUE if @color points to valid colorimetry info.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="cinfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="104">a #GstVideoColorimetry</doc>
- <type name="VideoColorimetry" c:type="GstVideoColorimetry*"/>
- </instance-parameter>
- <parameter name="color" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="105">a colorimetry string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_equal"
- c:identifier="gst_video_colorimetry_is_equal"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="251">Compare the 2 colorimetry sets for equality</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="263"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="258">%TRUE if @cinfo and @other are equal.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="cinfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="253">a #GstVideoColorimetry</doc>
- <type name="VideoColorimetry" c:type="const GstVideoColorimetry*"/>
- </instance-parameter>
- <parameter name="other" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="254">another #GstVideoColorimetry</doc>
- <type name="VideoColorimetry" c:type="const GstVideoColorimetry*"/>
- </parameter>
- </parameters>
- </method>
- <method name="matches" c:identifier="gst_video_colorimetry_matches">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="165">Check if the colorimetry information in @info matches that of the
-string @color.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="254"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="173">%TRUE if @color conveys the same colorimetry info as the color
-information in @info.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="cinfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="167">a #GstVideoInfo</doc>
- <type name="VideoColorimetry" c:type="const GstVideoColorimetry*"/>
- </instance-parameter>
- <parameter name="color" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="168">a colorimetry string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_string" c:identifier="gst_video_colorimetry_to_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="139">Make a string representation of @cinfo.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="260"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="145">a string representation of @cinfo
-or %NULL if all the entries of @cinfo are unknown values.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="cinfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="141">a #GstVideoColorimetry</doc>
- <type name="VideoColorimetry" c:type="const GstVideoColorimetry*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <record name="VideoContentLightLevel"
- c:type="GstVideoContentLightLevel"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.h"
- line="98">Content light level information specified in CEA-861.3, Appendix A.</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="116"/>
- <field name="max_content_light_level" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.h"
- line="100">the maximum content light level
- (abbreviated to MaxCLL) in candelas per square meter (cd/m^2 and nit)</doc>
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="max_frame_average_light_level" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.h"
- line="102">the maximum frame average light level
- (abbreviated to MaxFLL) in candelas per square meter (cd/m^2 and nit)</doc>
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="add_to_caps"
- c:identifier="gst_video_content_light_level_add_to_caps"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="366">Parse @caps and update @linfo</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="133"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="373">%TRUE if @linfo was successfully set to @caps</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="linfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="368">a #GstVideoContentLightLevel</doc>
- <type name="VideoContentLightLevel"
- c:type="const GstVideoContentLightLevel*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="369">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="from_caps"
- c:identifier="gst_video_content_light_level_from_caps"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="337">Parse @caps and update @linfo</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="129"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="344">if @caps has #GstVideoContentLightLevel and could be parsed</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="linfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="339">a #GstVideoContentLightLevel</doc>
- <type name="VideoContentLightLevel"
- c:type="GstVideoContentLightLevel*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="340">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="from_string"
- c:identifier="gst_video_content_light_level_from_string"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="269">Parse the value of content-light-level caps field and update @minfo
-with the parsed values.</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="122"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="277">%TRUE if @linfo points to valid #GstVideoContentLightLevel.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="linfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="271">a #GstVideoContentLightLevel</doc>
- <type name="VideoContentLightLevel"
- c:type="GstVideoContentLightLevel*"/>
- </instance-parameter>
- <parameter name="level" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="272">a content-light-level string from caps</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="init"
- c:identifier="gst_video_content_light_level_init"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="253">Initialize @linfo</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="119"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="linfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="255">a #GstVideoContentLightLevel</doc>
- <type name="VideoContentLightLevel"
- c:type="GstVideoContentLightLevel*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="to_string"
- c:identifier="gst_video_content_light_level_to_string"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="317">Convert @linfo to its string representation.</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="126"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="323">a string representation of @linfo.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="linfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="319">a #GstVideoContentLightLevel</doc>
- <type name="VideoContentLightLevel"
- c:type="const GstVideoContentLightLevel*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <callback name="VideoConvertSampleCallback"
- c:type="GstVideoConvertSampleCallback">
- <source-position filename="gst-libs/gst/video/video.h" line="148"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="sample" transfer-ownership="none">
- <type name="Gst.Sample" c:type="GstSample*"/>
- </parameter>
- <parameter name="error" transfer-ownership="none">
- <type name="GLib.Error" c:type="GError*"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="2">
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <record name="VideoConverter" c:type="GstVideoConverter" disguised="1">
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="276"/>
- <method name="frame"
- c:identifier="gst_video_converter_frame"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2671">Convert the pixels of @src into @dest using @convert.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="299"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2673">a #GstVideoConverter</doc>
- <type name="VideoConverter" c:type="GstVideoConverter*"/>
- </instance-parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2675">a #GstVideoFrame</doc>
- <type name="VideoFrame" c:type="const GstVideoFrame*"/>
- </parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2674">a #GstVideoFrame</doc>
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </method>
- <method name="free"
- c:identifier="gst_video_converter_free"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2505">Free @convert</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="290"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2507">a #GstVideoConverter</doc>
- <type name="VideoConverter" c:type="GstVideoConverter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_config" c:identifier="gst_video_converter_get_config">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2654">Get the current configuration of @convert.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="296"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2660">a #GstStructure that remains valid for as long as @convert is valid
- or until gst_video_converter_set_config() is called.</doc>
- <type name="Gst.Structure" c:type="const GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2656">a #GstVideoConverter</doc>
- <type name="VideoConverter" c:type="GstVideoConverter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_config"
- c:identifier="gst_video_converter_set_config"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2623">Set @config as extra configuration for @convert.
-
-If the parameters in @config can not be set exactly, this function returns
-%FALSE and will try to update as much state as possible. The new state can
-then be retrieved and refined with gst_video_converter_get_config().
-
-Look at the `GST_VIDEO_CONVERTER_OPT_*` fields to check valid configuration
-option and values.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="293"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2637">%TRUE when @config could be set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="convert" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2625">a #GstVideoConverter</doc>
- <type name="VideoConverter" c:type="GstVideoConverter*"/>
- </instance-parameter>
- <parameter name="config" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2626">a #GstStructure</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <function name="new"
- c:identifier="gst_video_converter_new"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2477">Create a new converter object to convert between @in_info and @out_info
-with @config.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="279"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2486">a #GstVideoConverter or %NULL if conversion is not possible.</doc>
- <type name="VideoConverter" c:type="GstVideoConverter*"/>
- </return-value>
- <parameters>
- <parameter name="in_info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2479">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="out_info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2480">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="config" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2481">a #GstStructure with configuration options</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_with_pool"
- c:identifier="gst_video_converter_new_with_pool"
- version="1.20"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2232">Create a new converter object to convert between @in_info and @out_info
-with @config.
-
-The optional @pool can be used to spawn threads, this is useful when
-creating new converters rapidly, for example when updating cropping.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="284"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2245">a #GstVideoConverter or %NULL if conversion is not possible.</doc>
- <type name="VideoConverter" c:type="GstVideoConverter*"/>
- </return-value>
- <parameters>
- <parameter name="in_info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2234">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="out_info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2235">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="config" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2236">a #GstStructure with configuration options</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="pool"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2237">a #GstTaskPool to spawn threads from</doc>
- <type name="Gst.TaskPool" c:type="GstTaskPool*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <record name="VideoCropMeta" c:type="GstVideoCropMeta">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="138">Extra buffer metadata describing image cropping.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="155"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="140">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="x" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="141">the horizontal offset</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="y" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="142">the vertical offset</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="width" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="143">the cropped width</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="height" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="144">the cropped height</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <function name="get_info" c:identifier="gst_video_crop_meta_get_info">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="161"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <class name="VideoDecoder"
- c:symbol-prefix="video_decoder"
- c:type="GstVideoDecoder"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstVideoDecoder"
- glib:get-type="gst_video_decoder_get_type"
- glib:type-struct="VideoDecoderClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="25">This base class is for video decoders turning encoded data into raw video
-frames.
-
-The GstVideoDecoder base class and derived subclasses should cooperate as
-follows:
-
-## Configuration
-
- * Initially, GstVideoDecoder calls @start when the decoder element
- is activated, which allows the subclass to perform any global setup.
-
- * GstVideoDecoder calls @set_format to inform the subclass of caps
- describing input video data that it is about to receive, including
- possibly configuration data.
- While unlikely, it might be called more than once, if changing input
- parameters require reconfiguration.
-
- * Incoming data buffers are processed as needed, described in Data
- Processing below.
-
- * GstVideoDecoder calls @stop at end of all processing.
-
-## Data processing
-
- * The base class gathers input data, and optionally allows subclass
- to parse this into subsequently manageable chunks, typically
- corresponding to and referred to as 'frames'.
-
- * Each input frame is provided in turn to the subclass' @handle_frame
- callback.
- The ownership of the frame is given to the @handle_frame callback.
-
- * If codec processing results in decoded data, the subclass should call
- @gst_video_decoder_finish_frame to have decoded data pushed.
- downstream. Otherwise, the subclass must call
- @gst_video_decoder_drop_frame, to allow the base class to do timestamp
- and offset tracking, and possibly to requeue the frame for a later
- attempt in the case of reverse playback.
-
-## Shutdown phase
-
- * The GstVideoDecoder class calls @stop to inform the subclass that data
- parsing will be stopped.
-
-## Additional Notes
-
- * Seeking/Flushing
-
- * When the pipeline is seeked or otherwise flushed, the subclass is
- informed via a call to its @reset callback, with the hard parameter
- set to true. This indicates the subclass should drop any internal data
- queues and timestamps and prepare for a fresh set of buffers to arrive
- for parsing and decoding.
-
- * End Of Stream
-
- * At end-of-stream, the subclass @parse function may be called some final
- times with the at_eos parameter set to true, indicating that the element
- should not expect any more data to be arriving, and it should parse and
- remaining frames and call gst_video_decoder_have_frame() if possible.
-
-The subclass is responsible for providing pad template caps for
-source and sink pads. The pads need to be named "sink" and "src". It also
-needs to provide information about the output caps, when they are known.
-This may be when the base class calls the subclass' @set_format function,
-though it might be during decoding, before calling
-@gst_video_decoder_finish_frame. This is done via
-@gst_video_decoder_set_output_state
-
-The subclass is also responsible for providing (presentation) timestamps
-(likely based on corresponding input ones). If that is not applicable
-or possible, the base class provides limited framerate based interpolation.
-
-Similarly, the base class provides some limited (legacy) seeking support
-if specifically requested by the subclass, as full-fledged support
-should rather be left to upstream demuxer, parser or alike. This simple
-approach caters for seeking and duration reporting using estimated input
-bitrates. To enable it, a subclass should call
-@gst_video_decoder_set_estimate_rate to enable handling of incoming
-byte-streams.
-
-The base class provides some support for reverse playback, in particular
-in case incoming data is not packetized or upstream does not provide
-fragments on keyframe boundaries. However, the subclass should then be
-prepared for the parsing and frame processing stage to occur separately
-(in normal forward processing, the latter immediately follows the former),
-The subclass also needs to ensure the parsing stage properly marks
-keyframes, unless it knows the upstream elements will do so properly for
-incoming data.
-
-The bare minimum that a functional subclass needs to implement is:
-
- * Provide pad templates
- * Inform the base class of output caps via
- @gst_video_decoder_set_output_state
-
- * Parse input data, if it is not considered packetized from upstream
- Data will be provided to @parse which should invoke
- @gst_video_decoder_add_to_frame and @gst_video_decoder_have_frame to
- separate the data belonging to each video frame.
-
- * Accept data in @handle_frame and provide decoded results to
- @gst_video_decoder_finish_frame, or call @gst_video_decoder_drop_frame.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="342"/>
- <virtual-method name="close">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="289"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="decide_allocation">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="319"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="drain">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="334"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="finish">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="306"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="flush">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="323"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="getcaps">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="331"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="handle_frame">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="308"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="negotiate" invoker="negotiate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4230">Negotiate with downstream elements to currently configured #GstVideoCodecState.
-Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
-negotiate fails.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="317"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4238">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4232">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="open">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="287"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="parse">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="295"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- <parameter name="adapter" transfer-ownership="none">
- <type name="GstBase.Adapter" c:type="GstAdapter*"/>
- </parameter>
- <parameter name="at_eos" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="propose_allocation">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="321"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="reset">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="303"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="hard" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_format">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="300"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="state" transfer-ownership="none">
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_event">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="311"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_query">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="325"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_event">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="314"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_query">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="328"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="291"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="293"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="transform_meta">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="336"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- <parameter name="meta" transfer-ownership="none">
- <type name="Gst.Meta" c:type="GstMeta*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="add_to_frame"
- c:identifier="gst_video_decoder_add_to_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3464">Removes next @n_bytes of input data and adds it to currently parsed frame.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="434"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3466">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="n_bytes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3467">the number of bytes to add</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </method>
- <method name="allocate_output_buffer"
- c:identifier="gst_video_decoder_allocate_output_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4262">Helper function that allocates a buffer to hold a video frame for @decoder's
-current #GstVideoCodecState.
-
-You should use gst_video_decoder_allocate_output_frame() instead of this
-function, if possible at all.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="444"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4272">allocated buffer, or NULL if no buffer could be
- allocated (e.g. when downstream is flushing or shutting down)</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4264">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="allocate_output_frame"
- c:identifier="gst_video_decoder_allocate_output_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4328">Helper function that allocates a buffer to hold a video frame for @decoder's
-current #GstVideoCodecState. Subclass should already have configured video
-state and set src pad caps.
-
-The buffer allocated here is owned by the frame and you should only
-keep references to the frame, not the buffer.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="452"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4340">%GST_FLOW_OK if an output buffer could be allocated</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4330">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4331">a #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </method>
- <method name="allocate_output_frame_with_params"
- c:identifier="gst_video_decoder_allocate_output_frame_with_params"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4350">Same as #gst_video_decoder_allocate_output_frame except it allows passing
-#GstBufferPoolAcquireParams to the sub call gst_buffer_pool_acquire_buffer.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="447"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4359">%GST_FLOW_OK if an output buffer could be allocated</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4352">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4353">a #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- <parameter name="params" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4354">a #GstBufferPoolAcquireParams</doc>
- <type name="Gst.BufferPoolAcquireParams"
- c:type="GstBufferPoolAcquireParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="drop_frame" c:identifier="gst_video_decoder_drop_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3057">Similar to gst_video_decoder_finish_frame(), but drops @frame in any
-case and posts a QoS message with the frame's details on the bus.
-In any case, the frame is considered finished and released.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="483"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3066">a #GstFlowReturn, usually GST_FLOW_OK.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3059">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3060">the #GstVideoCodecFrame to drop</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </method>
- <method name="finish_frame"
- c:identifier="gst_video_decoder_finish_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3156">@frame should have a valid decoded data buffer, whose metadata fields
-are then appropriately set according to frame data and pushed downstream.
-If no output data is provided, @frame is considered skipped.
-In any case, the frame is considered finished and released.
-
-After calling this function the output buffer of the frame is to be
-considered read-only. This function will also change the metadata
-of the buffer.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="479"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3170">a #GstFlowReturn resulting from sending data downstream</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3158">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3159">a decoded #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_allocator"
- c:identifier="gst_video_decoder_get_allocator">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4739">Lets #GstVideoDecoder sub-classes to know the memory @allocator
-used by the base class and its @params.
-
-Unref the @allocator after use it.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="412"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4741">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="allocator"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4742">the #GstAllocator
-used</doc>
- <type name="Gst.Allocator" c:type="GstAllocator**"/>
- </parameter>
- <parameter name="params"
- direction="out"
- caller-allocates="1"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4744">the
-#GstAllocationParams of @allocator</doc>
- <type name="Gst.AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_buffer_pool"
- c:identifier="gst_video_decoder_get_buffer_pool">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="417"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4725">the instance of the #GstBufferPool used
-by the decoder; free it after use it</doc>
- <type name="Gst.BufferPool" c:type="GstBufferPool*"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4723">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_estimate_rate"
- c:identifier="gst_video_decoder_get_estimate_rate">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="378"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4620">currently configured byte to time conversion setting</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4618">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_frame" c:identifier="gst_video_decoder_get_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3856">Get a pending unfinished #GstVideoCodecFrame</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="422"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3863">pending unfinished #GstVideoCodecFrame identified by @frame_number.</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3858">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="frame_number" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3859">system_frame_number of a frame</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_frames" c:identifier="gst_video_decoder_get_frames">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3887">Get all pending unfinished #GstVideoCodecFrame</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="429"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3893">pending unfinished #GstVideoCodecFrame.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="VideoCodecFrame"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3889">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_latency" c:identifier="gst_video_decoder_get_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4656">Query the configured decoder latency. Results will be returned via
-@min_latency and @max_latency.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="407"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4658">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="min_latency"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4659">address of variable in which to store the
- configured minimum latency, or %NULL</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="max_latency"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4661">address of variable in which to store the
- configured mximum latency, or %NULL</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_max_decode_time"
- c:identifier="gst_video_decoder_get_max_decode_time">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4410">Determines maximum possible decoding time for @frame that will
-allow it to decode and arrive in time (as determined by QoS events).
-In particular, a negative result means decoding in time is no longer possible
-and should therefore occur as soon/skippy as possible.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="472"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4420">max decoding time.</doc>
- <type name="Gst.ClockTimeDiff" c:type="GstClockTimeDiff"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4412">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4413">a #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_max_errors"
- c:identifier="gst_video_decoder_get_max_errors">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="385"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4517">currently configured decoder tolerated error count.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4515">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_needs_format"
- c:identifier="gst_video_decoder_get_needs_format"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4549">Queries decoder required format handling.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="392"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4555">%TRUE if required format handling is enabled.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4551">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_needs_sync_point"
- c:identifier="gst_video_decoder_get_needs_sync_point"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4886">Queries if the decoder requires a sync point before it starts outputting
-data in the beginning.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="399"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4893">%TRUE if a sync point is required in the beginning.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4888">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_oldest_frame"
- c:identifier="gst_video_decoder_get_oldest_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3835">Get the oldest pending unfinished #GstVideoCodecFrame</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="426"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3841">oldest pending unfinished #GstVideoCodecFrame.</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3837">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_output_state"
- c:identifier="gst_video_decoder_get_output_state">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3707">Get the #GstVideoCodecState currently describing the output stream.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="466"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3713">#GstVideoCodecState describing format of video data.</doc>
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3709">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_packetized"
- c:identifier="gst_video_decoder_get_packetized">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4586">Queries whether input data is considered packetized or not by the
-base class.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="371"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4593">TRUE if input data is considered packetized.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4588">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_pending_frame_size"
- c:identifier="gst_video_decoder_get_pending_frame_size"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3493">Returns the number of bytes previously added to the current frame
-by calling gst_video_decoder_add_to_frame().</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="441"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3500">The number of bytes pending for the current frame</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3495">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_qos_proportion"
- c:identifier="gst_video_decoder_get_qos_proportion"
- version="1.0.3">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="476"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4452">The current QoS proportion.</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4449">a #GstVideoDecoder
- current QoS proportion, or %NULL</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="have_frame" c:identifier="gst_video_decoder_have_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3543">Gathers all data collected for currently parsed frame, gathers corresponding
-metadata and passes it along for further processing, i.e. @handle_frame.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="438"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3550">a #GstFlowReturn</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3545">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="merge_tags" c:identifier="gst_video_decoder_merge_tags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4679">Sets the audio decoder tags and how they should be merged with any
-upstream stream tags. This will override any tags previously-set
-with gst_audio_decoder_merge_tags().
-
-Note that this is provided for convenience, and the subclass is
-not required to use this and can still do tag handling on its own.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="496"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4681">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="tags"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4682">a #GstTagList to merge, or NULL to unset
- previously-set tags</doc>
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4684">the #GstTagMergeMode to use, usually #GST_TAG_MERGE_REPLACE</doc>
- <type name="Gst.TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="negotiate" c:identifier="gst_video_decoder_negotiate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4230">Negotiate with downstream elements to currently configured #GstVideoCodecState.
-Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
-negotiate fails.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="469"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4238">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4232">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="proxy_getcaps"
- c:identifier="gst_video_decoder_proxy_getcaps"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="1904">Returns caps that express @caps (or sink template caps if @caps == NULL)
-restricted to resolution/format/... combinations supported by downstream
-elements.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="501"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="1914">a #GstCaps owned by caller</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="1906">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="1907">initial caps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="filter"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="1908">filter caps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="release_frame"
- c:identifier="gst_video_decoder_release_frame"
- version="1.2.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="2990">Similar to gst_video_decoder_drop_frame(), but simply releases @frame
-without any processing other than removing it from list of pending frames,
-after which it is considered finished and released.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="492"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="2992">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="2993">the #GstVideoCodecFrame to release</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </method>
- <method name="request_sync_point"
- c:identifier="gst_video_decoder_request_sync_point"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4787">Allows the #GstVideoDecoder subclass to request from the base class that
-a new sync should be requested from upstream, and that @frame was the frame
-when the subclass noticed that a new sync point is required. A reason for
-the subclass to do this could be missing reference frames, for example.
-
-The base class will then request a new sync point from upstream as long as
-the time that passed since the last one is exceeding
-#GstVideoDecoder:min-force-key-unit-interval.
-
-The subclass can signal via @flags how the frames until the next sync point
-should be handled:
-
- * If %GST_VIDEO_DECODER_REQUEST_SYNC_POINT_DISCARD_INPUT is selected then
- all following input frames until the next sync point are discarded.
- This can be useful if the lack of a sync point will prevent all further
- decoding and the decoder implementation is not very robust in handling
- missing references frames.
- * If %GST_VIDEO_DECODER_REQUEST_SYNC_POINT_CORRUPT_OUTPUT is selected
- then all output frames following @frame are marked as corrupted via
- %GST_BUFFER_FLAG_CORRUPTED. Corrupted frames can be automatically
- dropped by the base class, see #GstVideoDecoder:discard-corrupted-frames.
- Subclasses can manually mark frames as corrupted via %GST_VIDEO_CODEC_FRAME_FLAG_CORRUPTED
- before calling gst_video_decoder_finish_frame().</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="487"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4789">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4790">a #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4791">#GstVideoDecoderRequestSyncPointFlags</doc>
- <type name="VideoDecoderRequestSyncPointFlags"
- c:type="GstVideoDecoderRequestSyncPointFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_estimate_rate"
- c:identifier="gst_video_decoder_set_estimate_rate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4601">Allows baseclass to perform byte to time estimated conversion.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="374"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4603">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4604">whether to enable byte to time conversion</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_interlaced_output_state"
- c:identifier="gst_video_decoder_set_interlaced_output_state"
- version="1.16.">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3809">Same as #gst_video_decoder_set_output_state() but also allows you to also set
-the interlacing mode.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="461"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3821">the newly configured output state.</doc>
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3811">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="fmt" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3812">a #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="interlace_mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3815">A #GstVideoInterlaceMode</doc>
- <type name="VideoInterlaceMode" c:type="GstVideoInterlaceMode"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3813">The width in pixels</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3814">The height in pixels</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="reference"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3816">An optional reference #GstVideoCodecState</doc>
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_latency" c:identifier="gst_video_decoder_set_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4630">Lets #GstVideoDecoder sub-classes tell the baseclass what the decoder
-latency is. Will also post a LATENCY message on the bus so the pipeline
-can reconfigure its global latency.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="402"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4632">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="min_latency" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4633">minimum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="max_latency" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4634">maximum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_max_errors"
- c:identifier="gst_video_decoder_set_max_errors">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4493">Sets numbers of tolerated decoder errors, where a tolerated one is then only
-warned about, but more than tolerated will lead to fatal error. You can set
--1 for never returning fatal errors. Default is set to
-GST_VIDEO_DECODER_MAX_ERRORS.
-
-The '-1' option was added in 1.4</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="381"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4495">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="num" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4496">max tolerated errors</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_needs_format"
- c:identifier="gst_video_decoder_set_needs_format"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4527">Configures decoder format needs. If enabled, subclass needs to be
-negotiated with format caps before it can process any data. It will then
-never be handed any data before it has been configured.
-Otherwise, it might be handed data without having been configured and
-is then expected being able to do so either by default
-or based on the input data.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="388"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4529">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4530">new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_needs_sync_point"
- c:identifier="gst_video_decoder_set_needs_sync_point"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4863">Configures whether the decoder requires a sync point before it starts
-outputting data in the beginning. If enabled, the base class will discard
-all non-sync point frames in the beginning and after a flush and does not
-pass it to the subclass.
-
-If the first frame is not a sync point, the base class will request a sync
-point via the force-key-unit event.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="395"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4865">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4866">new state</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_output_state"
- c:identifier="gst_video_decoder_set_output_state">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3775">Creates a new #GstVideoCodecState with the specified @fmt, @width and @height
-as the output state for the decoder.
-Any previously set output state on @decoder will be replaced by the newly
-created one.
-
-If the subclass wishes to copy over existing fields (like pixel aspec ratio,
-or framerate) from an existing #GstVideoCodecState, it can be provided as a
-@reference.
-
-If the subclass wishes to override some fields from the output state (like
-pixel-aspect-ratio or framerate) it can do so on the returned #GstVideoCodecState.
-
-The new output state will only take effect (set on pads and buffers) starting
-from the next call to #gst_video_decoder_finish_frame().</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="456"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3798">the newly configured output state.</doc>
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3777">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="fmt" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3778">a #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3779">The width in pixels</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3780">The height in pixels</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="reference"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="3781">An optional reference #GstVideoCodecState</doc>
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_packetized"
- c:identifier="gst_video_decoder_set_packetized">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4571">Allows baseclass to consider input data as packetized or not. If the
-input is packetized, then the @parse method will not be called.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="367"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4573">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="packetized" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4574">whether the input data should be considered as packetized.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_use_default_pad_acceptcaps"
- c:identifier="gst_video_decoder_set_use_default_pad_acceptcaps"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4766">Lets #GstVideoDecoder sub-classes decide if they want the sink pad
-to use the default pad query handler to reply to accept-caps queries.
-
-By setting this to true it is possible to further customize the default
-handler with %GST_PAD_SET_ACCEPT_INTERSECT and
-%GST_PAD_SET_ACCEPT_TEMPLATE</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="506"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4768">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </instance-parameter>
- <parameter name="use" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4769">if the default pad accept-caps query handling should be used</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <property name="discard-corrupted-frames"
- version="1.20"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="634">If set to %TRUE the decoder will discard frames that are marked as
-corrupted instead of outputting them.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="max-errors"
- version="1.18"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="600">Maximum number of tolerated consecutive decode errors. See
-gst_video_decoder_set_max_errors() for more details.</doc>
- <type name="gint" c:type="gint"/>
- </property>
- <property name="min-force-key-unit-interval"
- version="1.20"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="614">Minimum interval between force-key-unit events sent upstream by the
-decoder. Setting this to 0 will cause every event to be handled, setting
-this to %GST_CLOCK_TIME_NONE will cause every event to be ignored.
-
-See gst_video_event_new_upstream_force_key_unit() for more details about
-force-key-unit events.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="qos"
- version="1.18"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="585">If set to %TRUE the decoder will handle QoS events received
-from downstream elements.
-This includes dropping output frames which are detected as late
-using the metrics reported by those events.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="element" readable="0" private="1">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="sinkpad" readable="0" private="1">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="srcpad" readable="0" private="1">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="stream_lock" readable="0" private="1">
- <type name="GLib.RecMutex" c:type="GRecMutex"/>
- </field>
- <field name="input_segment" readable="0" private="1">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="output_segment" readable="0" private="1">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="VideoDecoderPrivate" c:type="GstVideoDecoderPrivate*"/>
- </field>
- <field name="padding" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="VideoDecoderClass"
- c:type="GstVideoDecoderClass"
- glib:is-gtype-struct-for="VideoDecoder">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="196">Subclasses can override any of the available virtual methods or not, as
-needed. At minimum @handle_frame needs to be overridden, and @set_format
-and likely as well. If non-packetized input is supported or expected,
-@parse needs to be overridden as well.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="342"/>
- <field name="element_class" readable="0" private="1">
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="open">
- <callback name="open">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="287"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="close">
- <callback name="close">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="289"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="start">
- <callback name="start">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="291"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="293"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="parse">
- <callback name="parse">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="295"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- <parameter name="adapter" transfer-ownership="none">
- <type name="GstBase.Adapter" c:type="GstAdapter*"/>
- </parameter>
- <parameter name="at_eos" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_format">
- <callback name="set_format">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="300"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- <parameter name="state" transfer-ownership="none">
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="reset">
- <callback name="reset">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="303"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- <parameter name="hard" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="finish">
- <callback name="finish">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="306"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="handle_frame">
- <callback name="handle_frame">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="308"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_event">
- <callback name="sink_event">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="311"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_event">
- <callback name="src_event">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="314"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="negotiate">
- <callback name="negotiate">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="317"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4238">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.c"
- line="4232">a #GstVideoDecoder</doc>
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="decide_allocation">
- <callback name="decide_allocation">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="319"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="propose_allocation">
- <callback name="propose_allocation">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="321"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="flush">
- <callback name="flush">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="323"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_query">
- <callback name="sink_query">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="325"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_query">
- <callback name="src_query">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="328"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="getcaps">
- <callback name="getcaps">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="331"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="drain">
- <callback name="drain">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="334"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="transform_meta">
- <callback name="transform_meta">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="336"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="decoder" transfer-ownership="none">
- <type name="VideoDecoder" c:type="GstVideoDecoder*"/>
- </parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- <parameter name="meta" transfer-ownership="none">
- <type name="Gst.Meta" c:type="GstMeta*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="padding" readable="0" private="1">
- <array zero-terminated="0" fixed-size="14">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="VideoDecoderPrivate"
- c:type="GstVideoDecoderPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="116"/>
- </record>
- <bitfield name="VideoDecoderRequestSyncPointFlags"
- version="1.20"
- c:type="GstVideoDecoderRequestSyncPointFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="344">Flags to be used in combination with gst_video_decoder_request_sync_point().
-See the function documentation for more details.</doc>
- <source-position filename="gst-libs/gst/video/gstvideodecoder.h"
- line="359"/>
- <member name="discard_input"
- value="1"
- c:identifier="GST_VIDEO_DECODER_REQUEST_SYNC_POINT_DISCARD_INPUT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="346">discard all following
- input until the next sync point.</doc>
- </member>
- <member name="corrupt_output"
- value="2"
- c:identifier="GST_VIDEO_DECODER_REQUEST_SYNC_POINT_CORRUPT_OUTPUT">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideodecoder.h"
- line="348">discard all following
- output until the next sync point.</doc>
- </member>
- </bitfield>
- <interface name="VideoDirection"
- c:symbol-prefix="video_direction"
- c:type="GstVideoDirection"
- version="1.10"
- glib:type-name="GstVideoDirection"
- glib:get-type="gst_video_direction_get_type"
- glib:type-struct="VideoDirectionInterface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videodirection.c"
- line="30">The interface allows unified access to control flipping and rotation
-operations of video-sources or operators.</doc>
- <source-position filename="gst-libs/gst/video/videodirection.h"
- line="58"/>
- <property name="video-direction"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <type name="VideoOrientationMethod"/>
- </property>
- </interface>
- <record name="VideoDirectionInterface"
- c:type="GstVideoDirectionInterface"
- glib:is-gtype-struct-for="VideoDirection"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videodirection.h"
- line="47">#GstVideoDirectionInterface interface.</doc>
- <source-position filename="gst-libs/gst/video/videodirection.h"
- line="58"/>
- <field name="iface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videodirection.h"
- line="49">parent interface type.</doc>
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- </record>
- <record name="VideoDither" c:type="GstVideoDither" disguised="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="28">GstVideoDither provides implementations of several dithering algorithms
-that can be applied to lines of video pixels to quantize and dither them.</doc>
- <source-position filename="gst-libs/gst/video/video-dither.h" line="60"/>
- <method name="free" c:identifier="gst_video_dither_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="461">Free @dither</doc>
- <source-position filename="gst-libs/gst/video/video-dither.h"
- line="73"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dither" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="463">a #GstVideoDither</doc>
- <type name="VideoDither" c:type="GstVideoDither*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="line" c:identifier="gst_video_dither_line">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="476">Dither @width pixels starting from offset @x in @line using @dither.
-
-@y is the line number of @line in the output image.</doc>
- <source-position filename="gst-libs/gst/video/video-dither.h"
- line="76"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="dither" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="478">a #GstVideoDither</doc>
- <type name="VideoDither" c:type="GstVideoDither*"/>
- </instance-parameter>
- <parameter name="line"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="479">pointer to the pixels of the line</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="480">x coordinate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="481">y coordinate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="482">the width</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <function name="new"
- c:identifier="gst_video_dither_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="357">Make a new dither object for dithering lines of @format using the
-algorithm described by @method.
-
-Each component will be quantized to a multiple of @quantizer. Better
-performance is achieved when @quantizer is a power of 2.
-
-@width is the width of the lines that this ditherer will handle.</doc>
- <source-position filename="gst-libs/gst/video/video-dither.h"
- line="66"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="373">a new #GstVideoDither</doc>
- <type name="VideoDither" c:type="GstVideoDither*"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="359">a #GstVideoDitherMethod</doc>
- <type name="VideoDitherMethod" c:type="GstVideoDitherMethod"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="360">a #GstVideoDitherFlags</doc>
- <type name="VideoDitherFlags" c:type="GstVideoDitherFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="361">a #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="quantizer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="362">quantizer</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="363">the width of the lines</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <bitfield name="VideoDitherFlags"
- glib:type-name="GstVideoDitherFlags"
- glib:get-type="gst_video_dither_flags_get_type"
- c:type="GstVideoDitherFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.h"
- line="46">Extra flags that influence the result from gst_video_chroma_resample_new().</doc>
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_DITHER_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.h"
- line="48">no flags</doc>
- </member>
- <member name="interlaced"
- value="1"
- c:identifier="GST_VIDEO_DITHER_FLAG_INTERLACED"
- glib:nick="interlaced">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.h"
- line="49">the input is interlaced</doc>
- </member>
- <member name="quantize"
- value="2"
- c:identifier="GST_VIDEO_DITHER_FLAG_QUANTIZE"
- glib:nick="quantize">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.h"
- line="50">quantize values in addition to adding dither.</doc>
- </member>
- </bitfield>
- <enumeration name="VideoDitherMethod"
- glib:type-name="GstVideoDitherMethod"
- glib:get-type="gst_video_dither_method_get_type"
- c:type="GstVideoDitherMethod">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.h"
- line="28">Different dithering methods to use.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_DITHER_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.h"
- line="30">no dithering</doc>
- </member>
- <member name="verterr"
- value="1"
- c:identifier="GST_VIDEO_DITHER_VERTERR"
- glib:nick="verterr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.h"
- line="31">propagate rounding errors downwards</doc>
- </member>
- <member name="floyd_steinberg"
- value="2"
- c:identifier="GST_VIDEO_DITHER_FLOYD_STEINBERG"
- glib:nick="floyd-steinberg">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.h"
- line="32">Dither with floyd-steinberg error diffusion</doc>
- </member>
- <member name="sierra_lite"
- value="3"
- c:identifier="GST_VIDEO_DITHER_SIERRA_LITE"
- glib:nick="sierra-lite">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.h"
- line="33">Dither with Sierra Lite error diffusion</doc>
- </member>
- <member name="bayer"
- value="4"
- c:identifier="GST_VIDEO_DITHER_BAYER"
- glib:nick="bayer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.h"
- line="34">ordered dither using a bayer pattern</doc>
- </member>
- </enumeration>
- <class name="VideoEncoder"
- c:symbol-prefix="video_encoder"
- c:type="GstVideoEncoder"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstVideoEncoder"
- glib:get-type="gst_video_encoder_get_type"
- glib:type-struct="VideoEncoderClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="25">This base class is for video encoders turning raw video into
-encoded video data.
-
-GstVideoEncoder and subclass should cooperate as follows.
-
-## Configuration
-
- * Initially, GstVideoEncoder calls @start when the encoder element
- is activated, which allows subclass to perform any global setup.
- * GstVideoEncoder calls @set_format to inform subclass of the format
- of input video data that it is about to receive. Subclass should
- setup for encoding and configure base class as appropriate
- (e.g. latency). While unlikely, it might be called more than once,
- if changing input parameters require reconfiguration. Baseclass
- will ensure that processing of current configuration is finished.
- * GstVideoEncoder calls @stop at end of all processing.
-
-## Data processing
-
- * Base class collects input data and metadata into a frame and hands
- this to subclass' @handle_frame.
-
- * If codec processing results in encoded data, subclass should call
- @gst_video_encoder_finish_frame to have encoded data pushed
- downstream.
-
- * If implemented, baseclass calls subclass @pre_push just prior to
- pushing to allow subclasses to modify some metadata on the buffer.
- If it returns GST_FLOW_OK, the buffer is pushed downstream.
-
- * GstVideoEncoderClass will handle both srcpad and sinkpad events.
- Sink events will be passed to subclass if @event callback has been
- provided.
-
-## Shutdown phase
-
- * GstVideoEncoder class calls @stop to inform the subclass that data
- parsing will be stopped.
-
-Subclass is responsible for providing pad template caps for
-source and sink pads. The pads need to be named "sink" and "src". It should
-also be able to provide fixed src pad caps in @getcaps by the time it calls
-@gst_video_encoder_finish_frame.
-
-Things that subclass need to take care of:
-
- * Provide pad templates
- * Provide source pad caps before pushing the first buffer
- * Accept data in @handle_frame and provide encoded results to
- @gst_video_encoder_finish_frame.
-
-
-The #GstVideoEncoder:qos property will enable the Quality-of-Service
-features of the encoder which gather statistics about the real-time
-performance of the downstream elements. If enabled, subclasses can
-use gst_video_encoder_get_max_encode_time() to check if input frames
-are already late and drop them right away to give a chance to the
-pipeline to catch up.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="300"/>
- <implements name="Gst.Preset"/>
- <virtual-method name="close">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="251"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="decide_allocation">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="282"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="finish">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="266"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="flush">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="286"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="getcaps">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="271"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="handle_frame">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="260"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="negotiate" invoker="negotiate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="1992">Negotiate with downstream elements to currently configured #GstVideoCodecState.
-Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
-negotiate fails.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="280"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2000">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="1994">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="open">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="249"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="pre_push">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="268"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="propose_allocation">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="284"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="reset">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="263"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="hard" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_format">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="257"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="state" transfer-ownership="none">
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_event">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="274"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_query">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="288"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_event">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="277"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_query">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="291"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="start">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="253"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="stop">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="255"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="transform_meta">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="294"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- <parameter name="meta" transfer-ownership="none">
- <type name="Gst.Meta" c:type="GstMeta*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="allocate_output_buffer"
- c:identifier="gst_video_encoder_allocate_output_buffer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2025">Helper function that allocates a buffer to hold an encoded video frame
-for @encoder's current #GstVideoCodecState.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="327"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2033">allocated buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2027">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2028">size of the buffer</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="allocate_output_frame"
- c:identifier="gst_video_encoder_allocate_output_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2076">Helper function that allocates a buffer to hold an encoded video frame for @encoder's
-current #GstVideoCodecState. Subclass should already have configured video
-state and set src pad caps.
-
-The buffer allocated here is owned by the frame and you should only
-keep references to the frame, not the buffer.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="331"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2089">%GST_FLOW_OK if an output buffer could be allocated</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2078">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2079">a #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2080">size of the buffer</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="finish_frame"
- c:identifier="gst_video_encoder_finish_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2475">@frame must have a valid encoded data buffer, whose metadata fields
-are then appropriately set according to frame data or no buffer at
-all if the frame should be dropped.
-It is subsequently pushed downstream or provided to @pre_push.
-In any case, the frame is considered finished and released.
-
-After calling this function the output buffer of the frame is to be
-considered read-only. This function will also change the metadata
-of the buffer.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="336"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2490">a #GstFlowReturn resulting from sending data downstream</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2477">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2478">an encoded #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </method>
- <method name="finish_subframe"
- c:identifier="gst_video_encoder_finish_subframe"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2627">If multiple subframes are produced for one input frame then use this method
-for each subframe, except for the last one. Before calling this function,
-you need to fill frame-&gt;output_buffer with the encoded buffer to push.
-
-You must call #gst_video_encoder_finish_frame() for the last sub-frame
-to tell the encoder that the frame has been fully encoded.
-
-This function will change the metadata of @frame and frame-&gt;output_buffer
-will be pushed downstream.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="340"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2642">a #GstFlowReturn resulting from pushing the buffer downstream.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2629">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2630">a #GstVideoCodecFrame being encoded</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_allocator"
- c:identifier="gst_video_encoder_get_allocator">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2996">Lets #GstVideoEncoder sub-classes to know the memory @allocator
-used by the base class and its @params.
-
-Unref the @allocator after use it.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="368"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2998">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="allocator"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2999">the #GstAllocator
-used</doc>
- <type name="Gst.Allocator" c:type="GstAllocator**"/>
- </parameter>
- <parameter name="params"
- direction="out"
- caller-allocates="1"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3001">the
-#GstAllocationParams of @allocator</doc>
- <type name="Gst.AllocationParams" c:type="GstAllocationParams*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_frame" c:identifier="gst_video_encoder_get_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2900">Get a pending unfinished #GstVideoCodecFrame</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="317"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2907">pending unfinished #GstVideoCodecFrame identified by @frame_number.</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2902">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="frame_number" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2903">system_frame_number of a frame</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_frames" c:identifier="gst_video_encoder_get_frames">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2931">Get all pending unfinished #GstVideoCodecFrame</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="324"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2937">pending unfinished #GstVideoCodecFrame.</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="VideoCodecFrame"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2933">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_latency" c:identifier="gst_video_encoder_get_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2856">Query the configured encoding latency. Results will be returned via
-@min_latency and @max_latency.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="354"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2858">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="min_latency"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2859">address of variable in which to store the
- configured minimum latency, or %NULL</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="max_latency"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2861">address of variable in which to store the
- configured maximum latency, or %NULL</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_max_encode_time"
- c:identifier="gst_video_encoder_get_max_encode_time"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3043">Determines maximum possible encoding time for @frame that will
-allow it to encode and arrive in time (as determined by QoS events).
-In particular, a negative result means encoding in time is no longer possible
-and should therefore occur as soon/skippy as possible.
-
-If no QoS events have been received from downstream, or if
-#GstVideoEncoder:qos is disabled this function returns #G_MAXINT64.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="382"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3056">max decoding time.</doc>
- <type name="Gst.ClockTimeDiff" c:type="GstClockTimeDiff"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3045">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3046">a #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_min_force_key_unit_interval"
- c:identifier="gst_video_encoder_get_min_force_key_unit_interval"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3147">Returns the minimum force-keyunit interval, see gst_video_encoder_set_min_force_key_unit_interval()
-for more details.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="388"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3154">the minimum force-keyunit interval</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3149">the encoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_oldest_frame"
- c:identifier="gst_video_encoder_get_oldest_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2879">Get the oldest unfinished pending #GstVideoCodecFrame</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="321"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2885">oldest unfinished pending #GstVideoCodecFrame</doc>
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2881">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_output_state"
- c:identifier="gst_video_encoder_get_output_state">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2753">Get the current #GstVideoCodecState</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="306"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2759">#GstVideoCodecState describing format of video data.</doc>
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2755">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_qos_enabled"
- c:identifier="gst_video_encoder_is_qos_enabled"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3103">Checks if @encoder is currently configured to handle Quality-of-Service
-events from downstream.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="379"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3110">%TRUE if the encoder is configured to perform Quality-of-Service.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3105">the encoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="merge_tags" c:identifier="gst_video_encoder_merge_tags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2953">Sets the video encoder tags and how they should be merged with any
-upstream stream tags. This will override any tags previously-set
-with gst_video_encoder_merge_tags().
-
-Note that this is provided for convenience, and the subclass is
-not required to use this and can still do tag handling on its own.
-
-MT safe.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="363"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2955">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="tags"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2956">a #GstTagList to merge, or NULL to unset
- previously-set tags</doc>
- <type name="Gst.TagList" c:type="const GstTagList*"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2958">the #GstTagMergeMode to use, usually #GST_TAG_MERGE_REPLACE</doc>
- <type name="Gst.TagMergeMode" c:type="GstTagMergeMode"/>
- </parameter>
- </parameters>
- </method>
- <method name="negotiate" c:identifier="gst_video_encoder_negotiate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="1992">Negotiate with downstream elements to currently configured #GstVideoCodecState.
-Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
-negotiate fails.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="314"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2000">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="1994">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="proxy_getcaps"
- c:identifier="gst_video_encoder_proxy_getcaps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="775">Returns caps that express @caps (or sink template caps if @caps == NULL)
-restricted to resolution/format/... combinations supported by downstream
-elements (e.g. muxers).</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="344"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="785">a #GstCaps owned by caller</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="enc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="777">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="caps"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="778">initial caps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="filter"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="779">filter caps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_headers" c:identifier="gst_video_encoder_set_headers">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="615">Set the codec headers to be sent downstream whenever requested.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="359"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="617">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="headers" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="618">a list of #GstBuffer containing the codec header</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="Gst.Buffer"/>
- </type>
- </parameter>
- </parameters>
- </method>
- <method name="set_latency" c:identifier="gst_video_encoder_set_latency">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2832">Informs baseclass of encoding latency.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="349"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2834">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="min_latency" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2835">minimum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="max_latency" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2836">maximum latency</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_min_force_key_unit_interval"
- c:identifier="gst_video_encoder_set_min_force_key_unit_interval"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3125">Sets the minimum interval for requesting keyframes based on force-keyunit
-events. Setting this to 0 will allow to handle every event, setting this to
-%GST_CLOCK_TIME_NONE causes force-keyunit events to be ignored.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="385"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3127">the encoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="interval" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3128">minimum interval</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_min_pts"
- c:identifier="gst_video_encoder_set_min_pts"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3023">Request minimal value for PTS passed to handle_frame.
-
-For streams with reordered frames this can be used to ensure that there
-is enough time to accommodate first DTS, which may be less than first PTS</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="373"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3025">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="min_pts" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3026">minimal PTS that will be passed to handle_frame</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_output_state"
- c:identifier="gst_video_encoder_set_output_state">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2773">Creates a new #GstVideoCodecState with the specified caps as the output state
-for the encoder.
-Any previously set output state on @encoder will be replaced by the newly
-created one.
-
-The specified @caps should not contain any resolution, pixel-aspect-ratio,
-framerate, codec-data, .... Those should be specified instead in the returned
-#GstVideoCodecState.
-
-If the subclass wishes to copy over existing fields (like pixel aspect ratio,
-or framerate) from an existing #GstVideoCodecState, it can be provided as a
-@reference.
-
-If the subclass wishes to override some fields from the output state (like
-pixel-aspect-ratio or framerate) it can do so on the returned #GstVideoCodecState.
-
-The new output state will only take effect (set on pads and buffers) starting
-from the next call to #gst_video_encoder_finish_frame().</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="309"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2798">the newly configured output state.</doc>
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2775">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2776">the #GstCaps to use for the output</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="reference"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2777">An optional reference @GstVideoCodecState</doc>
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_qos_enabled"
- c:identifier="gst_video_encoder_set_qos_enabled"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3087">Configures @encoder to handle Quality-of-Service events from downstream.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="376"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3089">the encoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </instance-parameter>
- <parameter name="enabled" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="3090">the new qos value.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <property name="min-force-key-unit-interval"
- version="1.18"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="410">Minimum interval between force-keyunit requests in nanoseconds. See
-gst_video_encoder_set_min_force_key_unit_interval() for more details.</doc>
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="qos" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="element" readable="0" private="1">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="sinkpad" readable="0" private="1">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="srcpad" readable="0" private="1">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="stream_lock" readable="0" private="1">
- <type name="GLib.RecMutex" c:type="GRecMutex"/>
- </field>
- <field name="input_segment" readable="0" private="1">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="output_segment" readable="0" private="1">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="VideoEncoderPrivate" c:type="GstVideoEncoderPrivate*"/>
- </field>
- <field name="padding" readable="0" private="1">
- <array zero-terminated="0" fixed-size="20">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="VideoEncoderClass"
- c:type="GstVideoEncoderClass"
- glib:is-gtype-struct-for="VideoEncoder">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.h"
- line="159">Subclasses can override any of the available virtual methods or not, as
-needed. At minimum @handle_frame needs to be overridden, and @set_format
-and @get_caps are likely needed as well.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="300"/>
- <field name="element_class" readable="0" private="1">
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="open">
- <callback name="open">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="249"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="close">
- <callback name="close">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="251"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="start">
- <callback name="start">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="253"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="stop">
- <callback name="stop">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="255"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_format">
- <callback name="set_format">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="257"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- <parameter name="state" transfer-ownership="none">
- <type name="VideoCodecState" c:type="GstVideoCodecState*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="handle_frame">
- <callback name="handle_frame">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="260"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="reset">
- <callback name="reset">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="263"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- <parameter name="hard" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="finish">
- <callback name="finish">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="266"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="pre_push">
- <callback name="pre_push">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="268"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="getcaps">
- <callback name="getcaps">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="271"/>
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="enc" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_event">
- <callback name="sink_event">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="274"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_event">
- <callback name="src_event">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="277"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="negotiate">
- <callback name="negotiate">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="280"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="2000">%TRUE if the negotiation succeeded, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoencoder.c"
- line="1994">a #GstVideoEncoder</doc>
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="decide_allocation">
- <callback name="decide_allocation">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="282"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="propose_allocation">
- <callback name="propose_allocation">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="284"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="flush">
- <callback name="flush">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="286"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_query">
- <callback name="sink_query">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="288"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_query">
- <callback name="src_query">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="291"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="transform_meta">
- <callback name="transform_meta">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="294"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="encoder" transfer-ownership="none">
- <type name="VideoEncoder" c:type="GstVideoEncoder*"/>
- </parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
- </parameter>
- <parameter name="meta" transfer-ownership="none">
- <type name="Gst.Meta" c:type="GstMeta*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="16">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="VideoEncoderPrivate"
- c:type="GstVideoEncoderPrivate"
- disguised="1">
- <source-position filename="gst-libs/gst/video/gstvideoencoder.h"
- line="127"/>
- </record>
- <enumeration name="VideoFieldOrder"
- version="1.12"
- glib:type-name="GstVideoFieldOrder"
- glib:get-type="gst_video_field_order_get_type"
- c:type="GstVideoFieldOrder">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="260">Field order of interlaced content. This is only valid for
-interlace-mode=interleaved and not interlace-mode=mixed. In the case of
-mixed or GST_VIDEO_FIELD_ORDER_UNKOWN, the field order is signalled via
-buffer flags.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_VIDEO_FIELD_ORDER_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="262">unknown field order for interlaced content.
- The actual field order is signalled via buffer flags.</doc>
- </member>
- <member name="top_field_first"
- value="1"
- c:identifier="GST_VIDEO_FIELD_ORDER_TOP_FIELD_FIRST"
- glib:nick="top-field-first">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="264">top field is first</doc>
- </member>
- <member name="bottom_field_first"
- value="2"
- c:identifier="GST_VIDEO_FIELD_ORDER_BOTTOM_FIELD_FIRST"
- glib:nick="bottom-field-first">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="265">bottom field is first</doc>
- </member>
- <function name="from_string"
- c:identifier="gst_video_field_order_from_string"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="363">Convert @order to a #GstVideoFieldOrder</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="284"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="369">the #GstVideoFieldOrder of @order or
- #GST_VIDEO_FIELD_ORDER_UNKNOWN when @order is not a valid
- string representation for a #GstVideoFieldOrder.</doc>
- <type name="VideoFieldOrder" c:type="GstVideoFieldOrder"/>
- </return-value>
- <parameters>
- <parameter name="order" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="365">a field order</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_string"
- c:identifier="gst_video_field_order_to_string"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="344">Convert @order to its string representation.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="281"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="350">@order as a string or NULL if @order in invalid.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="order" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="346">a #GstVideoFieldOrder</doc>
- <type name="VideoFieldOrder" c:type="GstVideoFieldOrder"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <class name="VideoFilter"
- c:symbol-prefix="video_filter"
- c:type="GstVideoFilter"
- parent="GstBase.BaseTransform"
- abstract="1"
- glib:type-name="GstVideoFilter"
- glib:get-type="gst_video_filter_get_type"
- glib:type-struct="VideoFilterClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideofilter.c"
- line="21">Provides useful functions and a base class for video filters.
-
-The videofilter will by default enable QoS on the parent GstBaseTransform
-to implement frame dropping.</doc>
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="80"/>
- <virtual-method name="set_info">
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="69"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <type name="VideoFilter" c:type="GstVideoFilter*"/>
- </instance-parameter>
- <parameter name="incaps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="in_info" transfer-ownership="none">
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="outcaps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="out_info" transfer-ownership="none">
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="transform_frame">
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="74"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <type name="VideoFilter" c:type="GstVideoFilter*"/>
- </instance-parameter>
- <parameter name="inframe" transfer-ownership="none">
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- <parameter name="outframe" transfer-ownership="none">
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="transform_frame_ip">
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="76"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="trans" transfer-ownership="none">
- <type name="VideoFilter" c:type="GstVideoFilter*"/>
- </instance-parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <field name="element">
- <type name="GstBase.BaseTransform" c:type="GstBaseTransform"/>
- </field>
- <field name="negotiated">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="in_info">
- <type name="VideoInfo" c:type="GstVideoInfo"/>
- </field>
- <field name="out_info">
- <type name="VideoInfo" c:type="GstVideoInfo"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="VideoFilterClass"
- c:type="GstVideoFilterClass"
- glib:is-gtype-struct-for="VideoFilter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideofilter.h"
- line="57">The video filter class structure.</doc>
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="80"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideofilter.h"
- line="59">the parent class structure</doc>
- <type name="GstBase.BaseTransformClass"
- c:type="GstBaseTransformClass"/>
- </field>
- <field name="set_info">
- <callback name="set_info">
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="69"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="filter" transfer-ownership="none">
- <type name="VideoFilter" c:type="GstVideoFilter*"/>
- </parameter>
- <parameter name="incaps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="in_info" transfer-ownership="none">
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="outcaps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- <parameter name="out_info" transfer-ownership="none">
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="transform_frame">
- <callback name="transform_frame">
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="74"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="filter" transfer-ownership="none">
- <type name="VideoFilter" c:type="GstVideoFilter*"/>
- </parameter>
- <parameter name="inframe" transfer-ownership="none">
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- <parameter name="outframe" transfer-ownership="none">
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="transform_frame_ip">
- <callback name="transform_frame_ip">
- <source-position filename="gst-libs/gst/video/gstvideofilter.h"
- line="76"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="trans" transfer-ownership="none">
- <type name="VideoFilter" c:type="GstVideoFilter*"/>
- </parameter>
- <parameter name="frame" transfer-ownership="none">
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <bitfield name="VideoFlags"
- glib:type-name="GstVideoFlags"
- glib:get-type="gst_video_flags_get_type"
- c:type="GstVideoFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="244">Extra video flags</doc>
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="246">no flags</doc>
- </member>
- <member name="variable_fps"
- value="1"
- c:identifier="GST_VIDEO_FLAG_VARIABLE_FPS"
- glib:nick="variable-fps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="247">a variable fps is selected, fps_n and fps_d
- denote the maximum fps of the video</doc>
- </member>
- <member name="premultiplied_alpha"
- value="2"
- c:identifier="GST_VIDEO_FLAG_PREMULTIPLIED_ALPHA"
- glib:nick="premultiplied-alpha">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="249">Each color has been scaled by the alpha
- value.</doc>
- </member>
- </bitfield>
- <enumeration name="VideoFormat"
- glib:type-name="GstVideoFormat"
- glib:get-type="gst_video_format_get_type"
- c:type="GstVideoFormat">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="30">Enum value describing the most common video formats.
-
-See the [GStreamer raw video format design document](https://gstreamer.freedesktop.org/documentation/additional/design/mediatype-video-raw.html#formats)
-for details about the layout and packing of these formats in memory.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_VIDEO_FORMAT_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="32">Unknown or unset video format id</doc>
- </member>
- <member name="encoded"
- value="1"
- c:identifier="GST_VIDEO_FORMAT_ENCODED"
- glib:nick="encoded">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="33">Encoded video format. Only ever use that in caps for
- special video formats in combination with non-system
- memory GstCapsFeatures where it does not make sense
- to specify a real video format.</doc>
- </member>
- <member name="i420"
- value="2"
- c:identifier="GST_VIDEO_FORMAT_I420"
- glib:nick="i420">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="37">planar 4:2:0 YUV</doc>
- </member>
- <member name="yv12"
- value="3"
- c:identifier="GST_VIDEO_FORMAT_YV12"
- glib:nick="yv12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="38">planar 4:2:0 YVU (like I420 but UV planes swapped)</doc>
- </member>
- <member name="yuy2"
- value="4"
- c:identifier="GST_VIDEO_FORMAT_YUY2"
- glib:nick="yuy2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="39">packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...)</doc>
- </member>
- <member name="uyvy"
- value="5"
- c:identifier="GST_VIDEO_FORMAT_UYVY"
- glib:nick="uyvy">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="40">packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)</doc>
- </member>
- <member name="ayuv"
- value="6"
- c:identifier="GST_VIDEO_FORMAT_AYUV"
- glib:nick="ayuv">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="42">packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...)</doc>
- </member>
- <member name="rgbx"
- value="7"
- c:identifier="GST_VIDEO_FORMAT_RGBx"
- glib:nick="rgbx">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="43">sparse rgb packed into 32 bit, space last</doc>
- </member>
- <member name="bgrx"
- value="8"
- c:identifier="GST_VIDEO_FORMAT_BGRx"
- glib:nick="bgrx">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="44">sparse reverse rgb packed into 32 bit, space last</doc>
- </member>
- <member name="xrgb"
- value="9"
- c:identifier="GST_VIDEO_FORMAT_xRGB"
- glib:nick="xrgb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="45">sparse rgb packed into 32 bit, space first</doc>
- </member>
- <member name="xbgr"
- value="10"
- c:identifier="GST_VIDEO_FORMAT_xBGR"
- glib:nick="xbgr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="46">sparse reverse rgb packed into 32 bit, space first</doc>
- </member>
- <member name="rgba"
- value="11"
- c:identifier="GST_VIDEO_FORMAT_RGBA"
- glib:nick="rgba">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="47">rgb with alpha channel last</doc>
- </member>
- <member name="bgra"
- value="12"
- c:identifier="GST_VIDEO_FORMAT_BGRA"
- glib:nick="bgra">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="48">reverse rgb with alpha channel last</doc>
- </member>
- <member name="argb"
- value="13"
- c:identifier="GST_VIDEO_FORMAT_ARGB"
- glib:nick="argb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="49">rgb with alpha channel first</doc>
- </member>
- <member name="abgr"
- value="14"
- c:identifier="GST_VIDEO_FORMAT_ABGR"
- glib:nick="abgr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="50">reverse rgb with alpha channel first</doc>
- </member>
- <member name="rgb"
- value="15"
- c:identifier="GST_VIDEO_FORMAT_RGB"
- glib:nick="rgb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="51">RGB packed into 24 bits without padding (`R-G-B-R-G-B`)</doc>
- </member>
- <member name="bgr"
- value="16"
- c:identifier="GST_VIDEO_FORMAT_BGR"
- glib:nick="bgr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="52">reverse RGB packed into 24 bits without padding (`B-G-R-B-G-R`)</doc>
- </member>
- <member name="y41b"
- value="17"
- c:identifier="GST_VIDEO_FORMAT_Y41B"
- glib:nick="y41b">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="53">planar 4:1:1 YUV</doc>
- </member>
- <member name="y42b"
- value="18"
- c:identifier="GST_VIDEO_FORMAT_Y42B"
- glib:nick="y42b">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="54">planar 4:2:2 YUV</doc>
- </member>
- <member name="yvyu"
- value="19"
- c:identifier="GST_VIDEO_FORMAT_YVYU"
- glib:nick="yvyu">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="55">packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...)</doc>
- </member>
- <member name="y444"
- value="20"
- c:identifier="GST_VIDEO_FORMAT_Y444"
- glib:nick="y444">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="56">planar 4:4:4 YUV</doc>
- </member>
- <member name="v210"
- value="21"
- c:identifier="GST_VIDEO_FORMAT_v210"
- glib:nick="v210">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="57">packed 4:2:2 10-bit YUV, complex format</doc>
- </member>
- <member name="v216"
- value="22"
- c:identifier="GST_VIDEO_FORMAT_v216"
- glib:nick="v216">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="58">packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order</doc>
- </member>
- <member name="nv12"
- value="23"
- c:identifier="GST_VIDEO_FORMAT_NV12"
- glib:nick="nv12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="59">planar 4:2:0 YUV with interleaved UV plane</doc>
- </member>
- <member name="nv21"
- value="24"
- c:identifier="GST_VIDEO_FORMAT_NV21"
- glib:nick="nv21">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="60">planar 4:2:0 YUV with interleaved VU plane</doc>
- </member>
- <member name="gray8"
- value="25"
- c:identifier="GST_VIDEO_FORMAT_GRAY8"
- glib:nick="gray8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="62">8-bit grayscale</doc>
- </member>
- <member name="gray16_be"
- value="26"
- c:identifier="GST_VIDEO_FORMAT_GRAY16_BE"
- glib:nick="gray16-be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="64">16-bit grayscale, most significant byte first</doc>
- </member>
- <member name="gray16_le"
- value="27"
- c:identifier="GST_VIDEO_FORMAT_GRAY16_LE"
- glib:nick="gray16-le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="65">16-bit grayscale, least significant byte first</doc>
- </member>
- <member name="v308"
- value="28"
- c:identifier="GST_VIDEO_FORMAT_v308"
- glib:nick="v308">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="66">packed 4:4:4 YUV (Y-U-V ...)</doc>
- </member>
- <member name="rgb16"
- value="29"
- c:identifier="GST_VIDEO_FORMAT_RGB16"
- glib:nick="rgb16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="68">rgb 5-6-5 bits per component</doc>
- </member>
- <member name="bgr16"
- value="30"
- c:identifier="GST_VIDEO_FORMAT_BGR16"
- glib:nick="bgr16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="69">reverse rgb 5-6-5 bits per component</doc>
- </member>
- <member name="rgb15"
- value="31"
- c:identifier="GST_VIDEO_FORMAT_RGB15"
- glib:nick="rgb15">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="70">rgb 5-5-5 bits per component</doc>
- </member>
- <member name="bgr15"
- value="32"
- c:identifier="GST_VIDEO_FORMAT_BGR15"
- glib:nick="bgr15">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="71">reverse rgb 5-5-5 bits per component</doc>
- </member>
- <member name="uyvp"
- value="33"
- c:identifier="GST_VIDEO_FORMAT_UYVP"
- glib:nick="uyvp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="72">packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)</doc>
- </member>
- <member name="a420"
- value="34"
- c:identifier="GST_VIDEO_FORMAT_A420"
- glib:nick="a420">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="73">planar 4:4:2:0 AYUV</doc>
- </member>
- <member name="rgb8p"
- value="35"
- c:identifier="GST_VIDEO_FORMAT_RGB8P"
- glib:nick="rgb8p">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="74">8-bit paletted RGB</doc>
- </member>
- <member name="yuv9"
- value="36"
- c:identifier="GST_VIDEO_FORMAT_YUV9"
- glib:nick="yuv9">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="75">planar 4:1:0 YUV</doc>
- </member>
- <member name="yvu9"
- value="37"
- c:identifier="GST_VIDEO_FORMAT_YVU9"
- glib:nick="yvu9">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="76">planar 4:1:0 YUV (like YUV9 but UV planes swapped)</doc>
- </member>
- <member name="iyu1"
- value="38"
- c:identifier="GST_VIDEO_FORMAT_IYU1"
- glib:nick="iyu1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="77">packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...)</doc>
- </member>
- <member name="argb64"
- value="39"
- c:identifier="GST_VIDEO_FORMAT_ARGB64"
- glib:nick="argb64">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="78">rgb with alpha channel first, 16 bits per channel</doc>
- </member>
- <member name="ayuv64"
- value="40"
- c:identifier="GST_VIDEO_FORMAT_AYUV64"
- glib:nick="ayuv64">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="79">packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...)</doc>
- </member>
- <member name="r210"
- value="41"
- c:identifier="GST_VIDEO_FORMAT_r210"
- glib:nick="r210">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="80">packed 4:4:4 RGB, 10 bits per channel</doc>
- </member>
- <member name="i420_10be"
- value="42"
- c:identifier="GST_VIDEO_FORMAT_I420_10BE"
- glib:nick="i420-10be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="81">planar 4:2:0 YUV, 10 bits per channel</doc>
- </member>
- <member name="i420_10le"
- value="43"
- c:identifier="GST_VIDEO_FORMAT_I420_10LE"
- glib:nick="i420-10le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="82">planar 4:2:0 YUV, 10 bits per channel</doc>
- </member>
- <member name="i422_10be"
- value="44"
- c:identifier="GST_VIDEO_FORMAT_I422_10BE"
- glib:nick="i422-10be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="83">planar 4:2:2 YUV, 10 bits per channel</doc>
- </member>
- <member name="i422_10le"
- value="45"
- c:identifier="GST_VIDEO_FORMAT_I422_10LE"
- glib:nick="i422-10le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="84">planar 4:2:2 YUV, 10 bits per channel</doc>
- </member>
- <member name="y444_10be"
- value="46"
- c:identifier="GST_VIDEO_FORMAT_Y444_10BE"
- glib:nick="y444-10be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="85">planar 4:4:4 YUV, 10 bits per channel (Since: 1.2)</doc>
- </member>
- <member name="y444_10le"
- value="47"
- c:identifier="GST_VIDEO_FORMAT_Y444_10LE"
- glib:nick="y444-10le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="86">planar 4:4:4 YUV, 10 bits per channel (Since: 1.2)</doc>
- </member>
- <member name="gbr"
- value="48"
- c:identifier="GST_VIDEO_FORMAT_GBR"
- glib:nick="gbr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="87">planar 4:4:4 RGB, 8 bits per channel (Since: 1.2)</doc>
- </member>
- <member name="gbr_10be"
- value="49"
- c:identifier="GST_VIDEO_FORMAT_GBR_10BE"
- glib:nick="gbr-10be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="88">planar 4:4:4 RGB, 10 bits per channel (Since: 1.2)</doc>
- </member>
- <member name="gbr_10le"
- value="50"
- c:identifier="GST_VIDEO_FORMAT_GBR_10LE"
- glib:nick="gbr-10le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="89">planar 4:4:4 RGB, 10 bits per channel (Since: 1.2)</doc>
- </member>
- <member name="nv16"
- value="51"
- c:identifier="GST_VIDEO_FORMAT_NV16"
- glib:nick="nv16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="90">planar 4:2:2 YUV with interleaved UV plane (Since: 1.2)</doc>
- </member>
- <member name="nv24"
- value="52"
- c:identifier="GST_VIDEO_FORMAT_NV24"
- glib:nick="nv24">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="92">planar 4:4:4 YUV with interleaved UV plane (Since: 1.2)</doc>
- </member>
- <member name="nv12_64z32"
- value="53"
- c:identifier="GST_VIDEO_FORMAT_NV12_64Z32"
- glib:nick="nv12-64z32">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="93">NV12 with 64x32 tiling in zigzag pattern (Since: 1.4)</doc>
- </member>
- <member name="a420_10be"
- value="54"
- c:identifier="GST_VIDEO_FORMAT_A420_10BE"
- glib:nick="a420-10be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="94">planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6)</doc>
- </member>
- <member name="a420_10le"
- value="55"
- c:identifier="GST_VIDEO_FORMAT_A420_10LE"
- glib:nick="a420-10le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="95">planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6)</doc>
- </member>
- <member name="a422_10be"
- value="56"
- c:identifier="GST_VIDEO_FORMAT_A422_10BE"
- glib:nick="a422-10be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="96">planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6)</doc>
- </member>
- <member name="a422_10le"
- value="57"
- c:identifier="GST_VIDEO_FORMAT_A422_10LE"
- glib:nick="a422-10le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="97">planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6)</doc>
- </member>
- <member name="a444_10be"
- value="58"
- c:identifier="GST_VIDEO_FORMAT_A444_10BE"
- glib:nick="a444-10be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="98">planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6)</doc>
- </member>
- <member name="a444_10le"
- value="59"
- c:identifier="GST_VIDEO_FORMAT_A444_10LE"
- glib:nick="a444-10le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="99">planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6)</doc>
- </member>
- <member name="nv61"
- value="60"
- c:identifier="GST_VIDEO_FORMAT_NV61"
- glib:nick="nv61">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="100">planar 4:2:2 YUV with interleaved VU plane (Since: 1.6)</doc>
- </member>
- <member name="p010_10be"
- value="61"
- c:identifier="GST_VIDEO_FORMAT_P010_10BE"
- glib:nick="p010-10be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="101">planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10)</doc>
- </member>
- <member name="p010_10le"
- value="62"
- c:identifier="GST_VIDEO_FORMAT_P010_10LE"
- glib:nick="p010-10le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="102">planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10)</doc>
- </member>
- <member name="iyu2"
- value="63"
- c:identifier="GST_VIDEO_FORMAT_IYU2"
- glib:nick="iyu2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="67">packed 4:4:4 YUV (U-Y-V ...) (Since: 1.10)</doc>
- </member>
- <member name="vyuy"
- value="64"
- c:identifier="GST_VIDEO_FORMAT_VYUY"
- glib:nick="vyuy">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="41">packed 4:2:2 YUV (V0-Y0-U0-Y1 V2-Y2-U2-Y3 V4 ...)</doc>
- </member>
- <member name="gbra"
- value="65"
- c:identifier="GST_VIDEO_FORMAT_GBRA"
- glib:nick="gbra">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="103">planar 4:4:4:4 ARGB, 8 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="gbra_10be"
- value="66"
- c:identifier="GST_VIDEO_FORMAT_GBRA_10BE"
- glib:nick="gbra-10be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="104">planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="gbra_10le"
- value="67"
- c:identifier="GST_VIDEO_FORMAT_GBRA_10LE"
- glib:nick="gbra-10le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="105">planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="gbr_12be"
- value="68"
- c:identifier="GST_VIDEO_FORMAT_GBR_12BE"
- glib:nick="gbr-12be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="106">planar 4:4:4 RGB, 12 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="gbr_12le"
- value="69"
- c:identifier="GST_VIDEO_FORMAT_GBR_12LE"
- glib:nick="gbr-12le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="107">planar 4:4:4 RGB, 12 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="gbra_12be"
- value="70"
- c:identifier="GST_VIDEO_FORMAT_GBRA_12BE"
- glib:nick="gbra-12be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="108">planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="gbra_12le"
- value="71"
- c:identifier="GST_VIDEO_FORMAT_GBRA_12LE"
- glib:nick="gbra-12le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="109">planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="i420_12be"
- value="72"
- c:identifier="GST_VIDEO_FORMAT_I420_12BE"
- glib:nick="i420-12be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="110">planar 4:2:0 YUV, 12 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="i420_12le"
- value="73"
- c:identifier="GST_VIDEO_FORMAT_I420_12LE"
- glib:nick="i420-12le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="111">planar 4:2:0 YUV, 12 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="i422_12be"
- value="74"
- c:identifier="GST_VIDEO_FORMAT_I422_12BE"
- glib:nick="i422-12be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="112">planar 4:2:2 YUV, 12 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="i422_12le"
- value="75"
- c:identifier="GST_VIDEO_FORMAT_I422_12LE"
- glib:nick="i422-12le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="113">planar 4:2:2 YUV, 12 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="y444_12be"
- value="76"
- c:identifier="GST_VIDEO_FORMAT_Y444_12BE"
- glib:nick="y444-12be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="114">planar 4:4:4 YUV, 12 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="y444_12le"
- value="77"
- c:identifier="GST_VIDEO_FORMAT_Y444_12LE"
- glib:nick="y444-12le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="115">planar 4:4:4 YUV, 12 bits per channel (Since: 1.12)</doc>
- </member>
- <member name="gray10_le32"
- value="78"
- c:identifier="GST_VIDEO_FORMAT_GRAY10_LE32"
- glib:nick="gray10-le32">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="63">10-bit grayscale, packed into 32bit words (2 bits padding) (Since: 1.14)</doc>
- </member>
- <member name="nv12_10le32"
- value="79"
- c:identifier="GST_VIDEO_FORMAT_NV12_10LE32"
- glib:nick="nv12-10le32">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="61">10-bit variant of @GST_VIDEO_FORMAT_NV12, packed into 32bit words (MSB 2 bits padding) (Since: 1.14)</doc>
- </member>
- <member name="nv16_10le32"
- value="80"
- c:identifier="GST_VIDEO_FORMAT_NV16_10LE32"
- glib:nick="nv16-10le32">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="91">10-bit variant of @GST_VIDEO_FORMAT_NV16, packed into 32bit words (MSB 2 bits padding) (Since: 1.14)</doc>
- </member>
- <member name="nv12_10le40"
- value="81"
- c:identifier="GST_VIDEO_FORMAT_NV12_10LE40"
- glib:nick="nv12-10le40">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="116">Fully packed variant of NV12_10LE32 (Since: 1.16)</doc>
- </member>
- <member name="y210"
- value="82"
- c:identifier="GST_VIDEO_FORMAT_Y210"
- glib:nick="y210">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="117">packed 4:2:2 YUV, 10 bits per channel (Since: 1.16)</doc>
- </member>
- <member name="y410"
- value="83"
- c:identifier="GST_VIDEO_FORMAT_Y410"
- glib:nick="y410">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="118">packed 4:4:4 YUV, 10 bits per channel(A-V-Y-U...) (Since: 1.16)</doc>
- </member>
- <member name="vuya"
- value="84"
- c:identifier="GST_VIDEO_FORMAT_VUYA"
- glib:nick="vuya">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="119">packed 4:4:4 YUV with alpha channel (V0-U0-Y0-A0...) (Since: 1.16)</doc>
- </member>
- <member name="bgr10a2_le"
- value="85"
- c:identifier="GST_VIDEO_FORMAT_BGR10A2_LE"
- glib:nick="bgr10a2-le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="120">packed 4:4:4 RGB with alpha channel(B-G-R-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.16)</doc>
- </member>
- <member name="rgb10a2_le"
- value="86"
- c:identifier="GST_VIDEO_FORMAT_RGB10A2_LE"
- glib:nick="rgb10a2-le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="121">packed 4:4:4 RGB with alpha channel(R-G-B-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.18)</doc>
- </member>
- <member name="y444_16be"
- value="87"
- c:identifier="GST_VIDEO_FORMAT_Y444_16BE"
- glib:nick="y444-16be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="122">planar 4:4:4 YUV, 16 bits per channel (Since: 1.18)</doc>
- </member>
- <member name="y444_16le"
- value="88"
- c:identifier="GST_VIDEO_FORMAT_Y444_16LE"
- glib:nick="y444-16le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="123">planar 4:4:4 YUV, 16 bits per channel (Since: 1.18)</doc>
- </member>
- <member name="p016_be"
- value="89"
- c:identifier="GST_VIDEO_FORMAT_P016_BE"
- glib:nick="p016-be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="124">planar 4:2:0 YUV with interleaved UV plane, 16 bits per channel (Since: 1.18)</doc>
- </member>
- <member name="p016_le"
- value="90"
- c:identifier="GST_VIDEO_FORMAT_P016_LE"
- glib:nick="p016-le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="125">planar 4:2:0 YUV with interleaved UV plane, 16 bits per channel (Since: 1.18)</doc>
- </member>
- <member name="p012_be"
- value="91"
- c:identifier="GST_VIDEO_FORMAT_P012_BE"
- glib:nick="p012-be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="126">planar 4:2:0 YUV with interleaved UV plane, 12 bits per channel (Since: 1.18)</doc>
- </member>
- <member name="p012_le"
- value="92"
- c:identifier="GST_VIDEO_FORMAT_P012_LE"
- glib:nick="p012-le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="127">planar 4:2:0 YUV with interleaved UV plane, 12 bits per channel (Since: 1.18)</doc>
- </member>
- <member name="y212_be"
- value="93"
- c:identifier="GST_VIDEO_FORMAT_Y212_BE"
- glib:nick="y212-be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="128">packed 4:2:2 YUV, 12 bits per channel (Y-U-Y-V) (Since: 1.18)</doc>
- </member>
- <member name="y212_le"
- value="94"
- c:identifier="GST_VIDEO_FORMAT_Y212_LE"
- glib:nick="y212-le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="129">packed 4:2:2 YUV, 12 bits per channel (Y-U-Y-V) (Since: 1.18)</doc>
- </member>
- <member name="y412_be"
- value="95"
- c:identifier="GST_VIDEO_FORMAT_Y412_BE"
- glib:nick="y412-be">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="130">packed 4:4:4:4 YUV, 12 bits per channel(U-Y-V-A...) (Since: 1.18)</doc>
- </member>
- <member name="y412_le"
- value="96"
- c:identifier="GST_VIDEO_FORMAT_Y412_LE"
- glib:nick="y412-le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="131">packed 4:4:4:4 YUV, 12 bits per channel(U-Y-V-A...) (Since: 1.18)</doc>
- </member>
- <member name="nv12_4l4"
- value="97"
- c:identifier="GST_VIDEO_FORMAT_NV12_4L4"
- version="1.18"
- glib:nick="nv12-4l4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="238">NV12 with 4x4 tiles in linear order.</doc>
- </member>
- <member name="nv12_32l32"
- value="98"
- c:identifier="GST_VIDEO_FORMAT_NV12_32L32"
- version="1.18"
- glib:nick="nv12-32l32">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="246">NV12 with 32x32 tiles in linear order.</doc>
- </member>
- <function name="from_fourcc" c:identifier="gst_video_format_from_fourcc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6815">Converts a FOURCC value into the corresponding #GstVideoFormat.
-If the FOURCC cannot be represented by #GstVideoFormat,
-#GST_VIDEO_FORMAT_UNKNOWN is returned.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="571"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6823">the #GstVideoFormat describing the FOURCC value</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </return-value>
- <parameters>
- <parameter name="fourcc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6817">a FOURCC value representing raw YUV video</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </function>
- <function name="from_masks" c:identifier="gst_video_format_from_masks">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6741">Find the #GstVideoFormat for the given parameters.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="566"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6754">a #GstVideoFormat or GST_VIDEO_FORMAT_UNKNOWN when the parameters to
-not specify a known format.</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </return-value>
- <parameters>
- <parameter name="depth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6743">the amount of bits used for a pixel</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="bpp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6744">the amount of bits used to store a pixel. This value is bigger than
- @depth</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="endianness" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6746">the endianness of the masks, #G_LITTLE_ENDIAN or #G_BIG_ENDIAN</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="red_mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6747">the red mask</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="green_mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6748">the green mask</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="blue_mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6749">the blue mask</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="alpha_mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6750">the alpha mask, or 0 if no alpha mask</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="from_string" c:identifier="gst_video_format_from_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6907">Convert the @format string to its #GstVideoFormat.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="574"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6913">the #GstVideoFormat for @format or GST_VIDEO_FORMAT_UNKNOWN when the
-string is not a known format.</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6909">a format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_info" c:identifier="gst_video_format_get_info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6972">Get the #GstVideoFormatInfo for @format</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="584"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6978">The #GstVideoFormatInfo for @format.</doc>
- <type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6974">a #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_palette"
- c:identifier="gst_video_format_get_palette"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6988">Get the default palette of @format. This the palette used in the pack
-function for paletted formats.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="587"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6996">the default palette of @format or %NULL when
-@format does not have a palette.</doc>
- <type name="gpointer" c:type="gconstpointer"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6990">a #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6991">size of the palette in bytes</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_fourcc" c:identifier="gst_video_format_to_fourcc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6931">Converts a #GstVideoFormat value into the corresponding FOURCC. Only
-a few YUV formats have corresponding FOURCC values. If @format has
-no corresponding FOURCC value, 0 is returned.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="577"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6939">the FOURCC corresponding to @format</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6933">a #GstVideoFormat video format</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_string" c:identifier="gst_video_format_to_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6952">Returns a string containing a descriptive name for
-the #GstVideoFormat if there is one, or NULL otherwise.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="580"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6959">the name corresponding to @format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6954">a #GstVideoFormat video format</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <bitfield name="VideoFormatFlags"
- glib:type-name="GstVideoFormatFlags"
- glib:get-type="gst_video_format_flags_get_type"
- c:type="GstVideoFormatFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="262">The different video flags that a format info can have.</doc>
- <member name="yuv"
- value="1"
- c:identifier="GST_VIDEO_FORMAT_FLAG_YUV"
- glib:nick="yuv">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="264">The video format is YUV, components are numbered
- 0=Y, 1=U, 2=V.</doc>
- </member>
- <member name="rgb"
- value="2"
- c:identifier="GST_VIDEO_FORMAT_FLAG_RGB"
- glib:nick="rgb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="266">The video format is RGB, components are numbered
- 0=R, 1=G, 2=B.</doc>
- </member>
- <member name="gray"
- value="4"
- c:identifier="GST_VIDEO_FORMAT_FLAG_GRAY"
- glib:nick="gray">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="268">The video is gray, there is one gray component
- with index 0.</doc>
- </member>
- <member name="alpha"
- value="8"
- c:identifier="GST_VIDEO_FORMAT_FLAG_ALPHA"
- glib:nick="alpha">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="270">The video format has an alpha components with
- the number 3.</doc>
- </member>
- <member name="le"
- value="16"
- c:identifier="GST_VIDEO_FORMAT_FLAG_LE"
- glib:nick="le">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="272">The video format has data stored in little
- endianness.</doc>
- </member>
- <member name="palette"
- value="32"
- c:identifier="GST_VIDEO_FORMAT_FLAG_PALETTE"
- glib:nick="palette">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="274">The video format has a palette. The palette
- is stored in the second plane and indexes are stored in the first plane.</doc>
- </member>
- <member name="complex"
- value="64"
- c:identifier="GST_VIDEO_FORMAT_FLAG_COMPLEX"
- glib:nick="complex">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="276">The video format has a complex layout that
- can't be described with the usual information in the #GstVideoFormatInfo.</doc>
- </member>
- <member name="unpack"
- value="128"
- c:identifier="GST_VIDEO_FORMAT_FLAG_UNPACK"
- glib:nick="unpack">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="278">This format can be used in a
- #GstVideoFormatUnpack and #GstVideoFormatPack function.</doc>
- </member>
- <member name="tiled"
- value="256"
- c:identifier="GST_VIDEO_FORMAT_FLAG_TILED"
- glib:nick="tiled">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="280">The format is tiled, there is tiling information
- in the last plane.</doc>
- </member>
- </bitfield>
- <record name="VideoFormatInfo" c:type="GstVideoFormatInfo">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="408">Information for a video format.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="473"/>
- <field name="format" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="410">#GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </field>
- <field name="name" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="411">string representation of the format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="description" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="412">use readable description of the format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="413">#GstVideoFormatFlags</doc>
- <type name="VideoFormatFlags" c:type="GstVideoFormatFlags"/>
- </field>
- <field name="bits" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="414">The number of bits used to pack data items. This can be less than 8
- when multiple pixels are stored in a byte. for values &gt; 8 multiple bytes
- should be read according to the endianness flag before applying the shift
- and mask.</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="n_components" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="418">the number of components in the video format.</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="shift" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="419">the number of bits to shift away to get the component data</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="guint" c:type="guint"/>
- </array>
- </field>
- <field name="depth" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="420">the depth in bits for each component</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="guint" c:type="guint"/>
- </array>
- </field>
- <field name="pixel_stride" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="421">the pixel stride of each component. This is the amount of
- bytes to the pixel immediately to the right. When bits &lt; 8, the stride is
- expressed in bits. For 24-bit RGB, this would be 3 bytes, for example,
- while it would be 4 bytes for RGBx or ARGB.</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="gint" c:type="gint"/>
- </array>
- </field>
- <field name="n_planes" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="425">the number of planes for this format. The number of planes can be
- less than the amount of components when multiple components are packed into
- one plane.</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="plane" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="428">the plane number where a component can be found</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="guint" c:type="guint"/>
- </array>
- </field>
- <field name="poffset" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="429">the offset in the plane where the first pixel of the components
- can be found.</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="guint" c:type="guint"/>
- </array>
- </field>
- <field name="w_sub" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="431">subsampling factor of the width for the component. Use
- GST_VIDEO_SUB_SCALE to scale a width.</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="guint" c:type="guint"/>
- </array>
- </field>
- <field name="h_sub" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="433">subsampling factor of the height for the component. Use
- GST_VIDEO_SUB_SCALE to scale a height.</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="guint" c:type="guint"/>
- </array>
- </field>
- <field name="unpack_format" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="435">the format of the unpacked pixels. This format must have the
- #GST_VIDEO_FORMAT_FLAG_UNPACK flag set.</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </field>
- <field name="unpack_func" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="437">an unpack function for this format</doc>
- <type name="VideoFormatUnpack" c:type="GstVideoFormatUnpack"/>
- </field>
- <field name="pack_lines" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="438">the amount of lines that will be packed</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="pack_func" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="439">an pack function for this format</doc>
- <type name="VideoFormatPack" c:type="GstVideoFormatPack"/>
- </field>
- <field name="tile_mode" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="440">The tiling mode</doc>
- <type name="VideoTileMode" c:type="GstVideoTileMode"/>
- </field>
- <field name="tile_ws" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="441">The width of a tile, in bytes, represented as a shift</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="tile_hs" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="442">The height of a tile, in bytes, represented as a shift</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="component"
- c:identifier="gst_video_format_info_component"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7016">Fill @components with the number of all the components packed in plane @p
-for the format @info. A value of -1 in @components indicates that no more
-components are packed in the plane.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="561"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7018">#GstVideoFormatInfo</doc>
- <type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
- </instance-parameter>
- <parameter name="plane" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7019">a plane number</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="components"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7020">array used to store component numbers</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <callback name="VideoFormatPack" c:type="GstVideoFormatPack">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="368">Packs @width pixels from @src to the given planes and strides in the
-format @info. The pixels from source have each component interleaved
-and will be packed into the planes in @data.
-
-This function operates on pack_lines lines, meaning that @src should
-contain at least pack_lines lines with a stride of @sstride and @y
-should be a multiple of pack_lines.
-
-Subsampled formats will use the horizontally and vertically cosited
-component from the source. Subsampling should be performed before
-packing.
-
-Because this function does not have a x coordinate, it is not possible to
-pack pixels starting from an unaligned position. For tiled images this
-means that packing should start from a tile coordinate. For subsampled
-formats this means that a complete pixel needs to be packed.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="400"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="370">a #GstVideoFormatInfo</doc>
- <type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="371">flags to control the packing</doc>
- <type name="VideoPackFlags" c:type="GstVideoPackFlags"/>
- </parameter>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="372">a source array</doc>
- <type name="gpointer" c:type="const gpointer"/>
- </parameter>
- <parameter name="sstride" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="373">the source array stride</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="374">pointers to the destination data planes</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="stride" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="375">strides of the destination planes</doc>
- <type name="gint" c:type="const gint*"/>
- </parameter>
- <parameter name="chroma_site" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="376">the chroma siting of the target when subsampled (not used)</doc>
- <type name="VideoChromaSite" c:type="GstVideoChromaSite"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="377">the y position in the image to pack to</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="378">the amount of pixels to pack.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </callback>
- <callback name="VideoFormatUnpack" c:type="GstVideoFormatUnpack">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="338">Unpacks @width pixels from the given planes and strides containing data of
-format @info. The pixels will be unpacked into @dest with each component
-interleaved as per @info's unpack_format, which will usually be one of
-#GST_VIDEO_FORMAT_ARGB, #GST_VIDEO_FORMAT_AYUV, #GST_VIDEO_FORMAT_ARGB64 or
-#GST_VIDEO_FORMAT_AYUV64 depending on the format to unpack.
-@dest should at least be big enough to hold @width * bytes_per_pixel bytes
-where bytes_per_pixel relates to the unpack format and will usually be
-either 4 or 8 depending on the unpack format. bytes_per_pixel will be
-the same as the pixel stride for plane 0 for the above formats.
-
-For subsampled formats, the components will be duplicated in the destination
-array. Reconstruction of the missing components can be performed in a
-separate step after unpacking.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="363"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="340">a #GstVideoFormatInfo</doc>
- <type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="341">flags to control the unpacking</doc>
- <type name="VideoPackFlags" c:type="GstVideoPackFlags"/>
- </parameter>
- <parameter name="dest"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="342">a destination array</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="343">pointers to the data planes</doc>
- <type name="gpointer" c:type="const gpointer*"/>
- </parameter>
- <parameter name="stride" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="344">strides of the planes</doc>
- <type name="gint" c:type="const gint*"/>
- </parameter>
- <parameter name="x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="345">the x position in the image to start from</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="346">the y position in the image to start from</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="347">the amount of pixels to unpack.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </callback>
- <record name="VideoFrame" c:type="GstVideoFrame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="68">A video frame obtained from gst_video_frame_map()</doc>
- <source-position filename="gst-libs/gst/video/video-frame.h" line="94"/>
- <field name="info" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="70">the #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo"/>
- </field>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="71">#GstVideoFrameFlags for the frame</doc>
- <type name="VideoFrameFlags" c:type="GstVideoFrameFlags"/>
- </field>
- <field name="buffer" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="72">the mapped buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="73">pointer to metadata if any</doc>
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="id" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="74">id of the mapped frame. the id can for example be used to
- identify the frame in case of multiview video.</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="data" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="76">pointers to the plane data</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="map" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="77">mappings of the planes</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="Gst.MapInfo" c:type="GstMapInfo"/>
- </array>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="copy" c:identifier="gst_video_frame_copy">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="394">Copy the contents from @src to @dest.
-
-Note: Since: 1.18, @dest dimensions are allowed to be
-smaller than @src dimensions.</doc>
- <source-position filename="gst-libs/gst/video/video-frame.h"
- line="108"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="404">TRUE if the contents could be copied.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="396">a #GstVideoFrame</doc>
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </instance-parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="397">a #GstVideoFrame</doc>
- <type name="VideoFrame" c:type="const GstVideoFrame*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy_plane" c:identifier="gst_video_frame_copy_plane">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="281">Copy the plane with index @plane from @src to @dest.
-
-Note: Since: 1.18, @dest dimensions are allowed to be
-smaller than @src dimensions.</doc>
- <source-position filename="gst-libs/gst/video/video-frame.h"
- line="111"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="292">TRUE if the contents could be copied.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="283">a #GstVideoFrame</doc>
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </instance-parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="284">a #GstVideoFrame</doc>
- <type name="VideoFrame" c:type="const GstVideoFrame*"/>
- </parameter>
- <parameter name="plane" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="285">a plane</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="map" c:identifier="gst_video_frame_map">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="189">Use @info and @buffer to fill in the values of @frame. @frame is usually
-allocated on the stack, and you will pass the address to the #GstVideoFrame
-structure allocated on the stack; gst_video_frame_map() will then fill in
-the structures with the various video-specific information you need to access
-the pixels of the video buffer. You can then use accessor macros such as
-GST_VIDEO_FRAME_COMP_DATA(), GST_VIDEO_FRAME_PLANE_DATA(),
-GST_VIDEO_FRAME_COMP_STRIDE(), GST_VIDEO_FRAME_PLANE_STRIDE() etc.
-to get to the pixels.
-
-|[&lt;!-- language="C" --&gt;
- GstVideoFrame vframe;
- ...
- // set RGB pixels to black one at a time
- if (gst_video_frame_map (&amp;amp;vframe, video_info, video_buffer, GST_MAP_WRITE)) {
- guint8 *pixels = GST_VIDEO_FRAME_PLANE_DATA (vframe, 0);
- guint stride = GST_VIDEO_FRAME_PLANE_STRIDE (vframe, 0);
- guint pixel_stride = GST_VIDEO_FRAME_COMP_PSTRIDE (vframe, 0);
-
- for (h = 0; h &lt; height; ++h) {
- for (w = 0; w &lt; width; ++w) {
- guint8 *pixel = pixels + h * stride + w * pixel_stride;
-
- memset (pixel, 0, pixel_stride);
- }
- }
-
- gst_video_frame_unmap (&amp;amp;vframe);
- }
- ...
-]|
-
-All video planes of @buffer will be mapped and the pointers will be set in
-@frame-&gt;data.
-
-The purpose of this function is to make it easy for you to get to the video
-pixels in a generic way, without you having to worry too much about details
-such as whether the video data is allocated in one contiguous memory chunk
-or multiple memory chunks (e.g. one for each plane); or if custom strides
-and custom plane offsets are used or not (as signalled by GstVideoMeta on
-each buffer). This function will just fill the #GstVideoFrame structure
-with the right values and if you use the accessor macros everything will
-just work and you can access the data easily. It also maps the underlying
-memory chunks for you.</doc>
- <source-position filename="gst-libs/gst/video/video-frame.h"
- line="97"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="240">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="191">pointer to #GstVideoFrame</doc>
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="192">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="193">the buffer to map</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="194">#GstMapFlags</doc>
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="map_id" c:identifier="gst_video_frame_map_id">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="50">Use @info and @buffer to fill in the values of @frame with the video frame
-information of frame @id.
-
-When @id is -1, the default frame is mapped. When @id != -1, this function
-will return %FALSE when there is no GstVideoMeta with that id.
-
-All video planes of @buffer will be mapped and the pointers will be set in
-@frame-&gt;data.</doc>
- <source-position filename="gst-libs/gst/video/video-frame.h"
- line="101"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="67">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="52">pointer to #GstVideoFrame</doc>
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </instance-parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="53">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="54">the buffer to map</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="55">the frame id to map</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="56">#GstMapFlags</doc>
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="unmap" c:identifier="gst_video_frame_unmap">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="249">Unmap the memory previously mapped with gst_video_frame_map.</doc>
- <source-position filename="gst-libs/gst/video/video-frame.h"
- line="105"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="frame" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.c"
- line="251">a #GstVideoFrame</doc>
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <bitfield name="VideoFrameFlags"
- glib:type-name="GstVideoFrameFlags"
- glib:get-type="gst_video_frame_flags_get_type"
- c:type="GstVideoFrameFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="29">Extra video frame flags</doc>
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_FRAME_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="31">no flags</doc>
- </member>
- <member name="interlaced"
- value="1"
- c:identifier="GST_VIDEO_FRAME_FLAG_INTERLACED"
- glib:nick="interlaced">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="32">The video frame is interlaced. In mixed
- interlace-mode, this flag specifies if the frame is interlaced or
- progressive.</doc>
- </member>
- <member name="tff"
- value="2"
- c:identifier="GST_VIDEO_FRAME_FLAG_TFF"
- glib:nick="tff">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="35">The video frame has the top field first</doc>
- </member>
- <member name="rff"
- value="4"
- c:identifier="GST_VIDEO_FRAME_FLAG_RFF"
- glib:nick="rff">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="36">The video frame has the repeat flag</doc>
- </member>
- <member name="onefield"
- value="8"
- c:identifier="GST_VIDEO_FRAME_FLAG_ONEFIELD"
- glib:nick="onefield">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="37">The video frame has one field</doc>
- </member>
- <member name="multiple_view"
- value="16"
- c:identifier="GST_VIDEO_FRAME_FLAG_MULTIPLE_VIEW"
- glib:nick="multiple-view">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="38">The video contains one or
- more non-mono views</doc>
- </member>
- <member name="first_in_bundle"
- value="32"
- c:identifier="GST_VIDEO_FRAME_FLAG_FIRST_IN_BUNDLE"
- glib:nick="first-in-bundle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="40">The video frame is the first
- in a set of corresponding views provided as sequential frames.</doc>
- </member>
- <member name="top_field"
- value="10"
- c:identifier="GST_VIDEO_FRAME_FLAG_TOP_FIELD"
- glib:nick="top-field">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="42">The video frame has the top field only. This
- is the same as GST_VIDEO_FRAME_FLAG_TFF | GST_VIDEO_FRAME_FLAG_ONEFIELD
- (Since: 1.16).</doc>
- </member>
- <member name="onefield"
- value="8"
- c:identifier="GST_VIDEO_FRAME_FLAG_ONEFIELD"
- glib:nick="onefield">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="37">The video frame has one field</doc>
- </member>
- <member name="bottom_field"
- value="8"
- c:identifier="GST_VIDEO_FRAME_FLAG_BOTTOM_FIELD"
- glib:nick="bottom-field">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="45">The video frame has the bottom field
- only. This is the same as GST_VIDEO_FRAME_FLAG_ONEFIELD
- (GST_VIDEO_FRAME_FLAG_TFF flag unset) (Since: 1.16).</doc>
- </member>
- </bitfield>
- <bitfield name="VideoFrameMapFlags"
- version="1.6"
- glib:type-name="GstVideoFrameMapFlags"
- glib:get-type="gst_video_frame_map_flags_get_type"
- c:type="GstVideoFrameMapFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="234">Additional mapping flags for gst_video_frame_map().</doc>
- <member name="no_ref"
- value="65536"
- c:identifier="GST_VIDEO_FRAME_MAP_FLAG_NO_REF"
- glib:nick="no-ref">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="236">Don't take another reference of the buffer and store it in
- the GstVideoFrame. This makes sure that the buffer stays
- writable while the frame is mapped, but requires that the
- buffer reference stays valid until the frame is unmapped again.</doc>
- </member>
- <member name="last"
- value="16777216"
- c:identifier="GST_VIDEO_FRAME_MAP_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-frame.h"
- line="240">Offset to define more flags</doc>
- </member>
- </bitfield>
- <enumeration name="VideoGLTextureOrientation"
- c:type="GstVideoGLTextureOrientation">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="213">The orientation of the GL texture.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="228"/>
- <member name="normal_y_normal"
- value="0"
- c:identifier="GST_VIDEO_GL_TEXTURE_ORIENTATION_X_NORMAL_Y_NORMAL">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="215">Top line first in memory, left row first</doc>
- </member>
- <member name="normal_y_flip"
- value="1"
- c:identifier="GST_VIDEO_GL_TEXTURE_ORIENTATION_X_NORMAL_Y_FLIP">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="216">Bottom line first in memory, left row first</doc>
- </member>
- <member name="flip_y_normal"
- value="2"
- c:identifier="GST_VIDEO_GL_TEXTURE_ORIENTATION_X_FLIP_Y_NORMAL">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="217">Top line first in memory, right row first</doc>
- </member>
- <member name="flip_y_flip"
- value="3"
- c:identifier="GST_VIDEO_GL_TEXTURE_ORIENTATION_X_FLIP_Y_FLIP">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="218">Bottom line first in memory, right row first</doc>
- </member>
- </enumeration>
- <enumeration name="VideoGLTextureType" c:type="GstVideoGLTextureType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="190">The GL texture type.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="211"/>
- <member name="luminance"
- value="0"
- c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_LUMINANCE">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="192">Luminance texture, GL_LUMINANCE</doc>
- </member>
- <member name="luminance_alpha"
- value="1"
- c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_LUMINANCE_ALPHA">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="193">Luminance-alpha texture, GL_LUMINANCE_ALPHA</doc>
- </member>
- <member name="rgb16"
- value="2"
- c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_RGB16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="194">RGB 565 texture, GL_RGB</doc>
- </member>
- <member name="rgb"
- value="3"
- c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_RGB">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="195">RGB texture, GL_RGB</doc>
- </member>
- <member name="rgba"
- value="4"
- c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_RGBA">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="196">RGBA texture, GL_RGBA</doc>
- </member>
- <member name="r" value="5" c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_R">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="197">R texture, GL_RED_EXT</doc>
- </member>
- <member name="rg" value="6" c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_RG">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="198">RG texture, GL_RG_EXT</doc>
- </member>
- </enumeration>
- <callback name="VideoGLTextureUpload" c:type="GstVideoGLTextureUpload">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="234"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="meta" transfer-ownership="none">
- <type name="VideoGLTextureUploadMeta"
- c:type="GstVideoGLTextureUploadMeta*"/>
- </parameter>
- <parameter name="texture_id" transfer-ownership="none">
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </callback>
- <record name="VideoGLTextureUploadMeta"
- c:type="GstVideoGLTextureUploadMeta">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="251">Extra buffer metadata for uploading a buffer to an OpenGL texture
-ID. The caller of gst_video_gl_texture_upload_meta_upload() must
-have OpenGL set up and call this from a thread where it is valid
-to upload something to an OpenGL texture.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="278"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="253">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="texture_orientation" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="254">Orientation of the textures</doc>
- <type name="VideoGLTextureOrientation"
- c:type="GstVideoGLTextureOrientation"/>
- </field>
- <field name="n_textures" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="255">Number of textures that are generated</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="texture_type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="256">Type of each texture</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="VideoGLTextureType" c:type="GstVideoGLTextureType"/>
- </array>
- </field>
- <field name="buffer" readable="0" private="1">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="upload" readable="0" private="1">
- <type name="VideoGLTextureUpload" c:type="GstVideoGLTextureUpload"/>
- </field>
- <field name="user_data" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <field name="user_data_copy" readable="0" private="1">
- <type name="GObject.BoxedCopyFunc" c:type="GBoxedCopyFunc"/>
- </field>
- <field name="user_data_free" readable="0" private="1">
- <type name="GObject.BoxedFreeFunc" c:type="GBoxedFreeFunc"/>
- </field>
- <method name="upload"
- c:identifier="gst_video_gl_texture_upload_meta_upload">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="786">Uploads the buffer which owns the meta to a specific texture ID.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="300"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="793">%TRUE if uploading succeeded, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="788">a #GstVideoGLTextureUploadMeta</doc>
- <type name="VideoGLTextureUploadMeta"
- c:type="GstVideoGLTextureUploadMeta*"/>
- </instance-parameter>
- <parameter name="texture_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="789">the texture IDs to upload to</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <function name="get_info"
- c:identifier="gst_video_gl_texture_upload_meta_get_info">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="284"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <enumeration name="VideoGammaMode"
- version="1.6"
- glib:type-name="GstVideoGammaMode"
- glib:get-type="gst_video_gamma_mode_get_type"
- c:type="GstVideoGammaMode">
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_GAMMA_MODE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="227">disable gamma handling</doc>
- </member>
- <member name="remap"
- value="1"
- c:identifier="GST_VIDEO_GAMMA_MODE_REMAP"
- glib:nick="remap">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="228">convert between input and output gamma
-Different gamma conversion modes</doc>
- </member>
- </enumeration>
- <record name="VideoInfo"
- c:type="GstVideoInfo"
- glib:type-name="GstVideoInfo"
- glib:get-type="gst_video_info_get_type"
- c:symbol-prefix="video_info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="286">Information describing image properties. This information can be filled
-in from GstCaps with gst_video_info_from_caps(). The information is also used
-to store the specific video info when mapping a video frame with
-gst_video_frame_map().
-
-Use the provided macros to access the info in this structure.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h" line="345"/>
- <field name="finfo" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="288">the format info of the video</doc>
- <type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
- </field>
- <field name="interlace_mode" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="289">the interlace mode</doc>
- <type name="VideoInterlaceMode" c:type="GstVideoInterlaceMode"/>
- </field>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="290">additional video flags</doc>
- <type name="VideoFlags" c:type="GstVideoFlags"/>
- </field>
- <field name="width" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="291">the width of the video</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="height" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="292">the height of the video</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="294">the default size of one frame</doc>
- <type name="gsize" c:type="gsize"/>
- </field>
- <field name="views" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="293">the number of views for multiview video</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="chroma_site" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="295">a #GstVideoChromaSite.</doc>
- <type name="VideoChromaSite" c:type="GstVideoChromaSite"/>
- </field>
- <field name="colorimetry" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="296">the colorimetry info</doc>
- <type name="VideoColorimetry" c:type="GstVideoColorimetry"/>
- </field>
- <field name="par_n" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="297">the pixel-aspect-ratio numerator</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="par_d" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="298">the pixel-aspect-ratio denominator</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="fps_n" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="299">the framerate numerator</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="fps_d" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="300">the framerate denominator</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="offset" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="301">offsets of the planes</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="gsize" c:type="gsize"/>
- </array>
- </field>
- <field name="stride" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="302">strides of the planes</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="gint" c:type="gint"/>
- </array>
- </field>
- <union name="ABI" c:type="ABI">
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="344"/>
- <record name="abi" c:type="abi">
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="341"/>
- <field name="multiview_mode" writable="1">
- <type name="VideoMultiviewMode" c:type="GstVideoMultiviewMode"/>
- </field>
- <field name="multiview_flags" writable="1">
- <type name="VideoMultiviewFlags" c:type="GstVideoMultiviewFlags"/>
- </field>
- <field name="field_order" writable="1">
- <type name="VideoFieldOrder" c:type="GstVideoFieldOrder"/>
- </field>
- </record>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </union>
- <constructor name="new" c:identifier="gst_video_info_new" version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="94">Allocate a new #GstVideoInfo that is also initialized with
-gst_video_info_init().</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="428"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="100">a new #GstVideoInfo. free with gst_video_info_free().</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </return-value>
- </constructor>
- <method name="align" c:identifier="gst_video_info_align">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1432">Adjust the offset and stride fields in @info so that the padding and
-stride alignment in @align is respected.
-
-Extra padding will be added to the right side when stride alignment padding
-is required and @align will be updated with the new padding values.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="471"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1443">%FALSE if alignment could not be applied, e.g. because the
- size of a frame can't be represented as a 32 bit integer (Since: 1.12)</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1434">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </instance-parameter>
- <parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1435">alignment parameters</doc>
- <type name="VideoAlignment" c:type="GstVideoAlignment*"/>
- </parameter>
- </parameters>
- </method>
- <method name="align_full"
- c:identifier="gst_video_info_align_full"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1312">This variant of gst_video_info_align() provides the updated size, in bytes,
-of each video plane after the alignment, including all horizontal and vertical
-paddings.
-
-In case of GST_VIDEO_INTERLACE_MODE_ALTERNATE info, the returned sizes are the
-ones used to hold a single field, not the full frame.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="474"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1325">%FALSE if alignment could not be applied, e.g. because the
- size of a frame can't be represented as a 32 bit integer</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1314">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </instance-parameter>
- <parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1315">alignment parameters</doc>
- <type name="VideoAlignment" c:type="GstVideoAlignment*"/>
- </parameter>
- <parameter name="plane_size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1316">array used to store the plane sizes</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </method>
- <method name="convert" c:identifier="gst_video_info_convert">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1186">Converts among various #GstFormat types. This function handles
-GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For
-raw video, GST_FORMAT_DEFAULT corresponds to video frames. This
-function can be used to handle pad queries of the type GST_QUERY_CONVERT.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="458"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1199">TRUE if the conversion was successful.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1188">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </instance-parameter>
- <parameter name="src_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1189">#GstFormat of the @src_value</doc>
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="src_value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1190">value to convert</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- <parameter name="dest_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1191">#GstFormat of the @dest_value</doc>
- <type name="Gst.Format" c:type="GstFormat"/>
- </parameter>
- <parameter name="dest_value"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="1192">pointer to destination value</doc>
- <type name="gint64" c:type="gint64*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_video_info_copy" version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="60">Copy a GstVideoInfo structure.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="434"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="66">a new #GstVideoInfo. free with gst_video_info_free.</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="62">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="const GstVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_video_info_free" version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="76">Free a GstVideoInfo structure previously allocated with gst_video_info_new()
-or gst_video_info_copy().</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="437"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="78">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="from_caps" c:identifier="gst_video_info_from_caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="386">Parse @caps and update @info.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="452"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="393">TRUE if @caps could be parsed</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="388">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="389">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_video_info_init">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="118">Initialize @info with default values.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="431"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="120">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_equal" c:identifier="gst_video_info_is_equal">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="576">Compares two #GstVideoInfo and returns whether they are equal or not</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="465"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="583">%TRUE if @info and @other are equal, else %FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="578">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="const GstVideoInfo*"/>
- </instance-parameter>
- <parameter name="other" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="579">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="const GstVideoInfo*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_format" c:identifier="gst_video_info_set_format">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="234">Set the default info for a video frame of @format and @width and @height.
-
-Note: This initializes @info first, no values are preserved. This function
-does not set the offsets correctly for interlaced vertically
-subsampled formats.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="440"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="247">%FALSE if the returned video info is invalid, e.g. because the
- size of a frame can't be represented as a 32 bit integer (Since: 1.12)</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="236">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="237">the format</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="238">a width</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="239">a height</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_interlaced_format"
- c:identifier="gst_video_info_set_interlaced_format"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="260">Same as #gst_video_info_set_format but also allowing to set the interlaced
-mode.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="444"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="271">%FALSE if the returned video info is invalid, e.g. because the
- size of a frame can't be represented as a 32 bit integer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="262">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="263">the format</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="264">a #GstVideoInterlaceMode</doc>
- <type name="VideoInterlaceMode" c:type="GstVideoInterlaceMode"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="265">a width</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="266">a height</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_caps" c:identifier="gst_video_info_to_caps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="635">Convert the values of @info into a #GstCaps.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h"
- line="455"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="641">a new #GstCaps containing the info of @info.</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="637">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <enumeration name="VideoInterlaceMode"
- glib:type-name="GstVideoInterlaceMode"
- glib:get-type="gst_video_interlace_mode_get_type"
- c:type="GstVideoInterlaceMode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="54">The possible values of the #GstVideoInterlaceMode describing the interlace
-mode of the stream.</doc>
- <member name="progressive"
- value="0"
- c:identifier="GST_VIDEO_INTERLACE_MODE_PROGRESSIVE"
- glib:nick="progressive">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="56">all frames are progressive</doc>
- </member>
- <member name="interleaved"
- value="1"
- c:identifier="GST_VIDEO_INTERLACE_MODE_INTERLEAVED"
- glib:nick="interleaved">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="57">2 fields are interleaved in one video
- frame. Extra buffer flags describe the field order.</doc>
- </member>
- <member name="mixed"
- value="2"
- c:identifier="GST_VIDEO_INTERLACE_MODE_MIXED"
- glib:nick="mixed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="59">frames contains both interlaced and
- progressive video, the buffer flags describe the frame and fields.</doc>
- </member>
- <member name="fields"
- value="3"
- c:identifier="GST_VIDEO_INTERLACE_MODE_FIELDS"
- glib:nick="fields">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="61">2 fields are stored in one buffer, use the
- frame ID to get access to the required field. For multiview (the
- 'views' property &gt; 1) the fields of view N can be found at frame ID
- (N * 2) and (N * 2) + 1.
- Each field has only half the amount of lines as noted in the
- height property. This mode requires multiple GstVideoMeta metadata
- to describe the fields.</doc>
- </member>
- <member name="alternate"
- value="4"
- c:identifier="GST_VIDEO_INTERLACE_MODE_ALTERNATE"
- glib:nick="alternate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="68">1 field is stored in one buffer,
- @GST_VIDEO_BUFFER_FLAG_TF or @GST_VIDEO_BUFFER_FLAG_BF indicates if
- the buffer is carrying the top or bottom field, respectively. The top and
- bottom buffers must alternate in the pipeline, with this mode
- (Since: 1.16).</doc>
- </member>
- <function name="from_string"
- c:identifier="gst_video_interlace_mode_from_string"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="315">Convert @mode to a #GstVideoInterlaceMode</doc>
- <source-position filename="gst-libs/gst/video/video-info.h" line="89"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="321">the #GstVideoInterlaceMode of @mode or
- #GST_VIDEO_INTERLACE_MODE_PROGRESSIVE when @mode is not a valid
- string representation for a #GstVideoInterlaceMode.</doc>
- <type name="VideoInterlaceMode" c:type="GstVideoInterlaceMode"/>
- </return-value>
- <parameters>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="317">a mode</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_string"
- c:identifier="gst_video_interlace_mode_to_string"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="296">Convert @mode to its string representation.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h" line="86"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="302">@mode as a string or NULL if @mode in invalid.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="298">a #GstVideoInterlaceMode</doc>
- <type name="VideoInterlaceMode" c:type="GstVideoInterlaceMode"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <record name="VideoMasteringDisplayInfo"
- c:type="GstVideoMasteringDisplayInfo"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.h"
- line="48">Mastering display color volume information defined by SMPTE ST 2086
-(a.k.a static HDR metadata).</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="74"/>
- <field name="display_primaries" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.h"
- line="50">the xy coordinates of primaries in the CIE 1931 color space.
- the index 0 contains red, 1 is for green and 2 is for blue.
- each value is normalized to 50000 (meaning that in unit of 0.00002)</doc>
- <array zero-terminated="0" fixed-size="3">
- <type name="VideoMasteringDisplayInfoCoordinates"
- c:type="GstVideoMasteringDisplayInfoCoordinates"/>
- </array>
- </field>
- <field name="white_point" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.h"
- line="53">the xy coordinates of white point in the CIE 1931 color space.
- each value is normalized to 50000 (meaning that in unit of 0.00002)</doc>
- <type name="VideoMasteringDisplayInfoCoordinates"
- c:type="GstVideoMasteringDisplayInfoCoordinates"/>
- </field>
- <field name="max_display_mastering_luminance" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.h"
- line="55">the maximum value of display luminance
- in unit of 0.0001 candelas per square metre (cd/m^2 and nit)</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="min_display_mastering_luminance" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.h"
- line="57">the minimum value of display luminance
- in unit of 0.0001 candelas per square metre (cd/m^2 and nit)</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="add_to_caps"
- c:identifier="gst_video_mastering_display_info_add_to_caps"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="222">Set string representation of @minfo to @caps</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="95"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="229">%TRUE if @minfo was successfully set to @caps</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="minfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="224">a #GstVideoMasteringDisplayInfo</doc>
- <type name="VideoMasteringDisplayInfo"
- c:type="const GstVideoMasteringDisplayInfo*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="225">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="from_caps"
- c:identifier="gst_video_mastering_display_info_from_caps"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="192">Parse @caps and update @minfo</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="91"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="199">%TRUE if @caps has #GstVideoMasteringDisplayInfo and could be parsed</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="minfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="194">a #GstVideoMasteringDisplayInfo</doc>
- <type name="VideoMasteringDisplayInfo"
- c:type="GstVideoMasteringDisplayInfo*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="195">a #GstCaps</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </method>
- <method name="init"
- c:identifier="gst_video_mastering_display_info_init"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="44">Initialize @minfo</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="77"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="minfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="46">a #GstVideoMasteringDisplayInfo</doc>
- <type name="VideoMasteringDisplayInfo"
- c:type="GstVideoMasteringDisplayInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_equal"
- c:identifier="gst_video_mastering_display_info_is_equal"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="155">Checks equality between @minfo and @other.</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="87"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="162">%TRUE if @minfo and @other are equal.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="minfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="157">a #GstVideoMasteringDisplayInfo</doc>
- <type name="VideoMasteringDisplayInfo"
- c:type="const GstVideoMasteringDisplayInfo*"/>
- </instance-parameter>
- <parameter name="other" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="158">a #GstVideoMasteringDisplayInfo</doc>
- <type name="VideoMasteringDisplayInfo"
- c:type="const GstVideoMasteringDisplayInfo*"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_string"
- c:identifier="gst_video_mastering_display_info_to_string"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="136">Convert @minfo to its string representation</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="84"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="142">a string representation of @minfo</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="minfo" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="138">a #GstVideoMasteringDisplayInfo</doc>
- <type name="VideoMasteringDisplayInfo"
- c:type="const GstVideoMasteringDisplayInfo*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="from_string"
- c:identifier="gst_video_mastering_display_info_from_string"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="60">Extract #GstVideoMasteringDisplayInfo from @mastering</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="80"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="67">%TRUE if @minfo was filled with @mastering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="minfo"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="62">a #GstVideoMasteringDisplayInfo</doc>
- <type name="VideoMasteringDisplayInfo"
- c:type="GstVideoMasteringDisplayInfo*"/>
- </parameter>
- <parameter name="mastering" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="63">a #GstStructure representing #GstVideoMasteringDisplayInfo</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <record name="VideoMasteringDisplayInfoCoordinates"
- c:type="GstVideoMasteringDisplayInfoCoordinates"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.h"
- line="32">Used to represent display_primaries and white_point of
-#GstVideoMasteringDisplayInfo struct. See #GstVideoMasteringDisplayInfo</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="46"/>
- <field name="x" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.h"
- line="34">the x coordinate of CIE 1931 color space in unit of 0.00002.</doc>
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="y" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.h"
- line="35">the y coordinate of CIE 1931 color space in unit of 0.00002.</doc>
- <type name="guint16" c:type="guint16"/>
- </field>
- </record>
- <enumeration name="VideoMatrixMode"
- version="1.6"
- glib:type-name="GstVideoMatrixMode"
- glib:get-type="gst_video_matrix_mode_get_type"
- c:type="GstVideoMatrixMode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="198">Different color matrix conversion modes</doc>
- <member name="full"
- value="0"
- c:identifier="GST_VIDEO_MATRIX_MODE_FULL"
- glib:nick="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="200">do conversion between color matrices</doc>
- </member>
- <member name="input_only"
- value="1"
- c:identifier="GST_VIDEO_MATRIX_MODE_INPUT_ONLY"
- glib:nick="input-only">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="201">use the input color matrix to convert
- to and from R'G'B</doc>
- </member>
- <member name="output_only"
- value="2"
- c:identifier="GST_VIDEO_MATRIX_MODE_OUTPUT_ONLY"
- glib:nick="output-only">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="203">use the output color matrix to convert
- to and from R'G'B</doc>
- </member>
- <member name="none"
- value="3"
- c:identifier="GST_VIDEO_MATRIX_MODE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="205">disable color matrix conversion.</doc>
- </member>
- </enumeration>
- <record name="VideoMeta" c:type="GstVideoMeta">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="40">Extra buffer metadata describing image properties
-
-This meta can also be used by downstream elements to specifiy their
-buffer layout requirements for upstream. Upstream should try to
-fit those requirements, if possible, in order to prevent buffer copies.
-
-This is done by passing a custom #GstStructure to
-gst_query_add_allocation_meta() when handling the ALLOCATION query.
-This structure should be named 'video-meta' and can have the following
-fields:
-- padding-top (uint): extra pixels on the top
-- padding-bottom (uint): extra pixels on the bottom
-- padding-left (uint): extra pixels on the left side
-- padding-right (uint): extra pixels on the right side
-The padding fields have the same semantic as #GstVideoMeta.alignment
-and so represent the paddings requested on produced video buffers.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h" line="98"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="42">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="buffer" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="43">the buffer this metadata belongs to</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="44">additional video flags</doc>
- <type name="VideoFrameFlags" c:type="GstVideoFrameFlags"/>
- </field>
- <field name="format" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="45">the video format</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </field>
- <field name="id" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="46">identifier of the frame</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="width" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="47">the video width</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="height" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="48">the video height</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="n_planes" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="49">the number of planes in the image</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="offset" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="50">array of offsets for the planes. This field might not always be
- valid, it is used by the default implementation of @map.</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="gsize" c:type="gsize"/>
- </array>
- </field>
- <field name="stride" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="52">array of strides for the planes. This field might not always be
- valid, it is used by the default implementation of @map.</doc>
- <array zero-terminated="0" fixed-size="4">
- <type name="gint" c:type="gint"/>
- </array>
- </field>
- <field name="map">
- <callback name="map">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="93"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="meta" transfer-ownership="none">
- <type name="VideoMeta" c:type="GstVideoMeta*"/>
- </parameter>
- <parameter name="plane" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <type name="Gst.MapInfo" c:type="GstMapInfo*"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="stride" transfer-ownership="none">
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="unmap">
- <callback name="unmap">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="95"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="meta" transfer-ownership="none">
- <type name="VideoMeta" c:type="GstVideoMeta*"/>
- </parameter>
- <parameter name="plane" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <type name="Gst.MapInfo" c:type="GstMapInfo*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="alignment" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="56">the paddings and alignment constraints of the video buffer.
-It is up to the caller of `gst_buffer_add_video_meta_full()` to set it
-using gst_video_meta_set_alignment(), if they did not it defaults
-to no padding and no alignment. Since: 1.18</doc>
- <type name="VideoAlignment" c:type="GstVideoAlignment"/>
- </field>
- <method name="get_plane_height"
- c:identifier="gst_video_meta_get_plane_height"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="483">Compute the padded height of each plane from @meta (padded size
-divided by stride).
-
-It is not valid to call this function with a meta associated to a
-TILED video format.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="136"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="494">%TRUE if @meta's alignment is valid and @plane_height has been
-updated, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="485">a #GstVideoMeta</doc>
- <type name="VideoMeta" c:type="GstVideoMeta*"/>
- </instance-parameter>
- <parameter name="plane_height"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="486">array used to store the plane height</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_plane_size"
- c:identifier="gst_video_meta_get_plane_size"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="460">Compute the size, in bytes, of each video plane described in @meta including
-any padding and alignment constraint defined in @meta-&gt;alignment.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="133"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="468">%TRUE if @meta's alignment is valid and @plane_size has been
-updated, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="462">a #GstVideoMeta</doc>
- <type name="VideoMeta" c:type="GstVideoMeta*"/>
- </instance-parameter>
- <parameter name="plane_size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="463">array used to store the plane sizes</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </method>
- <method name="map" c:identifier="gst_video_meta_map">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="345">Map the video plane with index @plane in @meta and return a pointer to the
-first byte of the plane and the stride of the plane.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="123"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="357">TRUE if the map operation was successful.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="347">a #GstVideoMeta</doc>
- <type name="VideoMeta" c:type="GstVideoMeta*"/>
- </instance-parameter>
- <parameter name="plane" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="348">a plane</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="349">a #GstMapInfo</doc>
- <type name="Gst.MapInfo" c:type="GstMapInfo*"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="350">the data of @plane</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="stride"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="351">the stride of @plane</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="352">@GstMapFlags</doc>
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_alignment"
- c:identifier="gst_video_meta_set_alignment"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="424">Set the alignment of @meta to @alignment. This function checks that
-the paddings defined in @alignment are compatible with the strides
-defined in @meta and will fail to update if they are not.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="130"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="433">%TRUE if @alignment's meta has been updated, %FALSE if not</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="426">a #GstVideoMeta</doc>
- <type name="VideoMeta" c:type="GstVideoMeta*"/>
- </instance-parameter>
- <parameter name="alignment" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="427">a #GstVideoAlignment</doc>
- <type name="VideoAlignment" c:type="GstVideoAlignment"/>
- </parameter>
- </parameters>
- </method>
- <method name="unmap" c:identifier="gst_video_meta_unmap">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="376">Unmap a previously mapped plane with gst_video_meta_map().</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="127"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="384">TRUE if the memory was successfully unmapped.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="378">a #GstVideoMeta</doc>
- <type name="VideoMeta" c:type="GstVideoMeta*"/>
- </instance-parameter>
- <parameter name="plane" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="379">a plane</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="380">a #GstMapInfo</doc>
- <type name="Gst.MapInfo" c:type="GstMapInfo*"/>
- </parameter>
- </parameters>
- </method>
- <function name="get_info" c:identifier="gst_video_meta_get_info">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="104"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <record name="VideoMetaTransform" c:type="GstVideoMetaTransform">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="177">Extra data passed to a video transform #GstMetaTransformFunction such as:
-"gst-video-scale".</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="188"/>
- <field name="in_info" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="179">the input #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </field>
- <field name="out_info" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="180">the output #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </field>
- <function name="scale_get_quark"
- c:identifier="gst_video_meta_transform_scale_get_quark">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="619">Get the #GQuark for the "gst-video-scale" metadata transform operation.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="169"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="624">a #GQuark</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- </record>
- <bitfield name="VideoMultiviewFlags"
- glib:type-name="GstVideoMultiviewFlags"
- glib:get-type="gst_video_multiview_flags_get_type"
- c:type="GstVideoMultiviewFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="202">GstVideoMultiviewFlags are used to indicate extra properties of a
-stereo/multiview stream beyond the frame layout and buffer mapping
-that is conveyed in the #GstVideoMultiviewMode.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_MULTIVIEW_FLAGS_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="204">No flags</doc>
- </member>
- <member name="right_view_first"
- value="1"
- c:identifier="GST_VIDEO_MULTIVIEW_FLAGS_RIGHT_VIEW_FIRST"
- glib:nick="right-view-first">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="205">For stereo streams, the
- normal arrangement of left and right views is reversed.</doc>
- </member>
- <member name="left_flipped"
- value="2"
- c:identifier="GST_VIDEO_MULTIVIEW_FLAGS_LEFT_FLIPPED"
- glib:nick="left-flipped">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="207">The left view is vertically
- mirrored.</doc>
- </member>
- <member name="left_flopped"
- value="4"
- c:identifier="GST_VIDEO_MULTIVIEW_FLAGS_LEFT_FLOPPED"
- glib:nick="left-flopped">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="209">The left view is horizontally
- mirrored.</doc>
- </member>
- <member name="right_flipped"
- value="8"
- c:identifier="GST_VIDEO_MULTIVIEW_FLAGS_RIGHT_FLIPPED"
- glib:nick="right-flipped">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="211">The right view is
- vertically mirrored.</doc>
- </member>
- <member name="right_flopped"
- value="16"
- c:identifier="GST_VIDEO_MULTIVIEW_FLAGS_RIGHT_FLOPPED"
- glib:nick="right-flopped">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="213">The right view is
- horizontally mirrored.</doc>
- </member>
- <member name="half_aspect"
- value="16384"
- c:identifier="GST_VIDEO_MULTIVIEW_FLAGS_HALF_ASPECT"
- glib:nick="half-aspect">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="215">For frame-packed
- multiview modes, indicates that the individual
- views have been encoded with half the true width or height
- and should be scaled back up for display. This flag
- is used for overriding input layout interpretation
- by adjusting pixel-aspect-ratio.
- For side-by-side, column interleaved or checkerboard packings, the
- pixel width will be doubled. For row interleaved and top-bottom
- encodings, pixel height will be doubled.</doc>
- </member>
- <member name="mixed_mono"
- value="32768"
- c:identifier="GST_VIDEO_MULTIVIEW_FLAGS_MIXED_MONO"
- glib:nick="mixed-mono">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="224">The video stream contains both
- mono and multiview portions, signalled on each buffer by the
- absence or presence of the @GST_VIDEO_BUFFER_FLAG_MULTIPLE_VIEW
- buffer flag.</doc>
- </member>
- </bitfield>
- <class name="VideoMultiviewFlagsSet"
- c:symbol-prefix="video_multiview_flagset"
- parent="Gst.FlagSet"
- glib:type-name="GstVideoMultiviewFlagsSet"
- glib:get-type="gst_video_multiview_flagset_get_type"
- glib:fundamental="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.h"
- line="28">See #GstVideoMultiviewFlags.</doc>
- </class>
- <enumeration name="VideoMultiviewFramePacking"
- glib:type-name="GstVideoMultiviewFramePacking"
- glib:get-type="gst_video_multiview_frame_packing_get_type"
- c:type="GstVideoMultiviewFramePacking">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="153">#GstVideoMultiviewFramePacking represents the subset of #GstVideoMultiviewMode
-values that can be applied to any video frame without needing extra metadata.
-It can be used by elements that provide a property to override the
-multiview interpretation of a video stream when the video doesn't contain
-any markers.
-
-This enum is used (for example) on playbin, to re-interpret a played
-video stream as a stereoscopic video. The individual enum values are
-equivalent to and have the same value as the matching #GstVideoMultiviewMode.</doc>
- <member name="none"
- value="-1"
- c:identifier="GST_VIDEO_MULTIVIEW_FRAME_PACKING_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="155">A special value indicating
-no frame packing info.</doc>
- </member>
- <member name="mono"
- value="0"
- c:identifier="GST_VIDEO_MULTIVIEW_FRAME_PACKING_MONO"
- glib:nick="mono">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="157">All frames are monoscopic.</doc>
- </member>
- <member name="left"
- value="1"
- c:identifier="GST_VIDEO_MULTIVIEW_FRAME_PACKING_LEFT"
- glib:nick="left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="158">All frames represent a left-eye view.</doc>
- </member>
- <member name="right"
- value="2"
- c:identifier="GST_VIDEO_MULTIVIEW_FRAME_PACKING_RIGHT"
- glib:nick="right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="159">All frames represent a right-eye view.</doc>
- </member>
- <member name="side_by_side"
- value="3"
- c:identifier="GST_VIDEO_MULTIVIEW_FRAME_PACKING_SIDE_BY_SIDE"
- glib:nick="side-by-side">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="160">Left and right eye views are
-provided in the left and right half of the frame respectively.</doc>
- </member>
- <member name="side_by_side_quincunx"
- value="4"
- c:identifier="GST_VIDEO_MULTIVIEW_FRAME_PACKING_SIDE_BY_SIDE_QUINCUNX"
- glib:nick="side-by-side-quincunx">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="162">Left and right eye
-views are provided in the left and right half of the frame, but
-have been sampled using quincunx method, with half-pixel offset
-between the 2 views.</doc>
- </member>
- <member name="column_interleaved"
- value="5"
- c:identifier="GST_VIDEO_MULTIVIEW_FRAME_PACKING_COLUMN_INTERLEAVED"
- glib:nick="column-interleaved">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="166">Alternating vertical
-columns of pixels represent the left and right eye view respectively.</doc>
- </member>
- <member name="row_interleaved"
- value="6"
- c:identifier="GST_VIDEO_MULTIVIEW_FRAME_PACKING_ROW_INTERLEAVED"
- glib:nick="row-interleaved">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="168">Alternating horizontal
-rows of pixels represent the left and right eye view respectively.</doc>
- </member>
- <member name="top_bottom"
- value="7"
- c:identifier="GST_VIDEO_MULTIVIEW_FRAME_PACKING_TOP_BOTTOM"
- glib:nick="top-bottom">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="170">The top half of the frame
-contains the left eye, and the bottom half the right eye.</doc>
- </member>
- <member name="checkerboard"
- value="8"
- c:identifier="GST_VIDEO_MULTIVIEW_FRAME_PACKING_CHECKERBOARD"
- glib:nick="checkerboard">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="172">Pixels are arranged with
-alternating pixels representing left and right eye views in a
-checkerboard fashion.</doc>
- </member>
- </enumeration>
- <enumeration name="VideoMultiviewMode"
- glib:type-name="GstVideoMultiviewMode"
- glib:get-type="gst_video_multiview_mode_get_type"
- c:type="GstVideoMultiviewMode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="91">All possible stereoscopic 3D and multiview representations.
-In conjunction with #GstVideoMultiviewFlags, describes how
-multiview content is being transported in the stream.</doc>
- <member name="none"
- value="-1"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="93">A special value indicating
-no multiview information. Used in GstVideoInfo and other places to
-indicate that no specific multiview handling has been requested or
-provided. This value is never carried on caps.</doc>
- </member>
- <member name="mono"
- value="0"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_MONO"
- glib:nick="mono">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="97">All frames are monoscopic.</doc>
- </member>
- <member name="left"
- value="1"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_LEFT"
- glib:nick="left">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="98">All frames represent a left-eye view.</doc>
- </member>
- <member name="right"
- value="2"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_RIGHT"
- glib:nick="right">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="99">All frames represent a right-eye view.</doc>
- </member>
- <member name="side_by_side"
- value="3"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_SIDE_BY_SIDE"
- glib:nick="side-by-side">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="100">Left and right eye views are
-provided in the left and right half of the frame respectively.</doc>
- </member>
- <member name="side_by_side_quincunx"
- value="4"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_SIDE_BY_SIDE_QUINCUNX"
- glib:nick="side-by-side-quincunx">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="102">Left and right eye
-views are provided in the left and right half of the frame, but
-have been sampled using quincunx method, with half-pixel offset
-between the 2 views.</doc>
- </member>
- <member name="column_interleaved"
- value="5"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_COLUMN_INTERLEAVED"
- glib:nick="column-interleaved">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="106">Alternating vertical
-columns of pixels represent the left and right eye view respectively.</doc>
- </member>
- <member name="row_interleaved"
- value="6"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_ROW_INTERLEAVED"
- glib:nick="row-interleaved">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="108">Alternating horizontal
-rows of pixels represent the left and right eye view respectively.</doc>
- </member>
- <member name="top_bottom"
- value="7"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_TOP_BOTTOM"
- glib:nick="top-bottom">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="110">The top half of the frame
-contains the left eye, and the bottom half the right eye.</doc>
- </member>
- <member name="checkerboard"
- value="8"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_CHECKERBOARD"
- glib:nick="checkerboard">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="112">Pixels are arranged with
-alternating pixels representing left and right eye views in a
-checkerboard fashion.</doc>
- </member>
- <member name="frame_by_frame"
- value="32"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_FRAME_BY_FRAME"
- glib:nick="frame-by-frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="115">Left and right eye views
-are provided in separate frames alternately.</doc>
- </member>
- <member name="multiview_frame_by_frame"
- value="33"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_MULTIVIEW_FRAME_BY_FRAME"
- glib:nick="multiview-frame-by-frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="117">Multiple
-independent views are provided in separate frames in sequence.
-This method only applies to raw video buffers at the moment.
-Specific view identification is via the `GstVideoMultiviewMeta`
-and #GstVideoMeta(s) on raw video buffers.</doc>
- </member>
- <member name="separated"
- value="34"
- c:identifier="GST_VIDEO_MULTIVIEW_MODE_SEPARATED"
- glib:nick="separated">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.h"
- line="122">Multiple views are
-provided as separate #GstMemory framebuffers attached to each
-#GstBuffer, described by the `GstVideoMultiviewMeta`
-and #GstVideoMeta(s)</doc>
- </member>
- <function name="from_caps_string"
- c:identifier="gst_video_multiview_mode_from_caps_string"
- version="1.6">
- <source-position filename="gst-libs/gst/video/video-multiview.h"
- line="41"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="93">The #GstVideoMultiviewMode value
-
-Given a string from a caps multiview-mode field,
-output the corresponding #GstVideoMultiviewMode
-or #GST_VIDEO_MULTIVIEW_MODE_NONE</doc>
- <type name="VideoMultiviewMode" c:type="GstVideoMultiviewMode"/>
- </return-value>
- <parameters>
- <parameter name="caps_mview_mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="91">multiview-mode field string from caps</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_caps_string"
- c:identifier="gst_video_multiview_mode_to_caps_string"
- version="1.6">
- <source-position filename="gst-libs/gst/video/video-multiview.h"
- line="38"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="68">The caps string representation of the mode, or NULL if invalid.
-
-Given a #GstVideoMultiviewMode returns the multiview-mode caps string
-for insertion into a caps structure</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="mview_mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="66">A #GstVideoMultiviewMode value</doc>
- <type name="VideoMultiviewMode" c:type="GstVideoMultiviewMode"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <interface name="VideoOrientation"
- c:symbol-prefix="video_orientation"
- c:type="GstVideoOrientation"
- glib:type-name="GstVideoOrientation"
- glib:get-type="gst_video_orientation_get_type"
- glib:type-struct="VideoOrientationInterface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="30">The interface allows unified access to control flipping and autocenter
-operation of video-sources or operators.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="78"/>
- <virtual-method name="get_hcenter" invoker="get_hcenter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="104">Get the horizontal centering offset from the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="71"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="110">%TRUE in case the element supports centering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="106">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="center"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="107">return location for the result</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_hflip" invoker="get_hflip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="62">Get the horizontal flipping state (%TRUE for flipped) from the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="68">%TRUE in case the element supports flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="64">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="flip"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="65">return location for the result</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_vcenter" invoker="get_vcenter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="125">Get the vertical centering offset from the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="72"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="131">%TRUE in case the element supports centering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="127">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="center"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="128">return location for the result</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="get_vflip" invoker="get_vflip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="83">Get the vertical flipping state (%TRUE for flipped) from the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="70"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="89">%TRUE in case the element supports flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="85">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="flip"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="86">return location for the result</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_hcenter" invoker="set_hcenter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="188">Set the horizontal centering offset for the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="76"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="194">%TRUE in case the element supports centering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="190">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="center" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="191">centering offset</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_hflip" invoker="set_hflip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="146">Set the horizontal flipping state (%TRUE for flipped) for the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="74"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="152">%TRUE in case the element supports flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="148">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="flip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="149">use flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_vcenter" invoker="set_vcenter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="209">Set the vertical centering offset for the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="77"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="215">%TRUE in case the element supports centering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="211">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="center" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="212">centering offset</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_vflip" invoker="set_vflip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="167">Set the vertical flipping state (%TRUE for flipped) for the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="75"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="173">%TRUE in case the element supports flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="169">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="flip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="170">use flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="get_hcenter"
- c:identifier="gst_video_orientation_get_hcenter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="104">Get the horizontal centering offset from the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="92"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="110">%TRUE in case the element supports centering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="106">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="center"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="107">return location for the result</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_hflip" c:identifier="gst_video_orientation_get_hflip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="62">Get the horizontal flipping state (%TRUE for flipped) from the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="86"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="68">%TRUE in case the element supports flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="64">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="flip"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="65">return location for the result</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_vcenter"
- c:identifier="gst_video_orientation_get_vcenter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="125">Get the vertical centering offset from the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="95"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="131">%TRUE in case the element supports centering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="127">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="center"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="128">return location for the result</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_vflip" c:identifier="gst_video_orientation_get_vflip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="83">Get the vertical flipping state (%TRUE for flipped) from the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="89"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="89">%TRUE in case the element supports flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="85">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="flip"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="86">return location for the result</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_hcenter"
- c:identifier="gst_video_orientation_set_hcenter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="188">Set the horizontal centering offset for the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="104"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="194">%TRUE in case the element supports centering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="190">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="center" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="191">centering offset</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_hflip" c:identifier="gst_video_orientation_set_hflip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="146">Set the horizontal flipping state (%TRUE for flipped) for the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="98"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="152">%TRUE in case the element supports flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="148">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="flip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="149">use flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_vcenter"
- c:identifier="gst_video_orientation_set_vcenter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="209">Set the vertical centering offset for the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="107"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="215">%TRUE in case the element supports centering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="211">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="center" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="212">centering offset</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_vflip" c:identifier="gst_video_orientation_set_vflip">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="167">Set the vertical flipping state (%TRUE for flipped) for the given object.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="101"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="173">%TRUE in case the element supports flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_orientation"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="169">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </instance-parameter>
- <parameter name="flip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="170">use flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- </interface>
- <record name="VideoOrientationInterface"
- c:type="GstVideoOrientationInterface"
- glib:is-gtype-struct-for="VideoOrientation">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.h"
- line="47">#GstVideoOrientationInterface interface.</doc>
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="78"/>
- <field name="iface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.h"
- line="49">parent interface type.</doc>
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- <field name="get_hflip">
- <callback name="get_hflip">
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="69"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="68">%TRUE in case the element supports flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="video_orientation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="64">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </parameter>
- <parameter name="flip"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="65">return location for the result</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_vflip">
- <callback name="get_vflip">
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="70"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="89">%TRUE in case the element supports flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="video_orientation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="85">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </parameter>
- <parameter name="flip"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="86">return location for the result</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_hcenter">
- <callback name="get_hcenter">
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="71"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="110">%TRUE in case the element supports centering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="video_orientation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="106">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </parameter>
- <parameter name="center"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="107">return location for the result</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="get_vcenter">
- <callback name="get_vcenter">
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="72"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="131">%TRUE in case the element supports centering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="video_orientation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="127">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </parameter>
- <parameter name="center"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="128">return location for the result</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_hflip">
- <callback name="set_hflip">
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="74"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="152">%TRUE in case the element supports flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="video_orientation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="148">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </parameter>
- <parameter name="flip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="149">use flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_vflip">
- <callback name="set_vflip">
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="75"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="173">%TRUE in case the element supports flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="video_orientation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="169">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </parameter>
- <parameter name="flip" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="170">use flipping</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_hcenter">
- <callback name="set_hcenter">
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="76"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="194">%TRUE in case the element supports centering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="video_orientation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="190">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </parameter>
- <parameter name="center" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="191">centering offset</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_vcenter">
- <callback name="set_vcenter">
- <source-position filename="gst-libs/gst/video/videoorientation.h"
- line="77"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="215">%TRUE in case the element supports centering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="video_orientation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="211">#GstVideoOrientation interface of a #GstElement</doc>
- <type name="VideoOrientation" c:type="GstVideoOrientation*"/>
- </parameter>
- <parameter name="center" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videoorientation.c"
- line="212">centering offset</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- </record>
- <enumeration name="VideoOrientationMethod"
- version="1.10"
- glib:type-name="GstVideoOrientationMethod"
- glib:get-type="gst_video_orientation_method_get_type"
- c:type="GstVideoOrientationMethod">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="62">The different video orientation methods.</doc>
- <member name="identity"
- value="0"
- c:identifier="GST_VIDEO_ORIENTATION_IDENTITY"
- glib:nick="identity">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="64">Identity (no rotation)</doc>
- </member>
- <member name="90r"
- value="1"
- c:identifier="GST_VIDEO_ORIENTATION_90R"
- glib:nick="90r">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="65">Rotate clockwise 90 degrees</doc>
- </member>
- <member name="180"
- value="2"
- c:identifier="GST_VIDEO_ORIENTATION_180"
- glib:nick="180">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="66">Rotate 180 degrees</doc>
- </member>
- <member name="90l"
- value="3"
- c:identifier="GST_VIDEO_ORIENTATION_90L"
- glib:nick="90l">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="67">Rotate counter-clockwise 90 degrees</doc>
- </member>
- <member name="horiz"
- value="4"
- c:identifier="GST_VIDEO_ORIENTATION_HORIZ"
- glib:nick="horiz">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="68">Flip horizontally</doc>
- </member>
- <member name="vert"
- value="5"
- c:identifier="GST_VIDEO_ORIENTATION_VERT"
- glib:nick="vert">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="69">Flip vertically</doc>
- </member>
- <member name="ul_lr"
- value="6"
- c:identifier="GST_VIDEO_ORIENTATION_UL_LR"
- glib:nick="ul-lr">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="70">Flip across upper left/lower right diagonal</doc>
- </member>
- <member name="ur_ll"
- value="7"
- c:identifier="GST_VIDEO_ORIENTATION_UR_LL"
- glib:nick="ur-ll">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="71">Flip across upper right/lower left diagonal</doc>
- </member>
- <member name="auto"
- value="8"
- c:identifier="GST_VIDEO_ORIENTATION_AUTO"
- glib:nick="auto">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="72">Select flip method based on image-orientation tag</doc>
- </member>
- <member name="custom"
- value="9"
- c:identifier="GST_VIDEO_ORIENTATION_CUSTOM"
- glib:nick="custom">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.h"
- line="73">Current status depends on plugin internal setup</doc>
- </member>
- </enumeration>
- <interface name="VideoOverlay"
- c:symbol-prefix="video_overlay"
- c:type="GstVideoOverlay"
- glib:type-name="GstVideoOverlay"
- glib:get-type="gst_video_overlay_get_type"
- glib:type-struct="VideoOverlayInterface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="20">The #GstVideoOverlay interface is used for 2 main purposes :
-
-* To get a grab on the Window where the video sink element is going to render.
- This is achieved by either being informed about the Window identifier that
- the video sink element generated, or by forcing the video sink element to use
- a specific Window identifier for rendering.
-* To force a redrawing of the latest video frame the video sink element
- displayed on the Window. Indeed if the #GstPipeline is in #GST_STATE_PAUSED
- state, moving the Window around will damage its content. Application
- developers will want to handle the Expose events themselves and force the
- video sink element to refresh the Window's content.
-
-Using the Window created by the video sink is probably the simplest scenario,
-in some cases, though, it might not be flexible enough for application
-developers if they need to catch events such as mouse moves and button
-clicks.
-
-Setting a specific Window identifier on the video sink element is the most
-flexible solution but it has some issues. Indeed the application needs to set
-its Window identifier at the right time to avoid internal Window creation
-from the video sink element. To solve this issue a #GstMessage is posted on
-the bus to inform the application that it should set the Window identifier
-immediately. Here is an example on how to do that correctly:
-|[
-static GstBusSyncReply
-create_window (GstBus * bus, GstMessage * message, GstPipeline * pipeline)
-{
- // ignore anything but 'prepare-window-handle' element messages
- if (!gst_is_video_overlay_prepare_window_handle_message (message))
- return GST_BUS_PASS;
-
- win = XCreateSimpleWindow (disp, root, 0, 0, 320, 240, 0, 0, 0);
-
- XSetWindowBackgroundPixmap (disp, win, None);
-
- XMapRaised (disp, win);
-
- XSync (disp, FALSE);
-
- gst_video_overlay_set_window_handle (GST_VIDEO_OVERLAY (GST_MESSAGE_SRC (message)),
- win);
-
- gst_message_unref (message);
-
- return GST_BUS_DROP;
-}
-...
-int
-main (int argc, char **argv)
-{
-...
- bus = gst_pipeline_get_bus (GST_PIPELINE (pipeline));
- gst_bus_set_sync_handler (bus, (GstBusSyncHandler) create_window, pipeline,
- NULL);
-...
-}
-]|
-
-## Two basic usage scenarios
-
-There are two basic usage scenarios: in the simplest case, the application
-uses #playbin or #playsink or knows exactly what particular element is used
-for video output, which is usually the case when the application creates
-the videosink to use (e.g. #xvimagesink, #ximagesink, etc.) itself; in this
-case, the application can just create the videosink element, create and
-realize the window to render the video on and then
-call gst_video_overlay_set_window_handle() directly with the XID or native
-window handle, before starting up the pipeline.
-As #playbin and #playsink implement the video overlay interface and proxy
-it transparently to the actual video sink even if it is created later, this
-case also applies when using these elements.
-
-In the other and more common case, the application does not know in advance
-what GStreamer video sink element will be used for video output. This is
-usually the case when an element such as #autovideosink is used.
-In this case, the video sink element itself is created
-asynchronously from a GStreamer streaming thread some time after the
-pipeline has been started up. When that happens, however, the video sink
-will need to know right then whether to render onto an already existing
-application window or whether to create its own window. This is when it
-posts a prepare-window-handle message, and that is also why this message needs
-to be handled in a sync bus handler which will be called from the streaming
-thread directly (because the video sink will need an answer right then).
-
-As response to the prepare-window-handle element message in the bus sync
-handler, the application may use gst_video_overlay_set_window_handle() to tell
-the video sink to render onto an existing window surface. At this point the
-application should already have obtained the window handle / XID, so it
-just needs to set it. It is generally not advisable to call any GUI toolkit
-functions or window system functions from the streaming thread in which the
-prepare-window-handle message is handled, because most GUI toolkits and
-windowing systems are not thread-safe at all and a lot of care would be
-required to co-ordinate the toolkit and window system calls of the
-different threads (Gtk+ users please note: prior to Gtk+ 2.18
-`GDK_WINDOW_XID` was just a simple structure access, so generally fine to do
-within the bus sync handler; this macro was changed to a function call in
-Gtk+ 2.18 and later, which is likely to cause problems when called from a
-sync handler; see below for a better approach without `GDK_WINDOW_XID`
-used in the callback).
-
-## GstVideoOverlay and Gtk+
-
-|[
-#include &amp;lt;gst/video/videooverlay.h&amp;gt;
-#include &amp;lt;gtk/gtk.h&amp;gt;
-#ifdef GDK_WINDOWING_X11
-#include &amp;lt;gdk/gdkx.h&amp;gt; // for GDK_WINDOW_XID
-#endif
-#ifdef GDK_WINDOWING_WIN32
-#include &amp;lt;gdk/gdkwin32.h&amp;gt; // for GDK_WINDOW_HWND
-#endif
-...
-static guintptr video_window_handle = 0;
-...
-static GstBusSyncReply
-bus_sync_handler (GstBus * bus, GstMessage * message, gpointer user_data)
-{
- // ignore anything but 'prepare-window-handle' element messages
- if (!gst_is_video_overlay_prepare_window_handle_message (message))
- return GST_BUS_PASS;
-
- if (video_window_handle != 0) {
- GstVideoOverlay *overlay;
-
- // GST_MESSAGE_SRC (message) will be the video sink element
- overlay = GST_VIDEO_OVERLAY (GST_MESSAGE_SRC (message));
- gst_video_overlay_set_window_handle (overlay, video_window_handle);
- } else {
- g_warning ("Should have obtained video_window_handle by now!");
- }
-
- gst_message_unref (message);
- return GST_BUS_DROP;
-}
-...
-static void
-video_widget_realize_cb (GtkWidget * widget, gpointer data)
-{
-#if GTK_CHECK_VERSION(2,18,0)
- // Tell Gtk+/Gdk to create a native window for this widget instead of
- // drawing onto the parent widget.
- // This is here just for pedagogical purposes, GDK_WINDOW_XID will call
- // it as well in newer Gtk versions
- if (!gdk_window_ensure_native (widget-&gt;window))
- g_error ("Couldn't create native window needed for GstVideoOverlay!");
-#endif
-
-#ifdef GDK_WINDOWING_X11
- {
- gulong xid = GDK_WINDOW_XID (gtk_widget_get_window (video_window));
- video_window_handle = xid;
- }
-#endif
-#ifdef GDK_WINDOWING_WIN32
- {
- HWND wnd = GDK_WINDOW_HWND (gtk_widget_get_window (video_window));
- video_window_handle = (guintptr) wnd;
- }
-#endif
-}
-...
-int
-main (int argc, char **argv)
-{
- GtkWidget *video_window;
- GtkWidget *app_window;
- ...
- app_window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
- ...
- video_window = gtk_drawing_area_new ();
- g_signal_connect (video_window, "realize",
- G_CALLBACK (video_widget_realize_cb), NULL);
- gtk_widget_set_double_buffered (video_window, FALSE);
- ...
- // usually the video_window will not be directly embedded into the
- // application window like this, but there will be many other widgets
- // and the video window will be embedded in one of them instead
- gtk_container_add (GTK_CONTAINER (ap_window), video_window);
- ...
- // show the GUI
- gtk_widget_show_all (app_window);
-
- // realize window now so that the video window gets created and we can
- // obtain its XID/HWND before the pipeline is started up and the videosink
- // asks for the XID/HWND of the window to render onto
- gtk_widget_realize (video_window);
-
- // we should have the XID/HWND now
- g_assert (video_window_handle != 0);
- ...
- // set up sync handler for setting the xid once the pipeline is started
- bus = gst_pipeline_get_bus (GST_PIPELINE (pipeline));
- gst_bus_set_sync_handler (bus, (GstBusSyncHandler) bus_sync_handler, NULL,
- NULL);
- gst_object_unref (bus);
- ...
- gst_element_set_state (pipeline, GST_STATE_PLAYING);
- ...
-}
-]|
-
-## GstVideoOverlay and Qt
-
-|[
-#include &lt;glib.h&gt;;
-#include &lt;gst/gst.h&gt;;
-#include &lt;gst/video/videooverlay.h&gt;;
-
-#include &lt;QApplication&gt;;
-#include &lt;QTimer&gt;;
-#include &lt;QWidget&gt;;
-
-int main(int argc, char *argv[])
-{
- if (!g_thread_supported ())
- g_thread_init (NULL);
-
- gst_init (&amp;argc, &amp;argv);
- QApplication app(argc, argv);
- app.connect(&amp;app, SIGNAL(lastWindowClosed()), &amp;app, SLOT(quit ()));
-
- // prepare the pipeline
-
- GstElement *pipeline = gst_pipeline_new ("xvoverlay");
- GstElement *src = gst_element_factory_make ("videotestsrc", NULL);
- GstElement *sink = gst_element_factory_make ("xvimagesink", NULL);
- gst_bin_add_many (GST_BIN (pipeline), src, sink, NULL);
- gst_element_link (src, sink);
-
- // prepare the ui
-
- QWidget window;
- window.resize(320, 240);
- window.show();
-
- WId xwinid = window.winId();
- gst_video_overlay_set_window_handle (GST_VIDEO_OVERLAY (sink), xwinid);
-
- // run the pipeline
-
- GstStateChangeReturn sret = gst_element_set_state (pipeline,
- GST_STATE_PLAYING);
- if (sret == GST_STATE_CHANGE_FAILURE) {
- gst_element_set_state (pipeline, GST_STATE_NULL);
- gst_object_unref (pipeline);
- // Exit application
- QTimer::singleShot(0, QApplication::activeWindow(), SLOT(quit()));
- }
-
- int ret = app.exec();
-
- window.hide();
- gst_element_set_state (pipeline, GST_STATE_NULL);
- gst_object_unref (pipeline);
-
- return ret;
-}
-]|</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h" line="70"/>
- <function name="install_properties"
- c:identifier="gst_video_overlay_install_properties"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="518">This helper shall be used by classes implementing the #GstVideoOverlay
-interface that want the render rectangle to be controllable using
-properties. This helper will install "render-rectangle" property into the
-class.</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="108"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="oclass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="520">The class on which the properties will be installed</doc>
- <type name="GObject.ObjectClass" c:type="GObjectClass*"/>
- </parameter>
- <parameter name="last_prop_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="521">The first free property ID to use</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="set_property"
- c:identifier="gst_video_overlay_set_property"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="542">This helper shall be used by classes implementing the #GstVideoOverlay
-interface that want the render rectangle to be controllable using
-properties. This helper will parse and set the render rectangle calling
-gst_video_overlay_set_render_rectangle().</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="554">%TRUE if the @property_id matches the GstVideoOverlay property</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="544">The instance on which the property is set</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="last_prop_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="545">The highest property ID.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="property_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="546">The property ID</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="547">The #GValue to be set</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="expose" invoker="expose">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="407">Tell an overlay that it has been exposed. This will redraw the current frame
-in the drawable even if the pipeline is PAUSED.</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="61"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="overlay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="409">a #GstVideoOverlay to expose.</doc>
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="handle_events" invoker="handle_events">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="429">Tell an overlay that it should handle events from the window system. These
-events are forwarded upstream as navigation events. In some window system,
-events are not propagated in the window hierarchy if a client is listening
-for them. This method allows you to disable events handling completely
-from the #GstVideoOverlay.</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="63"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="overlay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="431">a #GstVideoOverlay to expose.</doc>
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </instance-parameter>
- <parameter name="handle_events" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="432">a #gboolean indicating if events should be handled or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_render_rectangle">
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="65"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="overlay" transfer-ownership="none">
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </instance-parameter>
- <parameter name="x" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_window_handle" invoker="set_window_handle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="330">This will call the video overlay's set_window_handle method. You
-should use this method to tell to an overlay to display video output to a
-specific window (e.g. an XWindow on X11). Passing 0 as the @handle will
-tell the overlay to stop using that window and create an internal one.</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="69"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="overlay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="332">a #GstVideoOverlay to set the window on.</doc>
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </instance-parameter>
- <parameter name="handle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="333">a handle referencing the window.</doc>
- <type name="guintptr" c:type="guintptr"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="expose" c:identifier="gst_video_overlay_expose">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="407">Tell an overlay that it has been exposed. This will redraw the current frame
-in the drawable even if the pipeline is PAUSED.</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="85"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="overlay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="409">a #GstVideoOverlay to expose.</doc>
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="got_window_handle"
- c:identifier="gst_video_overlay_got_window_handle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="355">This will post a "have-window-handle" element message on the bus.
-
-This function should only be used by video overlay plugin developers.</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="98"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="overlay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="357">a #GstVideoOverlay which got a window</doc>
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </instance-parameter>
- <parameter name="handle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="358">a platform-specific handle referencing the window</doc>
- <type name="guintptr" c:type="guintptr"/>
- </parameter>
- </parameters>
- </method>
- <method name="handle_events"
- c:identifier="gst_video_overlay_handle_events">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="429">Tell an overlay that it should handle events from the window system. These
-events are forwarded upstream as navigation events. In some window system,
-events are not propagated in the window hierarchy if a client is listening
-for them. This method allows you to disable events handling completely
-from the #GstVideoOverlay.</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="88"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="overlay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="431">a #GstVideoOverlay to expose.</doc>
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </instance-parameter>
- <parameter name="handle_events" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="432">a #gboolean indicating if events should be handled or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="prepare_window_handle"
- c:identifier="gst_video_overlay_prepare_window_handle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="381">This will post a "prepare-window-handle" element message on the bus
-to give applications an opportunity to call
-gst_video_overlay_set_window_handle() before a plugin creates its own
-window.
-
-This function should only be used by video overlay plugin developers.</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="102"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="overlay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="383">a #GstVideoOverlay which does not yet have an Window handle set</doc>
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_render_rectangle"
- c:identifier="gst_video_overlay_set_render_rectangle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="456">Configure a subregion as a video target within the window set by
-gst_video_overlay_set_window_handle(). If this is not used or not supported
-the video will fill the area of the window set as the overlay to 100%.
-By specifying the rectangle, the video can be overlayed to a specific region
-of that window only. After setting the new rectangle one should call
-gst_video_overlay_expose() to force a redraw. To unset the region pass -1 for
-the @width and @height parameters.
-
-This method is needed for non fullscreen video overlay in UI toolkits that
-do not support subwindows.</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="78"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="475">%FALSE if not supported by the sink.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="overlay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="458">a #GstVideoOverlay</doc>
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </instance-parameter>
- <parameter name="x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="459">the horizontal offset of the render area inside the window</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="460">the vertical offset of the render area inside the window</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="461">the width of the render area inside the window</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="462">the height of the render area inside the window</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_window_handle"
- c:identifier="gst_video_overlay_set_window_handle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="330">This will call the video overlay's set_window_handle method. You
-should use this method to tell to an overlay to display video output to a
-specific window (e.g. an XWindow on X11). Passing 0 as the @handle will
-tell the overlay to stop using that window and create an internal one.</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="92"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="overlay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="332">a #GstVideoOverlay to set the window on.</doc>
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </instance-parameter>
- <parameter name="handle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="333">a handle referencing the window.</doc>
- <type name="guintptr" c:type="guintptr"/>
- </parameter>
- </parameters>
- </method>
- </interface>
- <record name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition"
- glib:type-name="GstVideoOverlayComposition"
- glib:get-type="gst_video_overlay_composition_get_type"
- c:symbol-prefix="video_overlay_composition">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="22">Functions to create and handle overlay compositions on video buffers.
-
-An overlay composition describes one or more overlay rectangles to be
-blended on top of a video buffer.
-
-This API serves two main purposes:
-
-* it can be used to attach overlay information (subtitles or logos)
- to non-raw video buffers such as GL/VAAPI/VDPAU surfaces. The actual
- blending of the overlay can then be done by e.g. the video sink that
- processes these non-raw buffers.
-
-* it can also be used to blend overlay rectangles on top of raw video
- buffers, thus consolidating blending functionality for raw video in
- one place.
-
-Together, this allows existing overlay elements to easily handle raw
-and non-raw video as input in without major changes (once the overlays
-have been put into a #GstVideoOverlayComposition object anyway) - for raw
-video the overlay can just use the blending function to blend the data
-on top of the video, and for surface buffers it can just attach them to
-the buffer and let the sink render the overlays.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="202"/>
- <constructor name="new" c:identifier="gst_video_overlay_composition_new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="328">Creates a new video overlay composition object to hold one or more
-overlay rectangles.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="245"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="336">a new #GstVideoOverlayComposition. Unref with
- gst_video_overlay_composition_unref() when no longer needed.</doc>
- <type name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition*"/>
- </return-value>
- <parameters>
- <parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="330">a #GstVideoOverlayRectangle to add to the
- composition</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="add_rectangle"
- c:identifier="gst_video_overlay_composition_add_rectangle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="374">Adds an overlay rectangle to an existing overlay composition object. This
-must be done right after creating the overlay composition.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="248"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="comp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="376">a #GstVideoOverlayComposition</doc>
- <type name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition*"/>
- </instance-parameter>
- <parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="377">a #GstVideoOverlayRectangle to add to the
- composition</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </parameter>
- </parameters>
- </method>
- <method name="blend" c:identifier="gst_video_overlay_composition_blend">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="455">Blends the overlay rectangles in @comp on top of the raw video data
-contained in @video_buf. The data in @video_buf must be writable and
-mapped appropriately.
-
-Since @video_buf data is read and will be modified, it ought be
-mapped with flag GST_MAP_READWRITE.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="263"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="comp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="457">a #GstVideoOverlayComposition</doc>
- <type name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition*"/>
- </instance-parameter>
- <parameter name="video_buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="458">a #GstVideoFrame containing raw video data in a
- supported format. It should be mapped using GST_MAP_READWRITE</doc>
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_video_overlay_composition_copy">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="532">Makes a copy of @comp and all contained rectangles, so that it is possible
-to modify the composition and contained rectangles (e.g. add additional
-rectangles or change the render co-ordinates or render dimension). The
-actual overlay pixel data buffers contained in the rectangles are not
-copied.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="239"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="542">a new #GstVideoOverlayComposition equivalent
- to @comp.</doc>
- <type name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition*"/>
- </return-value>
- <parameters>
- <instance-parameter name="comp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="534">a #GstVideoOverlayComposition to copy</doc>
- <type name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_rectangle"
- c:identifier="gst_video_overlay_composition_get_rectangle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="424">Returns the @n-th #GstVideoOverlayRectangle contained in @comp.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="255"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="431">the @n-th rectangle, or NULL if @n is out of
- bounds. Will not return a new reference, the caller will need to
- obtain her own reference using gst_video_overlay_rectangle_ref()
- if needed.</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </return-value>
- <parameters>
- <instance-parameter name="comp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="426">a #GstVideoOverlayComposition</doc>
- <type name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition*"/>
- </instance-parameter>
- <parameter name="n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="427">number of the rectangle to get</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_seqnum"
- c:identifier="gst_video_overlay_composition_get_seqnum">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="609">Returns the sequence number of this composition. Sequence numbers are
-monotonically increasing and unique for overlay compositions and rectangles
-(meaning there will never be a rectangle with the same sequence number as
-a composition).</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="258"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="618">the sequence number of @comp</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="comp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="611">a #GstVideoOverlayComposition</doc>
- <type name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="make_writable"
- c:identifier="gst_video_overlay_composition_make_writable">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="570">Takes ownership of @comp and returns a version of @comp that is writable
-(i.e. can be modified). Will either return @comp right away, or create a
-new writable copy of @comp and unref @comp itself. All the contained
-rectangles will also be copied, but the actual overlay pixel data buffers
-contained in the rectangles are not copied.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="242"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="580">a writable #GstVideoOverlayComposition
- equivalent to @comp.</doc>
- <type name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition*"/>
- </return-value>
- <parameters>
- <instance-parameter name="comp" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="572">a #GstVideoOverlayComposition to copy</doc>
- <type name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="n_rectangles"
- c:identifier="gst_video_overlay_composition_n_rectangles">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="408">Returns the number of #GstVideoOverlayRectangle&lt;!-- --&gt;s contained in @comp.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="252"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="414">the number of rectangles</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="comp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="410">a #GstVideoOverlayComposition</doc>
- <type name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <record name="VideoOverlayCompositionMeta"
- c:type="GstVideoOverlayCompositionMeta">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.h"
- line="275">Extra buffer metadata describing image overlay data.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="287"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.h"
- line="277">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="overlay" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.h"
- line="278">the attached #GstVideoOverlayComposition</doc>
- <type name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition*"/>
- </field>
- <function name="get_info"
- c:identifier="gst_video_overlay_composition_meta_get_info">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="293"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <bitfield name="VideoOverlayFormatFlags"
- glib:type-name="GstVideoOverlayFormatFlags"
- glib:get-type="gst_video_overlay_format_flags_get_type"
- c:type="GstVideoOverlayFormatFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.h"
- line="80">Overlay format flags.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.h"
- line="82">no flags</doc>
- </member>
- <member name="premultiplied_alpha"
- value="1"
- c:identifier="GST_VIDEO_OVERLAY_FORMAT_FLAG_PREMULTIPLIED_ALPHA"
- glib:nick="premultiplied-alpha">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.h"
- line="83">RGB are premultiplied by A/255.</doc>
- </member>
- <member name="global_alpha"
- value="2"
- c:identifier="GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA"
- glib:nick="global-alpha">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.h"
- line="84">a global-alpha value != 1 is set.</doc>
- </member>
- </bitfield>
- <record name="VideoOverlayInterface"
- c:type="GstVideoOverlayInterface"
- glib:is-gtype-struct-for="VideoOverlay">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.h"
- line="47">#GstVideoOverlay interface</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h" line="70"/>
- <field name="iface">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.h"
- line="49">parent interface type.</doc>
- <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
- </field>
- <field name="expose">
- <callback name="expose">
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="61"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="overlay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="409">a #GstVideoOverlay to expose.</doc>
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="handle_events">
- <callback name="handle_events">
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="63"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="overlay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="431">a #GstVideoOverlay to expose.</doc>
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </parameter>
- <parameter name="handle_events" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="432">a #gboolean indicating if events should be handled or not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_render_rectangle">
- <callback name="set_render_rectangle">
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="65"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="overlay" transfer-ownership="none">
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </parameter>
- <parameter name="x" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_window_handle">
- <callback name="set_window_handle">
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="69"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="overlay" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="332">a #GstVideoOverlay to set the window on.</doc>
- <type name="VideoOverlay" c:type="GstVideoOverlay*"/>
- </parameter>
- <parameter name="handle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="333">a handle referencing the window.</doc>
- <type name="guintptr" c:type="guintptr"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- </record>
- <record name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle"
- glib:type-name="GstVideoOverlayRectangle"
- glib:get-type="gst_video_overlay_rectangle_get_type"
- c:symbol-prefix="video_overlay_rectangle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.h"
- line="30">An opaque video overlay rectangle object. A rectangle contains a single
-overlay rectangle which can be added to a composition.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="45"/>
- <constructor name="new_raw"
- c:identifier="gst_video_overlay_rectangle_new_raw">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="674">Creates a new video overlay rectangle with ARGB or AYUV pixel data.
-The layout in case of ARGB of the components in memory is B-G-R-A
-on little-endian platforms
-(corresponding to #GST_VIDEO_FORMAT_BGRA) and A-R-G-B on big-endian
-platforms (corresponding to #GST_VIDEO_FORMAT_ARGB). In other words,
-pixels are treated as 32-bit words and the lowest 8 bits then contain
-the blue component value and the highest 8 bits contain the alpha
-component value. Unless specified in the flags, the RGB values are
-non-premultiplied. This is the format that is used by most hardware,
-and also many rendering libraries such as Cairo, for example.
-The pixel data buffer must have #GstVideoMeta set.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="128"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="697">a new #GstVideoOverlayRectangle. Unref with
- gst_video_overlay_rectangle_unref() when no longer needed.</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </return-value>
- <parameters>
- <parameter name="pixels" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="676">a #GstBuffer pointing to the pixel memory</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="render_x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="677">the X co-ordinate on the video where the top-left corner of this
- overlay rectangle should be rendered to</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="render_y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="679">the Y co-ordinate on the video where the top-left corner of this
- overlay rectangle should be rendered to</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="render_width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="681">the render width of this rectangle on the video</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="render_height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="682">the render height of this rectangle on the video</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="683">flags</doc>
- <type name="VideoOverlayFormatFlags"
- c:type="GstVideoOverlayFormatFlags"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="copy" c:identifier="gst_video_overlay_rectangle_copy">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1587">Makes a copy of @rectangle, so that it is possible to modify it
-(e.g. to change the render co-ordinates or render dimension). The
-actual overlay pixel data buffers contained in the rectangle are not
-copied.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="134"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1596">a new #GstVideoOverlayRectangle equivalent
- to @rectangle.</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1589">a #GstVideoOverlayRectangle to copy</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_flags"
- c:identifier="gst_video_overlay_rectangle_get_flags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1512">Retrieves the flags associated with a #GstVideoOverlayRectangle.
-This is useful if the caller can handle both premultiplied alpha and
-non premultiplied alpha, for example. By knowing whether the rectangle
-uses premultiplied or not, it can request the pixel data in the format
-it is stored in, to avoid unnecessary conversion.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="178"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1522">the #GstVideoOverlayFormatFlags associated with the rectangle.</doc>
- <type name="VideoOverlayFormatFlags"
- c:type="GstVideoOverlayFormatFlags"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1514">a #GstVideoOverlayRectangle</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_global_alpha"
- c:identifier="gst_video_overlay_rectangle_get_global_alpha">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1533">Retrieves the global-alpha value associated with a #GstVideoOverlayRectangle.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="181"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1539">the global-alpha value associated with the rectangle.</doc>
- <type name="gfloat" c:type="gfloat"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1535">a #GstVideoOverlayRectangle</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_pixels_argb"
- c:identifier="gst_video_overlay_rectangle_get_pixels_argb">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="158"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1391">a #GstBuffer holding the ARGB pixel data with
- width and height of the render dimensions as per
- gst_video_overlay_rectangle_get_render_rectangle(). This function does
- not return a reference, the caller should obtain a reference of her own
- with gst_buffer_ref() if needed.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1384">a #GstVideoOverlayRectangle</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1385">flags
- If a global_alpha value != 1 is set for the rectangle, the caller
- should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
- if he wants to apply global-alpha himself. If the flag is not set
- global_alpha is applied internally before returning the pixel-data.</doc>
- <type name="VideoOverlayFormatFlags"
- c:type="GstVideoOverlayFormatFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pixels_ayuv"
- c:identifier="gst_video_overlay_rectangle_get_pixels_ayuv">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="162"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1414">a #GstBuffer holding the AYUV pixel data with
- width and height of the render dimensions as per
- gst_video_overlay_rectangle_get_render_rectangle(). This function does
- not return a reference, the caller should obtain a reference of her own
- with gst_buffer_ref() if needed.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1407">a #GstVideoOverlayRectangle</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1408">flags
- If a global_alpha value != 1 is set for the rectangle, the caller
- should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
- if he wants to apply global-alpha himself. If the flag is not set
- global_alpha is applied internally before returning the pixel-data.</doc>
- <type name="VideoOverlayFormatFlags"
- c:type="GstVideoOverlayFormatFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pixels_raw"
- c:identifier="gst_video_overlay_rectangle_get_pixels_raw">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="154"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1367">a #GstBuffer holding the pixel data with
- format as originally provided and specified in video meta with
- width and height of the render dimensions as per
- gst_video_overlay_rectangle_get_render_rectangle(). This function does
- not return a reference, the caller should obtain a reference of her own
- with gst_buffer_ref() if needed.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1360">a #GstVideoOverlayRectangle</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1361">flags
- If a global_alpha value != 1 is set for the rectangle, the caller
- should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
- if he wants to apply global-alpha himself. If the flag is not set
- global_alpha is applied internally before returning the pixel-data.</doc>
- <type name="VideoOverlayFormatFlags"
- c:type="GstVideoOverlayFormatFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pixels_unscaled_argb"
- c:identifier="gst_video_overlay_rectangle_get_pixels_unscaled_argb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1456">Retrieves the pixel data as it is. This is useful if the caller can
-do the scaling itself when handling the overlaying. The rectangle will
-need to be scaled to the render dimensions, which can be retrieved using
-gst_video_overlay_rectangle_get_render_rectangle().</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="170"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1470">a #GstBuffer holding the ARGB pixel data with
- #GstVideoMeta set. This function does not return a reference, the caller
- should obtain a reference of her own with gst_buffer_ref() if needed.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1458">a #GstVideoOverlayRectangle</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1459">flags.
- If a global_alpha value != 1 is set for the rectangle, the caller
- should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
- if he wants to apply global-alpha himself. If the flag is not set
- global_alpha is applied internally before returning the pixel-data.</doc>
- <type name="VideoOverlayFormatFlags"
- c:type="GstVideoOverlayFormatFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pixels_unscaled_ayuv"
- c:identifier="gst_video_overlay_rectangle_get_pixels_unscaled_ayuv">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1484">Retrieves the pixel data as it is. This is useful if the caller can
-do the scaling itself when handling the overlaying. The rectangle will
-need to be scaled to the render dimensions, which can be retrieved using
-gst_video_overlay_rectangle_get_render_rectangle().</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="174"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1498">a #GstBuffer holding the AYUV pixel data with
- #GstVideoMeta set. This function does not return a reference, the caller
- should obtain a reference of her own with gst_buffer_ref() if needed.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1486">a #GstVideoOverlayRectangle</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1487">flags.
- If a global_alpha value != 1 is set for the rectangle, the caller
- should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
- if he wants to apply global-alpha himself. If the flag is not set
- global_alpha is applied internally before returning the pixel-data.</doc>
- <type name="VideoOverlayFormatFlags"
- c:type="GstVideoOverlayFormatFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_pixels_unscaled_raw"
- c:identifier="gst_video_overlay_rectangle_get_pixels_unscaled_raw">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1428">Retrieves the pixel data as it is. This is useful if the caller can
-do the scaling itself when handling the overlaying. The rectangle will
-need to be scaled to the render dimensions, which can be retrieved using
-gst_video_overlay_rectangle_get_render_rectangle().</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="166"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1442">a #GstBuffer holding the pixel data with
- #GstVideoMeta set. This function does not return a reference, the caller
- should obtain a reference of her own with gst_buffer_ref() if needed.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1430">a #GstVideoOverlayRectangle</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1431">flags.
- If a global_alpha value != 1 is set for the rectangle, the caller
- should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
- if he wants to apply global-alpha himself. If the flag is not set
- global_alpha is applied internally before returning the pixel-data.</doc>
- <type name="VideoOverlayFormatFlags"
- c:type="GstVideoOverlayFormatFlags"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_render_rectangle"
- c:identifier="gst_video_overlay_rectangle_get_render_rectangle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="774">Retrieves the render position and render dimension of the overlay
-rectangle on the video.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="147"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="785">TRUE if valid render dimensions were retrieved.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="776">a #GstVideoOverlayRectangle</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- <parameter name="render_x"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="777">address where to store the X render offset</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="render_y"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="778">address where to store the Y render offset</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="render_width"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="779">address where to store the render width</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="render_height"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="780">address where to store the render height</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_seqnum"
- c:identifier="gst_video_overlay_rectangle_get_seqnum">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1616">Returns the sequence number of this rectangle. Sequence numbers are
-monotonically increasing and unique for overlay compositions and rectangles
-(meaning there will never be a rectangle with the same sequence number as
-a composition).
-
-Using the sequence number of a rectangle as an indicator for changed
-pixel-data of a rectangle is dangereous. Some API calls, like e.g.
-gst_video_overlay_rectangle_set_global_alpha(), automatically update
-the per rectangle sequence number, which is misleading for renderers/
-consumers, that handle global-alpha themselves. For them the
-pixel-data returned by gst_video_overlay_rectangle_get_pixels_*()
-won't be different for different global-alpha values. In this case a
-renderer could also use the GstBuffer pointers as a hint for changed
-pixel-data.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="137"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1635">the sequence number of @rectangle</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1618">a #GstVideoOverlayRectangle</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_global_alpha"
- c:identifier="gst_video_overlay_rectangle_set_global_alpha">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1550">Sets the global alpha value associated with a #GstVideoOverlayRectangle. Per-
-pixel alpha values are multiplied with this value. Valid
-values: 0 &lt;= global_alpha &lt;= 1; 1 to deactivate.
-
-@rectangle must be writable, meaning its refcount must be 1. You can
-make the rectangles inside a #GstVideoOverlayComposition writable using
-gst_video_overlay_composition_make_writable() or
-gst_video_overlay_composition_copy().</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="184"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1552">a #GstVideoOverlayRectangle</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- <parameter name="global_alpha" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="1553">Global alpha value (0 to 1.0)</doc>
- <type name="gfloat" c:type="gfloat"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_render_rectangle"
- c:identifier="gst_video_overlay_rectangle_set_render_rectangle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="806">Sets the render position and dimensions of the rectangle on the video.
-This function is mainly for elements that modify the size of the video
-in some way (e.g. through scaling or cropping) and need to adjust the
-details of any overlays to match the operation that changed the size.
-
-@rectangle must be writable, meaning its refcount must be 1. You can
-make the rectangles inside a #GstVideoOverlayComposition writable using
-gst_video_overlay_composition_make_writable() or
-gst_video_overlay_composition_copy().</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="140"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rectangle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="808">a #GstVideoOverlayRectangle</doc>
- <type name="VideoOverlayRectangle"
- c:type="GstVideoOverlayRectangle*"/>
- </instance-parameter>
- <parameter name="render_x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="809">render X position of rectangle on video</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="render_y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="810">render Y position of rectangle on video</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="render_width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="811">render width of rectangle</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="render_height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="812">render height of rectangle</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <bitfield name="VideoPackFlags"
- glib:type-name="GstVideoPackFlags"
- glib:get-type="gst_video_pack_flags_get_type"
- c:type="GstVideoPackFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="317">The different flags that can be used when packing and unpacking.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_PACK_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="319">No flag</doc>
- </member>
- <member name="truncate_range"
- value="1"
- c:identifier="GST_VIDEO_PACK_FLAG_TRUNCATE_RANGE"
- glib:nick="truncate-range">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="320">When the source has a smaller depth
- than the target format, set the least significant bits of the target
- to 0. This is likely slightly faster but less accurate. When this flag
- is not specified, the most significant bits of the source are duplicated
- in the least significant bits of the destination.</doc>
- </member>
- <member name="interlaced"
- value="2"
- c:identifier="GST_VIDEO_PACK_FLAG_INTERLACED"
- glib:nick="interlaced">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.h"
- line="325">The source is interlaced. The unpacked
- format will be interlaced as well with each line containing
- information from alternating fields. (Since: 1.2)</doc>
- </member>
- </bitfield>
- <enumeration name="VideoPrimariesMode"
- version="1.6"
- glib:type-name="GstVideoPrimariesMode"
- glib:get-type="gst_video_primaries_mode_get_type"
- c:type="GstVideoPrimariesMode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="244">Different primaries conversion modes</doc>
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_PRIMARIES_MODE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="246">disable conversion between primaries</doc>
- </member>
- <member name="merge_only"
- value="1"
- c:identifier="GST_VIDEO_PRIMARIES_MODE_MERGE_ONLY"
- glib:nick="merge-only">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="247">do conversion between primaries only
- when it can be merged with color matrix conversion.</doc>
- </member>
- <member name="fast"
- value="2"
- c:identifier="GST_VIDEO_PRIMARIES_MODE_FAST"
- glib:nick="fast">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.h"
- line="249">fast conversion between primaries</doc>
- </member>
- </enumeration>
- <record name="VideoRectangle" c:type="GstVideoRectangle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="68">Helper structure representing a rectangular area.</doc>
- <source-position filename="gst-libs/gst/video/gstvideosink.h" line="82"/>
- <field name="x" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="70">X coordinate of rectangle's top-left point</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="y" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="71">Y coordinate of rectangle's top-left point</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="w" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="72">width of the rectangle</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="h" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="73">height of the rectangle</doc>
- <type name="gint" c:type="gint"/>
- </field>
- </record>
- <record name="VideoRegionOfInterestMeta"
- c:type="GstVideoRegionOfInterestMeta">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="304">Extra buffer metadata describing an image region of interest</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="332"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="306">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="roi_type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="307">GQuark describing the semantic of the Roi (f.i. a face, a pedestrian)</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </field>
- <field name="id" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="308">identifier of this particular ROI</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="parent_id" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="309">identifier of its parent ROI, used f.i. for ROI hierarchisation.</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="x" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="310">x component of upper-left corner</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="y" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="311">y component of upper-left corner</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="w" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="312">bounding box width</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="h" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="313">bounding box height</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="params" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="314">list of #GstStructure containing element-specific params for downstream,
- see gst_video_region_of_interest_meta_add_param(). (Since: 1.14)</doc>
- <type name="GLib.List" c:type="GList*">
- <type name="gpointer" c:type="gpointer"/>
- </type>
- </field>
- <method name="add_param"
- c:identifier="gst_video_region_of_interest_meta_add_param"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1003">Attach element-specific parameters to @meta meant to be used by downstream
-elements which may handle this ROI.
-The name of @s is used to identify the element these parameters are meant for.
-
-This is typically used to tell encoders how they should encode this specific region.
-For example, a structure named "roi/x264enc" could be used to give the
-QP offsets this encoder should use when encoding the region described in @meta.
-Multiple parameters can be defined for the same meta so different encoders
-can be supported by cross platform applications).</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="363"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1005">a #GstVideoRegionOfInterestMeta</doc>
- <type name="VideoRegionOfInterestMeta"
- c:type="GstVideoRegionOfInterestMeta*"/>
- </instance-parameter>
- <parameter name="s" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1006">a #GstStructure</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_param"
- c:identifier="gst_video_region_of_interest_meta_get_param"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1030">Retrieve the parameter for @meta having @name as structure name,
-or %NULL if there is none.</doc>
- <doc-version xml:space="preserve">
-See also: gst_video_region_of_interest_meta_add_param()</doc-version>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="367"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1038">a #GstStructure</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </return-value>
- <parameters>
- <instance-parameter name="meta" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1032">a #GstVideoRegionOfInterestMeta</doc>
- <type name="VideoRegionOfInterestMeta"
- c:type="GstVideoRegionOfInterestMeta*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1033">a name.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <function name="get_info"
- c:identifier="gst_video_region_of_interest_meta_get_info">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="338"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <record name="VideoResampler" c:type="GstVideoResampler" version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.c"
- line="52">#GstVideoResampler is a structure which holds the information
-required to perform various kinds of resampling filtering.</doc>
- <source-position filename="gst-libs/gst/video/video-resampler.h"
- line="161"/>
- <field name="in_size" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="135">the input size</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="out_size" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="136">the output size</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="max_taps" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="137">the maximum number of taps</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="n_phases" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="138">the number of phases</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="offset" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="139">array with the source offset for each output element</doc>
- <type name="guint32" c:type="guint32*"/>
- </field>
- <field name="phase" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="140">array with the phase to use for each output element</doc>
- <type name="guint32" c:type="guint32*"/>
- </field>
- <field name="n_taps" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="141">array with new number of taps for each phase</doc>
- <type name="guint32" c:type="guint32*"/>
- </field>
- <field name="taps" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="142">the taps for all phases</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <method name="clear"
- c:identifier="gst_video_resampler_clear"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.c"
- line="431">Clear a previously initialized #GstVideoResampler @resampler.</doc>
- <source-position filename="gst-libs/gst/video/video-resampler.h"
- line="174"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="resampler" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.c"
- line="433">a #GstVideoResampler</doc>
- <type name="VideoResampler" c:type="GstVideoResampler*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init" c:identifier="gst_video_resampler_init">
- <source-position filename="gst-libs/gst/video/video-resampler.h"
- line="165"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="resampler" transfer-ownership="none">
- <type name="VideoResampler" c:type="GstVideoResampler*"/>
- </instance-parameter>
- <parameter name="method" transfer-ownership="none">
- <type name="VideoResamplerMethod"
- c:type="GstVideoResamplerMethod"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <type name="VideoResamplerFlags" c:type="GstVideoResamplerFlags"/>
- </parameter>
- <parameter name="n_phases" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="n_taps" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="shift" transfer-ownership="none">
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- <parameter name="in_size" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="out_size" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="options" transfer-ownership="none">
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <bitfield name="VideoResamplerFlags"
- version="1.6"
- glib:type-name="GstVideoResamplerFlags"
- glib:get-type="gst_video_resampler_flags_get_type"
- c:type="GstVideoResamplerFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="117">Different resampler flags.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_RESAMPLER_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="119">no flags</doc>
- </member>
- <member name="half_taps"
- value="1"
- c:identifier="GST_VIDEO_RESAMPLER_FLAG_HALF_TAPS"
- glib:nick="half-taps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="120">when no taps are given, half the
- number of calculated taps. This can be used when making scalers
- for the different fields of an interlaced picture. Since: 1.10</doc>
- </member>
- </bitfield>
- <enumeration name="VideoResamplerMethod"
- version="1.6"
- glib:type-name="GstVideoResamplerMethod"
- glib:get-type="gst_video_resampler_method_get_type"
- c:type="GstVideoResamplerMethod">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="30">Different subsampling and upsampling methods</doc>
- <member name="nearest"
- value="0"
- c:identifier="GST_VIDEO_RESAMPLER_METHOD_NEAREST"
- glib:nick="nearest">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="32">Duplicates the samples when
- upsampling and drops when downsampling</doc>
- </member>
- <member name="linear"
- value="1"
- c:identifier="GST_VIDEO_RESAMPLER_METHOD_LINEAR"
- glib:nick="linear">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="34">Uses linear interpolation to reconstruct
- missing samples and averaging to downsample</doc>
- </member>
- <member name="cubic"
- value="2"
- c:identifier="GST_VIDEO_RESAMPLER_METHOD_CUBIC"
- glib:nick="cubic">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="36">Uses cubic interpolation</doc>
- </member>
- <member name="sinc"
- value="3"
- c:identifier="GST_VIDEO_RESAMPLER_METHOD_SINC"
- glib:nick="sinc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="37">Uses sinc interpolation</doc>
- </member>
- <member name="lanczos"
- value="4"
- c:identifier="GST_VIDEO_RESAMPLER_METHOD_LANCZOS"
- glib:nick="lanczos">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-resampler.h"
- line="38">Uses lanczos interpolation</doc>
- </member>
- </enumeration>
- <record name="VideoScaler" c:type="GstVideoScaler" disguised="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="28">#GstVideoScaler is a utility object for rescaling and resampling
-video frames using various interpolation / sampling methods.</doc>
- <source-position filename="gst-libs/gst/video/video-scaler.h" line="51"/>
- <method name="2d" c:identifier="gst_video_scaler_2d">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1419">Scale a rectangle of pixels in @src with @src_stride to @dest with
-@dest_stride using the horizontal scaler @hscaler and the vertical
-scaler @vscale.
-
-One or both of @hscale and @vscale can be NULL to only perform scaling in
-one dimension or do a copy without scaling.
-
-@x and @y are the coordinates in the destination image to process.</doc>
- <source-position filename="gst-libs/gst/video/video-scaler.h"
- line="91"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="hscale" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1421">a horizontal #GstVideoScaler</doc>
- <type name="VideoScaler" c:type="GstVideoScaler*"/>
- </instance-parameter>
- <parameter name="vscale" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1422">a vertical #GstVideoScaler</doc>
- <type name="VideoScaler" c:type="GstVideoScaler*"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1423">a #GstVideoFormat for @srcs and @dest</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1424">source pixels</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="src_stride" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1425">source pixels stride</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="dest"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1426">destination pixels</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="dest_stride" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1427">destination pixels stride</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1428">the horizontal destination offset</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1429">the vertical destination offset</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1430">the number of output pixels to scale</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1431">the number of output lines to scale</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="combine_packed_YUV"
- c:identifier="gst_video_scaler_combine_packed_YUV"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1121">Combine a scaler for Y and UV into one scaler for the packed @format.</doc>
- <source-position filename="gst-libs/gst/video/video-scaler.h"
- line="85"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1130">a new horizontal videoscaler for @format.</doc>
- <type name="VideoScaler" c:type="GstVideoScaler*"/>
- </return-value>
- <parameters>
- <instance-parameter name="y_scale" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1123">a scaler for the Y component</doc>
- <type name="VideoScaler" c:type="GstVideoScaler*"/>
- </instance-parameter>
- <parameter name="uv_scale" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1124">a scaler for the U and V components</doc>
- <type name="VideoScaler" c:type="GstVideoScaler*"/>
- </parameter>
- <parameter name="in_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1125">the input video format</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="out_format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1126">the output video format</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_video_scaler_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="265">Free a previously allocated #GstVideoScaler @scale.</doc>
- <source-position filename="gst-libs/gst/video/video-scaler.h"
- line="61"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="scale" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="267">a #GstVideoScaler</doc>
- <type name="VideoScaler" c:type="GstVideoScaler*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_coeff" c:identifier="gst_video_scaler_get_coeff">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="301">For a given pixel at @out_offset, get the first required input pixel at
-@in_offset and the @n_taps filter coefficients.
-
-Note that for interlaced content, @in_offset needs to be incremented with
-2 to get the next input line.</doc>
- <source-position filename="gst-libs/gst/video/video-scaler.h"
- line="67"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="314">an array of @n_tap gdouble values with filter coefficients.</doc>
- <type name="gdouble" c:type="const gdouble*"/>
- </return-value>
- <parameters>
- <instance-parameter name="scale" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="303">a #GstVideoScaler</doc>
- <type name="VideoScaler" c:type="GstVideoScaler*"/>
- </instance-parameter>
- <parameter name="out_offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="304">an output offset</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="in_offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="305">result input offset</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="n_taps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="306">result n_taps</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_max_taps" c:identifier="gst_video_scaler_get_max_taps">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="285">Get the maximum number of taps for @scale.</doc>
- <source-position filename="gst-libs/gst/video/video-scaler.h"
- line="64"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="291">the maximum number of taps</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="scale" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="287">a #GstVideoScaler</doc>
- <type name="VideoScaler" c:type="GstVideoScaler*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="horizontal" c:identifier="gst_video_scaler_horizontal">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1336">Horizontally scale the pixels in @src to @dest, starting from @dest_offset
-for @width samples.</doc>
- <source-position filename="gst-libs/gst/video/video-scaler.h"
- line="73"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="scale" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1338">a #GstVideoScaler</doc>
- <type name="VideoScaler" c:type="GstVideoScaler*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1339">a #GstVideoFormat for @src and @dest</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="src"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1340">source pixels</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="dest"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1341">destination pixels</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="dest_offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1342">the horizontal destination offset</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1343">the number of pixels to scale</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="vertical" c:identifier="gst_video_scaler_vertical">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1376">Vertically combine @width pixels in the lines in @src_lines to @dest.
-@dest is the location of the target line at @dest_offset and
-@srcs are the input lines for @dest_offset.</doc>
- <source-position filename="gst-libs/gst/video/video-scaler.h"
- line="79"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="scale" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1378">a #GstVideoScaler</doc>
- <type name="VideoScaler" c:type="GstVideoScaler*"/>
- </instance-parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1379">a #GstVideoFormat for @srcs and @dest</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="src_lines"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1380">source pixels lines</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="dest"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1381">destination pixels</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="dest_offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1382">the vertical destination offset</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="1383">the number of pixels to scale</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <function name="new"
- c:identifier="gst_video_scaler_new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="195">Make a new @method video scaler. @in_size source lines/pixels will
-be scaled to @out_size destination lines/pixels.
-
-@n_taps specifies the amount of pixels to use from the source for one output
-pixel. If n_taps is 0, this function chooses a good value automatically based
-on the @method and @in_size/@out_size.</doc>
- <source-position filename="gst-libs/gst/video/video-scaler.h"
- line="54"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="211">a #GstVideoScaler</doc>
- <type name="VideoScaler" c:type="GstVideoScaler*"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="197">a #GstVideoResamplerMethod</doc>
- <type name="VideoResamplerMethod"
- c:type="GstVideoResamplerMethod"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="198">#GstVideoScalerFlags</doc>
- <type name="VideoScalerFlags" c:type="GstVideoScalerFlags"/>
- </parameter>
- <parameter name="n_taps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="199">number of taps to use</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="in_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="200">number of source elements</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="out_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="201">number of destination elements</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="options"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="202">extra options</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <bitfield name="VideoScalerFlags"
- glib:type-name="GstVideoScalerFlags"
- glib:get-type="gst_video_scaler_flags_get_type"
- c:type="GstVideoScalerFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.h"
- line="39">Different scale flags.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_SCALER_FLAG_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.h"
- line="41">no flags</doc>
- </member>
- <member name="interlaced"
- value="1"
- c:identifier="GST_VIDEO_SCALER_FLAG_INTERLACED"
- glib:nick="interlaced">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.h"
- line="42">Set up a scaler for interlaced content</doc>
- </member>
- </bitfield>
- <class name="VideoSink"
- c:symbol-prefix="video_sink"
- c:type="GstVideoSink"
- parent="GstBase.BaseSink"
- glib:type-name="GstVideoSink"
- glib:get-type="gst_video_sink_get_type"
- glib:type-struct="VideoSinkClass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.c"
- line="21">Provides useful functions and a base class for video sinks.
-
-GstVideoSink will configure the default base sink to drop frames that
-arrive later than 20ms as this is considered the default threshold for
-observing out-of-sync frames.</doc>
- <source-position filename="gst-libs/gst/video/gstvideosink.h"
- line="122"/>
- <function name="center_rect" c:identifier="gst_video_sink_center_rect">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.c"
- line="86">Takes @src rectangle and position it at the center of @dst rectangle with or
-without @scaling. It handles clipping if the @src rectangle is bigger than
-the @dst one and @scaling is set to FALSE.</doc>
- <source-position filename="gst-libs/gst/video/gstvideosink.h"
- line="128"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.c"
- line="88">the #GstVideoRectangle describing the source area</doc>
- <type name="VideoRectangle" c:type="GstVideoRectangle"/>
- </parameter>
- <parameter name="dst" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.c"
- line="89">the #GstVideoRectangle describing the destination area</doc>
- <type name="VideoRectangle" c:type="GstVideoRectangle"/>
- </parameter>
- <parameter name="result" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.c"
- line="90">a pointer to a #GstVideoRectangle which will receive the result area</doc>
- <type name="VideoRectangle" c:type="GstVideoRectangle*"/>
- </parameter>
- <parameter name="scaling" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.c"
- line="91">a #gboolean indicating if scaling should be applied or not</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <virtual-method name="show_frame">
- <source-position filename="gst-libs/gst/video/gstvideosink.h"
- line="118"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="video_sink" transfer-ownership="none">
- <type name="VideoSink" c:type="GstVideoSink*"/>
- </instance-parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <property name="show-preroll-frame"
- writable="1"
- construct="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.c"
- line="164">Whether to show video frames during preroll. If set to %FALSE, video
-frames will only be rendered in PLAYING state.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="element">
- <type name="GstBase.BaseSink" c:type="GstBaseSink"/>
- </field>
- <field name="width">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="87">video width (derived class needs to set this)</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="height">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="86">video height (derived class needs to set this)</doc>
- <type name="gint" c:type="gint"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="VideoSinkPrivate" c:type="GstVideoSinkPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="VideoSinkClass"
- c:type="GstVideoSinkClass"
- glib:is-gtype-struct-for="VideoSink">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="104">The video sink class structure. Derived classes should override the
-@show_frame virtual function.</doc>
- <source-position filename="gst-libs/gst/video/gstvideosink.h"
- line="122"/>
- <field name="parent_class">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideosink.h"
- line="106">the parent class structure</doc>
- <type name="GstBase.BaseSinkClass" c:type="GstBaseSinkClass"/>
- </field>
- <field name="show_frame">
- <callback name="show_frame">
- <source-position filename="gst-libs/gst/video/gstvideosink.h"
- line="118"/>
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="video_sink" transfer-ownership="none">
- <type name="VideoSink" c:type="GstVideoSink*"/>
- </parameter>
- <parameter name="buf" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="VideoSinkPrivate" c:type="GstVideoSinkPrivate" disguised="1">
- <source-position filename="gst-libs/gst/video/gstvideosink.h" line="66"/>
- </record>
- <enumeration name="VideoTileMode"
- glib:type-name="GstVideoTileMode"
- glib:get-type="gst_video_tile_mode_get_type"
- c:type="GstVideoTileMode">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="108">Enum value describing the available tiling modes.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_VIDEO_TILE_MODE_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="110">Unknown or unset tile mode</doc>
- </member>
- <member name="zflipz_2x2"
- value="65536"
- c:identifier="GST_VIDEO_TILE_MODE_ZFLIPZ_2X2"
- glib:nick="zflipz-2x2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="111">Every four adjacent blocks - two
- horizontally and two vertically are grouped together and are located
- in memory in Z or flipped Z order. In case of odd rows, the last row
- of blocks is arranged in linear order.</doc>
- </member>
- <member name="linear"
- value="131072"
- c:identifier="GST_VIDEO_TILE_MODE_LINEAR"
- version="1.18"
- glib:nick="linear">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="123">Tiles are in row order.</doc>
- </member>
- </enumeration>
- <enumeration name="VideoTileType"
- glib:type-name="GstVideoTileType"
- glib:get-type="gst_video_tile_type_get_type"
- c:type="GstVideoTileType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="28">Enum value describing the most common tiling types.</doc>
- <member name="indexed"
- value="0"
- c:identifier="GST_VIDEO_TILE_TYPE_INDEXED"
- glib:nick="indexed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.h"
- line="30">Tiles are indexed. Use
- gst_video_tile_get_index () to retrieve the tile at the requested
- coordinates.</doc>
- </member>
- </enumeration>
- <record name="VideoTimeCode"
- c:type="GstVideoTimeCode"
- version="1.10"
- glib:type-name="GstVideoTimeCode"
- glib:get-type="gst_video_time_code_get_type"
- c:symbol-prefix="video_time_code">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="75">@field_count must be 0 for progressive video and 1 or 2 for interlaced.
-
-A representation of a SMPTE time code.
-
-@hours must be positive and less than 24. Will wrap around otherwise.
-@minutes and @seconds must be positive and less than 60.
-@frames must be less than or equal to @config.fps_n / @config.fps_d
-These values are *NOT* automatically normalized.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="103"/>
- <field name="config" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="82">the corresponding #GstVideoTimeCodeConfig</doc>
- <type name="VideoTimeCodeConfig" c:type="GstVideoTimeCodeConfig"/>
- </field>
- <field name="hours" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="77">the hours field of #GstVideoTimeCode</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="minutes" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="78">the minutes field of #GstVideoTimeCode</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="seconds" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="79">the seconds field of #GstVideoTimeCode</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="frames" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="80">the frames field of #GstVideoTimeCode</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="field_count" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="81">Interlaced video field count</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <constructor name="new"
- c:identifier="gst_video_time_code_new"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="588">@field_count is 0 for progressive, 1 or 2 for interlaced.
-@latest_daiy_jam reference is stolen from caller.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="131"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="603">a new #GstVideoTimeCode with the given values.
-The values are not checked for being in a valid range. To see if your
-timecode actually has valid content, use gst_video_time_code_is_valid().</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </return-value>
- <parameters>
- <parameter name="fps_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="590">Numerator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="fps_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="591">Denominator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="latest_daily_jam" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="592">The latest daily jam of the #GstVideoTimeCode</doc>
- <type name="GLib.DateTime" c:type="GDateTime*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="593">#GstVideoTimeCodeFlags</doc>
- <type name="VideoTimeCodeFlags" c:type="GstVideoTimeCodeFlags"/>
- </parameter>
- <parameter name="hours" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="594">the hours field of #GstVideoTimeCode</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="minutes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="595">the minutes field of #GstVideoTimeCode</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="seconds" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="596">the seconds field of #GstVideoTimeCode</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="597">the frames field of #GstVideoTimeCode</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="field_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="598">Interlaced video field count</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_empty"
- c:identifier="gst_video_time_code_new_empty"
- version="1.10">
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="142"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="625">a new empty, invalid #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </return-value>
- </constructor>
- <constructor name="new_from_date_time"
- c:identifier="gst_video_time_code_new_from_date_time"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="721">The resulting config-&gt;latest_daily_jam is set to
-midnight, and timecode is set to the given time.
-
-This might return a completely invalid timecode, use
-gst_video_time_code_new_from_date_time_full() to ensure
-that you would get %NULL instead in that case.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="148"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="736">the #GstVideoTimeCode representation of @dt.</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </return-value>
- <parameters>
- <parameter name="fps_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="723">Numerator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="fps_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="724">Denominator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="dt" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="725">#GDateTime to convert</doc>
- <type name="GLib.DateTime" c:type="GDateTime*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="726">#GstVideoTimeCodeFlags</doc>
- <type name="VideoTimeCodeFlags" c:type="GstVideoTimeCodeFlags"/>
- </parameter>
- <parameter name="field_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="727">Interlaced video field count</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_date_time_full"
- c:identifier="gst_video_time_code_new_from_date_time_full"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="751">The resulting config-&gt;latest_daily_jam is set to
-midnight, and timecode is set to the given time.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="155"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="762">the #GstVideoTimeCode representation of @dt, or %NULL if
- no valid timecode could be created.</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </return-value>
- <parameters>
- <parameter name="fps_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="753">Numerator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="fps_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="754">Denominator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="dt" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="755">#GDateTime to convert</doc>
- <type name="GLib.DateTime" c:type="GDateTime*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="756">#GstVideoTimeCodeFlags</doc>
- <type name="VideoTimeCodeFlags" c:type="GstVideoTimeCodeFlags"/>
- </parameter>
- <parameter name="field_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="757">Interlaced video field count</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_string"
- c:identifier="gst_video_time_code_new_from_string"
- version="1.12">
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="145"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="683">a new #GstVideoTimeCode from the given string or %NULL
- if the string could not be passed.</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </return-value>
- <parameters>
- <parameter name="tc_str" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="681">The string that represents the #GstVideoTimeCode</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="add_frames"
- c:identifier="gst_video_time_code_add_frames"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="390">Adds or subtracts @frames amount of frames to @tc. tc needs to
-contain valid data, as verified by gst_video_time_code_is_valid().</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="208"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="392">a valid #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </instance-parameter>
- <parameter name="frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="393">How many frames to add or subtract</doc>
- <type name="gint64" c:type="gint64"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_interval"
- c:identifier="gst_video_time_code_add_interval"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="880">This makes a component-wise addition of @tc_inter to @tc. For example,
-adding ("01:02:03:04", "00:01:00:00") will return "01:03:03:04".
-When it comes to drop-frame timecodes,
-adding ("00:00:00;00", "00:01:00:00") will return "00:01:00;02"
-because of drop-frame oddities. However,
-adding ("00:09:00;02", "00:01:00:00") will return "00:10:00;00"
-because this time we can have an exact minute.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="224"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="897">A new #GstVideoTimeCode with @tc_inter added or %NULL
- if the interval can't be added.</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="882">The #GstVideoTimeCode where the diff should be added. This
-must contain valid timecode values.</doc>
- <type name="VideoTimeCode" c:type="const GstVideoTimeCode*"/>
- </instance-parameter>
- <parameter name="tc_inter" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="884">The #GstVideoTimeCodeInterval to add to @tc.
-The interval must contain valid values, except that for drop-frame
-timecode, it may also contain timecodes which would normally
-be dropped. These are then corrected to the next reasonable timecode.</doc>
- <type name="VideoTimeCodeInterval"
- c:type="const GstVideoTimeCodeInterval*"/>
- </parameter>
- </parameters>
- </method>
- <method name="clear"
- c:identifier="gst_video_time_code_clear"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="822">Initializes @tc with empty/zero/NULL values and frees any memory
-it might currently use.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="195"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="824">a #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="compare"
- c:identifier="gst_video_time_code_compare"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="503">Compares @tc1 and @tc2. If both have latest daily jam information, it is
-taken into account. Otherwise, it is assumed that the daily jam of both
-@tc1 and @tc2 was at the same time. Both time codes must be valid.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="201"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="512">1 if @tc1 is after @tc2, -1 if @tc1 is before @tc2, 0 otherwise.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="505">a valid #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="const GstVideoTimeCode*"/>
- </instance-parameter>
- <parameter name="tc2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="506">another valid #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="const GstVideoTimeCode*"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy"
- c:identifier="gst_video_time_code_copy"
- version="1.10">
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="165"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="851">a new #GstVideoTimeCode with the same values as @tc.</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="849">a #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="const GstVideoTimeCode*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="frames_since_daily_jam"
- c:identifier="gst_video_time_code_frames_since_daily_jam"
- version="1.10">
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="221"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="329">how many frames have passed since the daily jam of @tc.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="327">a valid #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="const GstVideoTimeCode*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free"
- c:identifier="gst_video_time_code_free"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="863">Frees @tc.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="162"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="865">a #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="increment_frame"
- c:identifier="gst_video_time_code_increment_frame"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="376">Adds one frame to @tc.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="205"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="378">a valid #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init"
- c:identifier="gst_video_time_code_init"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="781">@field_count is 0 for progressive, 1 or 2 for interlaced.
-@latest_daiy_jam reference is stolen from caller.
-
-Initializes @tc with the given values.
-The values are not checked for being in a valid range. To see if your
-timecode actually has valid content, use gst_video_time_code_is_valid().</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="168"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="783">a #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </instance-parameter>
- <parameter name="fps_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="784">Numerator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="fps_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="785">Denominator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="latest_daily_jam"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="786">The latest daily jam of the #GstVideoTimeCode</doc>
- <type name="GLib.DateTime" c:type="GDateTime*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="787">#GstVideoTimeCodeFlags</doc>
- <type name="VideoTimeCodeFlags" c:type="GstVideoTimeCodeFlags"/>
- </parameter>
- <parameter name="hours" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="788">the hours field of #GstVideoTimeCode</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="minutes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="789">the minutes field of #GstVideoTimeCode</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="seconds" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="790">the seconds field of #GstVideoTimeCode</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="791">the frames field of #GstVideoTimeCode</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="field_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="792">Interlaced video field count</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="init_from_date_time"
- c:identifier="gst_video_time_code_init_from_date_time"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="210">The resulting config-&gt;latest_daily_jam is set to midnight, and timecode is
-set to the given time.
-
-Will assert on invalid parameters, use gst_video_time_code_init_from_date_time_full()
-for being able to handle invalid parameters.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="180"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="212">an uninitialized #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </instance-parameter>
- <parameter name="fps_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="213">Numerator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="fps_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="214">Denominator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="dt" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="215">#GDateTime to convert</doc>
- <type name="GLib.DateTime" c:type="GDateTime*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="216">#GstVideoTimeCodeFlags</doc>
- <type name="VideoTimeCodeFlags" c:type="GstVideoTimeCodeFlags"/>
- </parameter>
- <parameter name="field_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="217">Interlaced video field count</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="init_from_date_time_full"
- c:identifier="gst_video_time_code_init_from_date_time_full"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="237">The resulting config-&gt;latest_daily_jam is set to
-midnight, and timecode is set to the given time.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="187"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="249">%TRUE if @tc could be correctly initialized to a valid timecode</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="239">a #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode*"/>
- </instance-parameter>
- <parameter name="fps_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="240">Numerator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="fps_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="241">Denominator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="dt" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="242">#GDateTime to convert</doc>
- <type name="GLib.DateTime" c:type="GDateTime*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="243">#GstVideoTimeCodeFlags</doc>
- <type name="VideoTimeCodeFlags" c:type="GstVideoTimeCodeFlags"/>
- </parameter>
- <parameter name="field_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="244">Interlaced video field count</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="is_valid"
- c:identifier="gst_video_time_code_is_valid"
- version="1.10">
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="198"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="60">whether @tc is a valid timecode (supported frame rate,
-hours/minutes/seconds/frames not overflowing)</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="58">#GstVideoTimeCode to check</doc>
- <type name="VideoTimeCode" c:type="const GstVideoTimeCode*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="nsec_since_daily_jam"
- c:identifier="gst_video_time_code_nsec_since_daily_jam"
- version="1.10">
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="218"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="306">how many nsec have passed since the daily jam of @tc.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="304">a valid #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="const GstVideoTimeCode*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="to_date_time"
- c:identifier="gst_video_time_code_to_date_time"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="158">The @tc.config-&gt;latest_daily_jam is required to be non-NULL.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="215"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="164">the #GDateTime representation of @tc or %NULL if @tc
- has no daily jam.</doc>
- <type name="GLib.DateTime" c:type="GDateTime*"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="160">A valid #GstVideoTimeCode to convert</doc>
- <type name="VideoTimeCode" c:type="const GstVideoTimeCode*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="to_string"
- c:identifier="gst_video_time_code_to_string"
- version="1.10">
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="212"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="120">the SMPTE ST 2059-1:2015 string representation of @tc. That will
-take the form hh:mm:ss:ff. The last separator (between seconds and frames)
-may vary:
-
-';' for drop-frame, non-interlaced content and for drop-frame interlaced
-field 2
-',' for drop-frame interlaced field 1
-':' for non-drop-frame, non-interlaced content and for non-drop-frame
-interlaced field 2
-'.' for non-drop-frame interlaced field 1</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="118">A #GstVideoTimeCode to convert</doc>
- <type name="VideoTimeCode" c:type="const GstVideoTimeCode*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <record name="VideoTimeCodeConfig"
- c:type="GstVideoTimeCodeConfig"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="54">Supported frame rates: 30000/1001, 60000/1001 (both with and without drop
-frame), and integer frame rates e.g. 25/1, 30/1, 50/1, 60/1.
-
-The configuration of the time code.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="73"/>
- <field name="fps_n" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="56">Numerator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="fps_d" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="57">Denominator of the frame rate</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="flags" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="58">the corresponding #GstVideoTimeCodeFlags</doc>
- <type name="VideoTimeCodeFlags" c:type="GstVideoTimeCodeFlags"/>
- </field>
- <field name="latest_daily_jam" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="59">The latest daily jam information, if present, or NULL</doc>
- <type name="GLib.DateTime" c:type="GDateTime*"/>
- </field>
- </record>
- <bitfield name="VideoTimeCodeFlags"
- version="1.10"
- glib:type-name="GstVideoTimeCodeFlags"
- glib:get-type="gst_video_time_code_flags_get_type"
- c:type="GstVideoTimeCodeFlags">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="32">Flags related to the time code information.
-For drop frame, only 30000/1001 and 60000/1001 frame rates are supported.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_VIDEO_TIME_CODE_FLAGS_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="34">No flags</doc>
- </member>
- <member name="drop_frame"
- value="1"
- c:identifier="GST_VIDEO_TIME_CODE_FLAGS_DROP_FRAME"
- glib:nick="drop-frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="35">Whether we have drop frame rate</doc>
- </member>
- <member name="interlaced"
- value="2"
- c:identifier="GST_VIDEO_TIME_CODE_FLAGS_INTERLACED"
- glib:nick="interlaced">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="36">Whether we have interlaced video</doc>
- </member>
- </bitfield>
- <record name="VideoTimeCodeInterval"
- c:type="GstVideoTimeCodeInterval"
- version="1.12"
- glib:type-name="GstVideoTimeCodeInterval"
- glib:get-type="gst_video_time_code_interval_get_type"
- c:symbol-prefix="video_time_code_interval">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="105">A representation of a difference between two #GstVideoTimeCode instances.
-Will not necessarily correspond to a real timecode (e.g. 00:00:10;00)</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="122"/>
- <field name="hours" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="107">the hours field of #GstVideoTimeCodeInterval</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="minutes" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="108">the minutes field of #GstVideoTimeCodeInterval</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="seconds" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="109">the seconds field of #GstVideoTimeCodeInterval</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="frames" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.h"
- line="110">the frames field of #GstVideoTimeCodeInterval</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <constructor name="new"
- c:identifier="gst_video_time_code_interval_new"
- version="1.12">
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="231"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="967">a new #GstVideoTimeCodeInterval with the given values.</doc>
- <type name="VideoTimeCodeInterval"
- c:type="GstVideoTimeCodeInterval*"/>
- </return-value>
- <parameters>
- <parameter name="hours" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="962">the hours field of #GstVideoTimeCodeInterval</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="minutes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="963">the minutes field of #GstVideoTimeCodeInterval</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="seconds" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="964">the seconds field of #GstVideoTimeCodeInterval</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="965">the frames field of #GstVideoTimeCodeInterval</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_string"
- c:identifier="gst_video_time_code_interval_new_from_string"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="982">@tc_inter_str must only have ":" as separators.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="237"/>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="988">a new #GstVideoTimeCodeInterval from the given string
- or %NULL if the string could not be passed.</doc>
- <type name="VideoTimeCodeInterval"
- c:type="GstVideoTimeCodeInterval*"/>
- </return-value>
- <parameters>
- <parameter name="tc_inter_str" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="984">The string that represents the #GstVideoTimeCodeInterval</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="clear"
- c:identifier="gst_video_time_code_interval_clear"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="1044">Initializes @tc with empty/zero/NULL values.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="253"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="1046">a #GstVideoTimeCodeInterval</doc>
- <type name="VideoTimeCodeInterval"
- c:type="GstVideoTimeCodeInterval*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="copy"
- c:identifier="gst_video_time_code_interval_copy"
- version="1.12">
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="243"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="1065">a new #GstVideoTimeCodeInterval with the same values as @tc.</doc>
- <type name="VideoTimeCodeInterval"
- c:type="GstVideoTimeCodeInterval*"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="1063">a #GstVideoTimeCodeInterval</doc>
- <type name="VideoTimeCodeInterval"
- c:type="const GstVideoTimeCodeInterval*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free"
- c:identifier="gst_video_time_code_interval_free"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="1076">Frees @tc.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="240"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="1078">a #GstVideoTimeCodeInterval</doc>
- <type name="VideoTimeCodeInterval"
- c:type="GstVideoTimeCodeInterval*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="init"
- c:identifier="gst_video_time_code_interval_init"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="1022">Initializes @tc with the given values.</doc>
- <source-position filename="gst-libs/gst/video/gstvideotimecode.h"
- line="246"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="1024">a #GstVideoTimeCodeInterval</doc>
- <type name="VideoTimeCodeInterval"
- c:type="GstVideoTimeCodeInterval*"/>
- </instance-parameter>
- <parameter name="hours" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="1025">the hours field of #GstVideoTimeCodeInterval</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="minutes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="1026">the minutes field of #GstVideoTimeCodeInterval</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="seconds" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="1027">the seconds field of #GstVideoTimeCodeInterval</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideotimecode.c"
- line="1028">the frames field of #GstVideoTimeCodeInterval</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <record name="VideoTimeCodeMeta"
- c:type="GstVideoTimeCodeMeta"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="370">Extra buffer metadata describing the GstVideoTimeCode of the frame.
-
-Each frame is assumed to have its own timecode, i.e. they are not
-automatically incremented/interpolated.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="386"/>
- <field name="meta" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="372">parent #GstMeta</doc>
- <type name="Gst.Meta" c:type="GstMeta"/>
- </field>
- <field name="tc" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.h"
- line="373">the GstVideoTimeCode to attach</doc>
- <type name="VideoTimeCode" c:type="GstVideoTimeCode"/>
- </field>
- <function name="get_info"
- c:identifier="gst_video_time_code_meta_get_info">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="393"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- </record>
- <enumeration name="VideoTransferFunction"
- glib:type-name="GstVideoTransferFunction"
- glib:get-type="gst_video_transfer_function_get_type"
- c:type="GstVideoTransferFunction">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="73">The video transfer function defines the formula for converting between
-non-linear RGB (R'G'B') and linear RGB</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_VIDEO_TRANSFER_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="75">unknown transfer function</doc>
- </member>
- <member name="gamma10"
- value="1"
- c:identifier="GST_VIDEO_TRANSFER_GAMMA10"
- glib:nick="gamma10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="76">linear RGB, gamma 1.0 curve</doc>
- </member>
- <member name="gamma18"
- value="2"
- c:identifier="GST_VIDEO_TRANSFER_GAMMA18"
- glib:nick="gamma18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="77">Gamma 1.8 curve</doc>
- </member>
- <member name="gamma20"
- value="3"
- c:identifier="GST_VIDEO_TRANSFER_GAMMA20"
- glib:nick="gamma20">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="78">Gamma 2.0 curve</doc>
- </member>
- <member name="gamma22"
- value="4"
- c:identifier="GST_VIDEO_TRANSFER_GAMMA22"
- glib:nick="gamma22">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="79">Gamma 2.2 curve</doc>
- </member>
- <member name="bt709"
- value="5"
- c:identifier="GST_VIDEO_TRANSFER_BT709"
- glib:nick="bt709">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="80">Gamma 2.2 curve with a linear segment in the lower
- range, also ITU-R BT470M / ITU-R BT1700 625 PAL &amp;
- SECAM / ITU-R BT1361</doc>
- </member>
- <member name="smpte240m"
- value="6"
- c:identifier="GST_VIDEO_TRANSFER_SMPTE240M"
- glib:nick="smpte240m">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="83">Gamma 2.2 curve with a linear segment in the
- lower range</doc>
- </member>
- <member name="srgb"
- value="7"
- c:identifier="GST_VIDEO_TRANSFER_SRGB"
- glib:nick="srgb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="85">Gamma 2.4 curve with a linear segment in the lower
- range. IEC 61966-2-1 (sRGB or sYCC)</doc>
- </member>
- <member name="gamma28"
- value="8"
- c:identifier="GST_VIDEO_TRANSFER_GAMMA28"
- glib:nick="gamma28">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="87">Gamma 2.8 curve, also ITU-R BT470BG</doc>
- </member>
- <member name="log100"
- value="9"
- c:identifier="GST_VIDEO_TRANSFER_LOG100"
- glib:nick="log100">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="88">Logarithmic transfer characteristic
- 100:1 range</doc>
- </member>
- <member name="log316"
- value="10"
- c:identifier="GST_VIDEO_TRANSFER_LOG316"
- glib:nick="log316">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="90">Logarithmic transfer characteristic
- 316.22777:1 range (100 * sqrt(10) : 1)</doc>
- </member>
- <member name="bt2020_12"
- value="11"
- c:identifier="GST_VIDEO_TRANSFER_BT2020_12"
- glib:nick="bt2020-12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="92">Gamma 2.2 curve with a linear segment in the lower
- range. Used for BT.2020 with 12 bits per
- component. Since: 1.6</doc>
- </member>
- <member name="adobergb"
- value="12"
- c:identifier="GST_VIDEO_TRANSFER_ADOBERGB"
- glib:nick="adobergb">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="95">Gamma 2.19921875. Since: 1.8</doc>
- </member>
- <member name="bt2020_10"
- value="13"
- c:identifier="GST_VIDEO_TRANSFER_BT2020_10"
- glib:nick="bt2020-10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="96">Rec. ITU-R BT.2020-2 with 10 bits per component.
- (functionally the same as the values
- GST_VIDEO_TRANSFER_BT709 and GST_VIDEO_TRANSFER_BT601).
- Since: 1.18</doc>
- </member>
- <member name="smpte2084"
- value="14"
- c:identifier="GST_VIDEO_TRANSFER_SMPTE2084"
- glib:nick="smpte2084">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="100">SMPTE ST 2084 for 10, 12, 14, and 16-bit systems.
- Known as perceptual quantization (PQ)
- Since: 1.18</doc>
- </member>
- <member name="arib_std_b67"
- value="15"
- c:identifier="GST_VIDEO_TRANSFER_ARIB_STD_B67"
- glib:nick="arib-std-b67">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="103">Association of Radio Industries and Businesses (ARIB)
- STD-B67 and Rec. ITU-R BT.2100-1 hybrid loggamma (HLG) system
- Since: 1.18</doc>
- </member>
- <member name="bt601"
- value="16"
- c:identifier="GST_VIDEO_TRANSFER_BT601"
- version="1.18"
- glib:nick="bt601">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.h"
- line="131">also known as SMPTE170M / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC</doc>
- </member>
- <function name="decode"
- c:identifier="gst_video_transfer_function_decode"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="544">Convert @val to its gamma decoded value. This is the inverse operation of
-@gst_video_color_transfer_encode().
-
-For a non-linear value L' in the range [0..1], conversion to the linear
-L is in general performed with a power function like:
-
-|[
- L = L' ^ gamma
-]|
-
-Depending on @func, different formulas might be applied. Some formulas
-encode a linear segment in the lower range.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="149"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="562">the gamma decoded value of @val</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <parameter name="func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="546">a #GstVideoTransferFunction</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="547">a value</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </function>
- <function name="encode"
- c:identifier="gst_video_transfer_function_encode"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="412">Convert @val to its gamma encoded value.
-
-For a linear value L in the range [0..1], conversion to the non-linear
-(gamma encoded) L' is in general performed with a power function like:
-
-|[
- L' = L ^ (1 / gamma)
-]|
-
-Depending on @func, different formulas might be applied. Some formulas
-encode a linear segment in the lower range.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="144"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="429">the gamma encoded value of @val</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <parameter name="func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="414">a #GstVideoTransferFunction</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="415">a value</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </function>
- <function name="from_iso"
- c:identifier="gst_video_transfer_function_from_iso"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="836">Converts the @value to the #GstVideoTransferFunction
-The transfer characteristics (TransferCharacteristics) value is
-defined by "ISO/IEC 23001-8 Section 7.2 Table 3"
-and "ITU-T H.273 Table 3".
-"H.264 Table E-4" and "H.265 Table E.4" share the identical values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="291"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="846">the matched #GstVideoTransferFunction</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="838">a ITU-T H.273 transfer characteristics value</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="is_equivalent"
- c:identifier="gst_video_transfer_function_is_equivalent"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="950">Returns whether @from_func and @to_func are equivalent. There are cases
-(e.g. BT601, BT709, and BT2020_10) where several functions are functionally
-identical. In these cases, when doing conversion, we should consider them
-as equivalent. Also, BT2020_12 is the same as the aforementioned three for
-less than 12 bits per pixel.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="297"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="963">TRUE if @from_func and @to_func can be considered equivalent.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="from_func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="952">#GstVideoTransferFunction to convert from</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </parameter>
- <parameter name="from_bpp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="953">bits per pixel to convert from</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="to_func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="954">#GstVideoTransferFunction to convert into</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </parameter>
- <parameter name="to_bpp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="955">bits per pixel to convert into</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="to_iso"
- c:identifier="gst_video_transfer_function_to_iso"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="701">Converts #GstVideoTransferFunction to the "transfer characteristics"
-(TransferCharacteristics) value defined by "ISO/IEC 23001-8 Section 7.2 Table 3"
-and "ITU-T H.273 Table 3".
-"H.264 Table E-4" and "H.265 Table E.4" share the identical values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h"
- line="282"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="710">The value of ISO/IEC 23001-8 transfer characteristics.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="703">a #GstVideoTransferFunction</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <record name="VideoVBIEncoder"
- c:type="GstVideoVBIEncoder"
- version="1.16"
- glib:type-name="GstVideoVBIEncoder"
- glib:get-type="gst_video_vbi_encoder_get_type"
- c:symbol-prefix="video_vbi_encoder">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="468">An encoder for writing ancillary data to the
-Vertical Blanking Interval lines of component signals.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="477"/>
- <constructor name="new"
- c:identifier="gst_video_vbi_encoder_new"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="601">Create a new #GstVideoVBIEncoder for the specified @format and @pixel_width.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="483"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="610">The new #GstVideoVBIEncoder or %NULL if the @format and/or @pixel_width
-is not supported.</doc>
- <type name="VideoVBIEncoder" c:type="GstVideoVBIEncoder*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="603">a #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="pixel_width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="604">The width in pixel to use</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="add_ancillary"
- c:identifier="gst_video_vbi_encoder_add_ancillary"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="685">Stores Video Ancillary data, according to SMPTE-291M specification.
-
-Note that the contents of the data are always read as 8bit data (i.e. do not contain
-the parity check bits).</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="492"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="703">%TRUE if enough space was left in the current line, %FALSE
- otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="687">a #GstVideoVBIEncoder</doc>
- <type name="VideoVBIEncoder" c:type="GstVideoVBIEncoder*"/>
- </instance-parameter>
- <parameter name="composite" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="688">%TRUE if composite ADF should be created, component otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="DID" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="689">The Data Identifier</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="SDID_block_number" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="690">The Secondary Data Identifier (if type 2) or the Data
- Block Number (if type 1)</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="693">The user data content of the Ancillary packet.
- Does not contain the ADF, DID, SDID nor CS.</doc>
- <array length="4" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="data_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="692">The amount of data (in bytes) in @data (max 255 bytes)</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_video_vbi_encoder_copy">
- <source-position filename="gst-libs/gst/video/video-anc.h" line="486"/>
- <return-value transfer-ownership="full">
- <type name="VideoVBIEncoder" c:type="GstVideoVBIEncoder*"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoVBIEncoder" c:type="const GstVideoVBIEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free"
- c:identifier="gst_video_vbi_encoder_free"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="584">Frees the @encoder.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="489"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="586">a #GstVideoVBIEncoder</doc>
- <type name="VideoVBIEncoder" c:type="GstVideoVBIEncoder*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="write_line"
- c:identifier="gst_video_vbi_encoder_write_line">
- <source-position filename="gst-libs/gst/video/video-anc.h" line="500"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="encoder" transfer-ownership="none">
- <type name="VideoVBIEncoder" c:type="GstVideoVBIEncoder*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <record name="VideoVBIParser"
- c:type="GstVideoVBIParser"
- version="1.16"
- glib:type-name="GstVideoVBIParser"
- glib:get-type="gst_video_vbi_parser_get_type"
- c:symbol-prefix="video_vbi_parser">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="422">A parser for detecting and extracting @GstVideoAncillary data from
-Vertical Blanking Interval lines of component signals.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="431"/>
- <constructor name="new"
- c:identifier="gst_video_vbi_parser_new"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="320">Create a new #GstVideoVBIParser for the specified @format and @pixel_width.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="457"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="329">The new #GstVideoVBIParser or %NULL if the @format and/or @pixel_width
-is not supported.</doc>
- <type name="VideoVBIParser" c:type="GstVideoVBIParser*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="322">a #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="pixel_width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="323">The width in pixel to use</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="add_line"
- c:identifier="gst_video_vbi_parser_add_line"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="523">Provide a new line of data to the @parser. Call gst_video_vbi_parser_get_ancillary()
-to get the Ancillary data that might be present on that line.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="466"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parser" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="525">a #GstVideoVBIParser</doc>
- <type name="VideoVBIParser" c:type="GstVideoVBIParser*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="526">The line of data to parse</doc>
- <array zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gst_video_vbi_parser_copy">
- <source-position filename="gst-libs/gst/video/video-anc.h" line="460"/>
- <return-value transfer-ownership="full">
- <type name="VideoVBIParser" c:type="GstVideoVBIParser*"/>
- </return-value>
- <parameters>
- <instance-parameter name="parser" transfer-ownership="none">
- <type name="VideoVBIParser" c:type="const GstVideoVBIParser*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free"
- c:identifier="gst_video_vbi_parser_free"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="374">Frees the @parser.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="463"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="parser" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="376">a #GstVideoVBIParser</doc>
- <type name="VideoVBIParser" c:type="GstVideoVBIParser*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_ancillary"
- c:identifier="gst_video_vbi_parser_get_ancillary"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="294">Parse the line provided previously by gst_video_vbi_parser_add_line().</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="453"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="303">%GST_VIDEO_VBI_PARSER_RESULT_OK if ancillary data was found and
-@anc was filled. %GST_VIDEO_VBI_PARSER_RESULT_DONE if there wasn't any
-data.</doc>
- <type name="VideoVBIParserResult" c:type="GstVideoVBIParserResult"/>
- </return-value>
- <parameters>
- <instance-parameter name="parser" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="296">a #GstVideoVBIParser</doc>
- <type name="VideoVBIParser" c:type="GstVideoVBIParser*"/>
- </instance-parameter>
- <parameter name="anc"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="297">a #GstVideoAncillary to start the eventual ancillary data</doc>
- <type name="VideoAncillary" c:type="GstVideoAncillary*"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <enumeration name="VideoVBIParserResult"
- version="1.16"
- glib:type-name="GstVideoVBIParserResult"
- glib:get-type="gst_video_vbi_parser_result_get_type"
- c:type="GstVideoVBIParserResult">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="436">Return values for #GstVideoVBIParser</doc>
- <member name="done"
- value="0"
- c:identifier="GST_VIDEO_VBI_PARSER_RESULT_DONE"
- glib:nick="done">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="438">No line were provided, or no more Ancillary data was found.</doc>
- </member>
- <member name="ok"
- value="1"
- c:identifier="GST_VIDEO_VBI_PARSER_RESULT_OK"
- glib:nick="ok">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="439">A #GstVideoAncillary was found.</doc>
- </member>
- <member name="error"
- value="2"
- c:identifier="GST_VIDEO_VBI_PARSER_RESULT_ERROR"
- glib:nick="error">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="440">An error occurred</doc>
- </member>
- </enumeration>
- <function name="buffer_add_video_afd_meta"
- c:identifier="gst_buffer_add_video_afd_meta"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1218">Attaches #GstVideoAFDMeta metadata to @buffer with the given
-parameters.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="265"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1228">the #GstVideoAFDMeta on @buffer.</doc>
- <type name="VideoAFDMeta" c:type="GstVideoAFDMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1220">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1221">0 for progressive or field 1 and 1 for field 2</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="spec" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1222">#GstVideoAFDSpec that applies to AFD value</doc>
- <type name="VideoAFDSpec" c:type="GstVideoAFDSpec"/>
- </parameter>
- <parameter name="afd" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1223">#GstVideoAFDValue AFD enumeration</doc>
- <type name="VideoAFDValue" c:type="GstVideoAFDValue"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_video_affine_transformation_meta"
- c:identifier="gst_buffer_add_video_affine_transformation_meta"
- version="1.8">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.c"
- line="110">Attaches GstVideoAffineTransformationMeta metadata to @buffer with
-the given parameters.</doc>
- <source-position filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="73"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.c"
- line="117">the #GstVideoAffineTransformationMeta on @buffer.</doc>
- <type name="VideoAffineTransformationMeta"
- c:type="GstVideoAffineTransformationMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.c"
- line="112">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_video_bar_meta"
- c:identifier="gst_buffer_add_video_bar_meta"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1328">Attaches #GstVideoBarMeta metadata to @buffer with the given
-parameters.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="326"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1345">the #GstVideoBarMeta on @buffer.
-
-See Table 6.11 Bar Data Syntax
-
-https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf</doc>
- <type name="VideoBarMeta" c:type="GstVideoBarMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1330">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="field" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1331">0 for progressive or field 1 and 1 for field 2</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="is_letterbox" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1332">if true then bar data specifies letterbox, otherwise pillarbox</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="bar_data1" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1333">If @is_letterbox is true, then the value specifies the
- last line of a horizontal letterbox bar area at top of reconstructed frame.
- Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox
- bar area at the left side of the reconstructed frame</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="bar_data2" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1337">If @is_letterbox is true, then the value specifies the
- first line of a horizontal letterbox bar area at bottom of reconstructed frame.
- Otherwise, it specifies the first horizontal
- luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_video_caption_meta"
- c:identifier="gst_buffer_add_video_caption_meta"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="993">Attaches #GstVideoCaptionMeta metadata to @buffer with the given
-parameters.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="417"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1003">the #GstVideoCaptionMeta on @buffer.</doc>
- <type name="VideoCaptionMeta" c:type="GstVideoCaptionMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="995">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="caption_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="996">The type of Closed Caption to add</doc>
- <type name="VideoCaptionType" c:type="GstVideoCaptionType"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="997">The Closed Caption data</doc>
- <array length="3" zero-terminated="0" c:type="const guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="998">The size of @data in bytes</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="buffer_add_video_crop_meta"
- c:identifier="gst_buffer_add_video_crop_meta"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="164"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function name="buffer_add_video_gl_texture_upload_meta"
- c:identifier="gst_buffer_add_video_gl_texture_upload_meta">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="738">Attaches GstVideoGLTextureUploadMeta metadata to @buffer with the given
-parameters.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="290"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="752">the #GstVideoGLTextureUploadMeta on @buffer.</doc>
- <type name="VideoGLTextureUploadMeta"
- c:type="GstVideoGLTextureUploadMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="740">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="texture_orientation" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="741">the #GstVideoGLTextureOrientation</doc>
- <type name="VideoGLTextureOrientation"
- c:type="GstVideoGLTextureOrientation"/>
- </parameter>
- <parameter name="n_textures" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="742">the number of textures</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="texture_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="743">array of #GstVideoGLTextureType</doc>
- <type name="VideoGLTextureType" c:type="GstVideoGLTextureType*"/>
- </parameter>
- <parameter name="upload"
- transfer-ownership="none"
- scope="call"
- closure="5">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="744">the function to upload the buffer to a specific texture ID</doc>
- <type name="VideoGLTextureUpload" c:type="GstVideoGLTextureUpload"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="745">user data for the implementor of @upload</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="user_data_copy"
- transfer-ownership="none"
- scope="call">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="746">function to copy @user_data</doc>
- <type name="GObject.BoxedCopyFunc" c:type="GBoxedCopyFunc"/>
- </parameter>
- <parameter name="user_data_free"
- transfer-ownership="none"
- scope="call">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="747">function to free @user_data</doc>
- <type name="GObject.BoxedFreeFunc" c:type="GBoxedFreeFunc"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_video_meta"
- c:identifier="gst_buffer_add_video_meta">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="262">Attaches GstVideoMeta metadata to @buffer with the given parameters and the
-default offsets and strides for @format and @width x @height.
-
-This function calculates the default offsets and strides and then calls
-gst_buffer_add_video_meta_full() with them.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="113"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="276">the #GstVideoMeta on @buffer.</doc>
- <type name="VideoMeta" c:type="GstVideoMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="264">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="265">#GstVideoFrameFlags</doc>
- <type name="VideoFrameFlags" c:type="GstVideoFrameFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="266">a #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="267">the width</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="268">the height</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_video_meta_full"
- c:identifier="gst_buffer_add_video_meta_full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="295">Attaches GstVideoMeta metadata to @buffer with the given parameters.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="117"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="308">the #GstVideoMeta on @buffer.</doc>
- <type name="VideoMeta" c:type="GstVideoMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="297">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="298">#GstVideoFrameFlags</doc>
- <type name="VideoFrameFlags" c:type="GstVideoFrameFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="299">a #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="300">the width</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="301">the height</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="n_planes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="302">number of planes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="303">offset of each plane</doc>
- <array zero-terminated="0" c:type="gsize*" fixed-size="4">
- <type name="gsize" c:type="gsize"/>
- </array>
- </parameter>
- <parameter name="stride" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="304">stride of each plane</doc>
- <array zero-terminated="0" c:type="gint*" fixed-size="4">
- <type name="gint" c:type="gint"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_video_overlay_composition_meta"
- c:identifier="gst_buffer_add_video_overlay_composition_meta">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="272">Sets an overlay composition on a buffer. The buffer will obtain its own
-reference to the composition, meaning this function does not take ownership
-of @comp.</doc>
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="296"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="281">a #GstVideoOverlayCompositionMeta</doc>
- <type name="VideoOverlayCompositionMeta"
- c:type="GstVideoOverlayCompositionMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="274">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="comp"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-overlay-composition.c"
- line="275">a #GstVideoOverlayComposition</doc>
- <type name="VideoOverlayComposition"
- c:type="GstVideoOverlayComposition*"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_video_region_of_interest_meta"
- c:identifier="gst_buffer_add_video_region_of_interest_meta">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="948">Attaches #GstVideoRegionOfInterestMeta metadata to @buffer with the given
-parameters.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="348"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="960">the #GstVideoRegionOfInterestMeta on @buffer.</doc>
- <type name="VideoRegionOfInterestMeta"
- c:type="GstVideoRegionOfInterestMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="950">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="roi_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="951">Type of the region of interest (e.g. "face")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="952">X position</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="953">Y position</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="w" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="954">width</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="h" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="955">height</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_video_region_of_interest_meta_id"
- c:identifier="gst_buffer_add_video_region_of_interest_meta_id">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="970">Attaches #GstVideoRegionOfInterestMeta metadata to @buffer with the given
-parameters.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="356"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="982">the #GstVideoRegionOfInterestMeta on @buffer.</doc>
- <type name="VideoRegionOfInterestMeta"
- c:type="GstVideoRegionOfInterestMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="972">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="roi_type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="973">Type of the region of interest (e.g. "face")</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </parameter>
- <parameter name="x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="974">X position</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="975">Y position</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="w" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="976">width</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="h" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="977">height</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_video_time_code_meta"
- c:identifier="gst_buffer_add_video_time_code_meta"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1140">Attaches #GstVideoTimeCodeMeta metadata to @buffer with the given
-parameters.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="400"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1148">the #GstVideoTimeCodeMeta on @buffer, or
-(since 1.16) %NULL if the timecode was invalid.</doc>
- <type name="VideoTimeCodeMeta" c:type="GstVideoTimeCodeMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1142">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="tc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1143">a #GstVideoTimeCode</doc>
- <type name="VideoTimeCode" c:type="const GstVideoTimeCode*"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_add_video_time_code_meta_full"
- c:identifier="gst_buffer_add_video_time_code_meta_full"
- version="1.10">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1165">Attaches #GstVideoTimeCodeMeta metadata to @buffer with the given
-parameters.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="405"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1181">the #GstVideoTimeCodeMeta on @buffer, or
-(since 1.16) %NULL if the timecode was invalid.</doc>
- <type name="VideoTimeCodeMeta" c:type="GstVideoTimeCodeMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1167">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="fps_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1168">framerate numerator</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="fps_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1169">framerate denominator</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="latest_daily_jam" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1170">a #GDateTime for the latest daily jam</doc>
- <type name="GLib.DateTime" c:type="GDateTime*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1171">a #GstVideoTimeCodeFlags</doc>
- <type name="VideoTimeCodeFlags" c:type="GstVideoTimeCodeFlags"/>
- </parameter>
- <parameter name="hours" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1172">hours since the daily jam</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="minutes" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1173">minutes since the daily jam</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="seconds" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1174">seconds since the daily jam</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="frames" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1175">frames since the daily jam</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="field_count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="1176">fields since the daily jam</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="buffer_get_video_afd_meta"
- c:identifier="gst_buffer_get_video_afd_meta"
- version="1.18"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="248">Gets the #GstVideoAFDMeta that might be present on @b.
-
-Note: there may be two #GstVideoAFDMeta structs for interlaced video.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="261"/>
- <parameters>
- <parameter name="b">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="250">A #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_get_video_affine_transformation_meta"
- c:identifier="gst_buffer_get_video_affine_transformation_meta"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="70"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_get_video_bar_meta"
- c:identifier="gst_buffer_get_video_bar_meta"
- version="1.18"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="311">Gets the #GstVideoBarMeta that might be present on @b.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="322"/>
- <parameters>
- <parameter name="b">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="313">A #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_get_video_caption_meta"
- c:identifier="gst_buffer_get_video_caption_meta"
- version="1.16"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="402">Gets the #GstVideoCaptionMeta that might be present on @b.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="413"/>
- <parameters>
- <parameter name="b">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.h"
- line="404">A #GstBuffer</doc>
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_get_video_crop_meta"
- c:identifier="gst_buffer_get_video_crop_meta"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="163"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_get_video_gl_texture_upload_meta"
- c:identifier="gst_buffer_get_video_gl_texture_upload_meta"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="286"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function name="buffer_get_video_meta"
- c:identifier="gst_buffer_get_video_meta">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="154">Find the #GstVideoMeta on @buffer with the lowest @id.
-
-Buffers can contain multiple #GstVideoMeta metadata items when dealing with
-multiview buffers.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="107"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="163">the #GstVideoMeta with lowest id (usually 0) or %NULL when there
-is no such metadata on @buffer.</doc>
- <type name="VideoMeta" c:type="GstVideoMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="156">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_get_video_meta_id"
- c:identifier="gst_buffer_get_video_meta_id">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="186">Find the #GstVideoMeta on @buffer with the given @id.
-
-Buffers can contain multiple #GstVideoMeta metadata items when dealing with
-multiview buffers.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="110"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="196">the #GstVideoMeta with @id or %NULL when there is no such metadata
-on @buffer.</doc>
- <type name="VideoMeta" c:type="GstVideoMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="188">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="189">a metadata id</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="buffer_get_video_multiview_meta"
- c:identifier="gst_buffer_get_video_multiview_meta"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-multiview.h"
- line="78"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_get_video_overlay_composition_meta"
- c:identifier="gst_buffer_get_video_overlay_composition_meta"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="295"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="buffer_get_video_region_of_interest_meta"
- c:identifier="gst_buffer_get_video_region_of_interest_meta"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="341"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function name="buffer_get_video_region_of_interest_meta_id"
- c:identifier="gst_buffer_get_video_region_of_interest_meta_id">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="917">Find the #GstVideoRegionOfInterestMeta on @buffer with the given @id.
-
-Buffers can contain multiple #GstVideoRegionOfInterestMeta metadata items if
-multiple regions of interests are marked on a frame.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="344"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="927">the #GstVideoRegionOfInterestMeta with @id or %NULL when there is
-no such metadata on @buffer.</doc>
- <type name="VideoRegionOfInterestMeta"
- c:type="GstVideoRegionOfInterestMeta*"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="919">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="920">a metadata id</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="buffer_get_video_time_code_meta"
- c:identifier="gst_buffer_get_video_time_code_meta"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="396"/>
- <parameters>
- <parameter name="b">
- </parameter>
- </parameters>
- </function-macro>
- <function name="buffer_pool_config_get_video_alignment"
- c:identifier="gst_buffer_pool_config_get_video_alignment">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideopool.c"
- line="69">Get the video alignment from the bufferpool configuration @config in
-in @align</doc>
- <source-position filename="gst-libs/gst/video/gstvideopool.h" line="54"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideopool.c"
- line="77">%TRUE if @config could be parsed correctly.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideopool.c"
- line="71">a #GstStructure</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideopool.c"
- line="72">a #GstVideoAlignment</doc>
- <type name="VideoAlignment" c:type="GstVideoAlignment*"/>
- </parameter>
- </parameters>
- </function>
- <function name="buffer_pool_config_set_video_alignment"
- c:identifier="gst_buffer_pool_config_set_video_alignment">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideopool.c"
- line="43">Set the video alignment in @align to the bufferpool configuration
-@config</doc>
- <source-position filename="gst-libs/gst/video/gstvideopool.h" line="51"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="config" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideopool.c"
- line="45">a #GstStructure</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="align" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideopool.c"
- line="46">a #GstVideoAlignment</doc>
- <type name="VideoAlignment" c:type="GstVideoAlignment*"/>
- </parameter>
- </parameters>
- </function>
- <function-macro name="buffer_remove_video_overlay_composition_meta"
- c:identifier="gst_buffer_remove_video_overlay_composition_meta"
- introspectable="0">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="297"/>
- <parameters>
- <parameter name="b">
- </parameter>
- <parameter name="m">
- </parameter>
- </parameters>
- </function-macro>
- <docsection name="gstvideo">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="32">This library contains some helper functions and includes the
-videosink and videofilter base classes.</doc>
- </docsection>
- <docsection name="gstvideoanc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="29">A collection of objects and methods to assist with handling Ancillary Data
-present in Vertical Blanking Interval as well as Closed Caption.</doc>
- </docsection>
- <docsection name="gstvideochroma">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="31">The functions gst_video_chroma_from_string() and gst_video_chroma_to_string() convert
-between #GstVideoChromaSite and string descriptions.
-
-#GstVideoChromaResample is a utility object for resampling chroma planes
-and converting between different chroma sampling sitings.</doc>
- </docsection>
- <docsection name="gstvideopool">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideopool.c"
- line="30">Special GstBufferPool subclass for raw video buffers.
-
-Allows configuration of video-specific requirements such as
-stride alignments or pixel padding, and can also be configured
-to automatically add #GstVideoMeta to the buffers.</doc>
- </docsection>
- <function name="is_video_overlay_prepare_window_handle_message"
- c:identifier="gst_is_video_overlay_prepare_window_handle_message">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="497">Convenience function to check if the given message is a
-"prepare-window-handle" message from a #GstVideoOverlay.</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="105"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="504">whether @msg is a "prepare-window-handle" message</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="msg" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="499">a #GstMessage</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_event_get_type"
- c:identifier="gst_navigation_event_get_type"
- moved-to="Navigation.event_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="706">Inspect a #GstEvent and return the #GstNavigationEventType of the event, or
-#GST_NAVIGATION_EVENT_INVALID if the event is not a #GstNavigation event.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="282"/>
- <return-value transfer-ownership="none">
- <type name="NavigationEventType" c:type="GstNavigationEventType"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="708">A #GstEvent to inspect.</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_event_parse_command"
- c:identifier="gst_navigation_event_parse_command"
- moved-to="Navigation.event_parse_command">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="895">Inspect a #GstNavigation command event and retrieve the enum value of the
-associated command.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="302"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="904">TRUE if the navigation command could be extracted, otherwise FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="897">A #GstEvent to inspect.</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="command"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="898">Pointer to GstNavigationCommand to receive the
- type of the navigation event.</doc>
- <type name="NavigationCommand" c:type="GstNavigationCommand*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_event_parse_key_event"
- c:identifier="gst_navigation_event_parse_key_event"
- moved-to="Navigation.event_parse_key_event">
- <source-position filename="gst-libs/gst/video/navigation.h" line="285"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="750">A #GstEvent to inspect.</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="key"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="751">A pointer to a location to receive
- the string identifying the key press. The returned string is owned by the
- event, and valid only until the event is unreffed.</doc>
- <type name="utf8" c:type="const gchar**"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_event_parse_mouse_button_event"
- c:identifier="gst_navigation_event_parse_mouse_button_event"
- moved-to="Navigation.event_parse_mouse_button_event">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="775">Retrieve the details of either a #GstNavigation mouse button press event or
-a mouse button release event. Determine which type the event is using
-gst_navigation_event_get_type() to retrieve the #GstNavigationEventType.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="289"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="789">TRUE if the button number and both coordinates could be extracted,
- otherwise FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="777">A #GstEvent to inspect.</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="button"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="778">Pointer to a gint that will receive the button
- number associated with the event.</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="x"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="780">Pointer to a gdouble to receive the x coordinate of the
- mouse button event.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="y"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="782">Pointer to a gdouble to receive the y coordinate of the
- mouse button event.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_event_parse_mouse_move_event"
- c:identifier="gst_navigation_event_parse_mouse_move_event"
- moved-to="Navigation.event_parse_mouse_move_event">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="817">Inspect a #GstNavigation mouse movement event and extract the coordinates
-of the event.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="293"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="828">TRUE if both coordinates could be extracted, otherwise FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="819">A #GstEvent to inspect.</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="x"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="820">Pointer to a gdouble to receive the x coordinate of the
- mouse movement.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="y"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="822">Pointer to a gdouble to receive the y coordinate of the
- mouse movement.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_event_parse_mouse_scroll_event"
- c:identifier="gst_navigation_event_parse_mouse_scroll_event"
- moved-to="Navigation.event_parse_mouse_scroll_event"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="851">Inspect a #GstNavigation mouse scroll event and extract the coordinates
-of the event.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="297"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="866">TRUE if all coordinates could be extracted, otherwise FALSE.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="853">A #GstEvent to inspect.</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="x"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="854">Pointer to a gdouble to receive the x coordinate of the
- mouse movement.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="y"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="856">Pointer to a gdouble to receive the y coordinate of the
- mouse movement.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="delta_x"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="858">Pointer to a gdouble to receive the delta_x coordinate of the
- mouse movement.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="delta_y"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="860">Pointer to a gdouble to receive the delta_y coordinate of the
- mouse movement.</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_message_get_type"
- c:identifier="gst_navigation_message_get_type"
- moved-to="Navigation.message_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="467">Check a bus message to see if it is a #GstNavigation event, and return
-the #GstNavigationMessageType identifying the type of the message if so.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="213"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="474">The type of the #GstMessage, or
-#GST_NAVIGATION_MESSAGE_INVALID if the message is not a #GstNavigation
-notification.</doc>
- <type name="NavigationMessageType" c:type="GstNavigationMessageType"/>
- </return-value>
- <parameters>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="469">A #GstMessage to inspect.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_message_new_angles_changed"
- c:identifier="gst_navigation_message_new_angles_changed"
- moved-to="Navigation.message_new_angles_changed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="639">Creates a new #GstNavigation message with type
-#GST_NAVIGATION_MESSAGE_ANGLES_CHANGED for notifying an application
-that the current angle, or current number of angles available in a
-multiangle video has changed.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="227"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="650">The new #GstMessage.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="641">A #GstObject to set as source of the new message.</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="cur_angle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="642">The currently selected angle.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="n_angles" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="643">The number of viewing angles now available.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_message_new_commands_changed"
- c:identifier="gst_navigation_message_new_commands_changed"
- moved-to="Navigation.message_new_commands_changed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="616">Creates a new #GstNavigation message with type
-#GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="224"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="623">The new #GstMessage.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="618">A #GstObject to set as source of the new message.</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_message_new_event"
- c:identifier="gst_navigation_message_new_event"
- moved-to="Navigation.message_new_event"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="561">Creates a new #GstNavigation message with type
-#GST_NAVIGATION_MESSAGE_EVENT.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="237"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="569">The new #GstMessage.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="563">A #GstObject to set as source of the new message.</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="564">A navigation #GstEvent</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_message_new_mouse_over"
- c:identifier="gst_navigation_message_new_mouse_over"
- moved-to="Navigation.message_new_mouse_over">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="507">Creates a new #GstNavigation message with type
-#GST_NAVIGATION_MESSAGE_MOUSE_OVER.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="216"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="516">The new #GstMessage.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="509">A #GstObject to set as source of the new message.</doc>
- <type name="Gst.Object" c:type="GstObject*"/>
- </parameter>
- <parameter name="active" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="510">%TRUE if the mouse has entered a clickable area of the display.
-%FALSE if it over a non-clickable area.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_message_parse_angles_changed"
- c:identifier="gst_navigation_message_parse_angles_changed"
- moved-to="Navigation.message_parse_angles_changed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="668">Parse a #GstNavigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED
-and extract the @cur_angle and @n_angles parameters.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="232"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="679">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="670">A #GstMessage to inspect.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </parameter>
- <parameter name="cur_angle"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="671">A pointer to a #guint to receive the new
- current angle number, or NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="n_angles"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="673">A pointer to a #guint to receive the new angle
- count, or NULL.</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_message_parse_event"
- c:identifier="gst_navigation_message_parse_event"
- moved-to="Navigation.message_parse_event"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="587">Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_EVENT
-and extract contained #GstEvent. The caller must unref the @event when done
-with it.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="241"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="597">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="589">A #GstMessage to inspect.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </parameter>
- <parameter name="event"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="590">a pointer to a #GstEvent to receive
- the contained navigation event.</doc>
- <type name="Gst.Event" c:type="GstEvent**"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_message_parse_mouse_over"
- c:identifier="gst_navigation_message_parse_mouse_over"
- moved-to="Navigation.message_parse_mouse_over">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="533">Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_MOUSE_OVER
-and extract the active/inactive flag. If the mouse over event is marked
-active, it indicates that the mouse is over a clickable area.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="220"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="543">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="message" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="535">A #GstMessage to inspect.</doc>
- <type name="Gst.Message" c:type="GstMessage*"/>
- </parameter>
- <parameter name="active"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="536">A pointer to a gboolean to receive the
- active/inactive state, or NULL.</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_query_get_type"
- c:identifier="gst_navigation_query_get_type"
- moved-to="Navigation.query_get_type">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="187">Inspect a #GstQuery and return the #GstNavigationQueryType associated with
-it if it is a #GstNavigation query.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="154"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="194">The #GstNavigationQueryType of the query, or
-#GST_NAVIGATION_QUERY_INVALID</doc>
- <type name="NavigationQueryType" c:type="GstNavigationQueryType"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="189">The query to inspect</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_query_new_angles"
- c:identifier="gst_navigation_query_new_angles"
- moved-to="Navigation.query_new_angles">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="383">Create a new #GstNavigation angles query. When executed, it will
-query the pipeline for the set of currently available angles, which may be
-greater than one in a multiangle video.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="175"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="390">The new query.</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </return-value>
- </function>
- <function name="navigation_query_new_commands"
- c:identifier="gst_navigation_query_new_commands"
- moved-to="Navigation.query_new_commands">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="222">Create a new #GstNavigation commands query. When executed, it will
-query the pipeline for the set of currently available commands.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="157"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="228">The new query.</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </return-value>
- </function>
- <function name="navigation_query_parse_angles"
- c:identifier="gst_navigation_query_parse_angles"
- moved-to="Navigation.query_parse_angles">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="426">Parse the current angle number in the #GstNavigation angles @query into the
-#guint pointed to by the @cur_angle variable, and the number of available
-angles into the #guint pointed to by the @n_angles variable.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="182"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="438">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="428">a #GstQuery</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="cur_angle"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="429">Pointer to a #guint into which to store the
- currently selected angle value from the query, or NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="n_angles"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="431">Pointer to a #guint into which to store the
- number of angles value from the query, or NULL</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_query_parse_commands_length"
- c:identifier="gst_navigation_query_parse_commands_length"
- moved-to="Navigation.query_parse_commands_length">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="314">Parse the number of commands in the #GstNavigation commands @query.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="167"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="321">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="316">a #GstQuery</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="n_cmds"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="317">the number of commands in this query.</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_query_parse_commands_nth"
- c:identifier="gst_navigation_query_parse_commands_nth"
- moved-to="Navigation.query_parse_commands_nth">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="344">Parse the #GstNavigation command query and retrieve the @nth command from
-it into @cmd. If the list contains less elements than @nth, @cmd will be
-set to #GST_NAVIGATION_COMMAND_INVALID.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="171"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="354">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="346">a #GstQuery</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="347">the nth command to retrieve.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="cmd"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="348">a pointer to store the nth command into.</doc>
- <type name="NavigationCommand" c:type="GstNavigationCommand*"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_query_set_angles"
- c:identifier="gst_navigation_query_set_angles"
- moved-to="Navigation.query_set_angles">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="405">Set the #GstNavigation angles query result field in @query.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="178"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="407">a #GstQuery</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="cur_angle" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="408">the current viewing angle to set.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="n_angles" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="409">the number of viewing angles to set.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="navigation_query_set_commandsv"
- c:identifier="gst_navigation_query_set_commandsv"
- moved-to="Navigation.query_set_commandsv">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="286">Set the #GstNavigation command query result fields in @query. The number
-of commands passed must be equal to @n_commands.</doc>
- <source-position filename="gst-libs/gst/video/navigation.h" line="163"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="query" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="288">a #GstQuery</doc>
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- <parameter name="n_cmds" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="289">the number of commands to set.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="cmds" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/navigation.c"
- line="290">An array containing @n_cmds
- @GstNavigationCommand values.</doc>
- <array length="1" zero-terminated="0" c:type="GstNavigationCommand*">
- <type name="NavigationCommand" c:type="GstNavigationCommand"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="video_afd_meta_api_get_type"
- c:identifier="gst_video_afd_meta_api_get_type">
- <source-position filename="gst-libs/gst/video/video-anc.h" line="242"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="video_afd_meta_get_info"
- c:identifier="gst_video_afd_meta_get_info"
- moved-to="VideoAFDMeta.get_info">
- <source-position filename="gst-libs/gst/video/video-anc.h" line="245"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="video_affine_transformation_meta_api_get_type"
- c:identifier="gst_video_affine_transformation_meta_api_get_type">
- <source-position filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="65"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="video_affine_transformation_meta_get_info"
- c:identifier="gst_video_affine_transformation_meta_get_info"
- moved-to="VideoAffineTransformationMeta.get_info">
- <source-position filename="gst-libs/gst/video/gstvideoaffinetransformationmeta.h"
- line="68"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="video_bar_meta_api_get_type"
- c:identifier="gst_video_bar_meta_api_get_type">
- <source-position filename="gst-libs/gst/video/video-anc.h" line="306"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="video_bar_meta_get_info"
- c:identifier="gst_video_bar_meta_get_info"
- moved-to="VideoBarMeta.get_info">
- <source-position filename="gst-libs/gst/video/video-anc.h" line="309"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="video_blend" c:identifier="gst_video_blend">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="279">Lets you blend the @src image into the @dest image</doc>
- <source-position filename="gst-libs/gst/video/video-blend.h" line="36"/>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="281">The #GstVideoFrame where to blend @src in</doc>
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="282">the #GstVideoFrame that we want to blend into</doc>
- <type name="VideoFrame" c:type="GstVideoFrame*"/>
- </parameter>
- <parameter name="x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="283">The x offset in pixel where the @src image should be blended</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="284">the y offset in pixel where the @src image should be blended</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="global_alpha" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="285">the global_alpha each per-pixel alpha value is multiplied
- with</doc>
- <type name="gfloat" c:type="gfloat"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_blend_scale_linear_RGBA"
- c:identifier="gst_video_blend_scale_linear_RGBA">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="139">Scales a buffer containing RGBA (or AYUV) video. This is an internal
-helper function which is used to scale subtitle overlays, and may be
-deprecated in the near future. Use #GstVideoScaler to scale video buffers
-instead.</doc>
- <source-position filename="gst-libs/gst/video/video-blend.h" line="31"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="141">the #GstVideoInfo describing the video data in @src_buffer</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="src_buffer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="142">the source buffer containing video pixels to scale</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="dest_height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="143">the height in pixels to scale the video data in @src_buffer to</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="dest_width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="144">the width in pixels to scale the video data in @src_buffer to</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="dest"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="145">pointer to a #GstVideoInfo structure that will be filled in
- with the details for @dest_buffer</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="dest_buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-blend.c"
- line="147">a pointer to a #GstBuffer variable, which will be
- set to a newly-allocated buffer containing the scaled pixels.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer**"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_calculate_display_ratio"
- c:identifier="gst_video_calculate_display_ratio">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="41">Given the Pixel Aspect Ratio and size of an input video frame, and the
-pixel aspect ratio of the intended display device, calculates the actual
-display ratio the video will be rendered with.</doc>
- <source-position filename="gst-libs/gst/video/video.h" line="133"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="56">A boolean indicating success and a calculated Display Ratio in the
-dar_n and dar_d parameters.
-The return value is FALSE in the case of integer overflow or other error.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="dar_n"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="43">Numerator of the calculated display_ratio</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="dar_d"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="44">Denominator of the calculated display_ratio</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="video_width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="45">Width of the video frame in pixels</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="video_height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="46">Height of the video frame in pixels</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="video_par_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="47">Numerator of the pixel aspect ratio of the input video.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="video_par_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="48">Denominator of the pixel aspect ratio of the input video.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="display_par_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="49">Numerator of the pixel aspect ratio of the display device</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="display_par_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="50">Denominator of the pixel aspect ratio of the display device</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_caption_meta_api_get_type"
- c:identifier="gst_video_caption_meta_api_get_type">
- <source-position filename="gst-libs/gst/video/video-anc.h" line="395"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="video_caption_meta_get_info"
- c:identifier="gst_video_caption_meta_get_info"
- moved-to="VideoCaptionMeta.get_info">
- <source-position filename="gst-libs/gst/video/video-anc.h" line="399"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="video_caption_type_from_caps"
- c:identifier="gst_video_caption_type_from_caps"
- moved-to="VideoCaptionType.from_caps"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1040">Parses fixed Closed Caption #GstCaps and returns the corresponding caption
-type, or %GST_VIDEO_CAPTION_TYPE_UNKNOWN.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="369"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1047">#GstVideoCaptionType.</doc>
- <type name="VideoCaptionType" c:type="GstVideoCaptionType"/>
- </return-value>
- <parameters>
- <parameter name="caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1042">Fixed #GstCaps to parse</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_caption_type_to_caps"
- c:identifier="gst_video_caption_type_to_caps"
- moved-to="VideoCaptionType.to_caps"
- version="1.16">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1080">Creates new caps corresponding to @type.</doc>
- <source-position filename="gst-libs/gst/video/video-anc.h" line="373"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1086">new #GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-anc.c"
- line="1082">#GstVideoCaptionType</doc>
- <type name="VideoCaptionType" c:type="GstVideoCaptionType"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_chroma_from_string"
- c:identifier="gst_video_chroma_from_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="78">Convert @s to a #GstVideoChromaSite</doc>
- <source-position filename="gst-libs/gst/video/video-chroma.h" line="56"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="84">a #GstVideoChromaSite or %GST_VIDEO_CHROMA_SITE_UNKNOWN when @s does
-not contain a valid chroma description.</doc>
- <type name="VideoChromaSite" c:type="GstVideoChromaSite"/>
- </return-value>
- <parameters>
- <parameter name="s" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="80">a chromasite string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_chroma_resample"
- c:identifier="gst_video_chroma_resample">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1040">Perform resampling of @width chroma pixels in @lines.</doc>
- <source-position filename="gst-libs/gst/video/video-chroma.h"
- line="107"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="resample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1042">a #GstVideoChromaResample</doc>
- <type name="VideoChromaResample" c:type="GstVideoChromaResample*"/>
- </parameter>
- <parameter name="lines"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1043">pixel lines</doc>
- <type name="gpointer" c:type="gpointer*"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="1044">the number of pixels on one line</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_chroma_resample_new"
- c:identifier="gst_video_chroma_resample_new"
- moved-to="VideoChromaResample.new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="929">Create a new resampler object for the given parameters. When @h_factor or
-@v_factor is &gt; 0, upsampling will be used, otherwise subsampling is
-performed.</doc>
- <source-position filename="gst-libs/gst/video/video-chroma.h" line="93"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="942">a new #GstVideoChromaResample that should be freed with
- gst_video_chroma_resample_free() after usage.</doc>
- <type name="VideoChromaResample" c:type="GstVideoChromaResample*"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="931">a #GstVideoChromaMethod</doc>
- <type name="VideoChromaMethod" c:type="GstVideoChromaMethod"/>
- </parameter>
- <parameter name="site" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="932">a #GstVideoChromaSite</doc>
- <type name="VideoChromaSite" c:type="GstVideoChromaSite"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="933">#GstVideoChromaFlags</doc>
- <type name="VideoChromaFlags" c:type="GstVideoChromaFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="934">the #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="h_factor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="935">horizontal resampling factor</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="v_factor" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="936">vertical resampling factor</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_chroma_to_string"
- c:identifier="gst_video_chroma_to_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="98">Converts @site to its string representation.</doc>
- <source-position filename="gst-libs/gst/video/video-chroma.h" line="59"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="104">a string describing @site.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="site" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-chroma.c"
- line="100">a #GstVideoChromaSite</doc>
- <type name="VideoChromaSite" c:type="GstVideoChromaSite"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_color_matrix_from_iso"
- c:identifier="gst_video_color_matrix_from_iso"
- moved-to="VideoColorMatrix.from_iso"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="799">Converts the @value to the #GstVideoColorMatrix
-The matrix coefficients (MatrixCoefficients) value is
-defined by "ISO/IEC 23001-8 Section 7.3 Table 4"
-and "ITU-T H.273 Table 4".
-"H.264 Table E-5" and "H.265 Table E.5" share the identical values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="288"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="809">the matched #GstVideoColorMatrix</doc>
- <type name="VideoColorMatrix" c:type="GstVideoColorMatrix"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="801">a ITU-T H.273 matrix coefficients value</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_color_matrix_get_Kr_Kb"
- c:identifier="gst_video_color_matrix_get_Kr_Kb"
- moved-to="VideoColorMatrix.get_Kr_Kb"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="322">Get the coefficients used to convert between Y'PbPr and R'G'B' using @matrix.
-
-When:
-
-|[
- 0.0 &lt;= [Y',R',G',B'] &lt;= 1.0)
- (-0.5 &lt;= [Pb,Pr] &lt;= 0.5)
-]|
-
-the general conversion is given by:
-
-|[
- Y' = Kr*R' + (1-Kr-Kb)*G' + Kb*B'
- Pb = (B'-Y')/(2*(1-Kb))
- Pr = (R'-Y')/(2*(1-Kr))
-]|
-
-and the other way around:
-
-|[
- R' = Y' + Cr*2*(1-Kr)
- G' = Y' - Cb*2*(1-Kb)*Kb/(1-Kr-Kb) - Cr*2*(1-Kr)*Kr/(1-Kr-Kb)
- B' = Y' + Cb*2*(1-Kb)
-]|</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="71"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="353">TRUE if @matrix was a YUV color format and @Kr and @Kb contain valid
- values.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="matrix" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="324">a #GstVideoColorMatrix</doc>
- <type name="VideoColorMatrix" c:type="GstVideoColorMatrix"/>
- </parameter>
- <parameter name="Kr"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="325">result red channel coefficient</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- <parameter name="Kb"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="326">result blue channel coefficient</doc>
- <type name="gdouble" c:type="gdouble*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_color_matrix_to_iso"
- c:identifier="gst_video_color_matrix_to_iso"
- moved-to="VideoColorMatrix.to_iso"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="666">Converts #GstVideoColorMatrix to the "matrix coefficients"
-(MatrixCoefficients) value defined by "ISO/IEC 23001-8 Section 7.3 Table 4"
-and "ITU-T H.273 Table 4".
-"H.264 Table E-5" and "H.265 Table E.5" share the identical values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="279"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="675">The value of ISO/IEC 23001-8 matrix coefficients.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="matrix" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="668">a #GstVideoColorMatrix</doc>
- <type name="VideoColorMatrix" c:type="GstVideoColorMatrix"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_color_primaries_from_iso"
- c:identifier="gst_video_color_primaries_from_iso"
- moved-to="VideoColorPrimaries.from_iso"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="886">Converts the @value to the #GstVideoColorPrimaries
-The colour primaries (ColourPrimaries) value is
-defined by "ISO/IEC 23001-8 Section 7.1 Table 2" and "ITU-T H.273 Table 2".
-"H.264 Table E-3" and "H.265 Table E.3" share the identical values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="294"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="895">the matched #GstVideoColorPrimaries</doc>
- <type name="VideoColorPrimaries" c:type="GstVideoColorPrimaries"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="888">a ITU-T H.273 colour primaries value</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_color_primaries_get_info"
- c:identifier="gst_video_color_primaries_get_info"
- moved-to="VideoColorPrimaries.get_info"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="303">Get information about the chromaticity coordinates of @primaries.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="223"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="309">a #GstVideoColorPrimariesInfo for @primaries.</doc>
- <type name="VideoColorPrimariesInfo"
- c:type="const GstVideoColorPrimariesInfo*"/>
- </return-value>
- <parameters>
- <parameter name="primaries" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="305">a #GstVideoColorPrimaries</doc>
- <type name="VideoColorPrimaries" c:type="GstVideoColorPrimaries"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_color_primaries_to_iso"
- c:identifier="gst_video_color_primaries_to_iso"
- moved-to="VideoColorPrimaries.to_iso"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="753">Converts #GstVideoColorPrimaries to the "colour primaries" (ColourPrimaries)
-value defined by "ISO/IEC 23001-8 Section 7.1 Table 2"
-and "ITU-T H.273 Table 2".
-"H.264 Table E-3" and "H.265 Table E.3" share the identical values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="285"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="762">The value of ISO/IEC 23001-8 colour primaries.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="primaries" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="755">a #GstVideoColorPrimaries</doc>
- <type name="VideoColorPrimaries" c:type="GstVideoColorPrimaries"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_color_range_offsets"
- c:identifier="gst_video_color_range_offsets"
- moved-to="VideoColorRange.offsets">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="188">Compute the offset and scale values for each component of @info. For each
-component, (c[i] - offset[i]) / scale[i] will scale the component c[i] to the
-range [0.0 .. 1.0].
-
-The reverse operation (c[i] * scale[i]) + offset[i] can be used to convert
-the component values in range [0.0 .. 1.0] back to their representation in
-@info and @range.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="268"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="range" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="190">a #GstVideoColorRange</doc>
- <type name="VideoColorRange" c:type="GstVideoColorRange"/>
- </parameter>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="191">a #GstVideoFormatInfo</doc>
- <type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
- </parameter>
- <parameter name="offset"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="192">output offsets</doc>
- <array zero-terminated="0" c:type="gint*" fixed-size="4">
- <type name="gint" c:type="gint"/>
- </array>
- </parameter>
- <parameter name="scale"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="193">output scale</doc>
- <array zero-terminated="0" c:type="gint*" fixed-size="4">
- <type name="gint" c:type="gint"/>
- </array>
- </parameter>
- </parameters>
- </function>
- <function name="video_color_transfer_decode"
- c:identifier="gst_video_color_transfer_decode"
- version="1.6"
- deprecated="1">
- <doc-deprecated xml:space="preserve">Use gst_video_transfer_function_decode() instead.</doc-deprecated>
- <source-position filename="gst-libs/gst/video/video-color.h" line="147"/>
- <return-value transfer-ownership="none">
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <parameter name="func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="531">a #GstVideoTransferFunction</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="532">a value</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_color_transfer_encode"
- c:identifier="gst_video_color_transfer_encode"
- version="1.6"
- deprecated="1">
- <doc-deprecated xml:space="preserve">Use gst_video_transfer_function_encode() instead.</doc-deprecated>
- <source-position filename="gst-libs/gst/video/video-color.h" line="142"/>
- <return-value transfer-ownership="none">
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <parameter name="func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="399">a #GstVideoTransferFunction</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="400">a value</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_convert_sample"
- c:identifier="gst_video_convert_sample"
- throws="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/convertframe.c"
- line="284">Converts a raw video buffer into the specified output caps.
-
-The output caps can be any raw video formats or any image formats (jpeg, png, ...).
-
-The width, height and pixel-aspect-ratio can also be specified in the output caps.</doc>
- <source-position filename="gst-libs/gst/video/video.h" line="159"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/convertframe.c"
- line="297">The converted #GstSample, or %NULL if an error happened (in which case @err
-will point to the #GError).</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </return-value>
- <parameters>
- <parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/convertframe.c"
- line="286">a #GstSample</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </parameter>
- <parameter name="to_caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/convertframe.c"
- line="287">the #GstCaps to convert to</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/convertframe.c"
- line="288">the maximum amount of time allowed for the processing.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_convert_sample_async"
- c:identifier="gst_video_convert_sample_async">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/convertframe.c"
- line="659">Converts a raw video buffer into the specified output caps.
-
-The output caps can be any raw video formats or any image formats (jpeg, png, ...).
-
-The width, height and pixel-aspect-ratio can also be specified in the output caps.
-
-@callback will be called after conversion, when an error occurred or if conversion didn't
-finish after @timeout. @callback will always be called from the thread default
-%GMainContext, see g_main_context_get_thread_default(). If GLib before 2.22 is used,
-this will always be the global default main context.
-
-@destroy_notify will be called after the callback was called and @user_data is not needed
-anymore.</doc>
- <source-position filename="gst-libs/gst/video/video.h" line="151"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="sample" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/convertframe.c"
- line="661">a #GstSample</doc>
- <type name="Gst.Sample" c:type="GstSample*"/>
- </parameter>
- <parameter name="to_caps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/convertframe.c"
- line="662">the #GstCaps to convert to</doc>
- <type name="Gst.Caps" c:type="const GstCaps*"/>
- </parameter>
- <parameter name="timeout" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/convertframe.c"
- line="663">the maximum amount of time allowed for the processing.</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="callback"
- transfer-ownership="none"
- scope="notified"
- closure="4"
- destroy="5">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/convertframe.c"
- line="664">%GstVideoConvertSampleCallback that will be called after conversion.</doc>
- <type name="VideoConvertSampleCallback"
- c:type="GstVideoConvertSampleCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/convertframe.c"
- line="665">extra data that will be passed to the @callback</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="destroy_notify"
- transfer-ownership="none"
- scope="async">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/convertframe.c"
- line="666">%GDestroyNotify to be called after @user_data is not needed anymore</doc>
- <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_converter_new"
- c:identifier="gst_video_converter_new"
- moved-to="VideoConverter.new"
- version="1.6"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2477">Create a new converter object to convert between @in_info and @out_info
-with @config.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="279"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2486">a #GstVideoConverter or %NULL if conversion is not possible.</doc>
- <type name="VideoConverter" c:type="GstVideoConverter*"/>
- </return-value>
- <parameters>
- <parameter name="in_info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2479">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="out_info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2480">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="config" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2481">a #GstStructure with configuration options</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_converter_new_with_pool"
- c:identifier="gst_video_converter_new_with_pool"
- moved-to="VideoConverter.new_with_pool"
- version="1.20"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2232">Create a new converter object to convert between @in_info and @out_info
-with @config.
-
-The optional @pool can be used to spawn threads, this is useful when
-creating new converters rapidly, for example when updating cropping.</doc>
- <source-position filename="gst-libs/gst/video/video-converter.h"
- line="284"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2245">a #GstVideoConverter or %NULL if conversion is not possible.</doc>
- <type name="VideoConverter" c:type="GstVideoConverter*"/>
- </return-value>
- <parameters>
- <parameter name="in_info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2234">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="out_info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2235">a #GstVideoInfo</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="config" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2236">a #GstStructure with configuration options</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- <parameter name="pool"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="2237">a #GstTaskPool to spawn threads from</doc>
- <type name="Gst.TaskPool" c:type="GstTaskPool*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_crop_meta_api_get_type"
- c:identifier="gst_video_crop_meta_api_get_type">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="158"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="video_crop_meta_get_info"
- c:identifier="gst_video_crop_meta_get_info"
- moved-to="VideoCropMeta.get_info">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="161"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="video_dither_new"
- c:identifier="gst_video_dither_new"
- moved-to="VideoDither.new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="357">Make a new dither object for dithering lines of @format using the
-algorithm described by @method.
-
-Each component will be quantized to a multiple of @quantizer. Better
-performance is achieved when @quantizer is a power of 2.
-
-@width is the width of the lines that this ditherer will handle.</doc>
- <source-position filename="gst-libs/gst/video/video-dither.h" line="66"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="373">a new #GstVideoDither</doc>
- <type name="VideoDither" c:type="GstVideoDither*"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="359">a #GstVideoDitherMethod</doc>
- <type name="VideoDitherMethod" c:type="GstVideoDitherMethod"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="360">a #GstVideoDitherFlags</doc>
- <type name="VideoDitherFlags" c:type="GstVideoDitherFlags"/>
- </parameter>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="361">a #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="quantizer" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="362">quantizer</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-dither.c"
- line="363">the width of the lines</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_event_is_force_key_unit"
- c:identifier="gst_video_event_is_force_key_unit">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="168">Checks if an event is a force key unit event. Returns true for both upstream
-and downstream force key unit events.</doc>
- <source-position filename="gst-libs/gst/video/video-event.h" line="65"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="175">%TRUE if the event is a valid force key unit event</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="170">A #GstEvent to check</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_event_new_downstream_force_key_unit"
- c:identifier="gst_video_event_new_downstream_force_key_unit">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="96">Creates a new downstream force key unit event. A downstream force key unit
-event can be sent down the pipeline to request downstream elements to produce
-a key unit. A downstream force key unit event must also be sent when handling
-an upstream force key unit event to notify downstream that the latter has been
-handled.
-
-To parse an event created by gst_video_event_new_downstream_force_key_unit() use
-gst_video_event_parse_downstream_force_key_unit().</doc>
- <source-position filename="gst-libs/gst/video/video-event.h" line="39"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="113">The new GstEvent</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="98">the timestamp of the buffer that starts a new key unit</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="stream_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="99">the stream_time of the buffer that starts a new key unit</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="running_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="100">the running_time of the buffer that starts a new key unit</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="all_headers" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="101">%TRUE to produce headers when starting a new key unit</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="102">integer that can be used to number key units</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_event_new_still_frame"
- c:identifier="gst_video_event_new_still_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="29">Creates a new Still Frame event. If @in_still is %TRUE, then the event
-represents the start of a still frame sequence. If it is %FALSE, then
-the event ends a still frame sequence.
-
-To parse an event created by gst_video_event_new_still_frame() use
-gst_video_event_parse_still_frame().</doc>
- <source-position filename="gst-libs/gst/video/video-event.h" line="31"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="40">The new GstEvent</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="in_still" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="31">boolean value for the still-frame state of the event.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_event_new_upstream_force_key_unit"
- c:identifier="gst_video_event_new_upstream_force_key_unit">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="134">Creates a new upstream force key unit event. An upstream force key unit event
-can be sent to request upstream elements to produce a key unit.
-
-@running_time can be set to request a new key unit at a specific
-running_time. If set to GST_CLOCK_TIME_NONE, upstream elements will produce a
-new key unit as soon as possible.
-
-To parse an event created by gst_video_event_new_downstream_force_key_unit() use
-gst_video_event_parse_downstream_force_key_unit().</doc>
- <source-position filename="gst-libs/gst/video/video-event.h" line="54"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="150">The new GstEvent</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </return-value>
- <parameters>
- <parameter name="running_time" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="136">the running_time at which a new key unit should be produced</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="all_headers" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="137">%TRUE to produce headers when starting a new key unit</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="count" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="138">integer that can be used to number key units</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_event_parse_downstream_force_key_unit"
- c:identifier="gst_video_event_parse_downstream_force_key_unit">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="196">Get timestamp, stream-time, running-time, all-headers and count in the force
-key unit event. See gst_video_event_new_downstream_force_key_unit() for a
-full description of the downstream force key unit event.
-
-@running_time will be adjusted for any pad offsets of pads it was passing through.</doc>
- <source-position filename="gst-libs/gst/video/video-event.h" line="46"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="211">%TRUE if the event is a valid downstream force key unit event.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="198">A #GstEvent to parse</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="timestamp"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="199">A pointer to the timestamp in the event</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="stream_time"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="200">A pointer to the stream-time in the event</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="running_time"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="201">A pointer to the running-time in the event</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="all_headers"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="202">A pointer to the all_headers flag in the event</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="count"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="203">A pointer to the count field of the event</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_event_parse_still_frame"
- c:identifier="gst_video_event_parse_still_frame">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="55">Parse a #GstEvent, identify if it is a Still Frame event, and
-return the still-frame state from the event if it is.
-If the event represents the start of a still frame, the in_still
-variable will be set to TRUE, otherwise FALSE. It is OK to pass NULL for the
-in_still variable order to just check whether the event is a valid still-frame
-event.
-
-Create a still frame event using gst_video_event_new_still_frame()</doc>
- <source-position filename="gst-libs/gst/video/video-event.h" line="34"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="70">%TRUE if the event is a valid still-frame event. %FALSE if not</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="57">A #GstEvent to parse</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="in_still"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="58">
- A boolean to receive the still-frame status from the event, or NULL</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_event_parse_upstream_force_key_unit"
- c:identifier="gst_video_event_parse_upstream_force_key_unit">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="270">Get running-time, all-headers and count in the force key unit event. See
-gst_video_event_new_upstream_force_key_unit() for a full description of the
-upstream force key unit event.
-
-Create an upstream force key unit event using gst_video_event_new_upstream_force_key_unit()
-
-@running_time will be adjusted for any pad offsets of pads it was passing through.</doc>
- <source-position filename="gst-libs/gst/video/video-event.h" line="59"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="285">%TRUE if the event is a valid upstream force-key-unit event. %FALSE if not</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="event" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="272">A #GstEvent to parse</doc>
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- <parameter name="running_time"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="273">A pointer to the running_time in the event</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime*"/>
- </parameter>
- <parameter name="all_headers"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="274">A pointer to the all_headers flag in the event</doc>
- <type name="gboolean" c:type="gboolean*"/>
- </parameter>
- <parameter name="count"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-event.c"
- line="275">A pointer to the count field in the event</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_field_order_from_string"
- c:identifier="gst_video_field_order_from_string"
- moved-to="VideoFieldOrder.from_string"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="363">Convert @order to a #GstVideoFieldOrder</doc>
- <source-position filename="gst-libs/gst/video/video-info.h" line="284"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="369">the #GstVideoFieldOrder of @order or
- #GST_VIDEO_FIELD_ORDER_UNKNOWN when @order is not a valid
- string representation for a #GstVideoFieldOrder.</doc>
- <type name="VideoFieldOrder" c:type="GstVideoFieldOrder"/>
- </return-value>
- <parameters>
- <parameter name="order" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="365">a field order</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_field_order_to_string"
- c:identifier="gst_video_field_order_to_string"
- moved-to="VideoFieldOrder.to_string"
- version="1.12">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="344">Convert @order to its string representation.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h" line="281"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="350">@order as a string or NULL if @order in invalid.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="order" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="346">a #GstVideoFieldOrder</doc>
- <type name="VideoFieldOrder" c:type="GstVideoFieldOrder"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_format_from_fourcc"
- c:identifier="gst_video_format_from_fourcc"
- moved-to="VideoFormat.from_fourcc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6815">Converts a FOURCC value into the corresponding #GstVideoFormat.
-If the FOURCC cannot be represented by #GstVideoFormat,
-#GST_VIDEO_FORMAT_UNKNOWN is returned.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="571"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6823">the #GstVideoFormat describing the FOURCC value</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </return-value>
- <parameters>
- <parameter name="fourcc" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6817">a FOURCC value representing raw YUV video</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_format_from_masks"
- c:identifier="gst_video_format_from_masks"
- moved-to="VideoFormat.from_masks">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6741">Find the #GstVideoFormat for the given parameters.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="566"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6754">a #GstVideoFormat or GST_VIDEO_FORMAT_UNKNOWN when the parameters to
-not specify a known format.</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </return-value>
- <parameters>
- <parameter name="depth" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6743">the amount of bits used for a pixel</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="bpp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6744">the amount of bits used to store a pixel. This value is bigger than
- @depth</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="endianness" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6746">the endianness of the masks, #G_LITTLE_ENDIAN or #G_BIG_ENDIAN</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="red_mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6747">the red mask</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="green_mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6748">the green mask</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="blue_mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6749">the blue mask</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="alpha_mask" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6750">the alpha mask, or 0 if no alpha mask</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_format_from_string"
- c:identifier="gst_video_format_from_string"
- moved-to="VideoFormat.from_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6907">Convert the @format string to its #GstVideoFormat.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="574"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6913">the #GstVideoFormat for @format or GST_VIDEO_FORMAT_UNKNOWN when the
-string is not a known format.</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6909">a format string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_format_get_info"
- c:identifier="gst_video_format_get_info"
- moved-to="VideoFormat.get_info">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6972">Get the #GstVideoFormatInfo for @format</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="584"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6978">The #GstVideoFormatInfo for @format.</doc>
- <type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6974">a #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_format_get_palette"
- c:identifier="gst_video_format_get_palette"
- moved-to="VideoFormat.get_palette"
- version="1.2">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6988">Get the default palette of @format. This the palette used in the pack
-function for paletted formats.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="587"/>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6996">the default palette of @format or %NULL when
-@format does not have a palette.</doc>
- <type name="gpointer" c:type="gconstpointer"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6990">a #GstVideoFormat</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6991">size of the palette in bytes</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_format_to_fourcc"
- c:identifier="gst_video_format_to_fourcc"
- moved-to="VideoFormat.to_fourcc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6931">Converts a #GstVideoFormat value into the corresponding FOURCC. Only
-a few YUV formats have corresponding FOURCC values. If @format has
-no corresponding FOURCC value, 0 is returned.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="577"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6939">the FOURCC corresponding to @format</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6933">a #GstVideoFormat video format</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_format_to_string"
- c:identifier="gst_video_format_to_string"
- moved-to="VideoFormat.to_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6952">Returns a string containing a descriptive name for
-the #GstVideoFormat if there is one, or NULL otherwise.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="580"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6959">the name corresponding to @format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="6954">a #GstVideoFormat video format</doc>
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_formats_raw"
- c:identifier="gst_video_formats_raw"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7084">Return all the raw video formats supported by GStreamer.</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="646"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7090">an array of #GstVideoFormat</doc>
- <array length="0" zero-terminated="0" c:type="const GstVideoFormat*">
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </array>
- </return-value>
- <parameters>
- <parameter name="len"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7086">the number of elements in the returned array</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_gl_texture_upload_meta_api_get_type"
- c:identifier="gst_video_gl_texture_upload_meta_api_get_type">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="281"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="video_gl_texture_upload_meta_get_info"
- c:identifier="gst_video_gl_texture_upload_meta_get_info"
- moved-to="VideoGLTextureUploadMeta.get_info">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="284"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="video_guess_framerate"
- c:identifier="gst_video_guess_framerate"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="98">Given the nominal duration of one video frame,
-this function will check some standard framerates for
-a close match (within 0.1%) and return one if possible,
-
-It will calculate an arbitrary framerate if no close
-match was found, and return %FALSE.
-
-It returns %FALSE if a duration of 0 is passed.</doc>
- <source-position filename="gst-libs/gst/video/video.h" line="143"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="113">%TRUE if a close "standard" framerate was
-recognised, and %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="100">Nominal duration of one frame</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- <parameter name="dest_n"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="101">Numerator of the calculated framerate</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="dest_d"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video.c"
- line="102">Denominator of the calculated framerate</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_interlace_mode_from_string"
- c:identifier="gst_video_interlace_mode_from_string"
- moved-to="VideoInterlaceMode.from_string"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="315">Convert @mode to a #GstVideoInterlaceMode</doc>
- <source-position filename="gst-libs/gst/video/video-info.h" line="89"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="321">the #GstVideoInterlaceMode of @mode or
- #GST_VIDEO_INTERLACE_MODE_PROGRESSIVE when @mode is not a valid
- string representation for a #GstVideoInterlaceMode.</doc>
- <type name="VideoInterlaceMode" c:type="GstVideoInterlaceMode"/>
- </return-value>
- <parameters>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="317">a mode</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_interlace_mode_to_string"
- c:identifier="gst_video_interlace_mode_to_string"
- moved-to="VideoInterlaceMode.to_string"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="296">Convert @mode to its string representation.</doc>
- <source-position filename="gst-libs/gst/video/video-info.h" line="86"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="302">@mode as a string or NULL if @mode in invalid.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-info.c"
- line="298">a #GstVideoInterlaceMode</doc>
- <type name="VideoInterlaceMode" c:type="GstVideoInterlaceMode"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_make_raw_caps"
- c:identifier="gst_video_make_raw_caps"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7108">Return a generic raw video caps for formats defined in @formats.
-If @formats is %NULL returns a caps for all the supported raw video formats,
-see gst_video_formats_raw().</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="681"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7117">a video @GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="formats"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7110">an array of raw #GstVideoFormat, or %NULL</doc>
- <array length="1" zero-terminated="0" c:type="const GstVideoFormat*">
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7111">the size of @formats</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_make_raw_caps_with_features"
- c:identifier="gst_video_make_raw_caps_with_features"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7126">Return a generic raw video caps for formats defined in @formats with features
-@features.
-If @formats is %NULL returns a caps for all the supported video formats,
-see gst_video_formats_raw().</doc>
- <source-position filename="gst-libs/gst/video/video-format.h"
- line="684"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7137">a video @GstCaps</doc>
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="formats"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7128">an array of raw #GstVideoFormat, or %NULL</doc>
- <array length="1" zero-terminated="0" c:type="const GstVideoFormat*">
- <type name="VideoFormat" c:type="GstVideoFormat"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7129">the size of @formats</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="features"
- transfer-ownership="full"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-format.c"
- line="7130">the #GstCapsFeatures to set on the caps</doc>
- <type name="Gst.CapsFeatures" c:type="GstCapsFeatures*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_mastering_display_info_from_string"
- c:identifier="gst_video_mastering_display_info_from_string"
- moved-to="VideoMasteringDisplayInfo.from_string"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="60">Extract #GstVideoMasteringDisplayInfo from @mastering</doc>
- <source-position filename="gst-libs/gst/video/video-hdr.h" line="80"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="67">%TRUE if @minfo was filled with @mastering</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="minfo"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="62">a #GstVideoMasteringDisplayInfo</doc>
- <type name="VideoMasteringDisplayInfo"
- c:type="GstVideoMasteringDisplayInfo*"/>
- </parameter>
- <parameter name="mastering" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-hdr.c"
- line="63">a #GstStructure representing #GstVideoMasteringDisplayInfo</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_meta_api_get_type"
- c:identifier="gst_video_meta_api_get_type">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="101"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="video_meta_get_info"
- c:identifier="gst_video_meta_get_info"
- moved-to="VideoMeta.get_info">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="104"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="video_meta_transform_scale_get_quark"
- c:identifier="gst_video_meta_transform_scale_get_quark"
- moved-to="VideoMetaTransform.scale_get_quark">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="619">Get the #GQuark for the "gst-video-scale" metadata transform operation.</doc>
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="169"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/gstvideometa.c"
- line="624">a #GQuark</doc>
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- <function name="video_multiview_get_doubled_height_modes"
- c:identifier="gst_video_multiview_get_doubled_height_modes"
- version="1.6">
- <source-position filename="gst-libs/gst/video/video-multiview.h"
- line="50"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="219">A const #GValue containing a list of stereo video modes
-
-Utility function that returns a #GValue with a GstList of packed stereo
-video modes with double the height of a single view for use in
-caps negotiations. Currently this is top-bottom and row-interleaved.</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- </function>
- <function name="video_multiview_get_doubled_size_modes"
- c:identifier="gst_video_multiview_get_doubled_size_modes"
- version="1.6">
- <source-position filename="gst-libs/gst/video/video-multiview.h"
- line="56"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="256">A const #GValue containing a list of stereo video modes
-
-Utility function that returns a #GValue with a GstList of packed
-stereo video modes that have double the width/height of a single
-view for use in caps negotiation. Currently this is just
-'checkerboard' layout.</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- </function>
- <function name="video_multiview_get_doubled_width_modes"
- c:identifier="gst_video_multiview_get_doubled_width_modes"
- version="1.6">
- <source-position filename="gst-libs/gst/video/video-multiview.h"
- line="53"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="237">A const #GValue containing a list of stereo video modes
-
-Utility function that returns a #GValue with a GstList of packed stereo
-video modes with double the width of a single view for use in
-caps negotiations. Currently this is side-by-side, side-by-side-quincunx
-and column-interleaved.</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- </function>
- <function name="video_multiview_get_mono_modes"
- c:identifier="gst_video_multiview_get_mono_modes"
- version="1.6">
- <source-position filename="gst-libs/gst/video/video-multiview.h"
- line="44"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="184">A const #GValue containing a list of mono video modes
-
-Utility function that returns a #GValue with a GstList of mono video
-modes (mono/left/right) for use in caps negotiations.</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- </function>
- <function name="video_multiview_get_unpacked_modes"
- c:identifier="gst_video_multiview_get_unpacked_modes"
- version="1.6">
- <source-position filename="gst-libs/gst/video/video-multiview.h"
- line="47"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="201">A const #GValue containing a list of 'unpacked' stereo video modes
-
-Utility function that returns a #GValue with a GstList of unpacked
-stereo video modes (separated/frame-by-frame/frame-by-frame-multiview)
-for use in caps negotiations.</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </return-value>
- </function>
- <function name="video_multiview_guess_half_aspect"
- c:identifier="gst_video_multiview_guess_half_aspect"
- version="1.6">
- <source-position filename="gst-libs/gst/video/video-multiview.h"
- line="63"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="370">A boolean indicating whether the
- #GST_VIDEO_MULTIVIEW_FLAGS_HALF_ASPECT flag should be set.
-
-Utility function that heuristically guess whether a
-frame-packed stereoscopic video contains half width/height
-encoded views, or full-frame views by looking at the
-overall display aspect ratio.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="mv_mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="364">A #GstVideoMultiviewMode</doc>
- <type name="VideoMultiviewMode" c:type="GstVideoMultiviewMode"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="365">Video frame width in pixels</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="366">Video frame height in pixels</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="par_n" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="367">Numerator of the video pixel-aspect-ratio</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="par_d" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="368">Denominator of the video pixel-aspect-ratio</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_multiview_mode_from_caps_string"
- c:identifier="gst_video_multiview_mode_from_caps_string"
- moved-to="VideoMultiviewMode.from_caps_string"
- version="1.6">
- <source-position filename="gst-libs/gst/video/video-multiview.h"
- line="41"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="93">The #GstVideoMultiviewMode value
-
-Given a string from a caps multiview-mode field,
-output the corresponding #GstVideoMultiviewMode
-or #GST_VIDEO_MULTIVIEW_MODE_NONE</doc>
- <type name="VideoMultiviewMode" c:type="GstVideoMultiviewMode"/>
- </return-value>
- <parameters>
- <parameter name="caps_mview_mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="91">multiview-mode field string from caps</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_multiview_mode_to_caps_string"
- c:identifier="gst_video_multiview_mode_to_caps_string"
- moved-to="VideoMultiviewMode.to_caps_string"
- version="1.6">
- <source-position filename="gst-libs/gst/video/video-multiview.h"
- line="38"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="68">The caps string representation of the mode, or NULL if invalid.
-
-Given a #GstVideoMultiviewMode returns the multiview-mode caps string
-for insertion into a caps structure</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="mview_mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="66">A #GstVideoMultiviewMode value</doc>
- <type name="VideoMultiviewMode" c:type="GstVideoMultiviewMode"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_multiview_video_info_change_mode"
- c:identifier="gst_video_multiview_video_info_change_mode"
- version="1.6">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="340">Utility function that transforms the width/height/PAR
-and multiview mode and flags of a #GstVideoInfo into
-the requested mode.</doc>
- <source-position filename="gst-libs/gst/video/video-multiview.h"
- line="59"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="info" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="342">A #GstVideoInfo structure to operate on</doc>
- <type name="VideoInfo" c:type="GstVideoInfo*"/>
- </parameter>
- <parameter name="out_mview_mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="343">A #GstVideoMultiviewMode value</doc>
- <type name="VideoMultiviewMode" c:type="GstVideoMultiviewMode"/>
- </parameter>
- <parameter name="out_mview_flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-multiview.c"
- line="344">A set of #GstVideoMultiviewFlags</doc>
- <type name="VideoMultiviewFlags" c:type="GstVideoMultiviewFlags"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_overlay_composition_meta_api_get_type"
- c:identifier="gst_video_overlay_composition_meta_api_get_type">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="290"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="video_overlay_composition_meta_get_info"
- c:identifier="gst_video_overlay_composition_meta_get_info"
- moved-to="VideoOverlayCompositionMeta.get_info">
- <source-position filename="gst-libs/gst/video/video-overlay-composition.h"
- line="293"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="video_overlay_install_properties"
- c:identifier="gst_video_overlay_install_properties"
- moved-to="VideoOverlay.install_properties"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="518">This helper shall be used by classes implementing the #GstVideoOverlay
-interface that want the render rectangle to be controllable using
-properties. This helper will install "render-rectangle" property into the
-class.</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="108"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="oclass" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="520">The class on which the properties will be installed</doc>
- <type name="GObject.ObjectClass" c:type="GObjectClass*"/>
- </parameter>
- <parameter name="last_prop_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="521">The first free property ID to use</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_overlay_set_property"
- c:identifier="gst_video_overlay_set_property"
- moved-to="VideoOverlay.set_property"
- version="1.14">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="542">This helper shall be used by classes implementing the #GstVideoOverlay
-interface that want the render rectangle to be controllable using
-properties. This helper will parse and set the render rectangle calling
-gst_video_overlay_set_render_rectangle().</doc>
- <source-position filename="gst-libs/gst/video/videooverlay.h"
- line="112"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="554">%TRUE if the @property_id matches the GstVideoOverlay property</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="544">The instance on which the property is set</doc>
- <type name="GObject.Object" c:type="GObject*"/>
- </parameter>
- <parameter name="last_prop_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="545">The highest property ID.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="property_id" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="546">The property ID</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/videooverlay.c"
- line="547">The #GValue to be set</doc>
- <type name="GObject.Value" c:type="const GValue*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_region_of_interest_meta_api_get_type"
- c:identifier="gst_video_region_of_interest_meta_api_get_type">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="335"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="video_region_of_interest_meta_get_info"
- c:identifier="gst_video_region_of_interest_meta_get_info"
- moved-to="VideoRegionOfInterestMeta.get_info">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="338"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="video_scaler_new"
- c:identifier="gst_video_scaler_new"
- moved-to="VideoScaler.new"
- introspectable="0">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="195">Make a new @method video scaler. @in_size source lines/pixels will
-be scaled to @out_size destination lines/pixels.
-
-@n_taps specifies the amount of pixels to use from the source for one output
-pixel. If n_taps is 0, this function chooses a good value automatically based
-on the @method and @in_size/@out_size.</doc>
- <source-position filename="gst-libs/gst/video/video-scaler.h" line="54"/>
- <return-value>
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="211">a #GstVideoScaler</doc>
- <type name="VideoScaler" c:type="GstVideoScaler*"/>
- </return-value>
- <parameters>
- <parameter name="method" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="197">a #GstVideoResamplerMethod</doc>
- <type name="VideoResamplerMethod" c:type="GstVideoResamplerMethod"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="198">#GstVideoScalerFlags</doc>
- <type name="VideoScalerFlags" c:type="GstVideoScalerFlags"/>
- </parameter>
- <parameter name="n_taps" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="199">number of taps to use</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="in_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="200">number of source elements</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="out_size" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="201">number of destination elements</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="options"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-scaler.c"
- line="202">extra options</doc>
- <type name="Gst.Structure" c:type="GstStructure*"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_tile_get_index"
- c:identifier="gst_video_tile_get_index"
- version="1.4">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.c"
- line="25">Get the tile index of the tile at coordinates @x and @y in the tiled
-image of @x_tiles by @y_tiles.
-
-Use this method when @mode is of type %GST_VIDEO_TILE_TYPE_INDEXED.</doc>
- <source-position filename="gst-libs/gst/video/video-tile.h" line="134"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.c"
- line="38">the index of the tile at @x and @y in the tiled image of
- @x_tiles by @y_tiles.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="mode" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.c"
- line="27">a #GstVideoTileMode</doc>
- <type name="VideoTileMode" c:type="GstVideoTileMode"/>
- </parameter>
- <parameter name="x" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.c"
- line="28">x coordinate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.c"
- line="29">y coordinate</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="x_tiles" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.c"
- line="30">number of horizintal tiles</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="y_tiles" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-tile.c"
- line="31">number of vertical tiles</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_time_code_meta_api_get_type"
- c:identifier="gst_video_time_code_meta_api_get_type">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="389"/>
- <return-value transfer-ownership="none">
- <type name="GType" c:type="GType"/>
- </return-value>
- </function>
- <function name="video_time_code_meta_get_info"
- c:identifier="gst_video_time_code_meta_get_info"
- moved-to="VideoTimeCodeMeta.get_info">
- <source-position filename="gst-libs/gst/video/gstvideometa.h"
- line="393"/>
- <return-value transfer-ownership="none">
- <type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
- </return-value>
- </function>
- <function name="video_transfer_function_decode"
- c:identifier="gst_video_transfer_function_decode"
- moved-to="VideoTransferFunction.decode"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="544">Convert @val to its gamma decoded value. This is the inverse operation of
-@gst_video_color_transfer_encode().
-
-For a non-linear value L' in the range [0..1], conversion to the linear
-L is in general performed with a power function like:
-
-|[
- L = L' ^ gamma
-]|
-
-Depending on @func, different formulas might be applied. Some formulas
-encode a linear segment in the lower range.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="149"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="562">the gamma decoded value of @val</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <parameter name="func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="546">a #GstVideoTransferFunction</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="547">a value</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_transfer_function_encode"
- c:identifier="gst_video_transfer_function_encode"
- moved-to="VideoTransferFunction.encode"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="412">Convert @val to its gamma encoded value.
-
-For a linear value L in the range [0..1], conversion to the non-linear
-(gamma encoded) L' is in general performed with a power function like:
-
-|[
- L' = L ^ (1 / gamma)
-]|
-
-Depending on @func, different formulas might be applied. Some formulas
-encode a linear segment in the lower range.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="144"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="429">the gamma encoded value of @val</doc>
- <type name="gdouble" c:type="gdouble"/>
- </return-value>
- <parameters>
- <parameter name="func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="414">a #GstVideoTransferFunction</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </parameter>
- <parameter name="val" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="415">a value</doc>
- <type name="gdouble" c:type="gdouble"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_transfer_function_from_iso"
- c:identifier="gst_video_transfer_function_from_iso"
- moved-to="VideoTransferFunction.from_iso"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="836">Converts the @value to the #GstVideoTransferFunction
-The transfer characteristics (TransferCharacteristics) value is
-defined by "ISO/IEC 23001-8 Section 7.2 Table 3"
-and "ITU-T H.273 Table 3".
-"H.264 Table E-4" and "H.265 Table E.4" share the identical values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="291"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="846">the matched #GstVideoTransferFunction</doc>
- <type name="VideoTransferFunction" c:type="GstVideoTransferFunction"/>
- </return-value>
- <parameters>
- <parameter name="value" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="838">a ITU-T H.273 transfer characteristics value</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_transfer_function_is_equivalent"
- c:identifier="gst_video_transfer_function_is_equivalent"
- moved-to="VideoTransferFunction.is_equivalent"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="950">Returns whether @from_func and @to_func are equivalent. There are cases
-(e.g. BT601, BT709, and BT2020_10) where several functions are functionally
-identical. In these cases, when doing conversion, we should consider them
-as equivalent. Also, BT2020_12 is the same as the aforementioned three for
-less than 12 bits per pixel.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="297"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="963">TRUE if @from_func and @to_func can be considered equivalent.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="from_func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="952">#GstVideoTransferFunction to convert from</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </parameter>
- <parameter name="from_bpp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="953">bits per pixel to convert from</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="to_func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="954">#GstVideoTransferFunction to convert into</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </parameter>
- <parameter name="to_bpp" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="955">bits per pixel to convert into</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="video_transfer_function_to_iso"
- c:identifier="gst_video_transfer_function_to_iso"
- moved-to="VideoTransferFunction.to_iso"
- version="1.18">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="701">Converts #GstVideoTransferFunction to the "transfer characteristics"
-(TransferCharacteristics) value defined by "ISO/IEC 23001-8 Section 7.2 Table 3"
-and "ITU-T H.273 Table 3".
-"H.264 Table E-4" and "H.265 Table E.4" share the identical values.</doc>
- <source-position filename="gst-libs/gst/video/video-color.h" line="282"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="710">The value of ISO/IEC 23001-8 transfer characteristics.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="func" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-color.c"
- line="703">a #GstVideoTransferFunction</doc>
- <type name="VideoTransferFunction"
- c:type="GstVideoTransferFunction"/>
- </parameter>
- </parameters>
- </function>
- <docsection name="videoconverter">
- <doc xml:space="preserve"
- filename="gst-libs/gst/video/video-converter.c"
- line="41">This object is used to convert video frames from one format to another.
-The object can perform conversion of:
-
- * video format
- * video colorspace
- * chroma-siting
- * video size</doc>
- </docsection>
- </namespace>
-</repository>
diff --git a/girs/GstWebRTC-1.0.gir b/girs/GstWebRTC-1.0.gir
deleted file mode 100644
index e6712f0d14..0000000000
--- a/girs/GstWebRTC-1.0.gir
+++ /dev/null
@@ -1,1742 +0,0 @@
-<?xml version="1.0"?>
-<!-- This file was automatically generated from C sources - DO NOT EDIT!
-To affect the contents of this file, edit the original C definitions,
-and/or use gtk-doc annotations. -->
-<repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="Gst" version="1.0"/>
- <include name="GstSdp" version="1.0"/>
- <package name="gstreamer-webrtc-1.0"/>
- <c:include name="gst/webrtc/webrtc.h"/>
- <namespace name="GstWebRTC"
- version="1.0"
- shared-library="libgstwebrtc-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <function-macro name="IS_WEBRTC_DATA_CHANNEL"
- c:identifier="GST_IS_WEBRTC_DATA_CHANNEL"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/datachannel.h" line="34"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_WEBRTC_DATA_CHANNEL_CLASS"
- c:identifier="GST_IS_WEBRTC_DATA_CHANNEL_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/datachannel.h" line="36"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_WEBRTC_DTLS_TRANSPORT"
- c:identifier="GST_IS_WEBRTC_DTLS_TRANSPORT"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/dtlstransport.h"
- line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_WEBRTC_DTLS_TRANSPORT_CLASS"
- c:identifier="GST_IS_WEBRTC_DTLS_TRANSPORT_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/dtlstransport.h"
- line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_WEBRTC_ICE_TRANSPORT"
- c:identifier="GST_IS_WEBRTC_ICE_TRANSPORT"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/icetransport.h"
- line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_WEBRTC_ICE_TRANSPORT_CLASS"
- c:identifier="GST_IS_WEBRTC_ICE_TRANSPORT_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/icetransport.h"
- line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_WEBRTC_RTP_RECEIVER"
- c:identifier="GST_IS_WEBRTC_RTP_RECEIVER"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtpreceiver.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_WEBRTC_RTP_RECEIVER_CLASS"
- c:identifier="GST_IS_WEBRTC_RTP_RECEIVER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtpreceiver.h" line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_WEBRTC_RTP_SENDER"
- c:identifier="GST_IS_WEBRTC_RTP_SENDER"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtpsender.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_WEBRTC_RTP_SENDER_CLASS"
- c:identifier="GST_IS_WEBRTC_RTP_SENDER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtpsender.h" line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_WEBRTC_RTP_TRANSCEIVER"
- c:identifier="GST_IS_WEBRTC_RTP_TRANSCEIVER"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtptransceiver.h"
- line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="IS_WEBRTC_RTP_TRANSCEIVER_CLASS"
- c:identifier="GST_IS_WEBRTC_RTP_TRANSCEIVER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtptransceiver.h"
- line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_DATA_CHANNEL"
- c:identifier="GST_WEBRTC_DATA_CHANNEL"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/datachannel.h" line="33"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_DATA_CHANNEL_CLASS"
- c:identifier="GST_WEBRTC_DATA_CHANNEL_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/datachannel.h" line="35"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_DATA_CHANNEL_GET_CLASS"
- c:identifier="GST_WEBRTC_DATA_CHANNEL_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/datachannel.h" line="37"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_DTLS_TRANSPORT"
- c:identifier="GST_WEBRTC_DTLS_TRANSPORT"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/dtlstransport.h"
- line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_DTLS_TRANSPORT_CLASS"
- c:identifier="GST_WEBRTC_DTLS_TRANSPORT_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/dtlstransport.h"
- line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_DTLS_TRANSPORT_GET_CLASS"
- c:identifier="GST_WEBRTC_DTLS_TRANSPORT_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/dtlstransport.h"
- line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_ICE_TRANSPORT"
- c:identifier="GST_WEBRTC_ICE_TRANSPORT"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/icetransport.h"
- line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_ICE_TRANSPORT_CLASS"
- c:identifier="GST_WEBRTC_ICE_TRANSPORT_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/icetransport.h"
- line="33"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_ICE_TRANSPORT_GET_CLASS"
- c:identifier="GST_WEBRTC_ICE_TRANSPORT_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/icetransport.h"
- line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_RTP_RECEIVER"
- c:identifier="GST_WEBRTC_RTP_RECEIVER"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtpreceiver.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_RTP_RECEIVER_CLASS"
- c:identifier="GST_WEBRTC_RTP_RECEIVER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtpreceiver.h" line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_RTP_RECEIVER_GET_CLASS"
- c:identifier="GST_WEBRTC_RTP_RECEIVER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtpreceiver.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_RTP_SENDER"
- c:identifier="GST_WEBRTC_RTP_SENDER"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtpsender.h" line="32"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_RTP_SENDER_CLASS"
- c:identifier="GST_WEBRTC_RTP_SENDER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtpsender.h" line="34"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_RTP_SENDER_GET_CLASS"
- c:identifier="GST_WEBRTC_RTP_SENDER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtpsender.h" line="36"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_RTP_TRANSCEIVER"
- c:identifier="GST_WEBRTC_RTP_TRANSCEIVER"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtptransceiver.h"
- line="31"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_RTP_TRANSCEIVER_CLASS"
- c:identifier="GST_WEBRTC_RTP_TRANSCEIVER_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtptransceiver.h"
- line="33"/>
- <parameters>
- <parameter name="klass">
- </parameter>
- </parameters>
- </function-macro>
- <function-macro name="WEBRTC_RTP_TRANSCEIVER_GET_CLASS"
- c:identifier="GST_WEBRTC_RTP_TRANSCEIVER_GET_CLASS"
- introspectable="0">
- <source-position filename="gst-libs/gst/webrtc/rtptransceiver.h"
- line="35"/>
- <parameters>
- <parameter name="obj">
- </parameter>
- </parameters>
- </function-macro>
- <enumeration name="WebRTCBundlePolicy"
- version="1.16"
- glib:type-name="GstWebRTCBundlePolicy"
- glib:get-type="gst_webrtc_bundle_policy_get_type"
- c:type="GstWebRTCBundlePolicy">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="340">See https://tools.ietf.org/html/draft-ietf-rtcweb-jsep-24#section-4.1.1
-for more information.</doc>
- <member name="none"
- value="0"
- c:identifier="GST_WEBRTC_BUNDLE_POLICY_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="342">none</doc>
- </member>
- <member name="balanced"
- value="1"
- c:identifier="GST_WEBRTC_BUNDLE_POLICY_BALANCED"
- glib:nick="balanced">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="343">balanced</doc>
- </member>
- <member name="max_compat"
- value="2"
- c:identifier="GST_WEBRTC_BUNDLE_POLICY_MAX_COMPAT"
- glib:nick="max-compat">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="344">max-compat</doc>
- </member>
- <member name="max_bundle"
- value="3"
- c:identifier="GST_WEBRTC_BUNDLE_POLICY_MAX_BUNDLE"
- glib:nick="max-bundle">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="345">max-bundle</doc>
- </member>
- </enumeration>
- <enumeration name="WebRTCDTLSSetup"
- glib:type-name="GstWebRTCDTLSSetup"
- glib:get-type="gst_webrtc_dtls_setup_get_type"
- c:type="GstWebRTCDTLSSetup">
- <member name="none"
- value="0"
- c:identifier="GST_WEBRTC_DTLS_SETUP_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="220">none</doc>
- </member>
- <member name="actpass"
- value="1"
- c:identifier="GST_WEBRTC_DTLS_SETUP_ACTPASS"
- glib:nick="actpass">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="221">actpass</doc>
- </member>
- <member name="active"
- value="2"
- c:identifier="GST_WEBRTC_DTLS_SETUP_ACTIVE"
- glib:nick="active">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="222">sendonly</doc>
- </member>
- <member name="passive"
- value="3"
- c:identifier="GST_WEBRTC_DTLS_SETUP_PASSIVE"
- glib:nick="passive">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="223">recvonly</doc>
- </member>
- </enumeration>
- <class name="WebRTCDTLSTransport"
- c:symbol-prefix="webrtc_dtls_transport"
- c:type="GstWebRTCDTLSTransport"
- parent="Gst.Object"
- glib:type-name="GstWebRTCDTLSTransport"
- glib:get-type="gst_webrtc_dtls_transport_get_type"
- glib:type-struct="WebRTCDTLSTransportClass">
- <source-position filename="gst-libs/gst/webrtc/webrtc_fwd.h" line="46"/>
- <property name="certificate" writable="1" transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="client" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="remote-certificate" transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="session-id"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="state" transfer-ownership="none">
- <type name="WebRTCDTLSTransportState"/>
- </property>
- <property name="transport" transfer-ownership="none">
- <type name="WebRTCICETransport"/>
- </property>
- </class>
- <record name="WebRTCDTLSTransportClass"
- c:type="GstWebRTCDTLSTransportClass"
- disguised="1"
- glib:is-gtype-struct-for="WebRTCDTLSTransport">
- <source-position filename="gst-libs/gst/webrtc/webrtc_fwd.h" line="46"/>
- </record>
- <enumeration name="WebRTCDTLSTransportState"
- glib:type-name="GstWebRTCDTLSTransportState"
- glib:get-type="gst_webrtc_dtls_transport_state_get_type"
- c:type="GstWebRTCDTLSTransportState">
- <member name="new"
- value="0"
- c:identifier="GST_WEBRTC_DTLS_TRANSPORT_STATE_NEW"
- glib:nick="new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="67">new</doc>
- </member>
- <member name="closed"
- value="1"
- c:identifier="GST_WEBRTC_DTLS_TRANSPORT_STATE_CLOSED"
- glib:nick="closed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="68">closed</doc>
- </member>
- <member name="failed"
- value="2"
- c:identifier="GST_WEBRTC_DTLS_TRANSPORT_STATE_FAILED"
- glib:nick="failed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="69">failed</doc>
- </member>
- <member name="connecting"
- value="3"
- c:identifier="GST_WEBRTC_DTLS_TRANSPORT_STATE_CONNECTING"
- glib:nick="connecting">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="70">connecting</doc>
- </member>
- <member name="connected"
- value="4"
- c:identifier="GST_WEBRTC_DTLS_TRANSPORT_STATE_CONNECTED"
- glib:nick="connected">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="71">connected</doc>
- </member>
- </enumeration>
- <class name="WebRTCDataChannel"
- c:symbol-prefix="webrtc_data_channel"
- c:type="GstWebRTCDataChannel"
- parent="GObject.Object"
- abstract="1"
- glib:type-name="GstWebRTCDataChannel"
- glib:get-type="gst_webrtc_data_channel_get_type"
- glib:type-struct="WebRTCDataChannelClass">
- <source-position filename="gst-libs/gst/webrtc/webrtc_fwd.h" line="63"/>
- <method name="close" c:identifier="gst_webrtc_data_channel_close">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="545">Close the @channel.</doc>
- <source-position filename="gst-libs/gst/webrtc/datachannel.h"
- line="46"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="547">a #GstWebRTCDataChannel</doc>
- <type name="WebRTCDataChannel" c:type="GstWebRTCDataChannel*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="send_data"
- c:identifier="gst_webrtc_data_channel_send_data">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="507">Send @data as a data message over @channel.</doc>
- <source-position filename="gst-libs/gst/webrtc/datachannel.h"
- line="40"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="509">a #GstWebRTCDataChannel</doc>
- <type name="WebRTCDataChannel" c:type="GstWebRTCDataChannel*"/>
- </instance-parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="510">a #GBytes or %NULL</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </parameter>
- </parameters>
- </method>
- <method name="send_string"
- c:identifier="gst_webrtc_data_channel_send_string">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="526">Send @str as a string message over @channel.</doc>
- <source-position filename="gst-libs/gst/webrtc/datachannel.h"
- line="43"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="channel" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="528">a #GstWebRTCDataChannel</doc>
- <type name="WebRTCDataChannel" c:type="GstWebRTCDataChannel*"/>
- </instance-parameter>
- <parameter name="str"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="529">a string or %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <property name="buffered-amount" transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="buffered-amount-low-threshold"
- writable="1"
- transfer-ownership="none">
- <type name="guint64" c:type="guint64"/>
- </property>
- <property name="id"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <property name="label"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="max-packet-lifetime"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <property name="max-retransmits"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <property name="negotiated"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="ordered"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="priority"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="WebRTCPriorityType"/>
- </property>
- <property name="protocol"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="ready-state" transfer-ownership="none">
- <type name="WebRTCDataChannelState"/>
- </property>
- <glib:signal name="close" when="last" action="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="353">Close the data channel</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="on-buffered-amount-low" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="on-close" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="on-error" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="error" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="299">the #GError thrown</doc>
- <type name="GLib.Error"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="on-message-data" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="308">a #GBytes of the data received</doc>
- <type name="GLib.Bytes"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="on-message-string" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="317">the data received as a string</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="on-open" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="send-data" when="last" action="1">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="334">a #GBytes with the data</doc>
- <type name="GLib.Bytes"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="send-string" when="last" action="1">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="345">the data to send as a string</doc>
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="WebRTCDataChannelClass"
- c:type="GstWebRTCDataChannelClass"
- disguised="1"
- glib:is-gtype-struct-for="WebRTCDataChannel">
- <source-position filename="gst-libs/gst/webrtc/webrtc_fwd.h" line="63"/>
- </record>
- <enumeration name="WebRTCDataChannelState"
- version="1.16"
- glib:type-name="GstWebRTCDataChannelState"
- glib:get-type="gst_webrtc_data_channel_state_get_type"
- c:type="GstWebRTCDataChannelState">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="319">See &lt;http://w3c.github.io/webrtc-pc/#dom-rtcdatachannelstate&gt;</doc>
- <member name="new"
- value="0"
- c:identifier="GST_WEBRTC_DATA_CHANNEL_STATE_NEW"
- glib:nick="new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="321">new</doc>
- </member>
- <member name="connecting"
- value="1"
- c:identifier="GST_WEBRTC_DATA_CHANNEL_STATE_CONNECTING"
- glib:nick="connecting">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="322">connection</doc>
- </member>
- <member name="open"
- value="2"
- c:identifier="GST_WEBRTC_DATA_CHANNEL_STATE_OPEN"
- glib:nick="open">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="323">open</doc>
- </member>
- <member name="closing"
- value="3"
- c:identifier="GST_WEBRTC_DATA_CHANNEL_STATE_CLOSING"
- glib:nick="closing">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="324">closing</doc>
- </member>
- <member name="closed"
- value="4"
- c:identifier="GST_WEBRTC_DATA_CHANNEL_STATE_CLOSED"
- glib:nick="closed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="325">closed</doc>
- </member>
- </enumeration>
- <enumeration name="WebRTCFECType"
- version="1.14.1"
- glib:type-name="GstWebRTCFECType"
- glib:get-type="gst_webrtc_fec_type_get_type"
- c:type="GstWebRTCFECType">
- <member name="none"
- value="0"
- c:identifier="GST_WEBRTC_FEC_TYPE_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="270">none</doc>
- </member>
- <member name="ulp_red"
- value="1"
- c:identifier="GST_WEBRTC_FEC_TYPE_ULP_RED"
- glib:nick="ulp-red">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="271">ulpfec + red</doc>
- </member>
- </enumeration>
- <enumeration name="WebRTCICEComponent"
- glib:type-name="GstWebRTCICEComponent"
- glib:get-type="gst_webrtc_ice_component_get_type"
- c:type="GstWebRTCICEComponent">
- <member name="rtp"
- value="0"
- c:identifier="GST_WEBRTC_ICE_COMPONENT_RTP"
- glib:nick="rtp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="175">RTP component</doc>
- </member>
- <member name="rtcp"
- value="1"
- c:identifier="GST_WEBRTC_ICE_COMPONENT_RTCP"
- glib:nick="rtcp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="176">RTCP component</doc>
- </member>
- </enumeration>
- <enumeration name="WebRTCICEConnectionState"
- glib:type-name="GstWebRTCICEConnectionState"
- glib:get-type="gst_webrtc_ice_connection_state_get_type"
- c:type="GstWebRTCICEConnectionState">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="97">See &lt;http://w3c.github.io/webrtc-pc/#dom-rtciceconnectionstate&gt;</doc>
- <member name="new"
- value="0"
- c:identifier="GST_WEBRTC_ICE_CONNECTION_STATE_NEW"
- glib:nick="new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="99">new</doc>
- </member>
- <member name="checking"
- value="1"
- c:identifier="GST_WEBRTC_ICE_CONNECTION_STATE_CHECKING"
- glib:nick="checking">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="100">checking</doc>
- </member>
- <member name="connected"
- value="2"
- c:identifier="GST_WEBRTC_ICE_CONNECTION_STATE_CONNECTED"
- glib:nick="connected">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="101">connected</doc>
- </member>
- <member name="completed"
- value="3"
- c:identifier="GST_WEBRTC_ICE_CONNECTION_STATE_COMPLETED"
- glib:nick="completed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="102">completed</doc>
- </member>
- <member name="failed"
- value="4"
- c:identifier="GST_WEBRTC_ICE_CONNECTION_STATE_FAILED"
- glib:nick="failed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="103">failed</doc>
- </member>
- <member name="disconnected"
- value="5"
- c:identifier="GST_WEBRTC_ICE_CONNECTION_STATE_DISCONNECTED"
- glib:nick="disconnected">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="104">disconnected</doc>
- </member>
- <member name="closed"
- value="6"
- c:identifier="GST_WEBRTC_ICE_CONNECTION_STATE_CLOSED"
- glib:nick="closed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="105">closed</doc>
- </member>
- </enumeration>
- <enumeration name="WebRTCICEGatheringState"
- glib:type-name="GstWebRTCICEGatheringState"
- glib:get-type="gst_webrtc_ice_gathering_state_get_type"
- c:type="GstWebRTCICEGatheringState">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="82">See &lt;http://w3c.github.io/webrtc-pc/#dom-rtcicegatheringstate&gt;</doc>
- <member name="new"
- value="0"
- c:identifier="GST_WEBRTC_ICE_GATHERING_STATE_NEW"
- glib:nick="new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="84">new</doc>
- </member>
- <member name="gathering"
- value="1"
- c:identifier="GST_WEBRTC_ICE_GATHERING_STATE_GATHERING"
- glib:nick="gathering">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="85">gathering</doc>
- </member>
- <member name="complete"
- value="2"
- c:identifier="GST_WEBRTC_ICE_GATHERING_STATE_COMPLETE"
- glib:nick="complete">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="86">complete</doc>
- </member>
- </enumeration>
- <enumeration name="WebRTCICERole"
- glib:type-name="GstWebRTCICERole"
- glib:get-type="gst_webrtc_ice_role_get_type"
- c:type="GstWebRTCICERole">
- <member name="controlled"
- value="0"
- c:identifier="GST_WEBRTC_ICE_ROLE_CONTROLLED"
- glib:nick="controlled">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="164">controlled</doc>
- </member>
- <member name="controlling"
- value="1"
- c:identifier="GST_WEBRTC_ICE_ROLE_CONTROLLING"
- glib:nick="controlling">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="165">controlling</doc>
- </member>
- </enumeration>
- <class name="WebRTCICETransport"
- c:symbol-prefix="webrtc_ice_transport"
- c:type="GstWebRTCICETransport"
- parent="Gst.Object"
- abstract="1"
- glib:type-name="GstWebRTCICETransport"
- glib:get-type="gst_webrtc_ice_transport_get_type"
- glib:type-struct="WebRTCICETransportClass">
- <source-position filename="gst-libs/gst/webrtc/webrtc_fwd.h" line="49"/>
- <property name="component"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="WebRTCICEComponent"/>
- </property>
- <property name="gathering-state" transfer-ownership="none">
- <type name="WebRTCICEGatheringState"/>
- </property>
- <property name="state" transfer-ownership="none">
- <type name="WebRTCICEConnectionState"/>
- </property>
- <glib:signal name="on-new-candidate" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="object" transfer-ownership="none">
- <type name="utf8" c:type="gchar*"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="on-selected-candidate-pair-change" when="last">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- </class>
- <record name="WebRTCICETransportClass"
- c:type="GstWebRTCICETransportClass"
- disguised="1"
- glib:is-gtype-struct-for="WebRTCICETransport">
- <source-position filename="gst-libs/gst/webrtc/webrtc_fwd.h" line="49"/>
- </record>
- <enumeration name="WebRTCICETransportPolicy"
- version="1.16"
- glib:type-name="GstWebRTCICETransportPolicy"
- glib:get-type="gst_webrtc_ice_transport_policy_get_type"
- c:type="GstWebRTCICETransportPolicy">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="360">See https://tools.ietf.org/html/draft-ietf-rtcweb-jsep-24#section-4.1.1
-for more information.</doc>
- <member name="all"
- value="0"
- c:identifier="GST_WEBRTC_ICE_TRANSPORT_POLICY_ALL"
- glib:nick="all">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="362">all</doc>
- </member>
- <member name="relay"
- value="1"
- c:identifier="GST_WEBRTC_ICE_TRANSPORT_POLICY_RELAY"
- glib:nick="relay">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="363">relay</doc>
- </member>
- </enumeration>
- <enumeration name="WebRTCKind"
- version="1.20"
- glib:type-name="GstWebRTCKind"
- glib:get-type="gst_webrtc_kind_get_type"
- c:type="GstWebRTCKind">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="376">https://w3c.github.io/mediacapture-main/#dom-mediastreamtrack-kind</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_WEBRTC_KIND_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="378">Kind has not yet been set</doc>
- </member>
- <member name="audio"
- value="1"
- c:identifier="GST_WEBRTC_KIND_AUDIO"
- glib:nick="audio">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="379">Kind is audio</doc>
- </member>
- <member name="video"
- value="2"
- c:identifier="GST_WEBRTC_KIND_VIDEO"
- glib:nick="video">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="380">Kind is audio</doc>
- </member>
- </enumeration>
- <enumeration name="WebRTCPeerConnectionState"
- glib:type-name="GstWebRTCPeerConnectionState"
- glib:get-type="gst_webrtc_peer_connection_state_get_type"
- c:type="GstWebRTCPeerConnectionState">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="141">See &lt;http://w3c.github.io/webrtc-pc/#dom-rtcpeerconnectionstate&gt;</doc>
- <member name="new"
- value="0"
- c:identifier="GST_WEBRTC_PEER_CONNECTION_STATE_NEW"
- glib:nick="new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="143">new</doc>
- </member>
- <member name="connecting"
- value="1"
- c:identifier="GST_WEBRTC_PEER_CONNECTION_STATE_CONNECTING"
- glib:nick="connecting">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="144">connecting</doc>
- </member>
- <member name="connected"
- value="2"
- c:identifier="GST_WEBRTC_PEER_CONNECTION_STATE_CONNECTED"
- glib:nick="connected">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="145">connected</doc>
- </member>
- <member name="disconnected"
- value="3"
- c:identifier="GST_WEBRTC_PEER_CONNECTION_STATE_DISCONNECTED"
- glib:nick="disconnected">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="146">disconnected</doc>
- </member>
- <member name="failed"
- value="4"
- c:identifier="GST_WEBRTC_PEER_CONNECTION_STATE_FAILED"
- glib:nick="failed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="147">failed</doc>
- </member>
- <member name="closed"
- value="5"
- c:identifier="GST_WEBRTC_PEER_CONNECTION_STATE_CLOSED"
- glib:nick="closed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="148">closed</doc>
- </member>
- </enumeration>
- <enumeration name="WebRTCPriorityType"
- version="1.16"
- glib:type-name="GstWebRTCPriorityType"
- glib:get-type="gst_webrtc_priority_type_get_type"
- c:type="GstWebRTCPriorityType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="300">See &lt;http://w3c.github.io/webrtc-pc/#dom-rtcprioritytype&gt;</doc>
- <member name="very_low"
- value="1"
- c:identifier="GST_WEBRTC_PRIORITY_TYPE_VERY_LOW"
- glib:nick="very-low">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="302">very-low</doc>
- </member>
- <member name="low"
- value="2"
- c:identifier="GST_WEBRTC_PRIORITY_TYPE_LOW"
- glib:nick="low">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="303">low</doc>
- </member>
- <member name="medium"
- value="3"
- c:identifier="GST_WEBRTC_PRIORITY_TYPE_MEDIUM"
- glib:nick="medium">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="304">medium</doc>
- </member>
- <member name="high"
- value="4"
- c:identifier="GST_WEBRTC_PRIORITY_TYPE_HIGH"
- glib:nick="high">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="305">high</doc>
- </member>
- </enumeration>
- <class name="WebRTCRTPReceiver"
- c:symbol-prefix="webrtc_rtp_receiver"
- c:type="GstWebRTCRTPReceiver"
- parent="Gst.Object"
- glib:type-name="GstWebRTCRTPReceiver"
- glib:get-type="gst_webrtc_rtp_receiver_get_type"
- glib:type-struct="WebRTCRTPReceiverClass">
- <source-position filename="gst-libs/gst/webrtc/webrtc_fwd.h" line="52"/>
- <property name="transport" version="1.20" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtpreceiver.c"
- line="107">The DTLS transport for this receiver</doc>
- <type name="WebRTCDTLSTransport"/>
- </property>
- </class>
- <record name="WebRTCRTPReceiverClass"
- c:type="GstWebRTCRTPReceiverClass"
- disguised="1"
- glib:is-gtype-struct-for="WebRTCRTPReceiver">
- <source-position filename="gst-libs/gst/webrtc/webrtc_fwd.h" line="52"/>
- </record>
- <class name="WebRTCRTPSender"
- c:symbol-prefix="webrtc_rtp_sender"
- c:type="GstWebRTCRTPSender"
- parent="Gst.Object"
- glib:type-name="GstWebRTCRTPSender"
- glib:get-type="gst_webrtc_rtp_sender_get_type"
- glib:type-struct="WebRTCRTPSenderClass">
- <source-position filename="gst-libs/gst/webrtc/webrtc_fwd.h" line="55"/>
- <method name="set_priority"
- c:identifier="gst_webrtc_rtp_sender_set_priority"
- version="1.20">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtpsender.c"
- line="61">Sets the content of the IPv4 Type of Service (ToS), also known as DSCP
-(Differentiated Services Code Point).
-This also sets the Traffic Class field of IPv6.</doc>
- <source-position filename="gst-libs/gst/webrtc/rtpsender.h" line="39"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="sender" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtpsender.c"
- line="63">a #GstWebRTCRTPSender</doc>
- <type name="WebRTCRTPSender" c:type="GstWebRTCRTPSender*"/>
- </instance-parameter>
- <parameter name="priority" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtpsender.c"
- line="64">The priority of this sender</doc>
- <type name="WebRTCPriorityType" c:type="GstWebRTCPriorityType"/>
- </parameter>
- </parameters>
- </method>
- <property name="priority"
- version="1.20"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtpsender.c"
- line="143">The priority from which to set the DSCP field on packets</doc>
- <type name="WebRTCPriorityType"/>
- </property>
- <property name="transport" version="1.20" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtpsender.c"
- line="158">The DTLS transport for this sender</doc>
- <type name="WebRTCDTLSTransport"/>
- </property>
- </class>
- <record name="WebRTCRTPSenderClass"
- c:type="GstWebRTCRTPSenderClass"
- disguised="1"
- glib:is-gtype-struct-for="WebRTCRTPSender">
- <source-position filename="gst-libs/gst/webrtc/webrtc_fwd.h" line="55"/>
- </record>
- <class name="WebRTCRTPTransceiver"
- c:symbol-prefix="webrtc_rtp_transceiver"
- c:type="GstWebRTCRTPTransceiver"
- parent="Gst.Object"
- abstract="1"
- glib:type-name="GstWebRTCRTPTransceiver"
- glib:get-type="gst_webrtc_rtp_transceiver_get_type"
- glib:type-struct="WebRTCRTPTransceiverClass">
- <source-position filename="gst-libs/gst/webrtc/webrtc_fwd.h" line="60"/>
- <property name="codec-preferences"
- version="1.20"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtptransceiver.c"
- line="285">Caps representing the codec preferences.</doc>
- <type name="Gst.Caps"/>
- </property>
- <property name="current-direction"
- version="1.20"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtptransceiver.c"
- line="253">The transceiver's current directionality, or none if the
-transceiver is stopped or has never participated in an exchange
-of offers and answers. To change the transceiver's
-directionality, set the value of the direction property.</doc>
- <type name="WebRTCRTPTransceiverDirection"/>
- </property>
- <property name="direction"
- version="1.18"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtptransceiver.c"
- line="216">Direction of the transceiver.</doc>
- <type name="WebRTCRTPTransceiverDirection"/>
- </property>
- <property name="kind" version="1.20" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtptransceiver.c"
- line="271">The kind of media this transceiver transports</doc>
- <type name="WebRTCKind"/>
- </property>
- <property name="mid" version="1.20" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtptransceiver.c"
- line="231">The media ID of the m-line associated with this transceiver. This
-association is established, when possible, whenever either a
-local or remote description is applied. This field is null if
-neither a local or remote description has been applied, or if its
-associated m-line is rejected by either a remote offer or any
-answer.</doc>
- <type name="utf8" c:type="gchar*"/>
- </property>
- <property name="mlineindex"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="receiver"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="WebRTCRTPReceiver"/>
- </property>
- <property name="sender"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="WebRTCRTPSender"/>
- </property>
- </class>
- <record name="WebRTCRTPTransceiverClass"
- c:type="GstWebRTCRTPTransceiverClass"
- disguised="1"
- glib:is-gtype-struct-for="WebRTCRTPTransceiver">
- <source-position filename="gst-libs/gst/webrtc/webrtc_fwd.h" line="60"/>
- </record>
- <enumeration name="WebRTCRTPTransceiverDirection"
- glib:type-name="GstWebRTCRTPTransceiverDirection"
- glib:get-type="gst_webrtc_rtp_transceiver_direction_get_type"
- c:type="GstWebRTCRTPTransceiverDirection">
- <member name="none"
- value="0"
- c:identifier="GST_WEBRTC_RTP_TRANSCEIVER_DIRECTION_NONE"
- glib:nick="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="203">none</doc>
- </member>
- <member name="inactive"
- value="1"
- c:identifier="GST_WEBRTC_RTP_TRANSCEIVER_DIRECTION_INACTIVE"
- glib:nick="inactive">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="204">inactive</doc>
- </member>
- <member name="sendonly"
- value="2"
- c:identifier="GST_WEBRTC_RTP_TRANSCEIVER_DIRECTION_SENDONLY"
- glib:nick="sendonly">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="205">sendonly</doc>
- </member>
- <member name="recvonly"
- value="3"
- c:identifier="GST_WEBRTC_RTP_TRANSCEIVER_DIRECTION_RECVONLY"
- glib:nick="recvonly">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="206">recvonly</doc>
- </member>
- <member name="sendrecv"
- value="4"
- c:identifier="GST_WEBRTC_RTP_TRANSCEIVER_DIRECTION_SENDRECV"
- glib:nick="sendrecv">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="207">sendrecv</doc>
- </member>
- </enumeration>
- <enumeration name="WebRTCSCTPTransportState"
- version="1.16"
- glib:type-name="GstWebRTCSCTPTransportState"
- glib:get-type="gst_webrtc_sctp_transport_state_get_type"
- c:type="GstWebRTCSCTPTransportState">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="281">See &lt;http://w3c.github.io/webrtc-pc/#dom-rtcsctptransportstate&gt;</doc>
- <member name="new"
- value="0"
- c:identifier="GST_WEBRTC_SCTP_TRANSPORT_STATE_NEW"
- glib:nick="new">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="283">new</doc>
- </member>
- <member name="connecting"
- value="1"
- c:identifier="GST_WEBRTC_SCTP_TRANSPORT_STATE_CONNECTING"
- glib:nick="connecting">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="284">connecting</doc>
- </member>
- <member name="connected"
- value="2"
- c:identifier="GST_WEBRTC_SCTP_TRANSPORT_STATE_CONNECTED"
- glib:nick="connected">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="285">connected</doc>
- </member>
- <member name="closed"
- value="3"
- c:identifier="GST_WEBRTC_SCTP_TRANSPORT_STATE_CLOSED"
- glib:nick="closed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="286">closed</doc>
- </member>
- </enumeration>
- <enumeration name="WebRTCSDPType"
- glib:type-name="GstWebRTCSDPType"
- glib:get-type="gst_webrtc_sdp_type_get_type"
- c:type="GstWebRTCSDPType">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="184">See &lt;http://w3c.github.io/webrtc-pc/#rtcsdptype&gt;</doc>
- <member name="offer"
- value="1"
- c:identifier="GST_WEBRTC_SDP_TYPE_OFFER"
- glib:nick="offer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="186">offer</doc>
- </member>
- <member name="pranswer"
- value="2"
- c:identifier="GST_WEBRTC_SDP_TYPE_PRANSWER"
- glib:nick="pranswer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="187">pranswer</doc>
- </member>
- <member name="answer"
- value="3"
- c:identifier="GST_WEBRTC_SDP_TYPE_ANSWER"
- glib:nick="answer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="188">answer</doc>
- </member>
- <member name="rollback"
- value="4"
- c:identifier="GST_WEBRTC_SDP_TYPE_ROLLBACK"
- glib:nick="rollback">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="189">rollback</doc>
- </member>
- <function name="to_string" c:identifier="gst_webrtc_sdp_type_to_string">
- <source-position filename="gst-libs/gst/webrtc/rtcsessiondescription.h"
- line="30"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.c"
- line="41">the string representation of @type or "unknown" when @type is not
- recognized.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.c"
- line="39">a #GstWebRTCSDPType</doc>
- <type name="WebRTCSDPType" c:type="GstWebRTCSDPType"/>
- </parameter>
- </parameters>
- </function>
- </enumeration>
- <record name="WebRTCSessionDescription"
- c:type="GstWebRTCSessionDescription"
- glib:type-name="GstWebRTCSessionDescription"
- glib:get-type="gst_webrtc_session_description_get_type"
- c:symbol-prefix="webrtc_session_description">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.h"
- line="36">See &lt;https://www.w3.org/TR/webrtc/#rtcsessiondescription-class&gt;</doc>
- <source-position filename="gst-libs/gst/webrtc/rtcsessiondescription.h"
- line="47"/>
- <field name="type" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.h"
- line="38">the #GstWebRTCSDPType of the description</doc>
- <type name="WebRTCSDPType" c:type="GstWebRTCSDPType"/>
- </field>
- <field name="sdp" writable="1">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.h"
- line="39">the #GstSDPMessage of the description</doc>
- <type name="GstSdp.SDPMessage" c:type="GstSDPMessage*"/>
- </field>
- <constructor name="new"
- c:identifier="gst_webrtc_session_description_new">
- <source-position filename="gst-libs/gst/webrtc/rtcsessiondescription.h"
- line="50"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.c"
- line="103">a new #GstWebRTCSessionDescription from @type
- and @sdp</doc>
- <type name="WebRTCSessionDescription"
- c:type="GstWebRTCSessionDescription*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.c"
- line="100">a #GstWebRTCSDPType</doc>
- <type name="WebRTCSDPType" c:type="GstWebRTCSDPType"/>
- </parameter>
- <parameter name="sdp" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.c"
- line="101">a #GstSDPMessage</doc>
- <type name="GstSdp.SDPMessage" c:type="GstSDPMessage*"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="copy" c:identifier="gst_webrtc_session_description_copy">
- <source-position filename="gst-libs/gst/webrtc/rtcsessiondescription.h"
- line="52"/>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.c"
- line="65">a new copy of @src</doc>
- <type name="WebRTCSessionDescription"
- c:type="GstWebRTCSessionDescription*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.c"
- line="63">a #GstWebRTCSessionDescription</doc>
- <type name="WebRTCSessionDescription"
- c:type="const GstWebRTCSessionDescription*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gst_webrtc_session_description_free">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.c"
- line="83">Free @desc and all associated resources</doc>
- <source-position filename="gst-libs/gst/webrtc/rtcsessiondescription.h"
- line="54"/>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="desc" transfer-ownership="full">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.c"
- line="85">a #GstWebRTCSessionDescription</doc>
- <type name="WebRTCSessionDescription"
- c:type="GstWebRTCSessionDescription*"/>
- </instance-parameter>
- </parameters>
- </method>
- </record>
- <enumeration name="WebRTCSignalingState"
- glib:type-name="GstWebRTCSignalingState"
- glib:get-type="gst_webrtc_signaling_state_get_type"
- c:type="GstWebRTCSignalingState">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="120">See &lt;http://w3c.github.io/webrtc-pc/#dom-rtcsignalingstate&gt;</doc>
- <member name="stable"
- value="0"
- c:identifier="GST_WEBRTC_SIGNALING_STATE_STABLE"
- glib:nick="stable">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="122">stable</doc>
- </member>
- <member name="closed"
- value="1"
- c:identifier="GST_WEBRTC_SIGNALING_STATE_CLOSED"
- glib:nick="closed">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="123">closed</doc>
- </member>
- <member name="have_local_offer"
- value="2"
- c:identifier="GST_WEBRTC_SIGNALING_STATE_HAVE_LOCAL_OFFER"
- glib:nick="have-local-offer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="124">have-local-offer</doc>
- </member>
- <member name="have_remote_offer"
- value="3"
- c:identifier="GST_WEBRTC_SIGNALING_STATE_HAVE_REMOTE_OFFER"
- glib:nick="have-remote-offer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="125">have-remote-offer</doc>
- </member>
- <member name="have_local_pranswer"
- value="4"
- c:identifier="GST_WEBRTC_SIGNALING_STATE_HAVE_LOCAL_PRANSWER"
- glib:nick="have-local-pranswer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="126">have-local-pranswer</doc>
- </member>
- <member name="have_remote_pranswer"
- value="5"
- c:identifier="GST_WEBRTC_SIGNALING_STATE_HAVE_REMOTE_PRANSWER"
- glib:nick="have-remote-pranswer">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="127">have-remote-pranswer</doc>
- </member>
- </enumeration>
- <enumeration name="WebRTCStatsType"
- glib:type-name="GstWebRTCStatsType"
- glib:get-type="gst_webrtc_stats_type_get_type"
- c:type="GstWebRTCStatsType">
- <member name="codec"
- value="1"
- c:identifier="GST_WEBRTC_STATS_CODEC"
- glib:nick="codec">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="235">codec</doc>
- </member>
- <member name="inbound_rtp"
- value="2"
- c:identifier="GST_WEBRTC_STATS_INBOUND_RTP"
- glib:nick="inbound-rtp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="236">inbound-rtp</doc>
- </member>
- <member name="outbound_rtp"
- value="3"
- c:identifier="GST_WEBRTC_STATS_OUTBOUND_RTP"
- glib:nick="outbound-rtp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="237">outbound-rtp</doc>
- </member>
- <member name="remote_inbound_rtp"
- value="4"
- c:identifier="GST_WEBRTC_STATS_REMOTE_INBOUND_RTP"
- glib:nick="remote-inbound-rtp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="238">remote-inbound-rtp</doc>
- </member>
- <member name="remote_outbound_rtp"
- value="5"
- c:identifier="GST_WEBRTC_STATS_REMOTE_OUTBOUND_RTP"
- glib:nick="remote-outbound-rtp">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="239">remote-outbound-rtp</doc>
- </member>
- <member name="csrc"
- value="6"
- c:identifier="GST_WEBRTC_STATS_CSRC"
- glib:nick="csrc">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="240">csrc</doc>
- </member>
- <member name="peer_connection"
- value="7"
- c:identifier="GST_WEBRTC_STATS_PEER_CONNECTION"
- glib:nick="peer-connection">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="241">peer-connectiion</doc>
- </member>
- <member name="data_channel"
- value="8"
- c:identifier="GST_WEBRTC_STATS_DATA_CHANNEL"
- glib:nick="data-channel">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="242">data-channel</doc>
- </member>
- <member name="stream"
- value="9"
- c:identifier="GST_WEBRTC_STATS_STREAM"
- glib:nick="stream">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="243">stream</doc>
- </member>
- <member name="transport"
- value="10"
- c:identifier="GST_WEBRTC_STATS_TRANSPORT"
- glib:nick="transport">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="244">transport</doc>
- </member>
- <member name="candidate_pair"
- value="11"
- c:identifier="GST_WEBRTC_STATS_CANDIDATE_PAIR"
- glib:nick="candidate-pair">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="245">candidate-pair</doc>
- </member>
- <member name="local_candidate"
- value="12"
- c:identifier="GST_WEBRTC_STATS_LOCAL_CANDIDATE"
- glib:nick="local-candidate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="246">local-candidate</doc>
- </member>
- <member name="remote_candidate"
- value="13"
- c:identifier="GST_WEBRTC_STATS_REMOTE_CANDIDATE"
- glib:nick="remote-candidate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="247">remote-candidate</doc>
- </member>
- <member name="certificate"
- value="14"
- c:identifier="GST_WEBRTC_STATS_CERTIFICATE"
- glib:nick="certificate">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/webrtc_fwd.h"
- line="248">certificate</doc>
- </member>
- </enumeration>
- <docsection name="gstwebrtc-datachannel">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/datachannel.c"
- line="21">&lt;https://www.w3.org/TR/webrtc/#rtcdatachannel&gt;</doc>
- </docsection>
- <docsection name="gstwebrtc-dtlstransport">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/dtlstransport.c"
- line="20">&lt;https://www.w3.org/TR/webrtc/#rtcdtlstransport&gt;</doc>
- </docsection>
- <docsection name="gstwebrtc-icetransport">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/icetransport.c"
- line="20">&lt;https://www.w3.org/TR/webrtc/#rtcicetransport&gt;</doc>
- </docsection>
- <docsection name="gstwebrtc-receiver">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtpreceiver.c"
- line="20">&lt;https://www.w3.org/TR/webrtc/#rtcrtpreceiver-interface&gt;</doc>
- </docsection>
- <docsection name="gstwebrtc-sender">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtpsender.c"
- line="20">&lt;https://www.w3.org/TR/webrtc/#rtcrtpsender-interface&gt;</doc>
- </docsection>
- <docsection name="gstwebrtc-sessiondescription">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.c"
- line="20">&lt;https://www.w3.org/TR/webrtc/#rtcsessiondescription-class&gt;</doc>
- </docsection>
- <docsection name="gstwebrtc-transceiver">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtptransceiver.c"
- line="20">&lt;https://www.w3.org/TR/webrtc/#rtcrtptransceiver-interface&gt;</doc>
- </docsection>
- <function name="webrtc_sdp_type_to_string"
- c:identifier="gst_webrtc_sdp_type_to_string"
- moved-to="WebRTCSDPType.to_string">
- <source-position filename="gst-libs/gst/webrtc/rtcsessiondescription.h"
- line="30"/>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.c"
- line="41">the string representation of @type or "unknown" when @type is not
- recognized.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve"
- filename="gst-libs/gst/webrtc/rtcsessiondescription.c"
- line="39">a #GstWebRTCSDPType</doc>
- <type name="WebRTCSDPType" c:type="GstWebRTCSDPType"/>
- </parameter>
- </parameters>
- </function>
- </namespace>
-</repository>