Structures

The following structures are available globally.

  • An annotation that indicates the result of scene analysis to determine the number of people present and the shot and stabilization types.

    See more

    Declaration

    Swift

    public struct AnalysisMarker : XMLRepresentable

  • A reference to a media file managed by a library.

    See also

    FCPXML Resources Documentation

    Some asset properties are optional because their values can be derived from the respective media file. However, the asset file may be offline when Final Cut Pro X tries to access it, therefore, it is recommended that you specify the following properties for all assets: hasAudio, hasVideo, audioSources, audioChannels, and audioRate.

    Third party tools can assign a unique identifier with the uid property of the asset. This allows you to reference the same asset in a subsequent XML import, even if the URL specified by the sourceURL is different. Final Cut Pro X locates the asset using the uid property value and relinks the media. The asset now uses the media file at the new URL.

    This enables a workflow where the initial XML import uses the proxy media that is currently available to allow the editor to start working. Then, when the respective high resolution media becomes available, a second XML import can be used to replace the proxy media with the high resolution media. For this to work, the proxy and the high resolution media must be compatible, meaning their frame rates match and the high resolution media covers the time range of the proxy media. If desired, you can also go back from the high resolution media to the proxy media, as long as the two medias are compatible. There can be a situation where an importing XML includes a media asset with its unique identifier assigned by a third party tool, yet the media asset has already been imported manually into Final Cut Pro X by the user. In such a case, Final Cut Pro X finds the asset through the URL specified by the sourceURL property and assigns the unique identifier from the importing XML to the asset already imported into Final Cut Pro X overriding the unique identifier generated by Final Cut Pro X. This is only possible when the media asset imported has a unique identifier assigned by Final Cut Pro X.

    See more

    Declaration

    Swift

    public struct Asset : Resource

  • Modifies the compositing blend mode and opacity percentage of the visible image.

    See more

    Declaration

    Swift

    public struct Blend : XMLRepresentable

  • Modifies the image size of a clip to fill, fit, or remain unchanged within its container’s frame size. The type property specifies the conform method to apply, which defaults to fit. With the absence of this adjustment, the clip is fit into the frame size.

    See also

    FCPXML Adjustments And Effects
    See more

    Declaration

    Swift

    public struct Conform : XMLRepresentable

  • Used to indicate rate conforming. When the timeline frame rate and the media frame rate are certain combinations, Final Cut Pro X automatically applies rate conforming by converting the media frame rate to match the timeline frame rate. As a result, the duration is also adjusted.

    See also

    FCPXML Story Elements
    See more

    Declaration

    Swift

    public struct ConformRate : XMLRepresentable

  • Modifies the corners of the visible image, adding a distort (or skew) effect using the bottomLeft, topLeft, topRight, and bottomRight properties. These attributes are two-dimensional point values expressed as a percentage of frame height.

    See also

    FCPXML Adjustments And Effects
    See more

    Declaration

    Swift

    public struct Corners : XMLRepresentable

  • Modifies the visible image width and height by cropping, trimming, or panning.

    See more

    Declaration

    Swift

    public struct Crop : XMLRepresentable

  • A reference to an effect plug-in (for example, FxPlug, Motion document, or Audio Unit). The sourceURL property specifies the location of a Motion template, when templates are managed in the library or another external location.

    See also

    FCPXML Resources Documentation
    See more

    Declaration

    Swift

    public struct Effect : Resource

  • Use a Final Cut Pro X event to store and organize clips and projects. You can import media files into a new or existing event. You can copy these files into an event’s own media folder, or reference them in their original locations. Final Cut Pro X tracks each imported file as an asset and ensures your event contains at least one clip per asset.

    See also

    FCPXML Concepts
    See more

    Declaration

    Swift

    public struct Event : XMLRepresentable

  • A container for the possible event items that can be included in a FCPXML document. See FCPXMLDocument.Configuration for possible document configurations.

    See more

    Declaration

    Swift

    public struct EventItems : Equatable

  • Undocumented

    See more

    Declaration

    Swift

    public struct Media : Resource

  • A structure that contains a point in a two-dimensional coordinate system.

    See more

    Declaration

    Swift

    public struct Point : XMLRepresentable