Clips - Daytalog documentation

Usage

const { log } = useDaytalog();
/*
Get an array of clips with clip name, ocf size, proxy size 
and durarion in timecode format.
*/ 
const clips = log.clips.map((clip) => {
  return {
    clip: clip.clip,
    ocfSize: clip.size(),
    proxySize: clip.proxy.size()
    duration: clip.durarionTC()
  };
});

Extended

Clips can be extended with data from other schemas.

Properties

clip

string

Clip Name

tc_start

string

Timecode start

tc_end

string

Timecode End

camera_model

string

Camera model

reel

string

Camera Reel

fps

number

Camera fps

sensor_fps

number

Camera sensor fps

lens

string

Camera Lens Info

shutter

string

Camera Shutter

resolution

string

Camera Resolution

codec

string

Camera Codec

gamma

string

Camera Gamma

ei

number

Camera Exposure Index

wb

number

Camera White Balance

tint

string

Camera Tint

lut

string

Camera LUT

copies

{ volumes: string, hash?: string }[]

OCF Clip Copies

proxy

Proxy

A collection of proxy related properties and methods

Show child attributes

string

Proxy Codec

string

Proxy Format

string

Proxy Resolution

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”.
Options: size( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

Show Example

// Automatically choose the best unit
const sizeAuto = clip.proxy.size();
console.log(sizeAuto); // Output: "117 MB"
// Specify the unit as Gigabytes
const sizeGB = clip.proxy.size({ type: 'gb' });
console.log(sizeGB); // Output: "0.117 GB"

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” )

Show Example

// Get size in the default unit (bytes)
const sizeNumberDefault = clip.proxy.sizeAsNumber();
console.log(sizeNumberDefault); // Output: 117000000
// Get size in Gigabytes
const sizeNumberGB = clip.proxy.sizeAsNumber({ type: 'gb' });
console.log(sizeNumberGB); // Output: 0.117
// Get size in Megabytes
const sizeNumberMB = clip.proxy.sizeAsNumber({ type: 'mb' });
console.log(sizeNumberMB); // Output: 117

[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” )

Show Example

// Get size as a tuple with automatic unit
const sizeTupleAuto = clip.proxy.sizeAsTuple();
console.log(sizeTupleAuto); // Output: [117, 'MB']
// Get size as a tuple in Gigabytes
const sizeTupleGB = clip.proxy.sizeAsTuple({ type: 'gb' });
console.log(sizeTupleGB); // Output: [0.117, 'GB']

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” )

Show Example

// Automatically choose the best unit
const sizeAuto = log.ocf.size();
console.log(sizeAuto); // Output: "117 MB"
// Specify the unit as Gigabytes
const sizeGB = log.ocf.size({ type: 'gb' });
console.log(sizeGB); // Output: "0.117 GB"

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” )

Show Example

// Get size in the default unit (bytes)
const sizeNumberDefault = log.ocf.sizeAsNumber();
console.log(sizeNumberDefault); // Output: 117000000
// Get size in Gigabytes
const sizeNumberGB = log.ocf.sizeAsNumber({ type: 'gb' });
console.log(sizeNumberGB); // Output: 0.117
// Get size in Megabytes
const sizeNumberMB = log.ocf.sizeAsNumber({ type: 'mb' });
console.log(sizeNumberMB); // Output: 117

sizeAsTuple()

[number, string]

Show Example

// Get size as a tuple with automatic unit
const sizeTupleAuto = log.ocf.sizeAsTuple();
console.log(sizeTupleAuto); // Output: [117, 'MB']
// Get size as a tuple in Gigabytes
const sizeTupleGB = log.ocf.sizeAsTuple({ type: 'gb' });
console.log(sizeTupleGB); // Output: [0.117, 'GB']

duration()

string

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

Show Example

const duration = log.ocf.duration();
console.log(duration); // Output: "1h, 30m, 45s"

durationTC()

string

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

Show Example

const durationTC = log.ocf.durationTC();
console.log(durationTC); // Output: "01:30:45:00"

durationObject()

{ hours: number; minutes: number; seconds: number }

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

Show Example

const durationObj = log.ocf.durationObject();
console.log(durationObj); // Output: { hours: 1, minutes: 30, seconds: 45 }

durationAsSeconds()

number

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

Show Example

const durationSeconds = log.ocf.durationAsSeconds();
console.log(durationSeconds); // Output: 5445

durationAsFrames()

number

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

Show Example

  const durationFrames = clip.durationAsFrames();
  console.log(durationFrames); // Output: 5445

​Usage

​Extended

​Properties

​clip

​tc_start

​tc_end

​camera_model

​reel

​fps

​sensor_fps

​lens

​shutter

​resolution

​codec

​gamma

​ei

​wb

​tint

​lut

​copies

​proxy

​sound

​size()

​sizeAsNumber()

​sizeAsTuple()

​duration()

​durationTC()

​durationObject()

​durationAsSeconds()

​durationAsFrames()

Usage

Extended

Properties

clip

tc_start

tc_end

camera_model

reel

fps

sensor_fps

lens

shutter

resolution

codec

gamma

ei

wb

tint

lut

copies

proxy

sound

size()

sizeAsNumber()

sizeAsTuple()

duration()

durationTC()

durationObject()

durationAsSeconds()

durationAsFrames()