Gjsify LogoGjsify Logo

An asset types from which #GESSourceClip will be extracted

Hierarchy

Index

Constructors

Properties

extractableType: GType<unknown>

The #GESExtractable object type that can be extracted from the asset.

gTypeInstance: TypeInstance
id: string

The ID of the asset. This should be unique amongst all assets with the same #GESAsset:extractable-type. Depending on the associated #GESExtractable implementation, this id may convey some information about the #GObject that should be extracted. Note that, as such, the ID will have an expected format, and you can not choose this value arbitrarily. By default, this will be set to the type name of the #GESAsset:extractable-type, but you should check the documentation of the extractable type to see whether they differ from the default behaviour.

parent: any
parentInstance: ClipAsset
proxy: Asset

The default proxy for this asset, or %NULL if it has no proxy. A proxy will act as a substitute for the original asset when the original is requested (see ges_asset_request()).

Setting this property will not usually remove the existing proxy, but will replace it as the default (see ges_asset_set_proxy()).

proxyTarget: Asset

The asset that this asset is a proxy for, or %NULL if it is not a proxy for another asset.

Note that even if this asset is acting as a proxy for another asset, but this asset is not the default #GESAsset:proxy, then proxy-target will still point to this other asset. So you should check the #GESAsset:proxy property of target-proxy before assuming it is the current default proxy for the target.

Note that the #GObject::notify for this property is emitted after the #GESAsset:proxy #GObject::notify for the corresponding (if any) asset it is now the proxy of/no longer the proxy of.

supportedFormats: TrackType

The formats supported by the asset.

name: string

