The resources element holds anything that other elements refer to:
any number of asset, effect, format,
media and locator elements. Each has a required
id, an XML ID that attributes such as ref and
format point at.
format
Video properties. Empty element.
| Attribute | Use | Meaning |
|---|---|---|
id | required | XML ID. |
name | optional | Name of the format. |
frameDuration | optional | Time of one frame. |
fieldOrder | optional | progressive, upper first or lower first. |
width, height | optional | Frame size in pixels. |
paspH, paspV | optional | Pixel aspect ratio, horizontal and vertical terms. |
colorSpace | optional | In the form <cp>-<tc>-<mc> (<name>): colour primaries, transfer characteristics and matrix coefficients, coded as in ISO/IEC 23001-8. The well-known names are Rec. 601 (NTSC), Rec. 601 (PAL), Rec. 709, Rec. 2020, Rec. 2020 PQ and Rec. 2020 HLG. |
projection | optional | none, equirectangular, fisheye, back-to-back fisheye or cubic. |
stereoscopic | optional | mono, side by side or over under. |
heroEye | optional | left or right. Version 1.13. |
asset
A reference to source media. Content: one or more media-rep, then an
optional metadata.
| Attribute | Use | Meaning |
|---|---|---|
id | required | XML ID. |
name | optional | Name. |
uid | optional | Identifier assigned by Final Cut Pro. If absent, a new default clip is created for the asset. |
start, duration | optional | Times. |
hasVideo, hasAudio | optional | Whether the media has these components. |
format | optional | IDREF of a format. |
videoSources, audioSources | optional | Number of sources. |
audioChannels, audioRate | optional | Channel count and sample rate. |
customLUTOverride | optional | A built-in log mode, as <logID> (<logName>), or a custom LUT, as LUT:<LUTID> (<LUTName>). |
colorSpaceOverride | optional | As format/@colorSpace, and also sRGB IEC61966-2.1 and Adobe RGB (1998). |
projectionOverride | optional | As format/@projection. |
stereoscopicOverride | optional | As format/@stereoscopic. |
auxVideoFlags | optional | Not described by Apple. |
heroEyeOverride | optional | left or right. Version 1.13. |
media-rep
One representation of an asset. Content: an optional bookmark element,
which holds text.
| Attribute | Use | Meaning |
|---|---|---|
kind | default original-media | original-media or proxy-media. |
sig | optional | Signature assigned by Final Cut Pro. |
src | required | The media location. |
suggestedFilename | optional | A file name to use when it should not be derived from the URL, with the extension. |
media
A reference to new or existing media by a Final Cut Pro identifier. Content: an optional
multicam or sequence. Without a uid, Final Cut
Pro creates a new media object from the child element.
| Attribute | Use | Meaning |
|---|---|---|
id | required | XML ID. |
name | optional | Name. |
uid | optional | Identifier assigned by Final Cut Pro. |
projectRef | optional | IDREF of a project. Without it the default instance is used. |
modDate | optional | Modification date. |
effect
A built-in or user-defined Motion effect, FxPlug plug-in, audio bundle or audio unit. Empty element.
| Attribute | Use | Meaning |
|---|---|---|
id | required | XML ID. |
name | optional | Name. |
uid | required | Identifier of the effect. |
src | optional | Location. |
locator
Points to a data file. Content: an optional bookmark.
| Attribute | Use | Meaning |
|---|---|---|
id | required | XML ID, used by attributes named dataLocator. |
url | required | The location. |
metadata and md
metadata holds any number of md elements. An md
may hold an array of string elements.
| Attribute | Use | Meaning |
|---|---|---|
key | required | The metadata key. |
value | optional | The value. |
editable | default 0 | 0 or 1. |
type | optional | string, boolean, integer, float, date or timecode. |
displayName, description, source | optional | Text describing the key. |
Sources and key prefixes
| Source | Key prefix | What it holds |
|---|---|---|
| Camera | com.apple.proapps.mio, org.smpte.mxf | From the capture device. Not editable, except cameraName. |
| Exif | com.apple.proapps.exif.{Exif} | Exif data from files such as JPEG. |
| Image | com.apple.proapps.image.{TIFF}, {CIFF}, {GIF}, {PNG}, {DNG}, {GPS} | From image files, or camera-specific metadata in them. |
| IPTC | com.apple.proapps.iptc.{IPTC} | Press photo metadata. |
| Share | com.apple.proapps.share, com.apple.quicktime | Added to a share output. |
| Spotlight | com.apple.proapps.spotlight | Spotlight metadata. |
| Studio | com.apple.proapps.studio | Defined by Final Cut Pro. |
| Custom | com.apple.proapps.custom or a reverse-DNS prefix | Added by users or other software. |
Editable keys
| Key | Display name | Type | Values |
|---|---|---|---|
com.apple.proapps.mio.cameraName | Camera Name | string | |
com.apple.proapps.studio.alphaHandling | Alpha Handling | integer | 0 Premultiply, 1 Straight, 2 None/Ignore Alpha |
com.apple.proapps.studio.angle | Camera Angle | string | |
com.apple.proapps.studio.metadataAnamorphicType | Anamorphic Override | integer | 0 None Set, 1 Standard, 2 Widescreen |
com.apple.proapps.studio.metadataDeinterlaceType | Deinterlace | boolean | |
com.apple.proapps.studio.metadataFieldDominanceOverride | Field Dominance Override | integer | 0 None Set, 1 Progressive, 2 Upper First, 3 Lower First |
com.apple.proapps.studio.metadataLocation | Location | string | |
com.apple.proapps.studio.reel | Reel | string | |
com.apple.proapps.studio.scene | Scene | string | |
com.apple.proapps.studio.shot | Take | string |