pipeline
AfterEffectsHost
Bases: HostBase
, IWorkfileHost
, ILoadHost
, IPublishHost
Source code in client/ayon_aftereffects/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 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
|
stub
property
Handle pulling stub from PS to run operations on host
Returns: (AEServerStub) or None
list_instances()
List all created instances from current workfile which will be published.
Pulls from File > File Info
For Scene Inventory (Manage...)
Returns:
Type | Description |
---|---|
(list) of dictionaries matching instances format |
Source code in client/ayon_aftereffects/api/pipeline.py
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
|
remove_instance(instance)
Remove instance from current workfile metadata.
Updates metadata of current file in File > File Info and removes icon highlight on group layer.
For Scene Inventory
Parameters:
Name | Type | Description | Default |
---|---|---|---|
instance | dict | instance representation from Scene Inventory model | required |
Source code in client/ayon_aftereffects/api/pipeline.py
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
|
application_launch()
Triggered after start of app
Source code in client/ayon_aftereffects/api/pipeline.py
172 173 174 |
|
cache_and_get_instances(creator)
Cache instances in shared data.
Storing all instances as a list as legacy instances might be still present. Args: creator (Creator): Plugin which would like to get instances from host. Returns: List[]: list of all instances stored in metadata
Source code in client/ayon_aftereffects/api/pipeline.py
273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
|
check_inventory()
Checks loaded containers if they are of highest version
Source code in client/ayon_aftereffects/api/pipeline.py
217 218 219 220 221 222 223 224 225 226 227 228 229 |
|
containerise(name, namespace, comp, context, loader=None, suffix='_CON')
Containerisation enables a tracking of version, author and origin for loaded assets.
Creates dictionary payloads that gets saved into file metadata. Each container contains of who loaded (loader) and members (single or multiple in case of background).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name | str | Name of resulting assembly | required |
namespace | str | Namespace under which to host container | required |
comp | AEItem | Composition to containerise | required |
context | dict | Asset information | required |
loader | str | Name of loader used to produce this container. | None |
suffix | str | Suffix of container, defaults to | '_CON' |
Returns:
Name | Type | Description |
---|---|---|
container | str | Name of container assembly |
Source code in client/ayon_aftereffects/api/pipeline.py
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
|
ls()
Yields containers from active AfterEffects document.
This is the host-equivalent of api.ls(), but instead of listing assets on disk, it lists assets already loaded in AE; once loaded they are called 'containers'. Used in Manage tool.
Containers could be on multiple levels, single images/videos/was as a FootageItem, or multiple items - backgrounds (folder with automatically created composition and all imported layers).
Yields:
Name | Type | Description |
---|---|---|
dict | container |
Source code in client/ayon_aftereffects/api/pipeline.py
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
|