Methods

  • addMetasFromString(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

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

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

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

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

    • transformFrom: TClosure<any, any>

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

    Returns Binding

  • checkMetaRegistered(metaItem: 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

    • metaItem: string

      The key for the container field to check

    Returns [boolean, MetaFlag, GType<unknown>]

  • connect(sigName: "notify::supported-formats", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::extractable-type", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::id", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::proxy", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::proxy-target", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    • sigName: "notify::supported-formats"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::extractable-type"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::proxy"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::proxy-target"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • emit(sigName: "notify::supported-formats", ...args: any[]): void
  • emit(sigName: "notify::extractable-type", ...args: any[]): void
  • emit(sigName: "notify::id", ...args: any[]): void
  • emit(sigName: "notify::proxy", ...args: any[]): void
  • emit(sigName: "notify::proxy-target", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Extracts a new #GESAsset:extractable-type object from the asset. The #GESAsset:id of the asset may determine the properties and state of the newly created object.

    Returns Extractable

  • forceFloating(): 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

  • Calls the given function on each of the meta container's set metadata fields.

    Parameters

    • func: MetaForeachFunc

      A function to call on each of container's set metadata fields

    Returns void

  • freezeNotify(): 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

  • getBoolean(metaItem: 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

    • metaItem: string

      The key for the container field to get

    Returns [boolean, boolean]

  • getData(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

  • getDate(metaItem: 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

    • metaItem: string

      The key for the container field to get

    Returns [boolean, GLib.Date]

  • 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

    • metaItem: string

      The key for the container field to get

    Returns [boolean, Gst.DateTime]

  • getDouble(metaItem: 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

    • metaItem: string

      The key for the container field to get

    Returns [boolean, number]

  • getExtractableType(): GType<unknown>
  • getFloat(metaItem: 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

    • metaItem: string

      The key for the container field to get

    Returns [boolean, number]

  • getFrameTime(frameNumber: number): number
  • Converts the given frame number into a timestamp, using the "natural" frame rate of the asset.

    You can use this to reference a specific frame in a media file and use this as, for example, the in-point or max-duration of a #GESClip.

    Parameters

    • frameNumber: number

      The frame number we want the internal time coordinate timestamp of

    Returns number

  • getId(): string
  • getInt(metaItem: 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

    • metaItem: string

      The key for the container field to get

    Returns [boolean, number]

  • getInt64(metaItem: 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

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

  • getMeta(key: string): any
  • Gets the current value of the specified field of the meta container.

    Parameters

    • key: string

      The key for the container field to get

    Returns any

  • getNaturalFramerate(): [boolean, number, number]
  • getProperty(propertyName?: 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 propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • Gets the #GESAsset:proxy-target of the asset.

    Note that the proxy target may have loaded with an error, so you should call ges_asset_get_error() on the returned target.

    Returns Asset

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getString(metaItem: 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

    • metaItem: string

      The key for the container field to get

    Returns string

  • getUint(metaItem: 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

    • metaItem: string

      The key for the container field to get

    Returns [boolean, number]

  • getUint64(metaItem: 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

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

  • Initializes the object implementing the interface.

    This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

    The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.

    Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

    If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

    One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

    Parameters

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead.

    This method is intended for language bindings. If writing in C, g_async_initable_new_async() should typically be used instead.

    When the initialization is finished, callback will be called. You can then call g_async_initable_init_finish() to get the result of the initialization.

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL, and the object doesn't support cancellable initialization, the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    As with #GInitable, if the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with g_critical() or g_warning(), but this must not be relied on.

    Callers should not assume that a class which implements #GAsyncInitable can be initialized multiple times; for more information, see g_initable_init(). If a class explicitly supports being initialized multiple times, implementation requires yielding all subsequent calls to init_async() on the results of the first call.

    For classes that also support the #GInitable interface, the default implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the #GAsyncInitable interface without overriding any interface methods.

    Parameters

    • ioPriority: number

      the [I/O priority][io-priority] of the operation

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • isFloating(): boolean
  • Get all the proxies that the asset has. The first item of the list will be the default #GESAsset:proxy. The second will be the proxy that is 'next in line' to be default, and so on.

    Returns Asset[]

  • metasToString(): string
  • notify(propertyName: 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

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

  • off(sigName: "notify::supported-formats", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::extractable-type", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::id", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::proxy", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::proxy-target", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    • sigName: "notify::supported-formats"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::extractable-type"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::proxy"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::proxy-target"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "notify::supported-formats", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::extractable-type", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::id", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::proxy", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::proxy-target", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: "notify::supported-formats"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::extractable-type"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::proxy"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::proxy-target"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "notify::supported-formats", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::extractable-type", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::id", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::proxy", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::proxy-target", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: "notify::supported-formats"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::extractable-type"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::id"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::proxy"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::proxy-target"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • 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

  • registerMeta(flags: MetaFlag, metaItem: 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

    • metaItem: string

      The key for the container field to register

    • value: any

      The value to set for the registered field

    Returns boolean

  • registerMetaBoolean(flags: MetaFlag, metaItem: 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

    • metaItem: string

      The key for the container field to register

    • value: boolean

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

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

    • metaItem: string

      The key for the container field to register

    • value: Gst.DateTime

      The value to set for the registered field

    Returns boolean

  • registerMetaDouble(flags: MetaFlag, metaItem: 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

    • metaItem: string

      The key for the container field to register

    • value: number

      The value to set for the registered field

    Returns boolean

  • registerMetaFloat(flags: MetaFlag, metaItem: 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

    • metaItem: string

      The key for the container field to register

    • value: number

      The value to set for the registered field

    Returns boolean

  • registerMetaInt(flags: MetaFlag, metaItem: 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

    • metaItem: string

      The key for the container field to register

    • value: number

      The value to set for the registered field

    Returns boolean

  • registerMetaInt64(flags: MetaFlag, metaItem: 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

    • metaItem: string

      The key for the container field to register

    • value: number

      The value to set for the registered field

    Returns boolean

  • registerMetaString(flags: MetaFlag, metaItem: 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

    • metaItem: string

      The key for the container field to register

    • value: string

      The value to set for the registered field

    Returns boolean

  • registerMetaUint(flags: MetaFlag, metaItem: 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

    • metaItem: string

      The key for the container field to register

    • value: number

      The value to set for the registered field

    Returns boolean

  • registerMetaUint64(flags: MetaFlag, metaItem: 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

    • metaItem: string

      The key for the container field to register

    • value: number

      The value to set for the registered field

    Returns boolean

  • registerStaticMeta(flags: MetaFlag, metaItem: 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

    • metaItem: string

      The key for the container field to register

    • type: GType<unknown>

      The required value type for the registered field

    Returns boolean

  • runDispose(): 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

  • setBoolean(metaItem: string, value: boolean): boolean
  • Sets the value of the specified field of the meta container to the given boolean value.

    Parameters

    • metaItem: string

      The key for the container field to set

    • value: boolean

      The value to set under meta_item

    Returns boolean

  • setData(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

  • setDate(metaItem: string, value: GLib.Date): boolean
  • Sets the value of the specified field of the meta container to the given date value.

    Parameters

    • metaItem: string

      The key for the container field to set

    • value: GLib.Date

      The value to set under meta_item

    Returns boolean

  • setDateTime(metaItem: string, value: Gst.DateTime): boolean
  • Sets the value of the specified field of the meta container to the given date time value.

    Parameters

    • metaItem: string

      The key for the container field to set

    • value: Gst.DateTime

      The value to set under meta_item

    Returns boolean

  • setDouble(metaItem: string, value: number): boolean
  • Sets the value of the specified field of the meta container to the given double value.

    Parameters

    • metaItem: string

      The key for the container field to set

    • value: number

      The value to set under meta_item

    Returns boolean

  • setFloat(metaItem: string, value: number): boolean
  • Sets the value of the specified field of the meta container to the given float value.

    Parameters

    • metaItem: string

      The key for the container field to set

    • value: number

      The value to set under meta_item

    Returns boolean

  • setInt(metaItem: string, value: number): boolean
  • Sets the value of the specified field of the meta container to the given int value.

    Parameters

    • metaItem: string

      The key for the container field to set

    • value: number

      The value to set under meta_item

    Returns boolean

  • setInt64(metaItem: string, value: number): boolean
  • Sets the value of the specified field of the meta container to the given int64 value.

    Parameters

    • metaItem: string

      The key for the container field to set

    • value: number

      The value to set under meta_item

    Returns boolean

  • setMarkerList(metaItem: string, list: MarkerList): boolean
  • Sets the value of the specified field of the meta container to the given marker list value.

    Parameters

    • metaItem: string

      The key for the container field to set

    • list: MarkerList

      The value to set under meta_item

    Returns boolean

  • setMeta(metaItem: 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

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

  • setProperty(propertyName: string, value?: any): void
  • setProxy(proxy: Asset): boolean
  • Sets the #GESAsset:proxy for the asset.

    If proxy is among the existing proxies of the asset (see ges_asset_list_proxies()) it will be moved to become the default proxy. Otherwise, if proxy is not %NULL, it will be added to the list of proxies, as the new default. The previous default proxy will become 'next in line' for if the new one is removed, and so on. As such, this will not actually remove the previous default proxy (use ges_asset_unproxy() for that).

    Note that an asset can only act as a proxy for one other asset.

    As a special case, if proxy is %NULL, then this method will actually remove all proxies from the asset.

    Parameters

    • proxy: Asset

      A new default proxy for asset

    Returns boolean

  • setString(metaItem: string, value: string): boolean
  • Sets the value of the specified field of the meta container to the given string value.

    Parameters

    • metaItem: string

      The key for the container field to set

    • value: string

      The value to set under meta_item

    Returns boolean

  • setSupportedFormats(supportedformats: TrackType): void
  • setUint(metaItem: string, value: number): boolean
  • Sets the value of the specified field of the meta container to the given uint value.

    Parameters

    • metaItem: string

      The key for the container field to set

    • value: number

      The value to set under meta_item

    Returns boolean

  • setUint64(metaItem: string, value: number): boolean
  • Sets the value of the specified field of the meta container to the given uint64 value.

    Parameters

    • metaItem: string

      The key for the container field to set

    • value: number

      The value to set under meta_item

    Returns boolean

  • stealData(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

  • stealQdata(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

  • thawNotify(): 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

  • unproxy(proxy: Asset): boolean
  • Removes the proxy from the available list of proxies for the asset. If the given proxy is the default proxy of the list, then the next proxy in the available list (see ges_asset_list_proxies()) will become the default. If there are no other proxies, then the asset will no longer have a default #GESAsset:proxy.

    Parameters

    • proxy: Asset

      An existing proxy of asset

    Returns boolean

  • 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

  • watchClosure(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

  • compatControl(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

    • gIface: TypeInterface

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

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

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

    • gIface: TypeInterface

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

    Returns ParamSpec[]

  • needsReload(extractableType: GType<unknown>, id: string): boolean
  • Indicate that an existing #GESAsset in the cache should be reloaded upon the next request. This can be used when some condition has changed, which may require that an existing asset should be updated. For example, if an external resource has changed or now become available.

    Note, the asset is not immediately changed, but will only actually reload on the next call to ges_asset_request() or ges_asset_request_async().

    Parameters

    • extractableType: GType<unknown>

      The #GESAsset:extractable-type of the asset that needs reloading

    • id: string

      The #GESAsset:id of the asset asset that needs reloading

    Returns boolean

  • 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

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

  • request(extractableType: GType<unknown>, id: string): Asset
  • Returns an asset with the given properties. If such an asset already exists in the cache (it has been previously created in GES), then a reference to the existing asset is returned. Otherwise, a newly created asset is returned, and also added to the cache.

    If the requested asset has been loaded with an error, then error is set, if given, and %NULL will be returned instead.

    Note that the given id may not be exactly the #GESAsset:id that is set on the returned asset. For instance, it may be adjusted into a standard format. Or, if a #GESExtractable type does not have its extraction parametrised, as is the case by default, then the given id may be ignored entirely and the #GESAsset:id set to some standard, in which case a %NULL id can be given.

    Similarly, the given extractable_type may not be exactly the #GESAsset:extractable-type that is set on the returned asset. Instead, the actual extractable type may correspond to a subclass of the given extractable_type, depending on the given id.

    Moreover, depending on the given extractable_type, the returned asset may belong to a subclass of #GESAsset.

    Finally, if the requested asset has a #GESAsset:proxy, then the proxy that is found at the end of the chain of proxies is returned (a proxy's proxy will take its place, and so on, unless it has no proxy).

    Some asset subclasses only support asynchronous construction of its assets, such as #GESUriClip. For such assets this method will fail, and you should use ges_asset_request_async() instead. In the case of #GESUriClip, you can use ges_uri_clip_asset_request_sync() if you only want to wait for the request to finish.

    Parameters

    • extractableType: GType<unknown>

      The #GESAsset:extractable-type of the asset

    • id: string

      The #GESAsset:id of the asset

    Returns Asset

  • Requests an asset with the given properties asynchronously (see ges_asset_request()). When the asset has been initialized or fetched from the cache, the given callback function will be called. The asset can then be retrieved in the callback using the ges_asset_request_finish() method on the given #GAsyncResult.

    Note that the source object passed to the callback will be the #GESAsset corresponding to the request, but it may not have loaded correctly and therefore can not be used as is. Instead, ges_asset_request_finish() should be used to fetch a usable asset, or indicate that an error occurred in the asset's creation.

    Note that the callback will be called in the #GMainLoop running under the same #GMainContext that ges_init() was called in. So, if you wish the callback to be invoked outside the default #GMainContext, you can call g_main_context_push_thread_default() in a new thread before calling ges_init().

    Example of an asynchronous asset request:

    // The request callback
    static void
    asset_loaded_cb (GESAsset * source, GAsyncResult * res, gpointer user_data)
    {
    GESAsset *asset;
    GError *error = NULL;

    asset = ges_asset_request_finish (res, &error);
    if (asset) {
    gst_print ("The file: %s is usable as a GESUriClip",
    ges_asset_get_id (asset));
    } else {
    gst_print ("The file: %s is *not* usable as a GESUriClip because: %s",
    ges_asset_get_id (source), error->message);
    }

    gst_object_unref (asset);
    }

    // The request:
    ges_asset_request_async (GES_TYPE_URI_CLIP, some_uri, NULL,
    (GAsyncReadyCallback) asset_loaded_cb, user_data);

    Parameters

    • extractableType: GType<unknown>

      The #GESAsset:extractable-type of the asset

    • id: string

      The #GESAsset:id of the asset

    • cancellable: Gio.Cancellable

      An object to allow cancellation of the asset request, or %NULL to ignore

    • callback: AsyncReadyCallback

      A function to call when the initialization is finished

    Returns void

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