@gtkx/ffi 0.8.0 → 0.9.1

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

@@ -1,5 +1,5 @@
 import { Ref } from "@gtkx/native";
-import { DebugColorMode, DebugGraphDetails, DebugLevel, EventType, EventTypeFlags, FlowReturn, Format, MessageType, PadMode, ParseFlags, PluginAPIFlags, QueryType, QueryTypeFlags, SearchMode, StackTraceFlags, StateChange, StreamType, TagFlag, TocEntryType, URIType } from "./enums.js";
+import { DebugColorMode, DebugGraphDetails, DebugLevel, EventType, EventTypeFlags, FlowReturn, Format, MessageType, PadMode, ParseFlags, PluginAPIFlags, QueryType, QueryTypeFlags, StackTraceFlags, StateChange, StreamType, TagFlag, TocEntryType, URIType } from "./enums.js";
 import { Buffer } from "./buffer.js";
 import { BufferList } from "./buffer-list.js";
 import { Caps } from "./caps.js";
@@ -37,7 +37,7 @@ export declare const bufferGetMaxMemory: () => number;
  * @param oldList - pointer to a pointer to a
  * @param newList - pointer to a #GstBufferList that
  */
-export declare const bufferListReplace: (oldList?: Ref<BufferList> | null, newList?: BufferList | null) => boolean;
+export declare const bufferListReplace: (oldList?: Ref<BufferList>, newList?: BufferList) => boolean;
 /**
  * Modifies a pointer to a #GstBufferList to point to a different
  * #GstBufferList. This function is similar to gst_buffer_list_replace() except
@@ -45,7 +45,7 @@ export declare const bufferListReplace: (oldList?: Ref<BufferList> | null, newLi
  * @param oldList - pointer to a pointer to a #GstBufferList
  * @param newList - pointer to a #GstBufferList
  */
-export declare const bufferListTake: (oldList: Ref<BufferList>, newList?: BufferList | null) => boolean;
+export declare const bufferListTake: (oldList: Ref<BufferList>, newList?: BufferList) => boolean;
 /**
  * Creates a #GstCapsFeatures from a string representation.
  * @param features - a string representation of a #GstCapsFeatures.
@@ -69,16 +69,8 @@ export declare const capsFromString: (string: string) => Caps | null;
  * @param oldContext - pointer to a pointer to a #GstContext
  * @param newContext - pointer to a #GstContext that will
  */
-export declare const contextReplace: (oldContext: Ref<Context>, newContext?: Context | null) => boolean;
+export declare const contextReplace: (oldContext: Ref<Context>, newContext?: Context) => boolean;
 export declare const coreErrorQuark: () => number;
-/**
- * Adds the logging function to the list of logging functions.
- * Be sure to use #G_GNUC_NO_INSTRUMENT on that function, it is needed.
- * @param func - the function to use
- * @param userData - user data
- * @param notify - called when `user_data` is not used anymore
- */
-export declare const debugAddLogFunction: (func: (...args: unknown[]) => unknown, notify: () => void, userData?: number | null) => void;
 /**
  * Adds a memory ringbuffer based debug logger that stores up to
  * `max_size_per_thread` bytes of logs per thread and times out threads after
@@ -186,7 +178,7 @@ export declare const debugLevelGetName: (level: DebugLevel) => string;
  * @param message - the actual message
  * @param userData - the FILE* to log to
  */
-export declare const debugLogDefault: (category: number, level: DebugLevel, file: string, _function: string, line: number, message: number, object?: GObject.GObject | null, userData?: number | null) => void;
+export declare const debugLogDefault: (category: number, level: DebugLevel, file: string, _function: string, line: number, message: number, object?: GObject.GObject, userData?: number) => void;
 /**
  * Returns the string representation for the specified debug log message
  * formatted in the same way as gst_debug_log_default() (the default handler),
@@ -201,7 +193,7 @@ export declare const debugLogDefault: (category: number, level: DebugLevel, file
  * @param object - the object this message relates to,
  * @param message - the actual message
  */
