GES.ExtractableInterface

Fields

Name

Type

Access

Description

asset_type

GObject.GType

r

The subclass type of GES.Asset that should be created when an asset with the corresponding GES.Asset :extractable-type is requested.

can_update_asset

bool

r

Whether an object of this class can have its GES.Asset change over its lifetime. This should be set to True if one of the object’s parameters that is associated with its ID can change after construction, which would require an asset with a new ID. Note that the subclass is required to handle the requesting and setting of the new asset on the object.

check_id

GES.ExtractableCheckId

r

The method to call to check whether a given ID is valid as an asset GES.Asset :id for the given GES.Asset :extractable-type. The returned ID is the actual GES.Asset :id that is set on the asset. The default implementation will simply always return the type name of the GES.Asset :extractable-type, even if the received ID is None. As such, any given ID is considered valid (or is ignored), but only one is actually ever set on an asset, which means the given GES.Asset :extractable-type can only have one associated asset.

get_id

object

r

The method to fetch the GES.Asset :id of some associated asset. Note that it may be the case that the object does not have its asset set, or even that an asset with such an GES.Asset :id does not exist in the GES cache. Instead, this should return the GES.Asset :id that is _compatible_ with the current state of the object. The default implementation simply returns the currently set asset ID, or the type name of the object, which is what is used as the GES.Asset :id by default, if no asset is set.

get_parameters_from_id

object

r

The method to call to get the object properties corresponding to a given asset GES.Asset :id. The default implementation will simply return no parameters. The default GES.Asset will call this to set the returned properties on the extracted object, but other subclasses may ignore this method.

get_real_extractable_type

object

r

The method to call to get the actual GES.Asset :extractable-type an asset should have set, given the requested GES.Asset :id. The default implementation simply returns the same type as given. You can overwrite this if it is more appropriate to extract the object from a subclass, depending on the requested GES.Asset :id. Note that when an asset is requested, this method will be called before the other class methods. In particular, this means that the check_id and get_parameters_from_id class methods of the returned type will be used (instead of our own).

parent

GObject.TypeInterface

r

register_metas

object

r

The method to set metadata on an asset. This is called on initiation of the asset, but before it begins to load its state.

set_asset

object

r

This method is called after the GES.Asset of an object is set. If your class supports the asset of an object changing, then you can use this method to change the parameters of the object to match the new asset GES.Asset :id. If setting the asset should be able to fail, you should implement set_asset_full instead.

set_asset_full

object

r

Like set_asset, but also allows you to return False to indicate a failure to change the object in response to a change in its asset.

Methods

None

Details

class GES.ExtractableInterface