ftrack_connect_pipeline.plugin.publish¶

ftrack_connect_pipeline.plugin.publish.collector¶

class ftrack_connect_pipeline.plugin.publish.collector.PublisherCollectorPlugin(session)[source]¶

Bases: BaseCollectorPlugin

Base Publisher Collector Plugin Class inherits from BaseCollectorPlugin

return_type¶

Required return type

alias of list

plugin_type = 'publisher.collector'¶: Type of the plugin

__init__(session)[source]¶: Initialise BasePlugin with instance of ftrack_api.session.Session

ftrack_connect_pipeline.plugin.publish.context¶

class ftrack_connect_pipeline.plugin.publish.context.PublisherContextPlugin(session)[source]¶

Bases: BaseContextPlugin

Base Publisher Context Plugin Class inherits from BaseContextPlugin

return_type¶

Required return type

alias of dict

plugin_type = 'publisher.context'¶: Type of the plugin

__init__(session)[source]¶: Initialise BasePlugin with instance of ftrack_api.session.Session

ftrack_connect_pipeline.plugin.publish.finalizer¶

class ftrack_connect_pipeline.plugin.publish.finalizer.PublisherFinalizerPlugin(session)[source]¶

Bases: BaseFinalizerPlugin

Base Publisher Finalizer Plugin Class inherits from BaseFinalizerPlugin

return_type¶

Required return type

alias of dict

plugin_type = 'publisher.finalizer'¶: Type of the plugin

version_dependencies = []¶: Ftrack dependencies of the current asset version

__init__(session)[source]¶: Initialise BasePlugin with instance of ftrack_api.session.Session

create_component(asset_version_entity, component_name, component_path)[source]¶

Creates an ftrack component on the given asset_version_entity with the given component_name pointing to the given component_path

asset_version_entity : instance of ftrack_api.entity.asset_version.AssetVersion

component_name : Name of the component to be created.

component_path : Linked path of the component data.

create_thumbnail(asset_version_entity, component_name, component_path)[source]¶

Creates and uploads an ftrack thumbnail for the given ftrack_api.entity.asset_version.AssetVersion from the given component_path

component_path : path to the thumbnail.

create_reviewable(asset_version_entity, component_name, component_path)[source]¶

Encodes the ftrack media for the given ftrack_api.entity.asset_version.AssetVersion from the given component_path

component_path : path to the image or video.

ftrack_connect_pipeline.plugin.publish.exporter¶

class ftrack_connect_pipeline.plugin.publish.exporter.PublisherExporterPlugin(session)[source]¶

Bases: BaseExporterPlugin

Base Publisher Output Plugin Class inherits from BaseExporterPlugin

return_type¶

Required return type

alias of list

plugin_type = 'publisher.exporter'¶: Type of the plugin

__init__(session)[source]¶: Initialise BasePlugin with instance of ftrack_api.session.Session

ftrack_connect_pipeline.plugin.publish.validator¶

class ftrack_connect_pipeline.plugin.publish.validator.PublisherValidatorPlugin(session)[source]¶

Bases: BaseValidatorPlugin

Base Publisher Validator Plugin Class inherits from BaseValidatorPlugin

return_type¶

Required return type

alias of bool

plugin_type = 'publisher.validator'¶: Type of the plugin

__init__(session)[source]¶: Initialise BasePlugin with instance of ftrack_api.session.Session