-export declare const debugLogGetLine: (category: number, level: DebugLevel, file: string, _function: string, line: number, message: number, object?: GObject.GObject | null) => string;
+export declare const debugLogGetLine: (category: number, level: DebugLevel, file: string, _function: string, line: number, message: number, object?: GObject.GObject) => string;
 /**
  * Logs the given message using the currently registered debugging handlers.
  * @param category - category to log
@@ -212,7 +204,7 @@ export declare const debugLogGetLine: (category: number, level: DebugLevel, file
  * @param id - the identifier of the object this message relates to
  * @param messageString - a message string
  */
-export declare const debugLogIdLiteral: (category: number, level: DebugLevel, file: string, _function: string, line: number, messageString: string, id?: string | null) => void;
+export declare const debugLogIdLiteral: (category: number, level: DebugLevel, file: string, _function: string, line: number, messageString: string, id?: string) => void;
 /**
  * Logs the given message using the currently registered debugging handlers.
  * @param category - category to log
@@ -223,7 +215,7 @@ export declare const debugLogIdLiteral: (category: number, level: DebugLevel, fi
  * @param object - the object this message relates to,
  * @param messageString - a message string
  */
-export declare const debugLogLiteral: (category: number, level: DebugLevel, file: string, _function: string, line: number, messageString: string, object?: GObject.GObject | null) => void;
+export declare const debugLogLiteral: (category: number, level: DebugLevel, file: string, _function: string, line: number, messageString: string, object?: GObject.GObject) => void;
 /**
  * Returns a string that represents @ptr. This is safe to call with
  * %GstStructure, %GstCapsFeatures, %GstMiniObject s (e.g. %GstCaps,
@@ -236,7 +228,7 @@ export declare const debugLogLiteral: (category: number, level: DebugLevel, file
  * unsafe to do.
  * @param ptr - the object
  */
-export declare const debugPrintObject: (ptr?: number | null) => string;
+export declare const debugPrintObject: (ptr?: number) => string;
 /**
  * Returns a string that represents @segments.
  *
@@ -244,22 +236,17 @@ export declare const debugPrintObject: (ptr?: number | null) => string;
  * might change between GStreamer versions.
  * @param segment - the %GstSegment
  */
-export declare const debugPrintSegment: (segment?: Segment | null) => string;
+export declare const debugPrintSegment: (segment?: Segment) => string;
 /**
  * If libunwind, glibc backtrace or DbgHelp are present
  * a stack trace is printed.
  */
 export declare const debugPrintStackTrace: () => void;
-/**
- * Removes all registered instances of the given logging functions.
- * @param func - the log function to remove, or %NULL to
- */
-export declare const debugRemoveLogFunction: (func?: (...args: unknown[]) => unknown | null) => number;
 /**
  * Removes all registered instances of log functions with the given user data.
  * @param data - user data of the log function to remove
  */
-export declare const debugRemoveLogFunctionByData: (data?: number | null) => number;
+export declare const debugRemoveLogFunctionByData: (data?: number) => number;
 /**
  * Removes any previously added ring buffer logger with
  * gst_debug_add_ring_buffer_logger().
@@ -461,7 +448,7 @@ export declare const getMainExecutablePath: () => string | null;
  * @param argc - pointer to application's argc
  * @param argv - pointer to application's argv
  */
-export declare const init: (argc?: Ref<number> | null, argv?: Ref<string[]> | null) => void;
+export declare const init: (argc?: Ref<number>, argv?: Ref<string[]>) => void;
 /**
  * Initializes the GStreamer library, setting up internal path lists,
  * registering built-in elements, and loading standard plugins.
@@ -472,11 +459,11 @@ export declare const init: (argc?: Ref<number> | null, argv?: Ref<string[]> | nu
  * @param argc - pointer to application's argc
  * @param argv - pointer to application's argv
  */
-export declare const initCheck: (argc?: Ref<number> | null, argv?: Ref<string[]> | null) => boolean;
+export declare const initCheck: (argc?: Ref<number>, argv?: Ref<string[]>) => boolean;
 /**
  * Checks if `obj` is a #GstCapsFeatures
  */
