@gtkx/ffi 0.10.5 → 0.11.0

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

@@ -7,43 +7,78 @@ import { Iterator } from "./iterator.js";
 import { Message } from "./message.js";
 import { Query } from "./query.js";
 import { Structure } from "./structure.js";
+import { GstObject } from "./object.js";
 import { Bus } from "./bus.js";
 import { Clock } from "./clock.js";
 import { ElementFactory } from "./element-factory.js";
+import { Pad } from "./pad.js";
 import { PadTemplate } from "./pad-template.js";
 import { Plugin } from "./plugin.js";
-import { Pad } from "./pad.js";
-import * as GObject from "../gobject/index.js";
-import { GstObject } from "./object.js";
+/**
+ * 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.
+ */
 export declare class Element extends GstObject {
     static readonly glibTypeName: string;
     static readonly objectType: "gobject";
     constructor();
-    /**
-     * Creates an element for handling the given URI.
-     * @param type - Whether to create a source or a sink
-     * @param uri - URI to create an element for
-     * @param elementname - Name of created element, can be %NULL.
-     */
-    static makeFromUri(type: URIType, uri: string, elementname?: string): Element;
+    /** Creates an element for handling the given URI. */
+    static makeFromUri(type: URIType, uri: string, elementname?: string | null): Element;
     /**
      * Create a new elementfactory capable of instantiating objects of the
      * `type` and add the factory to `plugin`.
-     * @param plugin - #GstPlugin to register the element with, or %NULL for
-     * @param name - name of elements of this type
-     * @param rank - rank of element (higher rank means more importance when autoplugging)
-     * @param type - GType of element to register
-     */
-    static register(name: string, rank: number, type: number, plugin?: Plugin): boolean;
-    /**
-     * Gets a string representing the given state change result.
-     * @param stateRet - a #GstStateChangeReturn to get the name of.
      */
+    static register(name: string, rank: number, type: number, plugin?: Plugin | null): boolean;
+    /** Gets a string representing the given state change result. */
     static stateChangeReturnGetName(stateRet: StateChangeReturn): string;
-    /**
-     * Gets a string representing the given state.
-     * @param state - a #GstState to get the name of.
-     */
+    /** Gets a string representing the given state. */
     static stateGetName(state: State): string;
     /**
      * Marks `type` as "documentation should be skipped".
@@ -63,7 +98,6 @@ export declare class Element extends GstObject {
      * gst_element_type_set_skip_documentation (my_type);
      * gst_element_register (plugin, "my-plugin-feature-name", rank, my_type);
      * ```
-     * @param type - a #GType of element
      */
     static typeSetSkipDocumentation(type: number): void;
     /**
@@ -86,25 +120,15 @@ export declare class Element extends GstObject {
      * The pad and the element should be unlocked when calling this function.
      *
      * This function will emit the #GstElement::pad-added signal on the element.
-     * @param pad - the #GstPad to add to the element.
      */
     addPad(pad: Pad): boolean;
-    /**
-     * @param propertyName - name of property to watch for changes, or
-     * @param includeValue - whether to include the new property value in the message
-     */
-    addPropertyDeepNotifyWatch(includeValue: boolean, propertyName?: string): number;
-    /**
-     * @param propertyName - name of property to watch for changes, or
-     * @param includeValue - whether to include the new property value in the message
-     */
-    addPropertyNotifyWatch(includeValue: boolean, propertyName?: string): number;
+    addPropertyDeepNotifyWatch(includeValue: boolean, propertyName?: string | null): number;
+    addPropertyNotifyWatch(includeValue: boolean, propertyName?: string | null): number;
     /**
      * Perform `transition` on `element`.
      *
      * This function must be called with STATE_LOCK held and is mainly used
      * internally.
-     * @param transition - the requested transition
      */
     changeState(transition: StateChange): StateChangeReturn;
     /**
@@ -121,7 +145,6 @@ export declare class Element extends GstObject {
      * or applications.
      *
      * This function must be called with STATE_LOCK held.
-     * @param ret - The previous state return value
      */
     continueState(ret: StateChangeReturn): StateChangeReturn;
     /**
@@ -144,7 +167,6 @@ export declare class Element extends GstObject {
      * 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.
-     * @param streamId - The stream-id
      */
     decorateStreamId(streamId: string): string;
     /**
@@ -175,27 +197,20 @@ export declare class Element extends GstObject {
      * 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`.
-     * @param pad - the #GstPad to find a compatible one for.
-     * @param caps - the #GstCaps to use as a filter.
      */
-    getCompatiblePad(pad: Pad, caps?: Caps): Pad | null;
+    getCompatiblePad(pad: Pad, caps?: Caps | null): Pad | null;
     /**
      * Retrieves a pad template from `element` that is compatible with `compattempl`.
      * Pads from compatible templates can be linked together.
-     * @param compattempl - the #GstPadTemplate to find a compatible
      */
     getCompatiblePadTemplate(compattempl: PadTemplate): PadTemplate | null;
     /**
      * Gets the context with `context_type` set on the element or NULL.
      *
      * MT safe.
-     * @param contextType - a name of a context to retrieve
      */
     getContext(contextType: string): Context | null;
-    /**
-     * Gets the context with `context_type` set on the element or NULL.
-     * @param contextType - a name of a context to retrieve
-     */
+    /** Gets the context with `context_type` set on the element or NULL. */
     getContextUnlocked(contextType: string): Context | null;
     /**
      * Gets the contexts set on the element.
@@ -214,19 +229,11 @@ export declare class Element extends GstObject {
      * if the element has no clock, or if its base time has not been set.
      */
     getCurrentRunningTime(): number;
-    /**
-     * Retrieves the factory that was used to create this element.
-     */
+    /** Retrieves the factory that was used to create this element. */
     getFactory(): ElementFactory | null;
-    /**
-     * Get metadata with `key` in `klass`.
-     * @param key - the key to get
-     */
+    /** Get metadata with `key` in `klass`. */
     getMetadata(key: string): string;
-    /**
-     * Retrieves a padtemplate from `element` with the given name.
-     * @param name - the name of the #GstPadTemplate to get.
-     */
+    /** Retrieves a padtemplate from `element` with the given name. */
     getPadTemplate(name: string): PadTemplate | null;
     /**
      * Retrieves a list of the pad templates associated with `element`. The
@@ -237,7 +244,6 @@ export declare class Element extends GstObject {
      * The name of this function is confusing to people learning GStreamer.
      * gst_element_request_pad_simple() aims at making it more explicit it is
      * a simplified gst_element_request_pad().
-     * @param name - the name of the request #GstPad to retrieve.
      */
     getRequestPad(name: string): Pad | null;
     /**
@@ -271,15 +277,11 @@ export declare class Element extends GstObject {
      * 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.
-     * @param state - a pointer to #GstState to hold the state.
-     * @param pending - a pointer to #GstState to hold the pending
-     * @param timeout - a #GstClockTime to specify the timeout for an async
      */
-    getState(timeout: number, state?: Ref<State>, pending?: Ref<State>): StateChangeReturn;
+    getState(timeout: number, state?: Ref<State> | null, pending?: Ref<State> | null): StateChangeReturn;
     /**
      * Retrieves a pad from `element` by name. This version only retrieves
      * already-existing (i.e. 'static') pads.
-     * @param name - the name of the static #GstPad to retrieve.
      */
     getStaticPad(name: string): Pad | null;
     /**
@@ -324,7 +326,6 @@ export declare class Element extends GstObject {
      *
      * Make sure you have added your elements to a bin or pipeline with
      * gst_bin_add() before trying to link them.
-     * @param dest - the #GstElement containing the destination pad.
      */
     link(dest: Element): boolean;
     /**
@@ -336,31 +337,22 @@ export declare class Element extends GstObject {
      *
      * Make sure you have added your elements to a bin or pipeline with
      * gst_bin_add() before trying to link them.
-     * @param dest - the #GstElement containing the destination pad.
-     * @param filter - the #GstCaps to filter the link,
      */
-    linkFiltered(dest: Element, filter?: Caps): boolean;
+    linkFiltered(dest: Element, filter?: Caps | null): boolean;
     /**
      * 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.
-     * @param srcpadname - the name of the #GstPad in source element
-     * @param dest - the #GstElement containing the destination pad.
-     * @param destpadname - the name of the #GstPad in destination element,
      */
-    linkPads(dest: Element, srcpadname?: string, destpadname?: string): boolean;
+    linkPads(dest: Element, srcpadname?: string | null, destpadname?: string | null): boolean;
     /**
      * 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`.
-     * @param srcpadname - the name of the #GstPad in source element
-     * @param dest - the #GstElement containing the destination pad.
-     * @param destpadname - the name of the #GstPad in destination element
-     * @param filter - the #GstCaps to filter the link,
      */
-    linkPadsFiltered(dest: Element, srcpadname?: string, destpadname?: string, filter?: Caps): boolean;
+    linkPadsFiltered(dest: Element, srcpadname?: string | null, destpadname?: string | null, filter?: Caps | null): boolean;
     /**
      * 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
@@ -372,12 +364,8 @@ export declare class Element extends GstObject {
      * linking pads with safety checks applied.
      *
      * This is a convenience function for gst_pad_link_full().
-     * @param srcpadname - the name of the #GstPad in source element
-     * @param dest - the #GstElement containing the destination pad.
-     * @param destpadname - the name of the #GstPad in destination element,
-     * @param flags - the #GstPadLinkCheck to be performed when linking pads.
      */
-    linkPadsFull(dest: Element, flags: PadLinkCheck, srcpadname?: string, destpadname?: string): boolean;
+    linkPadsFull(dest: Element, flags: PadLinkCheck, srcpadname?: string | null, destpadname?: string | null): boolean;
     /**
      * Brings the element to the lost state. The current state of the
      * element is copied to the pending state so that any call to
@@ -404,32 +392,15 @@ export declare class Element extends GstObject {
      * #GST_MESSAGE_INFO.
      *
      * MT safe.
-     * @param type - the #GstMessageType
-     * @param domain - the GStreamer GError domain this message belongs to
-     * @param code - the GError code belonging to the domain
-     * @param text - an allocated text string to be used
-     * @param debug - an allocated debug message to be
-     * @param file - the source code file where the error was generated
-     * @param _function - the source code function where the error was generated
-     * @param line - the source code line where the error was generated
      */
-    messageFull(type: MessageType, domain: number, code: number, file: string, _function: string, line: number, text?: string, debug?: string): void;
+    messageFull(type: MessageType, domain: number, code: number, file: string, function_: string, line: number, text?: string | null, debug?: string | null): void;
     /**
      * 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.
-     * @param type - the #GstMessageType
-     * @param domain - the GStreamer GError domain this message belongs to
-     * @param code - the GError code belonging to the domain
-     * @param text - an allocated text string to be used
-     * @param debug - an allocated debug message to be
-     * @param file - the source code file where the error was generated
-     * @param _function - the source code function where the error was generated
-     * @param line - the source code line where the error was generated
-     * @param structure - optional details structure
-     */
-    messageFullWithDetails(type: MessageType, domain: number, code: number, file: string, _function: string, line: number, structure: Structure, text?: string, debug?: string): void;
+     */
+    messageFullWithDetails(type: MessageType, domain: number, code: number, file: string, function_: string, line: number, structure: Structure, text?: string | null, debug?: string | null): void;
     /**
      * 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
@@ -446,7 +417,6 @@ export declare class Element extends GstObject {
      * 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.
-     * @param message - a #GstMessage to post
      */
     postMessage(message: Message): boolean;
     /**
@@ -463,16 +433,9 @@ export declare class Element extends GstObject {
      * random linked sinkpad of this element.
      *
      * Please note that some queries might need a running pipeline to work.
-     * @param query - the #GstQuery.
      */
     query(query: Query): boolean;
-    /**
-     * Queries an element to convert `src_val` in `src_format` to `dest_format`.
-     * @param srcFormat - a #GstFormat to convert from.
-     * @param srcVal - a value to convert.
-     * @param destFormat - the #GstFormat to convert to.
-     * @param destVal - a pointer to the result.
-     */
+    /** Queries an element to convert `src_val` in `src_format` to `dest_format`. */
     queryConvert(srcFormat: Format, srcVal: number, destFormat: Format, destVal: Ref<number>): boolean;
     /**
      * Queries an element (usually top-level pipeline or playbin element) for the
@@ -483,10 +446,8 @@ export declare class Element extends GstObject {
      * 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.
-     * @param format - the #GstFormat requested
-     * @param duration - A location in which to store the total duration, or %NULL.
      */
-    queryDuration(format: Format, duration?: Ref<number>): boolean;
+    queryDuration(format: Format, duration?: Ref<number> | null): boolean;
     /**
      * 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
@@ -497,10 +458,8 @@ export declare class Element extends GstObject {
      *
      * If one repeatedly calls this function one can also create a query and reuse
      * it in gst_element_query().
-     * @param format - the #GstFormat requested
-     * @param cur - a location in which to store the current
      */
-    queryPosition(format: Format, cur?: Ref<number>): boolean;
+    queryPosition(format: Format, cur?: Ref<number> | null): boolean;
     /**
      * Makes the element free the previously requested pad as obtained
      * with gst_element_request_pad().
@@ -510,7 +469,6 @@ export declare class Element extends GstObject {
      * followed by gst_object_unref() to free the `pad`.
      *
      * MT safe.
-     * @param pad - the #GstPad to release.
      */
     releaseRequestPad(pad: Pad): void;
     /**
@@ -530,12 +488,8 @@ export declare class Element extends GstObject {
      * The pad and the element should be unlocked when calling this function.
      *
      * This function will emit the #GstElement::pad-removed signal on the element.
-     * @param pad - the #GstPad to remove from the element.
      */
     removePad(pad: Pad): boolean;
-    /**
-     * @param watchId - watch id to remove
-     */
     removePropertyNotifyWatch(watchId: number): void;
     /**
      * Retrieves a request pad from the element according to the provided template.
@@ -543,11 +497,8 @@ export declare class Element extends GstObject {
      * gst_element_factory_get_static_pad_templates().
      *
      * The pad should be released with gst_element_release_request_pad().
-     * @param templ - a #GstPadTemplate of which we want a pad of.
-     * @param name - the name of the request #GstPad
-     * @param caps - the caps of the pad we want to
      */
-    requestPad(templ: PadTemplate, name?: string, caps?: Caps): Pad | null;
+    requestPad(templ: PadTemplate, name?: string | null, caps?: Caps | null): Pad | null;
     /**
      * Retrieves a pad from the element by name (e.g. "src_\%d"). This version only
      * retrieves request pads. The pad should be released with
@@ -561,7 +512,6 @@ export declare class Element extends GstObject {
      * a better name to gst_element_get_request_pad(). Prior to 1.20, users
      * should use gst_element_get_request_pad() which provides the same
      * functionality.
-     * @param name - the name of the request #GstPad to retrieve.
      */
     requestPadSimple(name: string): Pad | null;
     /**
@@ -570,13 +520,6 @@ export declare class Element extends GstObject {
      * gst_element_send_event().
      *
      * MT safe.
-     * @param rate - The new playback rate
-     * @param format - The format of the seek values
-     * @param flags - The optional seek flags.
-     * @param startType - The type and flags for the new start position
-     * @param start - The value of the new start position
-     * @param stopType - The type and flags for the new stop position
-     * @param stop - The value of the new stop position
      */
     seek(rate: number, format: Format, flags: SeekFlags, startType: SeekType, start: number, stopType: SeekType, stop: number): boolean;
     /**
@@ -594,9 +537,6 @@ export declare class Element extends GstObject {
      * 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.
-     * @param format - a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME
-     * @param seekFlags - seek options; playback applications will usually want to use
-     * @param seekPos - position to seek to (relative to the start); if you are doing
      */
     seekSimple(format: Format, seekFlags: SeekFlags, seekPos: number): boolean;
     /**
@@ -608,14 +548,12 @@ export declare class Element extends GstObject {
      * gst_event_ref() it if you want to reuse the event after this call.
      *
      * MT safe.
-     * @param event - the #GstEvent to send to the element.
      */
     sendEvent(event: Event): boolean;
     /**
      * Set the base time of an element. See gst_element_get_base_time().
      *
      * MT safe.
-     * @param time - the base time to set.
      */
     setBaseTime(time: number): void;
     /**
@@ -623,21 +561,18 @@ export declare class Element extends GstObject {
      * For internal use only, unless you're testing elements.
      *
      * MT safe.
-     * @param bus - the #GstBus to set.
      */
-    setBus(bus?: Bus): void;
+    setBus(bus?: Bus | null): void;
     /**
      * Sets the clock for the element. This function increases the
      * refcount on the clock. Any previously set clock on the object
      * is unreffed.
-     * @param clock - the #GstClock to set for the element.
      */
-    setClock(clock?: Clock): boolean;
+    setClock(clock?: Clock | null): boolean;
     /**
      * Sets the context of the element. Increases the refcount of the context.
      *
      * MT safe.
-     * @param context - the #GstContext to set.
      */
     setContext(context: Context): void;
     /**
@@ -649,7 +584,6 @@ export declare class Element extends GstObject {
      * next step proceed to change the child element's state.
      *
      * MT safe.
-     * @param lockedState - %TRUE to lock the element's state
      */
     setLockedState(lockedState: boolean): boolean;
     /**
@@ -665,7 +599,6 @@ export declare class Element extends GstObject {
      * pipelines, and you can also ensure that the pipelines have the same clock.
      *
      * MT safe.
-     * @param time - the base time to set.
      */
     setStartTime(time: number): void;
     /**
@@ -682,7 +615,6 @@ export declare class Element extends GstObject {
      *
      * State changes to %GST_STATE_READY or %GST_STATE_NULL never return
      * #GST_STATE_CHANGE_ASYNC.
-     * @param state - the element's new #GstState.
      */
     setState(state: State): StateChangeReturn;
     /**
@@ -696,22 +628,16 @@ export declare class Element extends GstObject {
      *
      * 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().
-     * @param dest - the sink #GstElement to unlink.
      */
     unlink(dest: Element): void;
     /**
      * Unlinks the two named pads of the source and destination elements.
      *
      * This is a convenience function for gst_pad_unlink().
-     * @param srcpadname - the name of the #GstPad in source element.
-     * @param dest - a #GstElement containing the destination pad.
-     * @param destpadname - the name of the #GstPad in destination element.
      */
     unlinkPads(srcpadname: string, dest: Element, destpadname: string): void;
     connect(signal: "no-more-pads", handler: (self: Element) => void, after?: boolean): number;
     connect(signal: "pad-added", handler: (self: Element, newPad: Pad) => void, after?: boolean): number;
     connect(signal: "pad-removed", handler: (self: Element, oldPad: Pad) => void, after?: boolean): number;
-    connect(signal: "deep-notify", handler: (self: Element, propObject: GstObject, prop: GObject.ParamSpec) => void, after?: boolean): number;
-    connect(signal: "notify", handler: (self: Element, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;
 }