Gjsify LogoGjsify Logo

#GstGLContext wraps an OpenGL context object in a uniform API. As a result of the limitation on OpenGL context, this object is not thread safe unless specified and must only be activated in a single thread.

Environment variables:

  • GST_GL_API: select which OpenGL API to create and OpenGL context for. Depending on the platform, the available values are 'opengl', 'opengl3' (core profile), and 'gles2'. See the the #GstGLAPI enumeration for more details.
  • GST_GL_PLATFORM: select which OpenGL platform to create an OpenGL context with. Depending on the platform and the dependencies available build-time, the available values are, 'glx', 'egl', 'cgl', 'wgl', and 'eagl'
  • GST_GL_CONFIG: select the configuration used for creating the OpenGL context and OpenGL surface. Written out as a GstStructure that has been serialized to string. e.g. GST_GL_CONFIG="gst-gl-context-config,red-size=8,green-size=8,blue-size=8,alpha-size=8,depth-size=16". Not all platforms will support the same level of functionality.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

flags: number

flags for this object

field
g_type_instance: TypeInstance
gl_vtable: GLFuncs

a list of OpenGL function pointers

field
name: string

The name of the object

field
parent: Gst.Object

this object's parent, weak ref

field
name: string

Methods

  • activate(activate: boolean): boolean
  • (De)activate the OpenGL context represented by this context.

    In OpenGL terms, calls eglMakeCurrent or similar with this context and the currently set window. See gst_gl_context_set_window() for details.

    Parameters

    • activate: boolean

      %TRUE to activate, %FALSE to deactivate

    Returns boolean

  • Attach the #GstControlBinding to the object. If there already was a #GstControlBinding for this property it will be replaced.

    The object's reference count will be incremented, and any floating reference will be removed (see gst_object_ref_sink())

    Parameters

    Returns boolean

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transform_from: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • check_feature(feature: string): boolean
  • Check for an OpenGL feature being supported.

    Note: Most features require that the context be created before it is possible to determine their existence and so will fail if that is not the case.

    Parameters

    • feature: string

      a platform specific feature

    Returns boolean

  • check_framebuffer_status(fbo_target: number): boolean
  • Must be called with context current.

    Parameters

    • fbo_target: number

      the GL value of the framebuffer target, GL_FRAMEBUFFER, GL_READ_FRAMEBUFFER, GL_DRAW_FRAMEBUFFER

    Returns boolean

  • check_gl_version(api: GstGL.GLAPI, maj: number, min: number): boolean
  • clear_framebuffer(): void
  • clear_shader(): void
  • Clear's the currently set shader from the GL state machine.

    Note: must be called in the GL thread.

    Returns void

  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • Creates an OpenGL context with the specified other_context as a context to share shareable OpenGL objects with. See the OpenGL specification for what is shared between OpenGL contexts.

    Since 1.20, the configuration can be overriden with the environment variable GST_GL_CONFIG which is a stringified #GstStructure as would be returned from gst_gl_context_get_config(). If GST_GL_CONFIG is not set, then the config will be chosen from other_context by calling gst_gl_context_get_config() on other_context. Otherwise, a default configuration is used.

    Calling gst_gl_context_request_config()) before calling gst_gl_context_create() will override the config from other_context but will not override the GST_GL_CONFIG environment variable.

    If an error occurs, and error is not %NULL, then error will contain details of the error and %FALSE will be returned.

    Should only be called once.

    Parameters

    • other_context: GstGL.GLContext

      a #GstGLContext to share OpenGL objects with

    Returns boolean

  • default_error(error: GLib.Error, debug: string): void
  • A default error function that uses g_printerr() to display the error message and the optional debug string..

    The default handler will simply print the error string using g_print.

    Parameters

    • error: GLib.Error

      the GError.

    • debug: string

      an additional debug information string, or %NULL

    Returns void

  • destroy(): void
  • Destroys an OpenGL context.

    Should only be called after gst_gl_context_create() has been successfully called for this context.

    Returns void

  • disconnect(id: number): void
  • emit(sigName: string, ...args: any[]): void
  • fill_info(): boolean
  • Fills context's info (version, extensions, vtable, etc) from the GL context in the current thread. Typically used with wrapped contexts to allow wrapped contexts to be used as regular #GstGLContext's.

    Returns boolean

  • force_floating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freeze_notify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • Retrieve the OpenGL configuration for this context. The context must have been successfully created for this function to return a valid value.

    Not all implementations currently support retrieving the config and will return %NULL when not supported.

    Returns Gst.Structure

  • get_control_rate(): number
  • Obtain the control-rate for this object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call gst_object_sync_values() in between. The length of the processing segment should be up to control-rate nanoseconds.

    If the object is not under property control, this will return %GST_CLOCK_TIME_NONE. This allows the element to avoid the sub-dividing.

    The control-rate is not expected to change if the element is in %GST_STATE_PAUSED or %GST_STATE_PLAYING.

    Returns number

  • get_data(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • get_g_value_array(property_name: string, timestamp?: number, interval?: number, values?: any[]): boolean
  • Gets a number of #GValues for the given controlled property starting at the requested time. The array values need to hold enough space for n_values of #GValue.

    This function is useful if one wants to e.g. draw a graph of the control curve or apply a control curve sample by sample.

    Parameters

    • property_name: string

      the name of the property to get

    • Optional timestamp: number

      the time that should be processed

    • Optional interval: number

      the time spacing between subsequent values

    • Optional values: any[]

      array to put control-values in

    Returns boolean

  • Get the currently enabled OpenGL api.

    The currently available API may be limited by the #GstGLDisplay in use and/or the #GstGLWindow chosen.

    Returns GstGL.GLAPI

  • get_gl_context(): number
  • get_gl_platform_version(): [number, number]
  • Get the version of the OpenGL platform (GLX, EGL, etc) used. Only valid after a call to gst_gl_context_create().

    Returns [number, number]

  • get_gl_version(): [number, number]
  • Returns the OpenGL version implemented by context. See gst_gl_context_get_gl_api() for retrieving the OpenGL api implemented by context.

    Returns [number, number]

  • get_name(): string
  • Returns a copy of the name of object. Caller should g_free() the return value after usage. For a nameless object, this returns %NULL, which you can safely g_free() as well.

    Free-function: g_free

    Returns string

  • get_path_string(): string
  • get_proc_address(name: string): object
  • Get a function pointer to a specified opengl function, name. If the the specific function does not exist, NULL is returned instead.

    Platform specific functions (names starting 'egl', 'glX', 'wgl', etc) can also be retrieved using this method.

    Note: This function may return valid function pointers that may not be valid to call in context. The caller is responsible for ensuring that the returned function is a valid function to call in context by either checking the OpenGL API and version or for an appropriate OpenGL extension.

    Note: On success, you need to cast the returned function pointer to the correct type to be able to call it correctly. On 32-bit Windows, this will include the GSTGLAPI identifier to use the correct calling convention. e.g.

    void (GSTGLAPI *PFN_glGetIntegerv) (GLenum name, GLint * ret)
    

    Parameters

    • name: string

      an opengl function name

    Returns object

  • get_property(property_name?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • get_value(property_name: string, timestamp?: number): any
  • Gets the value for the given controlled property at the requested time.

    Parameters

    • property_name: string

      the name of the property to get

    • Optional timestamp: number

      the time the control-change should be read from

    Returns any

  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • has_active_control_bindings(): boolean
  • Check if object has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.

    Parameters

    • ancestor: Gst.Object

      a #GstObject to check as ancestor

    Returns boolean

  • has_as_ancestor(ancestor: Gst.Object): boolean
  • is_floating(): boolean
  • is_shared(): boolean
  • notify(property_name: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • ref(...args: any[]): any
  • Increments the reference count on object. This function does not take the lock on object because it relies on atomic refcounting.

    This object returns the input parameter to ease writing constructs like : result = gst_object_ref (object->parent);

    Parameters

    • Rest ...args: any[]

    Returns any

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • Set the OpenGL configuration for this context. The context must not have been created for this function to succeed. Setting a %NULL config has the affect of removing any specific configuration request.

    Not all implementations currently support retrieving the config and this function will return FALSE when not supported.

    Note that calling this function may cause a subsequent gst_gl_context_create() to fail if config could not be matched with the platform-specific configuration.

    Note that the actual config used may be differ from the requested values.

    Parameters

    • gl_config: Gst.Structure

      a configuration structure for configuring the OpenGL context

    Returns boolean

  • run_dispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • set_control_binding_disabled(property_name: string, disabled: boolean): void
  • This function is used to disable the control bindings on a property for some time, i.e. gst_object_sync_values() will do nothing for the property.

    Parameters

    • property_name: string

      property to disable

    • disabled: boolean

      boolean that specifies whether to disable the controller or not.

    Returns void

  • set_control_bindings_disabled(disabled: boolean): void
  • This function is used to disable all controlled properties of the object for some time, i.e. gst_object_sync_values() will do nothing.

    Parameters

    • disabled: boolean

      boolean that specifies whether to disable the controller or not.

    Returns void

  • set_control_rate(control_rate: number): void
  • Change the control-rate for this object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call gst_object_sync_values() in between. The length of the processing segment should be up to control-rate nanoseconds.

    The control-rate should not change if the element is in %GST_STATE_PAUSED or %GST_STATE_PLAYING.

    Parameters

    • control_rate: number

      the new control-rate in nanoseconds.

    Returns void

  • set_data(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • set_name(name: string): boolean
  • Sets the name of object, or gives object a guaranteed unique name (if name is %NULL). This function makes a copy of the provided name, so the caller retains ownership of the name it sent.

    Parameters

    • name: string

      new name of object

    Returns boolean

  • Sets the parent of object to parent. The object's reference count will be incremented, and any floating reference will be removed (see gst_object_ref_sink()).

    Parameters

    Returns boolean

  • set_property(property_name: string, value?: any): void
  • Set's the current window on context to window. The window can only be changed before gst_gl_context_create() has been called and the window is not already running.

    Parameters

    Returns boolean

  • steal_data(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • steal_qdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • suggest_next_sync(): number
  • swap_buffers(): void
  • Swap the front and back buffers on the window attached to context. This will display the frame on the next refresh cycle.

    Returns void

  • sync_values(timestamp: number): boolean
  • Sets the properties of the object, according to the #GstControlSources that (maybe) handle them and for the given timestamp.

    If this function fails, it is most likely the application developers fault. Most probably the control sources are not setup correctly.

    Parameters

    • timestamp: number

      the time that should be processed

    Returns boolean

  • thaw_notify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unparent(): void
  • Clear the parent of object, removing the associated reference. This function decreases the refcount of object.

    MT safe. Grabs and releases object's lock.

    Returns void

  • unref(): void
  • Decrements the reference count on object. If reference count hits zero, destroy object. This function does not take the lock on object as it relies on atomic refcounting.

    The unref method should never be called with the LOCK held since this might deadlock the dispose function.

    Returns void

  • vfunc_activate(activate: boolean): boolean
  • (De)activate the OpenGL context represented by this context.

    In OpenGL terms, calls eglMakeCurrent or similar with this context and the currently set window. See gst_gl_context_set_window() for details.

    virtual

    Parameters

    • activate: boolean

      %TRUE to activate, %FALSE to deactivate

    Returns boolean

  • vfunc_check_feature(feature: string): boolean
  • Check for an OpenGL feature being supported.

    Note: Most features require that the context be created before it is possible to determine their existence and so will fail if that is not the case.

    virtual

    Parameters

    • feature: string

      a platform specific feature

    Returns boolean

  • vfunc_choose_format(): boolean
  • vfunc_constructed(): void
  • vfunc_destroy_context(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • Retrieve the OpenGL configuration for this context. The context must have been successfully created for this function to return a valid value.

    Not all implementations currently support retrieving the config and will return %NULL when not supported.

    virtual

    Returns Gst.Structure

  • Get the currently enabled OpenGL api.

    The currently available API may be limited by the #GstGLDisplay in use and/or the #GstGLWindow chosen.

    virtual

    Returns GstGL.GLAPI

  • vfunc_get_gl_context(): number
  • vfunc_get_gl_platform_version(): [number, number]
  • Get the version of the OpenGL platform (GLX, EGL, etc) used. Only valid after a call to gst_gl_context_create().

    virtual

    Returns [number, number]

  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    virtual

    Parameters

    Returns void

  • Set the OpenGL configuration for this context. The context must not have been created for this function to succeed. Setting a %NULL config has the affect of removing any specific configuration request.

    Not all implementations currently support retrieving the config and this function will return FALSE when not supported.

    Note that calling this function may cause a subsequent gst_gl_context_create() to fail if config could not be matched with the platform-specific configuration.

    Note that the actual config used may be differ from the requested values.

    virtual

    Parameters

    • gl_config: Gst.Structure

      a configuration structure for configuring the OpenGL context

    Returns boolean

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_swap_buffers(): void
  • Swap the front and back buffers on the window attached to context. This will display the frame on the next refresh cycle.

    virtual

    Returns void

  • watch_closure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • check_uniqueness(list: Gst.Object[], name: string): boolean
  • Checks to see if there is any object named name in list. This function does not do any locking of any kind. You might want to protect the provided list with the lock of the owner of the list. This function will lock each #GstObject in the list to compare the name, so be careful when passing a list with a locked object.

    Parameters

    • list: Gst.Object[]

      a list of #GstObject to check through

    • name: string

      the name to search for

    Returns boolean

  • compat_control(what: number, data: object): number
  • A default deep_notify signal callback for an object. The user data should contain a pointer to an array of strings that should be excluded from the notify. The default handler will print the new value of the property using g_print.

    MT safe. This function grabs and releases object's LOCK for getting its path string.

    Parameters

    • object: GObject.Object

      the #GObject that signalled the notify.

    • orig: Gst.Object

      a #GstObject that initiated the notify.

    • pspec: ParamSpec

      a #GParamSpec of the property.

    • excluded_props: string[]

      a set of user-specified properties to exclude or %NULL to show all changes.

    Returns void

  • default_get_proc_address(gl_api: GstGL.GLAPI, name: string): object
  • A default implementation of the various GetProcAddress functions that looks for name in the OpenGL shared libraries or in the current process.

    See also: gst_gl_context_get_proc_address()

    Parameters

    • gl_api: GstGL.GLAPI

      a #GstGLAPI

    • name: string

      then function to get the address of

    Returns object

  • get_current_gl_context(context_type: GLPlatform): number
  • Attempts to use the context_type specific GetProcAddress implementations to retrieve name.

    See also gst_gl_context_get_proc_address().

    Parameters

    • context_type: GLPlatform

      a #GstGLPlatform

    • gl_api: GstGL.GLAPI

      a #GstGLAPI

    • name: string

      the name of the function to retrieve

    Returns object

  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Wraps an existing OpenGL context into a #GstGLContext.

    Note: The caller is responsible for ensuring that the OpenGL context represented by handle stays alive while the returned #GstGLContext is active.

    context_type must not be %GST_GL_PLATFORM_NONE or %GST_GL_PLATFORM_ANY

    available_apis must not be %GST_GL_API_NONE or %GST_GL_API_ANY

    Parameters

    • display: GLDisplay

      a #GstGLDisplay

    • handle: number

      the OpenGL context to wrap

    • context_type: GLPlatform

      a #GstGLPlatform specifying the type of context in handle

    • available_apis: GstGL.GLAPI

      a #GstGLAPI containing the available OpenGL apis in handle

    Returns GstGL.GLContext

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

  • Atomically modifies a pointer to point to a new object. The reference count of oldobj is decreased and the reference count of newobj is increased.

    Either newobj and the value pointed to by oldobj may be %NULL.

    Parameters

    • oldobj: Gst.Object

      pointer to a place of a #GstObject to replace

    • newobj: Gst.Object

      a new #GstObject

    Returns [boolean, Gst.Object]

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method