-export declare const isCapsFeatures: (obj?: number | null) => boolean;
+export declare const isCapsFeatures: (obj?: number) => boolean;
 /**
  * Use this function to check if GStreamer has been initialized with gst_init()
  * or gst_init_check().
@@ -490,7 +477,7 @@ export declare const libraryErrorQuark: () => number;
  * @param oldMessage - pointer to a pointer to a #GstMessage
  * @param newMessage - pointer to a #GstMessage that
  */
-export declare const messageTake: (oldMessage: Ref<Message>, newMessage?: Message | null) => boolean;
+export declare const messageTake: (oldMessage: Ref<Message>, newMessage?: Message) => boolean;
 /**
  * Get a printable name for the given message type. Do not modify or free.
  * @param type - the message type
@@ -530,12 +517,6 @@ export declare const metaApiTypeHasTag: (api: number, tag: number) => boolean;
  * @param tags - tags for @api
  */
 export declare const metaApiTypeRegister: (api: string, tags: string[]) => number;
-/**
- * This function sets the aggregator function for a specific API type.
- * @param api - the #GType of the API for which the aggregator function is being set.
- * @param aggregator - the aggregator function to be associated with the given API
- */
-export declare const metaApiTypeSetParamsAggregator: (api: number, aggregator: (...args: unknown[]) => unknown) => void;
 /**
  * Recreate a #GstMeta from serialized data returned by
  * gst_meta_serialize() and add it to @buffer.
@@ -558,27 +539,6 @@ export declare const metaDeserialize: (buffer: Buffer, data: number, size: numbe
  * @param impl - the name
  */
 export declare const metaGetInfo: (impl: string) => number | null;
-/**
- * Register a new custom #GstMeta implementation, backed by an opaque
- * structure holding a #GstStructure.
- *
- * The registered info can be retrieved later with gst_meta_get_info() by using
- * `name` as the key.
- *
- * The backing #GstStructure can be retrieved with
- * gst_custom_meta_get_structure(), its mutability is conditioned by the
- * writability of the buffer the meta is attached to.
- *
- * When `transform_func` is %NULL, the meta and its backing #GstStructure
- * will always be copied when the transform operation is copy, other operations
- * are discarded, copy regions are ignored.
- * @param name - the name of the #GstMeta implementation
- * @param tags - tags for @api
- * @param transformFunc - a #GstMetaTransformFunction
- * @param userData - user data passed to @transform_func
- * @param destroyData - #GDestroyNotify for user_data
- */
-export declare const metaRegisterCustom: (name: string, tags: string[], destroyData: () => void, transformFunc?: (...args: unknown[]) => unknown | null, userData?: number | null) => number;
 /**
  * Simplified version of gst_meta_register_custom(), with no tags and no
  * transform function.
@@ -594,7 +554,7 @@ export declare const metaRegisterCustomSimple: (name: string) => number;
  * @param olddata - pointer to a pointer to a
  * @param newdata - pointer to new mini-object
  */
-export declare const miniObjectReplace: (olddata?: Ref<MiniObject> | null, newdata?: MiniObject | null) => boolean;
+export declare const miniObjectReplace: (olddata?: Ref<MiniObject>, newdata?: MiniObject) => boolean;
 /**
  * Modifies a pointer to point to a new mini-object. The modification
  * is done atomically. This version is similar to gst_mini_object_replace()
@@ -674,7 +634,7 @@ export declare const parseBinFromDescription: (binDescription: string, ghostUnli
  * @param context - a parse context allocated with
  * @param flags - parsing options, or #GST_PARSE_FLAG_NONE
  */
-export declare const parseBinFromDescriptionFull: (binDescription: string, ghostUnlinkedPads: boolean, flags: ParseFlags, context?: ParseContext | null) => Element;
+export declare const parseBinFromDescriptionFull: (binDescription: string, ghostUnlinkedPads: boolean, flags: ParseFlags, context?: ParseContext) => Element;
 /**
  * Get the error quark used by the parsing subsystem.
  */
@@ -702,7 +662,7 @@ export declare const parseLaunch: (pipelineDescription: string) => Element;
  * @param context - a parse context allocated with
  * @param flags - parsing options, or #GST_PARSE_FLAG_NONE
  */
