Skip to main content
Back to Log

Usage

Extended

Clips can be extended with data from other schemas.

Properties

clip

string
Clip Name

tc_start

string
optional
Timecode start

tc_end

string
optional
Timecode End

camera_model

string
optional
Camera model

reel

string
optional
Camera Reel

fps

number
optional
Camera fps

sensor_fps

number
optional
Camera sensor fps

lens

string
optional
Camera Lens Info

shutter

string
optional
Camera Shutter

resolution

string
optional
Camera Resolution

codec

string
optional
Camera Codec

gamma

string
optional
Camera Gamma

ei

number
optional
Camera Exposure Index

wb

number
optional
Camera White Balance

tint

string
optional
Camera Tint

lut

string
optional
Camera LUT

copies

{ volumes: string, hash?: string }[]
OCF Clip Copies

proxy

Proxy
A collection of proxy related properties and methods

sound

string[]
An array of Sound Clip names matched to this clip by TC

size()

string
Gets the size in a user-friendly format, such as “1.17 GB” or “117 MB”. You can specify the unit of measurement you prefer by providing an options object. The default unit is auto, which automatically selects the most appropriate unit.
Options: size( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

sizeAsNumber()

number
Retrieves the size as a numerical value. This method returns the size in a numerical format, which can be useful for calculations or comparisons. You can specify the unit of measurement by providing an options object. The default unit is bytes.
Options: sizeAsNumber( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

sizeAsTuple()

[number, string]
Obtains the size as a pair containing both the numerical value and its unit.
This method returns an array where the first element is the size number and the second element is the unit. You can specify the unit of measurement by providing an options object. The default unit is “auto”.
Options: sizeAsTuple( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

duration()

string
Retrieves the duration in a human-readable string format (e.g., “1h, 30m, 45s”).

durationTC()

string
Retrieves the duration in timecode format (e.g., “01:30:45:00”).

durationObject()

{ hours: number; minutes: number; seconds: number }
Retrieves the duration as an object with time components: hours, minutes, and seconds.

durationAsSeconds()

number
Retrieves the duration in seconds. Suitable if you want to do your own calculations.

durationAsFrames()

number
Retrieves the duration in frames. Suitable if you want to do your own calculations.