diff --git a/gir-files/Gst-1.0.gir b/gir-files/Gst-1.0.gir index 3eaac7897..659a61cfa 100644 --- a/gir-files/Gst-1.0.gir +++ b/gir-files/Gst-1.0.gir @@ -1824,6 +1824,7 @@ Derived classes can use this as first value in a list of flags. + A fundamental type that describes a 64-bit bitmask Buffers are the basic unit of data transfer in GStreamer. They contain the @@ -12770,6 +12771,7 @@ metadata. Free with g_strfreev() when no longer needed. + A fundamental type that describes a #gdouble range #GstDynamicTypeFactory is used to represent a type that can be @@ -18850,6 +18852,8 @@ printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc)); + 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. Create a new sub-class of #GST_TYPE_FLAG_SET which will pretty-print the human-readable flags @@ -19060,8 +19064,11 @@ is unknown. + A fundamental type that describes a fraction of an integer numerator +over an integer denominator + A fundamental type that describes a #GstFractionRange range @@ -19962,8 +19969,10 @@ whenever the datastructure changes. + A fundamental type that describes a #gint64 range + A fundamental type that describes a #gint range A GstIterator is used to retrieve multiple objects from another object in @@ -27170,13 +27179,21 @@ functions instead. + + 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. + + + Use this flag on GObject properties to signal they can make sense to be. controlled over time. This hint is used by the GstController. - + 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. @@ -30789,6 +30806,21 @@ Unref after usage. + + See gst_pad_template_set_documentation_caps(). + + + The caps to document. For convenience, this will return + gst_pad_template_get_caps() when no documentation caps were set. + + + + + the pad template to get documented capabilities on + + + + Emit the pad-created signal for this template when created by this pad. @@ -30806,6 +30838,26 @@ Unref after usage. + + 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. + + + + + + + the pad template to set documented capabilities on + + + + the documented capabilities + + + + The capabilities of the pad described by the pad template. @@ -30853,6 +30905,9 @@ Unref after usage. + + + @@ -30926,8 +30981,12 @@ pad functions cannot be called from within the callback. + A fundamental type that describes a #GParamSpec for arrays of +values + A fundamental type that describes a #GParamSpec for fractional +properties A GParamSpec derived structure for arrays of values. @@ -31998,6 +32057,13 @@ The cache is flushed every time the registry is rebuilt. + + + 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. + + @@ -39185,22 +39251,23 @@ whether a stream is of a certain type. - A #GstStructure is a collection of key/value pairs. The keys are expressed -as GQuarks and the values can be of any GType. + 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 "/-_.:". +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 +#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. +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(). @@ -39211,14 +39278,78 @@ 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. +Strings in structures must be ASCII or UTF-8 encoded. Other encodings are not +allowed. Strings may be %NULL however. -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. +## 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" (`<` and + `>`). For example `a-structure, list=<1, 2, 3> + +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" +``` + +> *Note*: 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. the GType of a structure @@ -46875,6 +47006,7 @@ Actual releases have 0, GIT versions have 1, prerelease versions have 2-... + A fundamental type that describes an ordered list of #GValue Appends @append_value to the GstValueArray in @value. @@ -47016,6 +47148,7 @@ or GST_VALUE_UNORDERED + A fundamental type that describes an unordered list of #GValue Appends @append_value to the GstValueList in @value. @@ -50683,6 +50816,51 @@ This function is typically called during an element's plugin initialization. + + Checks if @type is plugin API. See gst_type_mark_as_plugin_api() for +details. + + + %TRUE if @type is plugin API or %FALSE otherwise. + + + + + a GType + + + + What #GstPluginAPIFlags the plugin was marked with + + + + + + 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. + + + + + + + a GType + + + + a set of #GstPluginAPIFlags to further inform cache generation. + + + + Forces GStreamer to re-scan its plugin paths and update the default plugin registry. diff --git a/gir-files/GstAudio-1.0.gir b/gir-files/GstAudio-1.0.gir index eb681f1a2..28ee2826e 100644 --- a/gir-files/GstAudio-1.0.gir +++ b/gir-files/GstAudio-1.0.gir @@ -691,8 +691,14 @@ return to upstream/caller (indicating either GST_FLOW_ERROR or GST_FLOW_OK). - - List of all audio formats, for use in template caps strings. + + 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 > Signed > Unsigned + - native endianness preferred diff --git a/gir-files/GstBase-1.0.gir b/gir-files/GstBase-1.0.gir index 86c762a4f..abd1f7b4d 100644 --- a/gir-files/GstBase-1.0.gir +++ b/gir-files/GstBase-1.0.gir @@ -1505,8 +1505,8 @@ account when larger than the actually reported minimum latency. - - + + @@ -2093,6 +2093,19 @@ usage. + + + Start at running time 0. + + + Start at the running time of +the first buffer that is received. + + + Start at the running time +selected by the `start-time` property. + + diff --git a/gir-files/GstVideo-1.0.gir b/gir-files/GstVideo-1.0.gir index d62acdef5..7adc7eb44 100644 --- a/gir-files/GstVideo-1.0.gir +++ b/gir-files/GstVideo-1.0.gir @@ -2317,7 +2317,22 @@ return to upstream/caller (indicating either GST_FLOW_ERROR or GST_FLOW_OK). - + + 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 @@ -7534,6 +7549,21 @@ If no QoS events have been received from downstream, or if + + Returns the minimum force-keyunit interval, see gst_video_encoder_set_min_force_key_unit_interval() +for more details. + + + the minimum force-keyunit interval + + + + + the encoder + + + + Get the oldest unfinished pending #GstVideoCodecFrame @@ -7686,6 +7716,25 @@ elements (e.g. muxers). + + 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. + + + + + + + the encoder + + + + minimum interval + + + + Request minimal value for PTS passed to handle_frame. @@ -7762,6 +7811,11 @@ from the next call to #gst_video_encoder_finish_frame(). + + Minimum interval between force-keyunit requests in nanoseconds. See +gst_video_encoder_set_min_force_key_unit_interval() for more details. + + @@ -10291,6 +10345,7 @@ that is conveyed in the #GstVideoMultiviewMode. + See #GstVideoMultiviewFlags. #GstVideoMultiviewFramePacking represents the subset of #GstVideoMultiviewMode