-export declare const parseLaunchFull: (pipelineDescription: string, flags: ParseFlags, context?: ParseContext | null) => Element;
+export declare const parseLaunchFull: (pipelineDescription: string, flags: ParseFlags, context?: ParseContext) => Element;
 /**
  * Create a new element based on command line syntax.
  * `error` will contain an error message if an erroneous pipeline is specified.
@@ -718,7 +678,7 @@ export declare const parseLaunchv: (argv: string[]) => Element;
  * @param context - a parse context allocated with
  * @param flags - parsing options, or #GST_PARSE_FLAG_NONE
  */
-export declare const parseLaunchvFull: (argv: string[], flags: ParseFlags, context?: ParseContext | null) => Element;
+export declare const parseLaunchvFull: (argv: string[], flags: ParseFlags, context?: ParseContext) => Element;
 /**
  * Get the error quark.
  */
@@ -759,7 +719,7 @@ export declare const protectionSelectSystem: (systemIdentifiers: string[]) => st
  * @param oldQuery - pointer to a
  * @param newQuery - pointer to a #GstQuery that will
  */
-export declare const queryTake: (oldQuery?: Ref<Query> | null, newQuery?: Query | null) => boolean;
+export declare const queryTake: (oldQuery?: Ref<Query>, newQuery?: Query) => boolean;
 /**
  * Gets the #GstQueryTypeFlags associated with @type.
  * @param type - a #GstQueryType
@@ -820,7 +780,7 @@ export declare const streamTypeGetName: (stype: StreamType) => string;
  * @param oldstrPtr - pointer to a place of
  * @param newstr - a new #GstStructure
  */
-export declare const structureTake: (oldstrPtr?: Ref<Structure> | null, newstr?: Structure | null) => boolean;
+export declare const structureTake: (oldstrPtr?: Ref<Structure>, newstr?: Structure) => boolean;
 /**
  * Checks if the given type is already registered.
  * @param tag - name of the tag
@@ -875,7 +835,7 @@ export declare const tagListCopyValue: (dest: GObject.Value, list: TagList, tag:
  * @param oldTaglist - pointer to a pointer to a
  * @param newTaglist - pointer to a #GstTagList that
  */
-export declare const tagListReplace: (oldTaglist?: Ref<TagList> | null, newTaglist?: TagList | null) => boolean;
+export declare const tagListReplace: (oldTaglist?: Ref<TagList>, newTaglist?: TagList) => boolean;
 /**
  * Modifies a pointer to a #GstTagList to point to a different #GstTagList.
  * This function is similar to gst_tag_list_replace() except that it takes
@@ -883,7 +843,7 @@ export declare const tagListReplace: (oldTaglist?: Ref<TagList> | null, newTagli
  * @param oldTaglist - pointer to a pointer to a #GstTagList
  * @param newTaglist - pointer to a #GstTagList that
  */
-export declare const tagListTake: (oldTaglist: Ref<TagList>, newTaglist?: TagList | null) => boolean;
+export declare const tagListTake: (oldTaglist: Ref<TagList>, newTaglist?: TagList) => boolean;
 /**
  * This is a convenience function for the func argument of gst_tag_register().
  * It concatenates all given strings using a comma. The tag must be registered
@@ -909,35 +869,13 @@ export declare const tocEntryTypeGetNick: (type: TocEntryType) => string;
  * the entirety of the run-time of the process or till gst_deinit() is called.
  */
 export declare const tracingGetActiveTracers: () => Tracer[];
