Class (GI Class)

GES-1.0GESMarkerSince 1.18

A timed GES.MetaContainer object.

1.18

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

$gtype: GType<GES.Marker>

Accessors

Methods

  • Deserializes the given string, and adds and sets the found fields and their values on the container. The string should be the return of ges_meta_container_metas_to_string().

    Parameters

    • str: string

      A string to deserialize and add to container

    Returns boolean

    true if the fields in str was successfully deserialized and added to container.

  • 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.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.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 GObject.Binding 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.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    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.

    If flags contains GObject.BindingFlags.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 transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • 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

    • ...args: never[]

      the property on source to bind

    Returns any

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Checks whether the specified field has been registered as static, and gets the registered type and flags of the field, as used in ges_meta_container_register_meta() and ges_meta_container_register_static_meta().

    Parameters

    • meta_item: string

      The key for the container field to check

    Returns [boolean, GES.MetaFlag, GType<unknown>]

    true if the meta_item field has been registered on container.

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns 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.Object::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

  • Gets the current boolean value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.

    Parameters

    • meta_item: string

      The key for the container field to get

    Returns [boolean, boolean]

    true if the boolean value under meta_item was copied to dest.

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets the current date value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.

    Parameters

    • meta_item: string

      The key for the container field to get

    Returns [boolean, GLib.Date]

    true if the date value under meta_item was copied to dest.

  • Gets the current date time value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.

    Parameters

    • meta_item: string

      The key for the container field to get

    Returns [boolean, Gst.DateTime]

    true if the date time value under meta_item was copied to dest.

  • Gets the current double value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.

    Parameters

    • meta_item: string

      The key for the container field to get

    Returns [boolean, number]

    true if the double value under meta_item was copied to dest.

  • Gets the current float value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.

    Parameters

    • meta_item: string

      The key for the container field to get

    Returns [boolean, number]

    true if the float value under meta_item was copied to dest.

  • Gets the current int value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.

    Parameters

    • meta_item: string

      The key for the container field to get

    Returns [boolean, number]

    true if the int value under meta_item was copied to dest.

  • Gets the current int64 value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.

    Parameters

    • meta_item: string

      The key for the container field to get

    Returns [boolean, number]

    true if the int64 value under meta_item was copied to dest.

  • Gets the current marker list value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.

    Parameters

    • key: string

      The key for the container field to get

    Returns GES.MarkerList

    A copy of the marker list value under key, or null if it could not be fetched.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value 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 GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

  • Gets the current string value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.

    Parameters

    • meta_item: string

      The key for the container field to get

    Returns string

    The string value under meta_item, or null if it could not be fetched.

  • Gets the current uint value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.

    Parameters

    • meta_item: string

      The key for the container field to get

    Returns [boolean, number]

    true if the uint value under meta_item was copied to dest.

  • Gets the current uint64 value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.

    Parameters

    • meta_item: string

      The key for the container field to get

    Returns [boolean, number]

    true if the uint64 value under meta_item was copied to dest.

  • 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

  • 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.:

      typedef enum
    {
    PROP_FOO = 1,
    PROP_LAST
    } MyObjectProperty;

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
    0, 100,
    50,
    G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    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

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the floating 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

    object

  • Sets the value of the specified field of the meta container to the given value, and registers the field to only hold a value of the same type. After calling this, only values of the same type as value can be set for this field. The given flags can be set to make this field only readable after calling this method.

    Parameters

    • flags: GES.MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • value: any

      The value to set for the registered field

    Returns boolean

    true if the meta_item field was successfully registered on container to only hold value types, with the given flags, and the field was successfully set to value.

  • Sets the value of the specified field of the meta container to the given boolean value, and registers the field to only hold a boolean typed value. After calling this, only boolean values can be set for this field. The given flags can be set to make this field only readable after calling this method.

    Parameters

    • flags: GES.MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • value: boolean

      The value to set for the registered field

    Returns boolean

    true if the meta_item field was successfully registered on container to only hold boolean typed values, with the given flags, and the field was successfully set to value.

  • Sets the value of the specified field of the meta container to the given date value, and registers the field to only hold a date typed value. After calling this, only date values can be set for this field. The given flags can be set to make this field only readable after calling this method.

    Parameters

    • flags: GES.MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • value: GLib.Date

      The value to set for the registered field

    Returns boolean

    true if the meta_item field was successfully registered on container to only hold date typed values, with the given flags, and the field was successfully set to value.

  • Sets the value of the specified field of the meta container to the given date time value, and registers the field to only hold a date time typed value. After calling this, only date time values can be set for this field. The given flags can be set to make this field only readable after calling this method.

    Parameters

    • flags: GES.MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • value: Gst.DateTime

      The value to set for the registered field

    Returns boolean

    true if the meta_item field was successfully registered on container to only hold date time typed values, with the given flags, and the field was successfully set to value.

  • Sets the value of the specified field of the meta container to the given double value, and registers the field to only hold a double typed value. After calling this, only double values can be set for this field. The given flags can be set to make this field only readable after calling this method.

    Parameters

    • flags: GES.MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • value: number

      The value to set for the registered field

    Returns boolean

    true if the meta_item field was successfully registered on container to only hold double typed values, with the given flags, and the field was successfully set to value.

  • Sets the value of the specified field of the meta container to the given float value, and registers the field to only hold a float typed value. After calling this, only float values can be set for this field. The given flags can be set to make this field only readable after calling this method.

    Parameters

    • flags: GES.MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • value: number

      The value to set for the registered field

    Returns boolean

    true if the meta_item field was successfully registered on container to only hold float typed values, with the given flags, and the field was successfully set to value.

  • Sets the value of the specified field of the meta container to the given int value, and registers the field to only hold an int typed value. After calling this, only int values can be set for this field. The given flags can be set to make this field only readable after calling this method.

    Parameters

    • flags: GES.MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • value: number

      The value to set for the registered field

    Returns boolean

    true if the meta_item field was successfully registered on container to only hold int typed values, with the given flags, and the field was successfully set to value.

  • Sets the value of the specified field of the meta container to the given int64 value, and registers the field to only hold an int64 typed value. After calling this, only int64 values can be set for this field. The given flags can be set to make this field only readable after calling this method.

    Parameters

    • flags: GES.MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • value: number

      The value to set for the registered field

    Returns boolean

    true if the meta_item field was successfully registered on container to only hold int64 typed values, with the given flags, and the field was successfully set to value.

  • Sets the value of the specified field of the meta container to the given string value, and registers the field to only hold a string typed value. After calling this, only string values can be set for this field. The given flags can be set to make this field only readable after calling this method.

    Parameters

    • flags: GES.MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • value: string

      The value to set for the registered field

    Returns boolean

    true if the meta_item field was successfully registered on container to only hold string typed values, with the given flags, and the field was successfully set to value.

  • Sets the value of the specified field of the meta container to the given uint value, and registers the field to only hold a uint typed value. After calling this, only uint values can be set for this field. The given flags can be set to make this field only readable after calling this method.

    Parameters

    • flags: GES.MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • value: number

      The value to set for the registered field

    Returns boolean

    true if the meta_item field was successfully registered on container to only hold uint typed values, with the given flags, and the field was successfully set to value.

  • Sets the value of the specified field of the meta container to the given uint64 value, and registers the field to only hold a uint64 typed value. After calling this, only uint64 values can be set for this field. The given flags can be set to make this field only readable after calling this method.

    Parameters

    • flags: GES.MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • value: number

      The value to set for the registered field

    Returns boolean

    true if the meta_item field was successfully registered on container to only hold uint64 typed values, with the given flags, and the field was successfully set to value.

  • Registers a static metadata field on the container to only hold the specified type. After calling this, setting a value under this field can only succeed if its type matches the registered type of the field.

    Unlike ges_meta_container_register_meta(), no (initial) value is set for this field, which means you can use this method to reserve the space to be optionally set later.

    Note that if a value has already been set for the field being registered, then its type must match the registering type, and its value will be left in place. If the field has no set value, then you will likely want to include #GES_META_WRITABLE in flags to allow the value to be set later.

    Parameters

    • flags: GES.MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • type: GType

      The required value type for the registered field

    Returns boolean

    true if the meta_item field was successfully registered on container to only hold type values, with the given flags.

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • Sets the value of the specified field of the meta container to the given boolean value.

    Parameters

    • meta_item: string

      The key for the container field to set

    • value: boolean

      The value to set under meta_item

    Returns boolean

    true if value was set under meta_item for container.

  • 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 GLib.Quark 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 GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets the value of the specified field of the meta container to the given date value.

    Parameters

    • meta_item: string

      The key for the container field to set

    • value: GLib.Date

      The value to set under meta_item

    Returns boolean

    true if value was set under meta_item for container.

  • Sets the value of the specified field of the meta container to the given date time value.

    Parameters

    • meta_item: string

      The key for the container field to set

    • value: Gst.DateTime

      The value to set under meta_item

    Returns boolean

    true if value was set under meta_item for container.

  • Sets the value of the specified field of the meta container to the given double value.

    Parameters

    • meta_item: string

      The key for the container field to set

    • value: number

      The value to set under meta_item

    Returns boolean

    true if value was set under meta_item for container.

  • Sets the value of the specified field of the meta container to the given float value.

    Parameters

    • meta_item: string

      The key for the container field to set

    • value: number

      The value to set under meta_item

    Returns boolean

    true if value was set under meta_item for container.

  • Sets the value of the specified field of the meta container to the given int value.

    Parameters

    • meta_item: string

      The key for the container field to set

    • value: number

      The value to set under meta_item

    Returns boolean

    true if value was set under meta_item for container.

  • Sets the value of the specified field of the meta container to the given int64 value.

    Parameters

    • meta_item: string

      The key for the container field to set

    • value: number

      The value to set under meta_item

    Returns boolean

    true if value was set under meta_item for container.

  • Sets the value of the specified field of the meta container to the given marker list value.

    Parameters

    • meta_item: string

      The key for the container field to set

    • list: GES.MarkerList

      The value to set under meta_item

    Returns boolean

    true if value was set under meta_item for container.

  • Sets the value of the specified field of the meta container to a copy of the given value. If the given value is null, the field given by meta_item is removed and true is returned.

    Parameters

    • meta_item: string

      The key for the container field to set

    • Optionalvalue: GObject.Value

      The value to set under meta_item, or null to remove the corresponding field

    Returns boolean

    true if value was set under meta_item for container.

  • Sets the value of the specified field of the meta container to the given string value.

    Parameters

    • meta_item: string

      The key for the container field to set

    • value: string

      The value to set under meta_item

    Returns boolean

    true if value was set under meta_item for container.

  • Sets the value of the specified field of the meta container to the given uint value.

    Parameters

    • meta_item: string

      The key for the container field to set

    • value: number

      The value to set under meta_item

    Returns boolean

    true if value was set under meta_item for container.

  • Sets the value of the specified field of the meta container to the given uint64 value.

    Parameters

    • meta_item: string

      The key for the container field to set

    • value: number

      The value to set under meta_item

    Returns boolean

    true if value was set under meta_item for container.

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • 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 GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • 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.Object::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

  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the GObject.Object may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to null rather than retain a dangling pointer to a potentially invalid GObject.Object instance. Use g_clear_object() for this.

    Returns void

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns 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

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns 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

    Returns void

Methods - Inherited from GObject

  • 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 GObject.ParamSpec, 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 GObject.TypeInfo.) 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

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures