Total - Daytalog documentation

Properties

days()

string

Retrieves the total number of days.
You can optionally specify the minimum number of digits in the returned string (1 | 2 | 3).

Show Example

const totalDays = total.days();
console.log(totalDays); // Output: "52"
// With minimum digits
const totalDaysPadded = total.days(3);
console.log(totalDaysPadded); // Output: "052"

dayRange()

[string, string]

Retrieves the first and last day numbers as strings, e.g. [“1”, “52”].
You can optionally specify the minimum number of digits in the returned strings (1 | 2 | 3).

Show Example

const [startDay, endDay] = total.dayRange();
console.log(startDay, endDay); // Output: "1", "52"
// With minimum digits
const [startDayPadded, endDayPadded] = total.dayRange(2);
console.log(startDayPadded, endDayPadded); // Output: "01", "52"

dateRange()

[string, string]

Retrieves the first and last date of the project.
Returns a tuple of strings: [startDate, endDate]. You can optionally pass formatting options.
Options: dateRange( format: DateFormatOptions )

Show Example

const [start, end] = total.dateRange();
const dates = `${start} - ${end}`;
console.log(dates); // Output: 2025-01-01 - 2025-12-31

ocf.files()

number

Retrieves the total number of OCF files.

Show Example

const totalFiles = total.ocf.files();
console.log(totalFiles); // Output: 13214

ocf.size()

string

Gets the size of all OCF files 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: ocf.size( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

Show Example

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

ocf.sizeAsNumber()

number

Retrieves the OCF size as a numerical value.
This method returns the size in a numerical format, which can be useful for calculations or comparisons. The default unit is “bytes”.
Options: ocf.sizeAsNumber( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

Show Example

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

ocf.sizeAsTuple()

[number, string]

Obtains the OCF 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. The default unit is “auto”.
Options: ocf.sizeAsTuple( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

Show Example

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

ocf.duration()

string

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

Show Example

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

ocf.durationTC()

string

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

Show Example

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

ocf.durationObject()

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

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

Show Example

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

proxy.files()

number

Retrieves the total number of proxy files.

Show Example

const totalFiles = total.proxy.files();
console.log(totalFiles); // Output: 13214

proxy.size()

string

Gets the size of all proxy files 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: proxy.size( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

Show Example

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

proxy.sizeAsNumber()

number

Retrieves the proxy size as a numerical value.
This method returns the size in a numerical format, which can be useful for calculations or comparisons. The default unit is “bytes”.
Options: proxy.sizeAsNumber( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

Show Example

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

proxy.sizeAsTuple()

[number, string]

Obtains the proxy 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. The default unit is “auto”.
Options: proxy.sizeAsTuple( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

Show Example

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

sound.files()

number

Retrieves the total number of sound files.

Show Example

const totalFiles = total.sound.files();
console.log(totalFiles); // Output: 13214

sound.size()

string

Gets the size of all sound files 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: sound.size( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

Show Example

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

sound.sizeAsNumber()

number

Retrieves the sound size as a numerical value.
This method returns the size in a numerical format, which can be useful for calculations or comparisons. The default unit is “bytes”.
Options: sound.sizeAsNumber( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

Show Example

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

sound.sizeAsTuple()

[number, string]

Obtains the sound 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. The default unit is “auto”.
Options: sound.sizeAsTuple( type: “auto” | “tb” | “gb” | “mb” | “bytes” )

Show Example

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

File Schemas

Daytalog

​Properties

​days()

​dayRange()

​dateRange()

​ocf.files()

​ocf.size()

​ocf.sizeAsNumber()

​ocf.sizeAsTuple()

​ocf.duration()

​ocf.durationTC()

​ocf.durationObject()

​proxy.files()

​proxy.size()

​proxy.sizeAsNumber()

​proxy.sizeAsTuple()

​sound.files()

​sound.size()

​sound.sizeAsNumber()

​sound.sizeAsTuple()

Properties

days()

dayRange()

dateRange()

ocf.files()

ocf.size()

ocf.sizeAsNumber()

ocf.sizeAsTuple()

ocf.duration()

ocf.durationTC()

ocf.durationObject()

proxy.files()

proxy.size()

proxy.sizeAsNumber()

proxy.sizeAsTuple()

sound.files()

sound.size()

sound.sizeAsNumber()

sound.sizeAsTuple()