Gjsify LogoGjsify Logo

#GESLayer-s are responsible for collecting and ordering #GESClip-s.

A layer within a timeline will have an associated priority, corresponding to their index within the timeline. A layer with the index/priority 0 will have the highest priority and the layer with the largest index will have the lowest priority (the order of priorities, in this sense, is the reverse of the numerical ordering of the indices). ges_timeline_move_layer() should be used if you wish to change how layers are prioritised in a timeline.

Layers with higher priorities will have their content priorities over content from lower priority layers, similar to how layers are used in image editing. For example, if two separate layers both display video content, then the layer with the higher priority will have its images shown first. The other layer will only have its image shown if the higher priority layer has no content at the given playtime, or is transparent in some way. Audio content in separate layers will simply play in addition.

Hierarchy

Index

Constructors

Properties

_ges_reserved: object[]
auto_transition: boolean

Whether to automatically create a #GESTransitionClip whenever two #GESSource-s that both belong to a #GESClip in the layer overlap. See #GESTimeline for what counts as an overlap.

When a layer is added to a #GESTimeline, if this property is left as %FALSE, but the timeline's #GESTimeline:auto-transition is %TRUE, it will be set to %TRUE as well.

g_type_instance: TypeInstance
max_nle_priority: number
min_nle_priority: number
priority: number

The priority of the layer in the #GESTimeline. 0 is the highest priority. Conceptually, a timeline is a stack of layers, and the priority of the layer represents its position in the stack. Two layers should not have the same priority within a given GESTimeline.

