ftrack_connect_pipeline.client

class ftrack_connect_pipeline.client.HostConnection(event_manager, host_data)

Bases: object

Host Connection Base class. This class is used to communicate between the client and the host.

property context_id

Returns the current context id as fetched from the host

property event_manager

Returns instance of EventManager

property session

Returns instance of ftrack_api.session.Session

property definitions

Returns the current definitions, filtered on discoverable.

property id

Returns the current host id.

property name

Returns the current host name.

property host_types

Returns the list of compatible host for the current definitions.

__init__(event_manager, host_data)

Initialise HostConnection with instance of EventManager , and host_data

host_data : Dictionary containing the host information. provide_host_information()

run(data, engine, callback=None)

Publish an event with the topic PIPELINE_HOST_RUN with the given data and engine.

launch_client(name, source=None)

Send a widget launch event, to be picked up by DCC.

subscribe_host_context_change()

Have host connection subscribe to context change events, to be able to notify client

change_host_context_id(context_id)

class ftrack_connect_pipeline.client.Client(event_manager, multithreading_enabled=True)

Bases: object

Base client class.

ui_types = [None]

Compatible UI for this client.

definition_filters = None

Use only definitions that matches the definition_filters

definition_extensions_filter = None

(Open) Only show definitions and components capable of accept these filename extensions.

property session

Returns instance of ftrack_api.session.Session

property event_manager

Returns instance of EventManager

property connected

Returns True if client is connected to a HOST

property context_id

Returns the current context id from host

property context

Returns the current context

property host_connections

Return the current list of host_connections

property host_connection

Return instance of HostConnection

property schema

Return the current schema.

property definition

Returns the current definition.

property definitions

Returns the definitions list of the current host connection

property engine_type

Return the current engine type

property logs

Return the log items

property multithreading_enabled

Return True if DCC supports multithreading (write operations)

__init__(event_manager, multithreading_enabled=True)

Initialise Client with instance of EventManager

discover_hosts(force_rediscover=False, time_out=3)

Find for available hosts during the optional time_out and Returns a list of discovered HostConnection.

Skip this and use existing singleton host connection if previously detected, unless force_rediscover is True.

filter_host(host_connection)

Return True if the host_connection should be considered

host_connection: ftrack_connect_pipeline.client.HostConnection

change_host(host_connection)

Client(user) has chosen the host connection to use, set it to host_connection

on_hosts_discovered(host_connections)

Callback, hosts has been discovered. To be overridden by the qt client

on_host_changed(host_connection)

Called when the host has been (re-)selected by the user. To be overridden by the qt client.

subscribe_host_context_change()

Have host connection subscribe to context change events, to be able to notify client

on_context_changed(context_id)

Called when the context has been set or changed within the host connection, either from this client or remote (other client or the host). Should be overridden by client.

unsubscribe_host_context_change()

Unsubscribe to client context change events

run_definition(definition=None, engine_type=None)

Calls the run() to run the entire given definition with the given engine_type.

Callback received at _run_callback()

get_schema_from_definition(definition)

Return matching schema for the given definition

change_definition(definition, schema=None)

Assign the given schema and the given definition as the current schema and definition

run_plugin(plugin_data, method, engine_type)

Calls the run() to run one single plugin.

Callback received at _run_callback()

plugin_data : Dictionary with the plugin information.

method : method of the plugin to be run

on_ready(callback, time_out=3)

calls the given callback method when host is been discovered with the optional time_out

change_engine(engine_type)

Assign the given engine_type as the current engine_type

on_client_notification()

Subscribe to topic PIPELINE_CLIENT_NOTIFICATION to receive client notifications from the host in _notify_client()

ftrack_connect_pipeline.client.asset_manager

class ftrack_connect_pipeline.client.asset_manager.AssetManagerClient(event_manager, multithreading_enabled=True)

Bases: Client

Asset Manager Client Base Class

