Tries intersecting struct1 and struct2 and reports whether the result would not be empty.
Duplicates a #GstStructure and all its fields and values.
Calls the provided function once for each field in the #GstStructure. In contrast to gst.structure.Structure.foreach_, the function may modify the fields. In contrast to gst.structure.Structure.mapInPlace, the field is removed from the structure if false is returned from the function. The structure must be mutable.
Fixate all values in structure using gst.global.valueFixate. structure will be modified in-place and should be writable.
Fixates a #GstStructure by changing the given field with its fixated value.
Fixates a #GstStructure by changing the given field_name field to the given target boolean if that field is not fixed yet.
Fixates a #GstStructure by changing the given field to the nearest double to target that is a subset of the existing field.
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.
Fixates a #GstStructure by changing the given field to the nearest integer to target that is a subset of the existing field.
Fixates a #GstStructure by changing the given field_name field to the given target string if that field is not fixed yet.
Calls the provided function once for each field in the #GstStructure. The function must not modify the fields. Also see gst.structure.Structure.mapInPlace and gst.structure.Structure.filterAndMapInPlace.
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.
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.
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.
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.
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.
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.
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.
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.
Sets the unsigned 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 flagstype is correct.
Read the GstFlagSet flags and mask out of the structure into the provided pointers.
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.
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.
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.
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.
Get the name of structure as a string.
Get the name of structure as a GQuark.
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.
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.
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.
Get the value of the field with name fieldname.
Check if structure contains a field named fieldname.
Check if structure contains a field named fieldname and with GType type.
Checks if the structure has the given name
Get the value of the field with GQuark field.
Check if structure contains a field named field.
Check if structure contains a field named field and with GType type.
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.
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.
Intersects struct1 and struct2 and returns the intersection.
Tests if the two #GstStructure are equal.
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.
Calls the provided function once for each field in the #GstStructure. In contrast to gst.structure.Structure.foreach_, the function may modify but not delete the fields. The structure must be mutable.
Get the number of fields in the structure.
Get the name of the given field number, counting from 0 onwards.
Removes all fields in a GstStructure.
Removes the field with the given name. If the field with the given name does not exist, the structure is unchanged.
Converts structure to a human-readable string representation.
Alias for gst.structure.Structure.serialize but with nullable annotation because it can return null when gst.types.SerializeFlags.Strict flag is set.
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.
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.
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 "/-_.:".
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.
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.
Converts structure to a human-readable string representation.
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.
Creates a new, empty #GstStructure with the given name.
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.
Creates a new, empty #GstStructure with the given name as a GQuark.
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.
Pointer to the C boxed value
Get the GType of this boxed type.
Boxed GType property.
Convenience method to return this cast to a type. For use in D with statements.
Make a copy of the wrapped C boxed data.
Copy a C boxed value using g_boxed_copy.
Free a C boxed value using g_boxed_free.
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.Structure.setParentRefcount method.
A #GstStructure can be created with gst.structure.Structure.newEmpty or gst.structure.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.Structure.setValue or gst.structure.Structure.set.
Field values can be retrieved with gst.structure.Structure.getValue or the more convenient gst_structure_get_*() functions.
Fields can be removed with gst.structure.Structure.removeField or gst.structure.Structure.removeFields.
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:
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:
*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 harfbuzz.types.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:
Structures are delimited either by a null character \0 or a semicolon ; 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:
They also allow for nested structure, such as:
Since 1.20, nested structures and caps can be specified using brackets ([ and ]), for example:
> *note*: gst.structure.Structure.toString_ won't use that syntax for backward > compatibility reason, gst.structure.Structure.serializeFull has been added for > that purpose.