Skip to content

pipeline

Basic AYON integration

FlameHost

Bases: HostBase, ILoadHost, IPublishHost

Source code in client/ayon_flame/api/pipeline.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
class FlameHost(HostBase, ILoadHost, IPublishHost):
    name = "flame"

    def __init__(self):
        super().__init__()
        self._publish_context_data = {}

    def get_containers(self):
        return ls()

    def install(self):
        """Install all requirements for Flame host"""
        install()

    def get_context_data(self):
        """required by IPublishHost"""
        return deepcopy(self._publish_context_data)

    def update_context_data(self, data, changes):
        """required by IPublishHost"""
        self._publish_context_data = deepcopy(data)

    def get_current_context(self):
        current_ctx = super().get_current_context()

        # Flame can be used as a multi-workfile host.
        # When working with batch, we try to get the
        # current context from the batch metadata.
        if CTX.context == "FlameMenuBatch":
            import ayon_flame.api as flapi
            metadata_node = flapi.get_metadata_node()
            if metadata_node:
                data = flapi.read_node_metadata(metadata_node)
                try:
                    return {
                        "project_name": current_ctx["project_name"],
                        "folder_path": data["folderPath"],
                        "task_name": data["task"]
                    }
                except (KeyError, TypeError) as error:
                    log.warning(
                        "Could not read context from batch metadata: %r",
                        error
                    )

        return current_ctx

get_context_data()

required by IPublishHost

Source code in client/ayon_flame/api/pipeline.py 
53
54
55
def get_context_data(self):
    """required by IPublishHost"""
    return deepcopy(self._publish_context_data)

install()

Install all requirements for Flame host

Source code in client/ayon_flame/api/pipeline.py 
49
50
51
def install(self):
    """Install all requirements for Flame host"""
    install()

update_context_data(data, changes)

required by IPublishHost

Source code in client/ayon_flame/api/pipeline.py 
57
58
59
def update_context_data(self, data, changes):
    """required by IPublishHost"""
    self._publish_context_data = deepcopy(data)

containerise(flame_clip_segment, name, namespace, context, loader=None, data=None)

Containerise a flame clip segment.

Source code in client/ayon_flame/api/pipeline.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
def containerise(flame_clip_segment,
                 name,
                 namespace,
                 context,
                 loader=None,
                 data=None):
    """ Containerise a flame clip segment.
    """
    data_imprint = {
        "schema": "ayon:container-3.0",
        "id": AYON_CONTAINER_ID,
        "name": str(name),
        "namespace": str(namespace),
        "loader": str(loader),
        "representation": context["representation"]["id"],
    }

    if data:
        data_imprint.update(data)

    # timeline item imprinted data
    set_segment_data_marker(flame_clip_segment, data_imprint)

    return True

imprint(item, data=None)

Adding AYON data to Flame timeline segment.

Also including publish attribute into tag.

Parameters:

Name Type Description Default
item PySegment | PyClip

flame api object

 required
data dict

Any data which needs to be imprinted

 None

Examples:

data = { 'asset': 'sq020sh0280', 'productType': 'render', 'productName': 'productMain' }

Source code in client/ayon_flame/api/pipeline.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
def imprint(item, data=None):
    """
    Adding AYON data to Flame timeline segment.

    Also including publish attribute into tag.

    Arguments:
        item (flame.PySegment | flame.PyClip): flame api object
        data (dict): Any data which needs to be imprinted

    Examples:
        data = {
            'asset': 'sq020sh0280',
            'productType': 'render',
            'productName': 'productMain'
        }
    """
    data = data or {}

    if isinstance(item, flame.PySegment):
        set_segment_data_marker(item, data)
    elif isinstance(item, flame.PyClip):
        set_clip_data_marker(item, data)
    else:
        raise TypeError("Unsupported item type: {}".format(type(item)))

list_instances()

List all created instances from current workfile.

Source code in client/ayon_flame/api/pipeline.py 
155
156
157
def list_instances():
    """List all created instances from current workfile."""
    log.debug("TODO: list_instances")

ls()

List available containers.

Source code in client/ayon_flame/api/pipeline.py 
132
133
134
135
def ls():
    """List available containers.
    """
    return []  # TODO implement this from metadata

parse_container(tl_segment, validate=True)

Return container data from timeline_item's AYON tag.

Source code in client/ayon_flame/api/pipeline.py 
138
139
140
141
def parse_container(tl_segment, validate=True):
    """Return container data from timeline_item's AYON tag.
    """
    log.debug("TODO: parse_container")

remove_instance(instance)

Remove instance marker from track item.

Source code in client/ayon_flame/api/pipeline.py 
150
151
152
def remove_instance(instance):
    """Remove instance marker from track item."""
    log.debug("TODO: remove_instance")

update_container(tl_segment, data=None)

Update container data to input timeline_item's AYON tag.

Source code in client/ayon_flame/api/pipeline.py 
144
145
146
147
def update_container(tl_segment, data=None):
    """Update container data to input timeline_item's AYON tag.
    """
    log.debug("TODO: update_container")