definition_filters = ['asset_manager']

Use only definitions that matches the definition_filters

__init__(event_manager, multithreading_enabled=True)

Initialise AssetManagerClient with instance of EventManager

on_host_changed(host_connection)

Asset manager host has been selected, fetch definition. Return False if no definitions.

resolve_dependencies(context_id, resolve_dependencies_callback, options=None)

Calls the run() to run the method resolve_dependencies() To fetch list of version dependencies on the given context_id.

Callback received resolve_dependencies_callback

context_id : Should be the ID of an existing task.

resolve_dependencies_callback : Callback function that should take the result as argument.

options : The options to supply to the plugin.

discover_assets(plugin=None)

Calls the ftrack_connect_pipeline.client.HostConnection.run() to run the method ftrack_connect_pipeline.host.engine.AssetManagerEngine.discover_assets()

Callback received at _asset_discovered_callback()

plugin : Optional plugin to be run in the method. (Not implremented yet)

load_assets(asset_info_list)

Calls the run() to run the method load_assets() To load the assets of the given asset_info_list.

Callback received at _load_assets_callback()

asset_info_list : Should a list pf be instances of FtrackAssetInfo

select_assets(asset_info_list)

Calls the run() to run the method select_assets() To select the assets of the given asset_info_list

asset_info_list : Should a list pf be instances of FtrackAssetInfo

update_assets(asset_info_list, plugin)

Calls the run() to run the method update_assets() To update to the last version the assets of the given asset_info_list.

Callback received at _update_assets_callback()

asset_info_list : Should a list pf be instances of FtrackAssetInfo

plugin : The plugin definition of the plugin to run during the update_assets method

change_version(asset_info, new_version_id)

Calls the ftrack_connect_pipeline.client.HostConnection.run() to run the method ftrack_connect_pipeline.host.engine.AssetManagerEngine.change_version() To change the version of the given asset_info.

Callback received at _change_version_callback()

asset_info : Should be instance of ftrack_connect_pipeline.asset.FtrackAssetInfo

new_version_id : Should be an AssetVersion id.

unload_assets(asset_info_list)

Calls the run() to run the method unload_assets() To unload the assets of the given asset_info_list.

Callback received at _unload_assets_callback()

asset_info_list : Should a list pf be instances of FtrackAssetInfo

remove_assets(asset_info_list)

Calls the run() to run the method remove_assets() To remove the assets of the given asset_info_list.

Callback received at _remove_assets_callback()

asset_info_list : Should a list pf be instances of FtrackAssetInfo

ftrack_connect_pipeline.client.loader_loader

class ftrack_connect_pipeline.client.loader.LoaderClient(event_manager, multithreading_enabled=True)

Bases: Client

Loader Client Base Class

definition_filters = ['loader']

Use only definitions that matches the definition_filters

__init__(event_manager, multithreading_enabled=True)

Initialise OpenerClient with instance of EventManager

ftrack_connect_pipeline.client.opener_opener

class ftrack_connect_pipeline.client.opener.OpenerClient(event_manager)

Bases: Client

Opener Client Base Class

definition_filters = ['opener']

Use only definitions that matches the definition_filters

__init__(event_manager)

Initialise OpenerClient with instance of EventManager

ftrack_connect_pipeline.client.publisher_publisher

class ftrack_connect_pipeline.client.publisher.PublisherClient(event_manager)

Bases: Client

Publisher Client Base Class

definition_filters = ['publisher']

Use only definitions that matches the definition_filters

__init__(event_manager)

Initialise PublisherClient with instance of EventManager

ftrack_connect_pipeline.client.log_viewer

class ftrack_connect_pipeline.client.log_viewer.LogViewerClient(event_manager)

Bases: Client

Log Viewer Client Base Class

definition_filters = ['log_viewer']

Use only definitions that matches the definition_filters

__init__(event_manager)

Initialise LogViewerClient with instance of EventManager