-
Notifications
You must be signed in to change notification settings - Fork 12
/
info.yml
219 lines (186 loc) · 10 KB
/
info.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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
170
171
172
173
174
175
176
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
215
216
217
218
219
# Copyright (c) 2021 Shotgun Software Inc.
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
# Source Code License included in this distribution package. See LICENSE.
# By accessing, using, copying or modifying this work you indicate your
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
# not expressly granted therein are reserved by Shotgun Software Inc.
# Metadata defining the behaviour and requirements for this engine
# expected fields in the configuration file for this engine
configuration:
debug_logging:
type: bool
description: Controls whether debug messages should be emitted to the logger
default_value: False
project_switching:
type: bool
description: Hint about the possibility to switch project
default_value: False
project_startup_hook:
type: hook
default_value: "{self}/project_startup.py"
description: Contains the logic for determining and creating the workspace and
users to use when launching into a Flame project.
backburner_hooks:
type: hook
default_value: "{self}/backburner_hooks.py"
description: Contains the Backburner background job logic
execute_command_hooks:
type: hook
default_value: "{self}/execute_command.py"
description: Contains the logic for starting command line subprocess withing Flame process.
flame_batch_publish_type:
type: tank_type
description: The publish type associated with Flame Batch scripts. This parameter is used
to help the Flare launch process auto-load a Batch script from Flow Production Tracking at startup.
default_value: "Flame Batch File"
backburner_manager:
type: str
default_value: ""
description: The host where the backburner manager is located. All backburner
jobs generated by the flame engine will be dispatched to this server.
This setting is only supported on Flame 2016.1 and above. If this
value is not specified, the system default will be used.
backburner_shared_tmp:
type: str
default_value: ""
description: A folder where the Flame engine can put temporary files. This folder
needs to be accessible from all backburner nodes, so if you are running
a larger backburner setup, this path must be some sort of shared network
location. If this is not defined, the default temporary directory for the
system will be used and backburner jobs will be limited to the local
system unless backburner_servers or backburner_server_group is
also defined.
backburner_servers:
type: str
default_value: ""
description: Comma separated list of servers to use when submitting a backburner job.
(Ignored if a group is used)
backburner_server_group:
type: str
default_value: ""
description: The group name of the servers to use when submitting a backburner job.
backburner_job_completion:
type: str
default_value: "delete"
description: Action to be done on Backburner job completion.
Possible values are default, leaveInQueue, delete[:days], archive[:days].
Default will use the manager or application default for the action.
backburner_cmd_job_priority:
type: int
default_value: 50
description: Priority of command line jobs sent to Backburner.
(0 is highest, 100 is lowest)
backburner_cmd_job_type:
type: str
default_value: "ShotgunCmdjob"
description: The type of command line job to send to Backburner.
This is defined by the name of the Command Line Adapter binary in
Backburner Adapters folders.
Not all versions of Backburner support this feature.
Pre Backburner 2022 should use UserCmdjobAdapter.
Backburner 2022 and up should use ShotgunCmdjob.
generate_thumbnails:
type: bool
default_value: True
description: Generate thumbnails for assets exported from Flame when submitting to Flow Production Tracking.
thumbnails_preset_path:
type: str
default_value: "Generate Thumbnail.xml"
description: Path to the preset to use to generate thumbnails. If a relative path
is passed, the path to the application specific presets for Flow Production Tracking will
be prepended (/opt/Autodesk/presets/<version>/export/presets/shotgun/file_sequence).
This setting only apply from Flame 2019.1 and above.
generate_previews:
type: bool
default_value: True
description: Generate preview for assets exported from Flame when submitting to Flow Production Tracking.
Not all Flow Production Tracking entities supports preview and the code will fallback on thumbnail
for entities that do not support it.
previews_preset_path:
type: str
default_value: "Generate Preview.xml"
description: Path to the preset to use to generate previews. If a relative path
is passed, the path to the application specific presets for Flow Production Tracking will
be prepended (/opt/Autodesk/presets/<version>/export/presets/shotgun/movie_file).
This setting only apply from Flame 2019.1 and abve.
generate_local_movies:
type: bool
default_value: True
description: Global switch to allow or not the generation an higher quality movies
file that will not be uploaded to Flow Production Tracking but can be used by client applications
that do not want or cannot read original exported media from Flame.
This is currently only used by tk-flame-export.
local_movies_preset_path:
type: str
default_value: "Generate Local Movie.xml"
description: Path to the preset to use to generate local movies. If a relative path
is passed, the path to the application specific presets for Flow Production Tracking will
be prepended (/opt/Autodesk/presets/<version>/export/presets/shotgun/movie_file).
This setting only apply from Flame 2019.1 and above.
bypass_server_transcoding:
description: Try to bypass the Flow Production Tracking server side transcoding for thumbnail generation if possible.
This will upload the preview quicktime as is and will not generate a webm,
meaning that playback will not be supported on all browsers.
This will also disable playable movie preview and film strip generation.
For more information about this option, please see the documentation.
type: bool
default_value: False
media_path_root:
description: Default root directory of media for versions created by batch setup created
by the loader. Can be overriden by the environment variable SHOTGUN_FLAME_MEDIA_PATH_ROOT.
If no value is defined, rendering write file nodes will fails.
type: str
default_value: ""
go_to_batch_on_load:
type: bool
description: Go to batch upon actions form the loader that create or modify batch group.
default_value: True
use_builtin_plugin:
type: bool
description: Whether to prepare the launch of Flame to make use of its builtin Toolkit
plugin or not. If false, the classic-style Toolkit integration will be
initialized when Flame is launched.
default_value: False
run_at_startup:
type: list
description: "Controls what apps will run on startup. This is a list where each element
is a dictionary with two keys: 'app_instance' and 'name'. The app_instance
value connects this entry to a particular app instance defined in the
environment configuration file. The name is the menu name of the command
to run when flame starts up. If name is '' then all commands from the
given app instance are started."
allows_empty: True
default_value: []
values:
type: dict
items:
name: { type: str }
app_instance: { type: str }
context_menu:
type: list
description: "Controls the commands that show up in Flame's context menu. This is a list
where each element is a dictionary with three keys: 'app_instance', 'name' and 'display_name'.
The app_instance value connects this entry to a particular app instance defined
in the environment configuration file. The name value is name of the registered command in the
engine. The display_name value is the name that Flame should show in the menu.
If name is '' then all commands from the given app instance are started.
If display_name is not present, name will be used instead"
allows_empty: True
default_value: []
values:
type: dict
items:
name: { type: str }
app_instance: { type: str }
#display_name: { type: str } (optional)
# the Flow Production Tracking fields that this engine needs in order to operate correctly
requires_shotgun_fields:
# More verbose description of this item
display_name: "Flow Production Tracking Engine for Flame"
description: "Flow Production Tracking Integration in Flame"
# Required minimum versions for this item to run
requires_shotgun_version:
requires_core_version: "v0.18.45"