Interface

GES-1.0 ▶ GES ▶ Extractable ▶ Interface

Interface for implementing Extractable. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_get_id(): string;
    vfunc_set_asset(asset: GES.Asset): void;
    vfunc_set_asset_full(asset: GES.Asset): boolean;
}

Hierarchy (View Summary)

Index

Methods

vfunc_get_id vfunc_set_asset vfunc_set_asset_full

Methods

  • Gets the GES.Asset.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 GES.Asset.id that is compatible with the current state of the object, as determined by the GES.Extractable implementer. If it was indeed extracted from an asset, this should return the same as its corresponding asset GES.Asset.id.

    Returns string

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

    Parameters

    Returns void

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

    Parameters

    Returns boolean