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 (Download template plugin) to help get you started with writing your own plugin for a particular event.
- Handling events
- ftrack server event list
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.
Synchronous. Published by the session to allow configuring of location instances:
Event( topic='ftrack.api.session.configure-location', data=dict( session=self ) )
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' ) )
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' ) )
Event( topic='ftrack.api.session.ready', data=dict( session=<Session instance>, ) )
Since the event is synchronous and blocking, avoid doing any unnecessary work as it will slow down session initialization.
Also see example usage in