@gtkx/ffi 0.10.4 → 0.11.0

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

@@ -7,11 +7,71 @@ import { Event } from "./event.js";
 import { Iterator } from "./iterator.js";
 import { Query } from "./query.js";
 import { StaticPadTemplate } from "./static-pad-template.js";
+import { GstObject } from "./object.js";
 import { Element } from "./element.js";
 import { PadTemplate } from "./pad-template.js";
 import { Stream } from "./stream.js";
-import * as GObject from "../gobject/index.js";
-import { GstObject } from "./object.js";
+/**
+ * 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.
+ */
 export declare class Pad extends GstObject {
     static readonly glibTypeName: string;
     static readonly objectType: "gobject";
@@ -20,17 +80,13 @@ export declare class Pad extends GstObject {
      * 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.
-     * @param name - the name of the new pad.
-     * @param direction - the #GstPadDirection of the pad.
      */
-    constructor(direction: PadDirection, name?: string);
+    constructor(direction: PadDirection, name?: string | null);
     /**
      * 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.
-     * @param templ - the #GstStaticPadTemplate to use
-     * @param name - the name of the pad
      */
     static newFromStaticTemplate(templ: StaticPadTemplate, name: string): Pad;
     /**
@@ -38,28 +94,20 @@ export declare class Pad extends GstObject {
      * 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.
-     * @param templ - the pad template to use
-     * @param name - the name of the pad
-     */
-    static newFromTemplate(templ: PadTemplate, name?: string): Pad;
-    /**
-     * Gets a string representing the given pad-link return.
-     * @param ret - a #GstPadLinkReturn to get the name of.
      */
+    static newFromTemplate(templ: PadTemplate, name?: string | null): Pad;
+    /** Gets a string representing the given pad-link return. */
     static linkGetName(ret: PadLinkReturn): string;
     /**
      * 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.
-     * @param mode - the requested activation mode
-     * @param active - whether or not the pad should be active.
      */
     activateMode(mode: PadMode, active: boolean): boolean;
     /**
      * Checks if the source pad and the sink pad are compatible so they can be
      * linked.
-     * @param sinkpad - the sink #GstPad.
      */
     canLink(sinkpad: Pad): boolean;
     /**
@@ -78,7 +126,6 @@ export declare class Pad extends GstObject {
      *
      * In all cases, success or failure, the caller loses its reference to `buffer`
      * after calling this function.
-     * @param buffer - the #GstBuffer to send, return GST_FLOW_ERROR
      */
     chain(buffer: Buffer): FlowReturn;
     /**
@@ -98,7 +145,6 @@ export declare class Pad extends GstObject {
      * after calling this function.
      *
      * MT safe.
-     * @param list - the #GstBufferList to send, return GST_FLOW_ERROR
      */
     chainList(list: BufferList): FlowReturn;
     /**
@@ -124,10 +170,8 @@ export declare class Pad 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 parent - Parent #GstElement of `pad`
-     * @param streamId - The stream-id
      */
-    createStreamId(parent: Element, streamId?: string): string;
+    createStreamId(parent: Element, streamId?: string | null): string;
     /**
      * Invokes the default event handler for the given pad.
      *
@@ -136,10 +180,8 @@ export declare class Pad extends GstObject {
      *
      * The event is sent to all pads internally linked to `pad`. This function
      * takes ownership of `event`.
-     * @param parent - the parent of `pad` or %NULL
-     * @param event - the #GstEvent to handle.
      */
-    eventDefault(event: Event, parent?: GstObject): boolean;
+    eventDefault(event: Event, parent?: GstObject | null): boolean;
     /**
      * Gets the capabilities of the allowed media types that can flow through
      * `pad` and its peer.
@@ -165,22 +207,16 @@ export declare class Pad extends GstObject {
      * No locking is performed in this function.
      */
     getElementPrivate(): number | null;
-    /**
-     * Gets the #GstFlowReturn return from the last data passed by this pad.
-     */
+    /** Gets the #GstFlowReturn return from the last data passed by this pad. */
     getLastFlowReturn(): FlowReturn;
     /**
      * Get the offset applied to the running time of `pad`. `pad` has to be a source
      * pad.
      */
     getOffset(): number;
-    /**
-     * Gets the template for `pad`.
-     */
+    /** Gets the template for `pad`. */
     getPadTemplate(): PadTemplate | null;
-    /**
-     * Gets the capabilities for `pad`'s template.
-     */
+    /** Gets the capabilities for `pad`'s template. */
     getPadTemplateCaps(): Caps;
     /**
      * Gets the parent of `pad`, cast to a #GstElement. If a `pad` has no parent or
@@ -219,9 +255,6 @@ export declare class Pad extends GstObject {
      * will be unchanged.
      *
      * This is a lowlevel function. Usually gst_pad_pull_range() is used.
-     * @param offset - The start offset of the buffer
-     * @param size - The length of the buffer
-     * @param buffer - a pointer to hold the #GstBuffer,
      */
     getRange(offset: number, size: number, buffer: Ref<Buffer>): FlowReturn;
     /**
@@ -232,8 +265,6 @@ export declare class Pad extends GstObject {
     /**
      * Returns a new reference of the sticky event of type `event_type`
      * from the event.
-     * @param eventType - the #GstEventType that should be retrieved.
-     * @param idx - the index of the event
      */
     getStickyEvent(eventType: EventType, idx: number): Event | null;
     /**
@@ -260,13 +291,9 @@ export declare class Pad extends GstObject {
      * set, #GST_TASK_STOPPED is returned.
      */
     getTaskState(): TaskState;
-    /**
-     * Check if `pad` has caps set on it with a #GST_EVENT_CAPS event.
-     */
+    /** Check if `pad` has caps set on it with a #GST_EVENT_CAPS event. */
     hasCurrentCaps(): boolean;
-    /**
-     * Query if a pad is active
-     */
+    /** Query if a pad is active */
     isActive(): boolean;
     /**
      * Checks if the pad is blocked or not. This function returns the
@@ -279,9 +306,7 @@ export declare class Pad extends GstObject {
      * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
      */
     isBlocking(): boolean;
-    /**
-     * Checks if a `pad` is linked to another pad or not.
-     */
+    /** Checks if a `pad` is linked to another pad or not. */
     isLinked(): boolean;
     /**
      * Gets an iterator for the pads to which the given pad is linked to inside
@@ -300,13 +325,9 @@ export declare class Pad extends GstObject {
      * pads inside the parent element with opposite direction.
      *
      * The caller must free this iterator after use with gst_iterator_free().
-     * @param parent - the parent of `pad` or %NULL
-     */
-    iterateInternalLinksDefault(parent?: GstObject): Iterator | null;
-    /**
-     * Links the source pad and the sink pad.
-     * @param sinkpad - the sink #GstPad to link.
      */
+    iterateInternalLinksDefault(parent?: GstObject | null): Iterator | null;
+    /** Links the source pad and the sink pad. */
     link(sinkpad: Pad): PadLinkReturn;
     /**
      * Links the source pad and the sink pad.
@@ -318,8 +339,6 @@ export declare class Pad extends GstObject {
      * for more information.
      *
      * MT Safe.
-     * @param sinkpad - the sink #GstPad to link.
-     * @param flags - the checks to validate when linking
      */
     linkFull(sinkpad: Pad, flags: PadLinkCheck): PadLinkReturn;
     /**
@@ -330,7 +349,6 @@ export declare class Pad extends GstObject {
      *
      * If `src` or `sink` pads don't have parent elements or do not share a common
      * ancestor, the link will fail.
-     * @param sink - a #GstPad
      */
     linkMaybeGhosting(sink: Pad): boolean;
     /**
@@ -345,8 +363,6 @@ export declare class Pad extends GstObject {
      * 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.
-     * @param sink - a #GstPad
-     * @param flags - some #GstPadLinkCheck flags
      */
     linkMaybeGhostingFull(sink: Pad, flags: PadLinkCheck): boolean;
     /**
@@ -370,13 +386,11 @@ export declare class Pad extends GstObject {
      *
      * The caller is responsible for both the allocation and deallocation of
      * the query structure.
-     * @param query - the #GstQuery to perform.
      */
     peerQuery(query: Query): boolean;
     /**
      * Check if the peer of `pad` accepts `caps`. If `pad` has no peer, this function
      * returns %TRUE.
-     * @param caps - a #GstCaps to check on the pad
      */
     peerQueryAcceptCaps(caps: Caps): boolean;
     /**
@@ -388,30 +402,17 @@ export declare class Pad extends GstObject {
      * 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`.
-     * @param filter - a #GstCaps filter, or %NULL.
      */
-    peerQueryCaps(filter?: Caps): Caps;
+    peerQueryCaps(filter?: Caps | null): Caps;
     /**
      * Queries the peer pad of a given sink pad 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.
      */
     peerQueryConvert(srcFormat: Format, srcVal: number, destFormat: Format, destVal: Ref<number>): boolean;
-    /**
-     * Queries the peer pad of a given sink pad for the total stream duration.
-     * @param format - the #GstFormat requested
-     * @param duration - a location in which to store the total
-     */
-    peerQueryDuration(format: Format, duration?: Ref<number>): boolean;
-    /**
-     * Queries the peer of a given sink pad for the stream position.
-     * @param format - the #GstFormat requested
-     * @param cur - a location in which to store the current
-     */
-    peerQueryPosition(format: Format, cur?: Ref<number>): boolean;
+    /** Queries the peer pad of a given sink pad for the total stream duration. */
+    peerQueryDuration(format: Format, duration?: Ref<number> | null): boolean;
+    /** Queries the peer of a given sink pad for the stream position. */
+    peerQueryPosition(format: Format, cur?: Ref<number> | null): boolean;
     /**
      * Checks if all internally linked pads of `pad` accepts the caps in `query` and
      * returns the intersection of the results.
@@ -419,7 +420,6 @@ export declare class Pad extends GstObject {
      * 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.
-     * @param query - an ACCEPT_CAPS #GstQuery.
      */
     proxyQueryAcceptCaps(query: Query): boolean;
     /**
@@ -429,7 +429,6 @@ export declare class Pad extends GstObject {
      * 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.
-     * @param query - a CAPS #GstQuery.
      */
     proxyQueryCaps(query: Query): boolean;
     /**
@@ -458,9 +457,6 @@ export declare class Pad extends GstObject {
      * 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.
-     * @param offset - The start offset of the buffer
-     * @param size - The length of the buffer
-     * @param buffer - a pointer to hold the #GstBuffer, returns
      */
     pullRange(offset: number, size: number, buffer: Ref<Buffer>): FlowReturn;
     /**
@@ -475,7 +471,6 @@ export declare class Pad extends GstObject {
      *
      * In all cases, success or failure, the caller loses its reference to `buffer`
      * after calling this function.
-     * @param buffer - the #GstBuffer to push returns GST_FLOW_ERROR
      */
     push(buffer: Buffer): FlowReturn;
     /**
@@ -485,7 +480,6 @@ export declare class Pad extends GstObject {
      *
      * 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.
-     * @param event - the #GstEvent to push out of the pad.
      */
     pushEvent(event: Event): boolean;
     /**
@@ -502,7 +496,6 @@ export declare class Pad extends GstObject {
      *
      * In all cases, success or failure, the caller loses its reference to `list`
      * after calling this function.
-     * @param list - the #GstBufferList to push returns GST_FLOW_ERROR
      */
     pushList(list: BufferList): FlowReturn;
     /**
@@ -516,13 +509,9 @@ export declare class Pad extends GstObject {
      * the query structure.
      *
      * Please also note that some queries might need a running pipeline to work.
-     * @param query - the #GstQuery to perform.
      */
     query(query: Query): boolean;
-    /**
-     * Check if the given pad accepts the caps.
-     * @param caps - a #GstCaps to check on the pad
-     */
+    /** Check if the given pad accepts the caps. */
     queryAcceptCaps(caps: Caps): boolean;
     /**
      * Gets the capabilities this pad can produce or consume.
@@ -540,16 +529,9 @@ export declare class Pad extends GstObject {
      *
      * Note that this function does not return writable #GstCaps, use
      * gst_caps_make_writable() before modifying the caps.
-     * @param filter - suggested #GstCaps, or %NULL
-     */
-    queryCaps(filter?: Caps): Caps;
-    /**
-     * Queries a pad 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.
      */
+    queryCaps(filter?: Caps | null): Caps;
+    /** Queries a pad to convert `src_val` in `src_format` to `dest_format`. */
     queryConvert(srcFormat: Format, srcVal: number, destFormat: Format, destVal: Ref<number>): boolean;
     /**
      * Invokes the default query handler for the given pad.
@@ -557,27 +539,16 @@ export declare class Pad extends GstObject {
      * 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.
-     * @param parent - the parent of `pad` or %NULL
-     * @param query - the #GstQuery to handle.
-     */
-    queryDefault(query: Query, parent?: GstObject): boolean;
-    /**
-     * Queries a pad for the total stream duration.
-     * @param format - the #GstFormat requested
-     * @param duration - a location in which to store the total
      */
-    queryDuration(format: Format, duration?: Ref<number>): boolean;
-    /**
-     * Queries a pad for the stream position.
-     * @param format - the #GstFormat requested
-     * @param cur - A location in which to store the current position, or %NULL.
-     */
-    queryPosition(format: Format, cur?: Ref<number>): boolean;
+    queryDefault(query: Query, parent?: GstObject | null): boolean;
+    /** Queries a pad for the total stream duration. */
+    queryDuration(format: Format, duration?: Ref<number> | null): boolean;
+    /** Queries a pad for the stream position. */
+    queryPosition(format: Format, cur?: Ref<number> | null): boolean;
     /**
      * Remove the probe with `id` from `pad`.
      *
      * MT safe.
-     * @param id - the probe id to remove
      */
     removeProbe(id: number): void;
     /**
@@ -601,7 +572,6 @@ export declare class Pad extends GstObject {
      *
      * 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.
-     * @param event - the #GstEvent to send to the pad.
      */
     sendEvent(event: Event): boolean;
     /**
@@ -614,22 +584,19 @@ export declare class Pad extends GstObject {
      *
      * If not `active`, calls gst_pad_activate_mode() with the pad's current mode
      * and a %FALSE argument.
-     * @param active - whether or not the pad should be active.
      */
     setActive(active: boolean): boolean;
     /**
      * 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.
-     * @param priv - The private data to attach to the pad.
      */
-    setElementPrivate(priv?: number): void;
+    setElementPrivate(priv?: number | null): void;
     /**
      * Set the offset that will be applied to the running time of `pad`. Upon next
      * buffer, every sticky events (notably segment) will be pushed again with
      * their running time adjusted. For that reason this is only reliable on
      * source pads.
-     * @param offset - the offset
      */
     setOffset(offset: number): void;
     /**
@@ -644,15 +611,11 @@ export declare class Pad extends GstObject {
      * released so as to ensure that streaming through this pad has finished.
      */
     stopTask(): boolean;
-    /**
-     * Store the sticky `event` on `pad`
-     * @param event - a #GstEvent
-     */
+    /** Store the sticky `event` on `pad` */
     storeStickyEvent(event: Event): FlowReturn;
     /**
      * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
      * signal on both pads.
-     * @param sinkpad - the sink #GstPad to unlink.
      */
     unlink(sinkpad: Pad): boolean;
     /**
@@ -667,7 +630,5 @@ export declare class Pad extends GstObject {
     useFixedCaps(): void;
     connect(signal: "linked", handler: (self: Pad, peer: Pad) => void, after?: boolean): number;
     connect(signal: "unlinked", handler: (self: Pad, peer: Pad) => void, after?: boolean): number;
-    connect(signal: "deep-notify", handler: (self: Pad, propObject: GstObject, prop: GObject.ParamSpec) => void, after?: boolean): number;
-    connect(signal: "notify", handler: (self: Pad, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;
 }