Note that the timeline needs to be committed (with #ges_timeline_commit) for the change to be taken into account.

timeline: GES.Timeline

the #GESTimeline where this layer is being used.

field
$gtype: GType<GES.Layer>
name: string

Methods

  • add_asset(asset: Asset, start: number, inpoint: number, duration: number, track_types: TrackType): Clip
  • See ges_layer_add_asset_full(), which also gives an error.

    Parameters

    • asset: Asset

      The asset to extract the new clip from

    • start: number

      The #GESTimelineElement:start value to set on the new clip If start == #GST_CLOCK_TIME_NONE, it will be added to the end of layer, i.e. it will be set to layer's duration

    • inpoint: number

      The #GESTimelineElement:in-point value to set on the new clip

    • duration: number

      The #GESTimelineElement:duration value to set on the new clip

    • track_types: TrackType

      The #GESClip:supported-formats to set on the the new clip, or #GES_TRACK_TYPE_UNKNOWN to use the default

    Returns Clip

  • add_asset_full(asset: Asset, start: number, inpoint: number, duration: number, track_types: TrackType): Clip
  • Extracts a new clip from an asset and adds it to the layer with the given properties.

    Parameters

    • asset: Asset

      The asset to extract the new clip from

    • start: number

      The #GESTimelineElement:start value to set on the new clip If start == #GST_CLOCK_TIME_NONE, it will be added to the end of layer, i.e. it will be set to layer's duration

    • inpoint: number

      The #GESTimelineElement:in-point value to set on the new clip

    • duration: number

      The #GESTimelineElement:duration value to set on the new clip

    • track_types: TrackType

      The #GESClip:supported-formats to set on the the new clip, or #GES_TRACK_TYPE_UNKNOWN to use the default

    Returns Clip

  • add_clip(clip: Clip): boolean
  • add_clip_full(clip: Clip): boolean
  • Adds the given clip to the layer. If the method succeeds, the layer will take ownership of the clip.

    This method will fail and return %FALSE if clip already resides in some layer. It can also fail if the additional clip breaks some compositional rules (see #GESTimelineElement).

    Parameters

    • clip: Clip

      The clip to add

    Returns boolean

  • add_metas_from_string(str: string): boolean
  • 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

  • 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_meta_registered(meta_item: string): [boolean, MetaFlag, GType<unknown>]
  • 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, MetaFlag, GType<unknown>]

  • disconnect(id: number): void
  • emit(sigName: "active-changed", active: boolean, tracks: Track[], ...args: any[]): void
  • emit(sigName: "clip-added", clip: Clip, ...args: any[]): void
  • emit(sigName: "clip-removed", clip: Clip, ...args: any[]): void
  • emit(sigName: "notify::auto-transition", ...args: any[]): void
  • emit(sigName: "notify::priority", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • 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

  • get_active_for_track(track: Track): boolean
  • Gets whether the layer is active for the given track. See ges_layer_set_active_for_tracks().

    Parameters

    • track: Track

      The #GESTrack to check if layer is currently active for

    Returns boolean

  • get_auto_transition(): boolean
  • get_boolean(meta_item: string): [boolean, boolean]
  • 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]

  • get_clips_in_interval(start: number, end: number): Clip[]
  • Gets the clips within the layer that appear between start and end.

    Parameters

    • start: number

      Start of the interval

    • end: number

      End of the interval

    Returns Clip[]

  • get_data(key?: string): object
  • get_date(meta_item: string): [boolean, GLib.Date]
  • 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]

  • get_date_time(meta_item: string): [boolean, Gst.DateTime]
  • 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]

  • get_double(meta_item: string): [boolean, number]
  • 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]

  • get_duration(): number
  • Retrieves the duration of the layer, which is the difference between the start of the layer (always time 0) and the end (which will be the end time of the final clip).

    Returns number

  • get_float(meta_item: string): [boolean, number]
  • 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]

  • get_id(): string
  • Gets the #GESAsset:id of some associated asset. It may be the case that the object has no set asset, or even that such an asset does not yet exist in the GES cache. Instead, this will return the asset #GESAsset:id that is compatible with the current state of the object, as determined by the #GESExtractable implementer. If it was indeed extracted from an asset, this should return the same as its corresponding asset #GESAsset:id.

    Returns string

  • get_int(meta_item: string): [boolean, number]
  • 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]

  • get_int64(meta_item: string): [boolean, number]
  • 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]

  • 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 MarkerList

  • get_meta(key: string): any
  • get_priority(): number
  • Get the priority of the layer. When inside a timeline, this is its index in the timeline. See ges_timeline_move_layer().

    Returns number

  • 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_string(meta_item: string): string
  • 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

  • get_uint(meta_item: string): [boolean, number]
  • 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]

  • get_uint64(meta_item: string): [boolean, number]
  • 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]

  • 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

  • is_empty(): boolean
  • Convenience method to check if the layer is empty (doesn't contain any #GESClip), or not.

    Returns boolean

  • is_floating(): boolean
  • metas_to_string(): string
  • 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

  • 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

  • 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

  • register_meta(flags: MetaFlag, meta_item: string, value: any): boolean
  • 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: 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

  • register_meta_boolean(flags: MetaFlag, meta_item: string, value: boolean): boolean
  • 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: 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

  • register_meta_date(flags: MetaFlag, meta_item: string, value: GLib.Date): boolean
  • 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: 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

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

  • register_meta_double(flags: MetaFlag, meta_item: string, value: number): boolean
  • 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: 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

  • register_meta_float(flags: MetaFlag, meta_item: string, value: number): boolean
  • 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: 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

  • register_meta_int(flags: MetaFlag, meta_item: string, value: number): boolean
  • 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: 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

  • register_meta_int64(flags: MetaFlag, meta_item: string, value: number): boolean
  • 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: 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

  • register_meta_string(flags: MetaFlag, meta_item: string, value: string): boolean
  • 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: 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

  • register_meta_uint(flags: MetaFlag, meta_item: string, value: number): boolean
  • 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: 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

  • register_meta_uint64(flags: MetaFlag, meta_item: string, value: number): boolean
  • 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: 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

  • register_static_meta(flags: MetaFlag, meta_item: string, type: GType<unknown>): boolean
  • 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: MetaFlag

      Flags to be used for the registered field

    • meta_item: string

      The key for the container field to register

    • type: GType<unknown>

      The required value type for the registered field

    Returns boolean

  • remove_clip(clip: Clip): boolean
  • run_dispose(): void
  • set_active_for_tracks(active: boolean, tracks: Track[]): boolean
  • Activate or deactivate track elements in tracks (or in all tracks if tracks is %NULL).

    When a layer is deactivated for a track, all the #GESTrackElement-s in the track that belong to a #GESClip in the layer will no longer be active in the track, regardless of their individual #GESTrackElement:active value.

    Note that by default a layer will be active for all of its timeline's tracks.

    Parameters

    • active: boolean

      Whether elements in tracks should be active or not

    • tracks: Track[]

      The list of tracks layer should be (de-)active in, or %NULL to include all the tracks in the layer's timeline

    Returns boolean

  • set_asset(asset: Asset): boolean
  • Sets the asset for this extractable object.

    When an object is extracted from an asset using ges_asset_extract() its asset will be automatically set. Note that many classes that implement #GESExtractable will automatically create their objects using assets when you call their new methods. However, you can use this method to associate an object with a compatible asset if it was created by other means and does not yet have an asset. Or, for some implementations of #GESExtractable, you can use this to change the asset of the given extractable object, which will lead to a change in its state to match the new asset #GESAsset:id.

    Parameters

    • asset: Asset

      The asset to set

    Returns boolean

  • set_auto_transition(auto_transition: boolean): void
  • Sets #GESLayer:auto-transition for the layer. Use ges_timeline_set_auto_transition() if you want all layers within a #GESTimeline to have #GESLayer:auto-transition set to %TRUE. Use this method if you want different values for different layers (and make sure to keep #GESTimeline:auto-transition as %FALSE for the corresponding timeline).

    Parameters

    • auto_transition: boolean

      Whether transitions should be automatically added to the layer

    Returns void

  • set_boolean(meta_item: string, value: boolean): boolean
  • 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

  • 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_date(meta_item: string, value: GLib.Date): boolean
  • 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

  • set_date_time(meta_item: string, value: Gst.DateTime): boolean
  • set_double(meta_item: string, value: number): boolean
  • 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

  • set_float(meta_item: string, value: number): boolean
  • 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

  • set_int(meta_item: string, value: number): boolean
  • 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

  • set_int64(meta_item: string, value: number): boolean
  • 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

  • set_marker_list(meta_item: string, list: MarkerList): boolean
  • set_meta(meta_item: string, value: any): boolean
  • 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

    • value: any

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

    Returns boolean

  • set_priority(priority: number): void
  • Sets the layer to the given priority. See #GESLayer:priority.

    Parameters

    • priority: number

      The priority to set

    Returns void

  • set_property(property_name: string, value?: any): void
  • set_string(meta_item: string, value: string): boolean
  • 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

  • set_uint(meta_item: string, value: number): boolean
  • 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

  • set_uint64(meta_item: string, value: number): boolean
  • 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

  • steal_data(key?: string): 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

  • 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

  • unref(): 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 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 instance. Use g_clear_object() for this.

    Returns void

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_id(): string
  • Gets the #GESAsset:id of some associated asset. It may be the case that the object has no set asset, or even that such an asset does not yet exist in the GES cache. Instead, this will return the asset #GESAsset:id that is compatible with the current state of the object, as determined by the #GESExtractable implementer. If it was indeed extracted from an asset, this should return the same as its corresponding asset #GESAsset:id.

    virtual

    Returns string

  • 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

  • vfunc_object_added(object: Clip): void
  • vfunc_object_removed(object: Clip): void
  • vfunc_set_asset(asset: Asset): void
  • vfunc_set_asset_full(asset: Asset): boolean
  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): 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

  • compat_control(what: number, data: object): number
  • 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[]

  • 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

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