-/**
- * Register `func` to be called when the trace hook `detail` is getting invoked.
- * Use %NULL for `detail` to register to all hooks.
- * @param tracer - the tracer
- * @param detail - the detailed hook
- * @param func - the callback
- */
-export declare const tracingRegisterHook: (tracer: Tracer, detail: string, func: (...args: unknown[]) => unknown) => void;
-/**
- * Registers a new typefind function to be used for typefinding. After
- * registering this function will be available for typefinding.
- * This function is typically called during an element's plugin initialization.
- * @param plugin - A #GstPlugin, or %NULL for a static typefind function
- * @param name - The name for registering
- * @param rank - The rank (or importance) of this typefind function
- * @param func - The #GstTypeFindFunction to use
- * @param extensions - Optional comma-separated list of extensions
- * @param possibleCaps - Optionally the caps that could be returned when typefinding
- * @param data - Optional user data. This user data must be available until the plugin
- * @param dataNotify - a #GDestroyNotify that will be called on `data` when the plugin
- */
-export declare const typeFindRegister: (name: string, rank: number, func: (...args: unknown[]) => unknown, dataNotify: () => void, plugin?: Plugin | null, extensions?: string | null, possibleCaps?: Caps | null, data?: number | null) => boolean;
 /**
  * Checks if `type` is plugin API. See gst_type_mark_as_plugin_api() for
  * details.
  * @param type - a GType
  * @param flags - What #GstPluginAPIFlags the plugin was marked with
  */
-export declare const typeIsPluginApi: (type: number, flags?: Ref<PluginAPIFlags> | null) => boolean;
+export declare const typeIsPluginApi: (type: number, flags?: Ref<PluginAPIFlags>) => boolean;
 /**
  * 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
@@ -1054,23 +992,6 @@ export declare const uriProtocolIsSupported: (type: URIType, protocol: string) =
  * @param protocol - A string
  */
 export declare const uriProtocolIsValid: (protocol: string) => boolean;
-/**
- * Searches inside `array` for `search_data` by using the comparison function
- * @search_func. `array` must be sorted ascending.
- *
- * As `search_data` is always passed as second argument to `search_func` it's
- * not required that `search_data` has the same type as the array elements.
- *
- * The complexity of this search function is O(log (num_elements)).
- * @param array - the sorted input array
- * @param numElements - number of elements in the array
- * @param elementSize - size of every element in bytes
- * @param searchFunc - function to compare two
- * @param mode - search mode that should be used
- * @param searchData - element that should be found
- * @param userData - data to pass to @search_func
- */
-export declare const utilArrayBinarySearch: (numElements: number, elementSize: number, searchFunc: (a: unknown, b: unknown) => number, mode: SearchMode, array?: number | null, searchData?: number | null) => number | null;
 /**
  * Returns smallest integral value not less than log2(v).
  * @param v - a #guint32 value.
@@ -1380,7 +1301,7 @@ export declare const valueDeserialize: (dest: GObject.Value, src: string) => boo
  * @param src - string to deserialize
  * @param pspec - the #GParamSpec describing the expected value
  */
-export declare const valueDeserializeWithPspec: (dest: GObject.Value, src: string, pspec?: GObject.ParamSpec | null) => boolean;
+export declare const valueDeserializeWithPspec: (dest: GObject.Value, src: string, pspec?: GObject.ParamSpec) => boolean;
 /**
  * Fixate `src` into a new value @dest.
  * For ranges, the first element is taken. For lists and arrays, the
@@ -1513,7 +1434,7 @@ export declare const valueInitAndCopy: (dest: GObject.Value, src: GObject.Value)
  * @param value1 - a value to intersect
  * @param value2 - another value to intersect
  */
-export declare const valueIntersect: (value1: GObject.Value, value2: GObject.Value, dest?: GObject.Value | null) => boolean;
+export declare const valueIntersect: (value1: GObject.Value, value2: GObject.Value, dest?: GObject.Value) => boolean;
 /**
  * Tests if the given GValue, if available in a GstStructure (or any other
  * container) contains a "fixed" (which means: one value) or an "unfixed"
@@ -1645,7 +1566,7 @@ export declare const valueSetStructure: (value: GObject.Value, structure: Struct
  * @param minuend - the value to subtract from
  * @param subtrahend - the value to subtract
  */
-export declare const valueSubtract: (minuend: GObject.Value, subtrahend: GObject.Value, dest?: GObject.Value | null) => boolean;
+export declare const valueSubtract: (minuend: GObject.Value, subtrahend: GObject.Value, dest?: GObject.Value) => boolean;
 /**
  * Creates a GValue corresponding to the union of `value1` and @value2.
  * @param dest - the destination value