OCF - Daytalog documentation

Back to Log

Properties

clips

OcfClipType[]

OCF Clips (Original Camera Files)

files()

number

Retrieves the total number of files

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]

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 = 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']

copies()

{ volumes: string[]; clips: string[]; count: [number, number] }[]

Retrieves the copies as an array of objects.

Show Properties

volumes

string[]

The volumes for the copy. A copy can be split on multiple volumes.

clips

string[]

The clips in this copy

count

[number, number]

First number represents the number of clips in this copy. Second number is total number of clips. The copy has all clips if both numbers are equal. Else it is not complete.

Show Example

const copies = log.ocf.copies();
console.log(copies); // Output: [{ volumes: ['Volume1'], clips: ['A001C001'], count: [10, 10] }, ...]

reels()

string[]

Gets the reels as an array of strings.
You can optionally group reels by passing rangeMerging: true.
Options: reels( rangeMerging: boolean )

Show Example

// Retrieve reels without grouping (default)
const reels = log.ocf.reels();
console.log(reels); // Output: ['Reel1', 'Reel2', 'Reel3']
// Retrieve merged reels
const mergedReels = log.ocf.reels({ rangeMerging: true });
console.log(mergedReels); // Output: ['Reel1 - Reel3', '+ 2 other clips']

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 total seconds. Suitable if you want to do your own calculations.

Show Example

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

File Schemas

Daytalog

​Properties

​clips

​files()

​size()

​sizeAsNumber()

​sizeAsTuple()

​copies()

​reels()

​duration()

​durationTC()

​durationObject()

​durationAsSeconds()

Properties

clips

files()

size()

sizeAsNumber()

sizeAsTuple()

copies()

reels()

duration()

durationTC()

durationObject()

durationAsSeconds()