Skip to main content

Event list

The following is a consolidated list of events published directly by this API.

For some events, a template plugin file is also listed for download template plugin to help get you started with writing your own plugin for a particular event.

tip

ftrack.api.session.get-file-type-from-string​

The event is Synchronous. Published by the session, when creating a component, to retrieve the file extension from the given path:

Event(
    topic='ftrack.api.session.get-file-type-from-string',
    data=dict(
        file_path=file_path,
    )
)

Expects returned data to be:

A Python string

note

This event is to make users able to further customise the way extensions are extracted from the file names. An example are coumpound extensions such as : a_file.geo.bz, which are specific to some industries only.

ftrack.api.session.construct-entity-type​

Download template plugin construct_entity_type.py

The event is Synchronous. Published by the session to retrieve constructed class for specified schema:

Event(
    topic='ftrack.api.session.construct-entity-type',
    data=dict(
        schema=schema,
        schemas=schemas
    )
)

Expects returned data to be:

A Python class.

tip

Read customizing entity types.

ftrack.api.session.configure-location​

Download template plugin

The event is Synchronous. Published by the session to allow configuring of location instances:

Event(
    topic='ftrack.api.session.configure-location',
    data=dict(
        session=self
    )
)
tip

Configuring locations <locations/configuring/automatically>.

ftrack.location.component-added​

Published whenever a component is added to a location:

Event(
    topic='ftrack.location.component-added',
    data=dict(
        component_id='e2dc0524-b576-11d3-9612-080027331d74',
        location_id='07b82a97-8cf9-11e3-9383-20c9d081909b'
    )
)

ftrack.location.component-removed​

Published whenever a component is removed from a location:

Event(
    topic='ftrack.location.component-removed',
    data=dict(
        component_id='e2dc0524-b576-11d3-9612-080027331d74',
        location_id='07b82a97-8cf9-11e3-9383-20c9d081909b'
    )
)

ftrack.api.session.ready​

The event is Synchronous. Published after a ~ftrack_api.session.Session has been initialized and is ready to be used:

Event(
    topic='ftrack.api.session.ready',
    data=dict(
        session=<Session instance>,
    )
)
warning

Since the event is synchronous and blocking, avoid doing any unnecessary work as it will slow down session initialization.

tip

Also see example usage in example_plugin_using_session.py.

ftrack.api.session.reset​

The event is Synchronous. Published after a ~ftrack_api.session.Session has been reset and is ready to be used again:

Event(
    topic='ftrack.api.session.reset',
    data=dict(
        session=<Session instance>,
    )
)