Format

public struct Format : Resource

A reference to a Final Cut Pro X video format definition.

See also

FCPXML Resources Documentation
  • id

    The identifier of the format. This identifier is unique within the context of a FCPXML document and refers to the resource identifier (e.g. r1).

    Declaration

    Swift

    public let id: String

  • The name of the format.

    Declaration

    Swift

    public var name: String?

  • The frame duration of the format.

    Declaration

    Swift

    public var frameDuration: CMTime?

  • The field order of the format.

    Declaration

    Swift

    public var fieldOrder: FieldOrder?

  • The video frame width, in pixels.

    Declaration

    Swift

    public var width: Int?

  • The video frame height, in pixels.

    Declaration

    Swift

    public var height: Int?

  • The relative width of a pixel when video is encoded with non-square pixels.

    Declaration

    Swift

    public var paspH: Int?

  • The relative height of a pixel when video is encoded with non-square pixels.

    Declaration

    Swift

    public var paspV: Int?

  • The color space of the format.

    Declaration

    Swift

    public var colorSpace: ColorSpace?

  • The projection type of the format.

    Declaration

    Swift

    public var projection: Projection?

  • The stereoscopic mode of the format.

    Declaration

    Swift

    public var stereoscopic: Stereoscopic?

  • Initializes a new format with a resource identifier.

    Declaration

    Swift

    public init(id: String, name: String? = nil, width: Int? = nil, height: Int? = nil)

    Parameters

    id

    The identifier of the format.
    name

    The name of the format.
    width

    The video frame width, in pixels.
    height

    The video frame height, in pixels.