Project Node Metadata (XML)
Project nodes have XML metadata associated with them. You can gain access to it using the getMetaData and setMetaData methods on the WireTapNodeHandle object for the project node.
Valid Values for Project Metadata
The following table shows valid values for each element in a project XML stream. The 'Editable' column indicates whether the value may be modified, with 'Creation Only' indicating only when the project is created, and 'No' indicating the value is read-only. Values are returned by the IFFFS Wiretap Server when you call getMetaData on the WireTapNodeHandle object for the project node.
| Element | Type | Allowed Values | Editable | Description |
|---|---|---|---|---|
<Template> |
string |
Any | Creation Only | Name of the project template. Will be used instead of default project settings. Any other element will override both defaults and template settings. |
<Name> |
string |
Any | No | Name of the project. Must match node name at creation. |
<Description> |
string |
Any | Yes | Project description. |
<Nickname> |
string |
Any | No | Project Nickname. |
<Version> |
string |
Any | No | Project version. |
<CreationDate> |
string |
Any | No | Creation date. |
<ProjectDir> |
string |
Any | Creation Only | Path of the project home directory. |
<MediaDir> |
string |
Any | Creation Only | Path of the media cache directory. |
<SetupDir> |
string |
Any | Creation Only | Path to the setups directory. |
<CatalogDir> |
string |
Any | No | Path of the project catalog files (aka libraries). |
<FrameWidth> |
integer |
24 to 16384 (inclusive) | Yes | Default resolution width. Must be a multiple of 4 for 8-bit resolution, multiple of 2 otherwise except for 32-bit FP. |
<FrameHeight> |
integer |
24 to 16384 (inclusive) | Yes | Default resolution height. |
<FrameDepth> |
string |
8-bit10-bit12-bit16-bit fp32-bit fp |
Yes | Default resolution depth. |
<AspectRatio> |
decimal |
0.001 to 100.0 (inclusive) | Yes | Default resolution aspect ratio. |
<FieldDominance> |
string |
FIELD_1FIELD_2PROGRESSIVE |
Yes | Default resolution field dominance. |
<FrameRate> |
string |
23.976 fps24 fps25 fps29.97 fps DF29.97 fps NDF30 fps50 fps59.94 fps DF59.94 fps NDF60 fps |
Yes | Default frame rate. The fp in 16-bit fp means floating point. |
<IntermediatesProfile> |
integer:[integer] |
See tables below | Yes | Intermediate Profile. |
<ProxyWidthHint> |
decimal |
0.0 to 1.0 (exclusive) | Yes | Ratio between proxy and default resolution width. Used to compute the size of proxies. |
<ProxyWidth> |
integer |
24 to 16384 (inclusive) | Yes | Proxy width. Must be a multiple of 4. Calculated: <FrameWidth> x <ProxyWidthHint>Will be converted to <ProxyWidthHint> when modified. |
<ProxyDepth> |
string |
8-bit10-bit12-bit16-bit fp32-bit fp |
No | Default proxy depth. Based on default resolution depth. |
<ProxyMinFrameSize> |
integer |
24 to 16384 (inclusive) | Yes | Minimum frame width for which a proxy will be generated. Must be a multiple of 4. |
<ProxyQuality> |
string |
lanczosdraftbicubicmitchelltriangleimpulseshannonquadraticgaussian |
Yes | Proxy generation algorithm. Default is lanczos.See Proxy Quality description for details. |
<HdrMode> |
string |
Dolby Vision 2.9Dolby Vision 4.0 |
Yes | HDR mode. |
<HdrCmuType> |
string |
eCMUiCMUHDMI Tunneling |
Yes | HDR CMU type. |
<HdrMasteringId> |
integer |
Any | Yes | HDR Mastering ID. |
<OCIOConfigFile> |
string |
Any | Yes | Absolute path to an OCIO Configuration file. Has precedence over <ColourPolicyName>.Any error in the colour configuration will be detected at next application startup. |
<ColourPolicyName> |
string |
Any | Yes | Specify the OCIO config file via the name attribute from inside one of the configs stored in the Autodesk or Shared preset locations. Cannot be used with <OCIOConfigFile>.Any error in the colour configuration will be detected at next application startup. |
<DefaultStartFrame> |
integer |
>= 0 | Yes | Default start frame. |
<ShotgunProjectName> |
string |
Any | Yes | Flow Production Tracking project name linked to Flame project. |
Note: Proxies are no longer enabled by the project, but by each clip individually. There is no public method to generate proxies.
Note: At project creation, any missing elements will be inferred from either default values or the sysconfig.cfg file.
Note: When modifying a project, any element missing will remain unchanged unless conflicting settings are changed.
<ProxyWidth> and <ProxyWidthHint> for example modify each other.<IntermediatesProfile> Supported Values
Integer (and legacy Float) Pixel Formats
| Integer Pixel Format | Float Pixel Format | <IntermediatesProfile> first integer value |
|---|---|---|
| Uncompressed | OpenEXR (PIZ) | 0 |
| Uncompressed | Raw | 2 |
| Packed | OpenEXR (PIZ) | 3 |
| Packed | Raw | 4 |
| QuickTime DNx | ||
| DNxHR/DNxHD 444 | Raw | 512 |
| DNxHR/DNxHD HQ | Raw | 513 |
| DNxHR/DNxHD SQ | Raw | 514 |
| DNxHR/DNxHD LB | Raw | 515 |
| DNxHR/DNxHD 444 | OpenEXR (PIZ) | 640 |
| DNxHR/DNxHD HQ | OpenEXR (PIZ) | 641 |
| DNxHR/DNxHD SQ | OpenEXR (PIZ) | 642 |
| DNxHR/DNxHD LB | OpenEXR (PIZ) | 643 |
| QuickTime ProRes | ||
| Apple ProRes 422 Proxy | Raw | 65792 |
| Apple ProRes 422 LT | Raw | 65793 |
| Apple ProRes 422 | Raw | 65794 |
| Apple ProRes 422 HQ | Raw | 65795 |
| Apple ProRes 4444 | Raw | 65796 |
| Apple ProRes 4444 XQ | Raw | 65797 |
| Apple ProRes 422 Proxy | OpenEXR (PIZ) | 65536 |
| Apple ProRes 422 LT | OpenEXR (PIZ) | 65537 |
| Apple ProRes 422 | OpenEXR (PIZ) | 65538 |
| Apple ProRes 422 HQ | OpenEXR (PIZ) | 65539 |
| Apple ProRes 4444 | OpenEXR (PIZ) | 65540 |
| Apple ProRes 4444 XQ | OpenEXR (PIZ) | 65541 |
Floating Point Pixel Formats
| Float Pixel Format | <IntermediatesProfile> second integer value |
|---|---|
| Raw | 64704 |
| OpenEXR (uncompressed) | 6264 |
| OpenEXR (RLE) | 333944 |
| OpenEXR (B44) | 465016 |
| OpenEXR (B44A) | 530552 |
| OpenEXR (PIZ) | 596088 |
| OpenEXR (ZIP scanline) | 661624 |
| OpenEXR (ZIP multi-scanline) | 727160 |
| OpenEXR (PXR24) | 792696 |
| OpenEXR (DWAA) | 1120376 |
| OpenEXR (DWAB) | 1185912 |
XSD Validation
XSD Schema for the Project XML can be found in /opt/Autodesk/xml/<version>/schema/wiretap/project.xsd.
The following xmllint command can be used to validate an XML:
xmllint --schema /opt/Autodesk/xml/<version>/schema/wiretap/project.xsd <xml file>Sample XML for Project Metadata
The following is the metadata for a typical project that you would create using the create_node method on the WireTapNodeHandle object for the project node. Note that several of the fields are optional and are given here simply as an example. In the following snippet, the IntermediatesProfile specified here is QuickTime (Apple ProRes 4444 XQ) with OpenEXR (DWAA).
<Project>
<Name>MyProject</Name>
<Nickname/>
<Description>My project description</Description>
<ShotgunProjectName/>
<CreationDate>03/28/25 16:18:41</CreationDate>
<CatalogDir>/var/opt/Autodesk/flame/projects/MyProject/catalog</CatalogDir>
<ProjectDir>/var/opt/Autodesk/flame/projects/MyProject</ProjectDir>
<SetupDir>/var/opt/Autodesk/flame/projects/MyProject/setups</SetupDir>
<MediaDir>/var/opt/Autodesk/flame/projects/MyProject/media</MediaDir>
<Version>2026</Version>
<FrameWidth>1920</FrameWidth>
<FrameHeight>1080</FrameHeight>
<FrameDepth>8-bit</FrameDepth>
<AspectRatio>1.77778</AspectRatio>
<FieldDominance>PROGRESSIVE</FieldDominance>
<ProxyWidth>960</ProxyWidth>
<ProxyWidthHint>0.500000</ProxyWidthHint>
<ProxyMinFrameSize>720</ProxyMinFrameSize>
<ProxyQuality>lanczos</ProxyQuality>
<ProxyDepth>8-bit</ProxyDepth>
<HdrMode>Dolby Vision 2.9</HdrMode>
<HdrCmuType>iCMU</HdrCmuType>
<HdrMasteringId>7</HdrMasteringId>
<ColourPolicyName/>
<OCIOConfigFile>/var/opt/Autodesk/flame/projects/MyProject/setups/colour_mgmt/config.ocio</OCIOConfigFile>
<IntermediatesProfile>65541:1120376</IntermediatesProfile>
<FrameRate>29.97 fps NDF</FrameRate>
<DefaultStartFrame>1</DefaultStartFrame>
</Project>