@gtkx/ffi 0.10.5 → 0.11.0

package/dist/generated/gst/structure.d.ts

@@ -72,16 +72,16 @@ import * as GObject from "../gobject/index.js";
  * Some types have special delimiters:
  *
  * - [GstValueArray](GST_TYPE_ARRAY) are inside "less and greater than" (`<` and
- * `>`). For example `a-structure, array=<1, 2, 3>
+ *   `>`). 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]`
+ *   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 curly brackets (`{` and `}`).
- * For example `a-structure, list={1, 2, 3}`
+ *   For example `a-structure, list={1, 2, 3}`
  * - [GStrv](G_TYPE_STRV) are inside "less and greater than" (`<` and
- * `>`) and each string is double-quoted.
- * For example `a-structure, strv=(GStrv)<"foo", "bar">`. Since 1.26.0.
+ *   `>`) and each string is double-quoted.
+ *   For example `a-structure, strv=(GStrv)<"foo", "bar">`. Since 1.26.0.
  *
  * Structures are delimited either by a null character `\0` or a semicolon `;`
  * the latter allowing to store multiple structures in the same string (see
@@ -123,18 +123,14 @@ export declare class Structure extends NativeObject {
      * where parsing ended will be returned.
      *
      * Free-function: gst_structure_free
-     * @param string - a string representation of a #GstStructure.
-     * @param end - pointer to store the end of the string in.
      */
-    constructor(string: string, end?: Ref<string>);
-    constructor(_args: unknown[]);
+    constructor(string: string, end?: Ref<string> | null);
     /**
      * 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
-     * @param name - name of new structure
      */
     static newEmpty(name: string): Structure;
     /**
@@ -148,21 +144,18 @@ export declare class Structure extends NativeObject {
      * #GST_SERIALIZE_FLAG_BACKWARD_COMPAT)
      *
      * Free-function: gst_structure_free
-     * @param string - a string representation of a #GstStructure
      */
     static newFromString(string: string): Structure;
     /**
      * Creates a new, empty #GstStructure with the given name as a GQuark.
      *
      * Free-function: gst_structure_free
-     * @param quark - name of new structure
      */
     static newIdEmpty(quark: number): Structure;
     /**
      * Creates a new, empty #GstStructure with the given name.
      *
      * Free-function: gst_structure_free
-     * @param name - name of new structure
      */
     static newIdStrEmpty(name: IdStr): Structure;
     /**
@@ -174,11 +167,8 @@ export declare class Structure extends NativeObject {
      * to be a static string.
      *
      * Free-function: gst_structure_free
-     * @param name - name of new structure
      */
     static newStaticStrEmpty(name: string): Structure;
-    protected createPtr(_args: unknown[]): unknown;
-    static fromPtr(ptr: unknown): Structure;
     /**
      * Atomically modifies a pointer to point to a new structure.
      * The #GstStructure `oldstr_ptr` is pointing to is freed and
@@ -188,14 +178,11 @@ export declare class Structure extends NativeObject {
      *
      * It is a programming error if both `newstr` and the value pointed to by
      * `oldstr_ptr` refer to the same, non-%NULL structure.
-     * @param oldstrPtr - pointer to a place of
-     * @param newstr - a new #GstStructure
      */
-    static take(oldstrPtr?: Ref<Structure>, newstr?: Structure): boolean;
+    static take(oldstrPtr?: Ref<Structure> | null, newstr?: Structure | null): boolean;
     /**
      * Tries intersecting `struct1` and `struct2` and reports whether the result
      * would not be empty.
-     * @param struct2 - a #GstStructure
      */
     canIntersect(struct2: Structure): boolean;
     /**
@@ -209,46 +196,32 @@ export declare class Structure extends NativeObject {
      * `structure` will be modified in-place and should be writable.
      */
     fixate(): void;
-    /**
-     * Fixates a #GstStructure by changing the given field with its fixated value.
-     * @param fieldName - a field in `structure`
-     */
+    /** Fixates a #GstStructure by changing the given field with its fixated value. */
     fixateField(fieldName: string): boolean;
     /**
      * Fixates a #GstStructure by changing the given `field_name` field to the given
      * `target` boolean if that field is not fixed yet.
-     * @param fieldName - a field in `structure`
-     * @param target - the target value of the fixation
      */
     fixateFieldBoolean(fieldName: string, target: boolean): boolean;
     /**
      * Fixates a #GstStructure by changing the given field to the nearest
      * double to `target` that is a subset of the existing field.
-     * @param fieldName - a field in `structure`
-     * @param target - the target value of the fixation
      */
     fixateFieldNearestDouble(fieldName: string, target: number): boolean;
     /**
      * 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.
-     * @param fieldName - a field in `structure`
-     * @param targetNumerator - The numerator of the target value of the fixation
-     * @param targetDenominator - The denominator of the target value of the fixation
      */
     fixateFieldNearestFraction(fieldName: string, targetNumerator: number, targetDenominator: number): boolean;
     /**
      * Fixates a #GstStructure by changing the given field to the nearest
      * integer to `target` that is a subset of the existing field.
-     * @param fieldName - a field in `structure`
-     * @param target - the target value of the fixation
      */
     fixateFieldNearestInt(fieldName: string, target: number): boolean;
     /**
      * Fixates a #GstStructure by changing the given `field_name` field to the given
      * `target` string if that field is not fixed yet.
-     * @param fieldName - a field in `structure`
-     * @param target - the target value of the fixation
      */
     fixateFieldString(fieldName: string, target: string): boolean;
     /**
@@ -261,24 +234,18 @@ export declare class Structure extends NativeObject {
      * 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.
-     * @param fieldname - the name of a field
-     * @param array - a pointer to a #GValueArray
      */
     getArray(fieldname: string, array: Ref<GObject.ValueArray>): boolean;
     /**
      * 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.
-     * @param fieldname - the name of a field
-     * @param value - a pointer to a #gboolean to set
      */
     getBoolean(fieldname: string, value: Ref<boolean>): boolean;
     /**
      * 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.
-     * @param fieldname - the name of a field
-     * @param value - a pointer to a #GstClockTime to set
      */
     getClockTime(fieldname: string, value: Ref<number>): boolean;
     /**
@@ -290,8 +257,6 @@ export declare class Structure extends NativeObject {
      * 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).
-     * @param fieldname - the name of a field
-     * @param value - a pointer to a #GDate to set
      */
     getDate(fieldname: string, value: Ref<GLib.Date>): boolean;
     /**
@@ -303,74 +268,53 @@ export declare class Structure extends NativeObject {
      * 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).
-     * @param fieldname - the name of a field
-     * @param value - a pointer to a #GstDateTime to set
      */
     getDateTime(fieldname: string, value: Ref<DateTime>): boolean;
     /**
      * 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.
-     * @param fieldname - the name of a field
-     * @param value - a pointer to a gdouble to set
      */
     getDouble(fieldname: string, value: Ref<number>): boolean;
     /**
      * 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.
-     * @param fieldname - the name of a field
-     * @param enumtype - the enum type of a field
-     * @param value - a pointer to an int to set
      */
     getEnum(fieldname: string, enumtype: number, value: Ref<number>): boolean;
     /**
      * 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.
-     * @param fieldname - the name of the field
      */
     getFieldType(fieldname: string): number;
     /**
      * 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.
-     * @param fieldname - the name of a field
-     * @param flagsType - the flags type of a field
-     * @param value - a pointer to an unsigned int to set
      */
     getFlags(fieldname: string, flagsType: number, value: Ref<number>): boolean;
     /**
      * Read the GstFlagSet flags and mask out of the structure into the
      * provided pointers.
-     * @param fieldname - the name of a field
-     * @param valueFlags - a pointer to a guint for the flags field
-     * @param valueMask - a pointer to a guint for the mask field
      */
-    getFlagset(fieldname: string, valueFlags?: Ref<number>, valueMask?: Ref<number>): boolean;
+    getFlagset(fieldname: string, valueFlags?: Ref<number> | null, valueMask?: Ref<number> | null): boolean;
     /**
      * 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.
-     * @param fieldname - the name of a field
-     * @param valueNumerator - a pointer to an int to set
-     * @param valueDenominator - a pointer to an int to set
      */
     getFraction(fieldname: string, valueNumerator: Ref<number>, valueDenominator: Ref<number>): boolean;
     /**
      * 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.
-     * @param fieldname - the name of a field
-     * @param value - a pointer to an int to set
      */
     getInt(fieldname: string, value: Ref<number>): boolean;
     /**
      * 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.
-     * @param fieldname - the name of a field
-     * @param value - a pointer to a #gint64 to set
      */
     getInt64(fieldname: string, value: Ref<number>): boolean;
     /**
@@ -378,21 +322,13 @@ export declare class Structure extends NativeObject {
      * 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.
-     * @param fieldname - the name of a field
-     * @param array - a pointer to a #GValueArray
      */
     getList(fieldname: string, array: Ref<GObject.ValueArray>): boolean;
-    /**
-     * Get the name of `structure` as a string.
-     */
+    /** Get the name of `structure` as a string. */
     getName(): string;
-    /**
-     * Get the name of `structure` as a GQuark.
-     */
+    /** Get the name of `structure` as a GQuark. */
     getNameId(): number;
-    /**
-     * Get the name of `structure` as a GstIdStr.
-     */
+    /** Get the name of `structure` as a GstIdStr. */
     getNameIdStr(): IdStr;
     /**
      * Finds the field corresponding to `fieldname`, and returns the string
@@ -401,144 +337,88 @@ export declare class Structure extends NativeObject {
      *
      * The string should not be modified, and remains valid until the next
      * call to a gst_structure_*() function with the given structure.
-     * @param fieldname - the name of a field
      */
     getString(fieldname: string): string | null;
     /**
      * 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.
-     * @param fieldname - the name of a field
-     * @param value - a pointer to a uint to set
      */
     getUint(fieldname: string, value: Ref<number>): boolean;
     /**
      * 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.
-     * @param fieldname - the name of a field
-     * @param value - a pointer to a #guint64 to set
      */
     getUint64(fieldname: string, value: Ref<number>): boolean;
-    /**
-     * Get the value of the field with name `fieldname`.
-     * @param fieldname - the name of the field to get
-     */
+    /** Get the value of the field with name `fieldname`. */
     getValue(fieldname: string): GObject.Value | null;
-    /**
-     * Check if `structure` contains a field named `fieldname`.
-     * @param fieldname - the name of a field
-     */
+    /** Check if `structure` contains a field named `fieldname`. */
     hasField(fieldname: string): boolean;
-    /**
-     * Check if `structure` contains a field named `fieldname` and with GType `type`.
-     * @param fieldname - the name of a field
-     * @param type - the type of a value
-     */
+    /** Check if `structure` contains a field named `fieldname` and with GType `type`. */
     hasFieldTyped(fieldname: string, type: number): boolean;
-    /**
-     * Checks if the structure has the given name
-     * @param name - structure name to check for
-     */
+    /** Checks if the structure has the given name */
     hasName(name: string): boolean;
-    /**
-     * Get the value of the field with GQuark `field`.
-     * @param field - the #GQuark of the field to get
-     */
+    /** Get the value of the field with GQuark `field`. */
     idGetValue(field: number): GObject.Value | null;
-    /**
-     * Check if `structure` contains a field named `field`.
-     * @param field - #GQuark of the field name
-     */
+    /** Check if `structure` contains a field named `field`. */
     idHasField(field: number): boolean;
-    /**
-     * Check if `structure` contains a field named `field` and with GType `type`.
-     * @param field - #GQuark of the field name
-     * @param type - the type of a value
-     */
+    /** Check if `structure` contains a field named `field` and with GType `type`. */
     idHasFieldTyped(field: number, type: number): boolean;
     /**
      * 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.
-     * @param field - a #GQuark representing a field
-     * @param value - the new value of the field
      */
     idSetValue(field: number, value: GObject.Value): void;
     /**
      * 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.
-     * @param fieldname - the name of the field
      */
     idStrGetFieldType(fieldname: IdStr): number;
-    /**
-     * Get the value of the field with name `fieldname`.
-     * @param fieldname - the name of the field to get
-     */
+    /** Get the value of the field with name `fieldname`. */
     idStrGetValue(fieldname: IdStr): GObject.Value | null;
-    /**
-     * Check if `structure` contains a field named `fieldname`.
-     * @param fieldname - the name of a field
-     */
+    /** Check if `structure` contains a field named `fieldname`. */
     idStrHasField(fieldname: IdStr): boolean;
-    /**
-     * Check if `structure` contains a field named `fieldname` and with GType `type`.
-     * @param fieldname - the name of a field
-     * @param type - the type of a value
-     */
+    /** Check if `structure` contains a field named `fieldname` and with GType `type`. */
     idStrHasFieldTyped(fieldname: IdStr, type: number): boolean;
     /**
      * Get the name (as a GstIdStr) of the given field number,
      * counting from 0 onwards.
-     * @param index - the index to get the name of
      */
     idStrNthFieldName(index: number): IdStr;
     /**
      * Removes the field with the given name.  If the field with the given
      * name does not exist, the structure is unchanged.
-     * @param fieldname - the name of the field to remove
      */
     idStrRemoveField(fieldname: IdStr): void;
     /**
      * 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.
-     * @param fieldname - the name of the field to set
-     * @param value - the new value of the field
      */
     idStrSetValue(fieldname: IdStr, value: GObject.Value): void;
     /**
      * Sets the field with the given GstIdStr `field` to `value`.  If the field
      * does not exist, it is created.  If the field exists, the previous
      * value is replaced and freed.
-     * @param fieldname - the name of the field to set
-     * @param value - the new value of the field
      */
     idStrTakeValue(fieldname: IdStr, value: GObject.Value): void;
     /**
      * 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.
-     * @param field - a #GQuark representing a field
-     * @param value - the new value of the field
      */
     idTakeValue(field: number, value: GObject.Value): void;
-    /**
-     * Intersects `struct1` and `struct2` and returns the intersection.
-     * @param struct2 - a #GstStructure
-     */
+    /** Intersects `struct1` and `struct2` and returns the intersection. */
     intersect(struct2: Structure): Structure | null;
-    /**
-     * Tests if the two #GstStructure are equal.
-     * @param structure2 - a #GstStructure.
-     */
+    /** Tests if the two #GstStructure are equal. */
     isEqual(structure2: Structure): boolean;
     /**
      * 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`.
-     * @param superset - a potentially greater #GstStructure
      */
     isSubset(superset: Structure): boolean;
     /**
@@ -546,23 +426,15 @@ export declare class Structure extends NativeObject {
      * is not set or its refcount is 1, %FALSE otherwise.
      */
     isWritable(): boolean;
-    /**
-     * Get the number of fields in the structure.
-     */
+    /** Get the number of fields in the structure. */
     nFields(): number;
-    /**
-     * Get the name of the given field number, counting from 0 onwards.
-     * @param index - the index to get the name of
-     */
+    /** Get the name of the given field number, counting from 0 onwards. */
     nthFieldName(index: number): string;
-    /**
-     * Removes all fields in a GstStructure.
-     */
+    /** Removes all fields in a GstStructure. */
     removeAllFields(): void;
     /**
      * Removes the field with the given name.  If the field with the given
      * name does not exist, the structure is unchanged.
-     * @param fieldname - the name of the field to remove
      */
     removeField(fieldname: string): void;
     /**
@@ -578,13 +450,11 @@ export declare class Structure extends NativeObject {
      * Use gst_structure_serialize_full() instead.
      *
      * Free-function: g_free
-     * @param flags - The flags to use to serialize structure
      */
     serialize(flags: SerializeFlags): string;
     /**
      * Alias for gst_structure_serialize() but with nullable annotation because it
      * can return %NULL when %GST_SERIALIZE_FLAG_STRICT flag is set.
-     * @param flags - The flags to use to serialize structure
      */
     serializeFull(flags: SerializeFlags): string | null;
     /**
@@ -592,8 +462,6 @@ export declare class Structure extends NativeObject {
      * 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.
-     * @param fieldname - the name of a field
-     * @param array - a pointer to a #GValueArray
      */
     setArray(fieldname: string, array: GObject.ValueArray): void;
     /**
@@ -601,22 +469,18 @@ export declare class Structure extends NativeObject {
      * 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.
-     * @param fieldname - the name of a field
-     * @param array - a pointer to a #GValueArray
      */
     setList(fieldname: string, array: GObject.ValueArray): void;
     /**
      * 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 "/-_.:".
-     * @param name - the new name of the structure
      */
     setName(name: string): void;
     /**
      * 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 "/-_.:".
-     * @param name - the new name of the structure
      */
     setNameIdStr(name: IdStr): void;
     /**
@@ -626,7 +490,6 @@ export declare class Structure extends NativeObject {
      *
      * `name` needs to be valid for the remaining lifetime of the process, e.g. has
      * to be a static string.
-     * @param name - the new name of the structure
      */
     setNameStaticStr(name: string): void;
     /**
@@ -634,15 +497,12 @@ export declare class Structure extends NativeObject {
      * 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.
-     * @param refcount - a pointer to the parent's refcount
      */
     setParentRefcount(refcount: number): boolean;
     /**
      * 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.
-     * @param fieldname - the name of the field to set
-     * @param value - the new value of the field
      */
     setValue(fieldname: string, value: GObject.Value): void;
     /**
@@ -652,16 +512,12 @@ export declare class Structure extends NativeObject {
      *
      * `fieldname` needs to be valid for the remaining lifetime of the process, e.g.
      * has to be a static string.
-     * @param fieldname - the name of the field to set
-     * @param value - the new value of the field
      */
     setValueStaticStr(fieldname: string, value: GObject.Value): void;
     /**
      * 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`.
-     * @param fieldname - the name of the field to set
-     * @param value - the new value of the field
      */
     takeValue(fieldname: string, value: GObject.Value): void;
     /**
@@ -671,8 +527,6 @@ export declare class Structure extends NativeObject {
      *
      * `fieldname` needs to be valid for the remaining lifetime of the process, e.g.
      * has to be a static string.
-     * @param fieldname - the name of the field to set
-     * @param value - the new value of the field
      */
     takeValueStaticStr(fieldname: string, value: GObject.Value): void;
     /**