@vidispine/vdt-js 22.3.0

createMetadataType

Create a VidiCore MetadataType from a simplified object structure

createMetadataType

Parameters

metadata

(object
            = {})

object to create MetadataType from

Returns

object: a MetadataType object

parseMetadataType

Parses MetadataType according to specified options. The attributes can be targeted for each sub-type.

parseMetadataType

Parameters

metadataType

(Object
            = {})

A MetadataType from VidiCore.

options

(Object
            = {})

Options which change how the metadataType is parsed.

Name	Description
options.joinValue `string`	String to join the values, eg ','.
options.includeAttributes `boolean`	Include attributes on all objects.
options.includeMetadataAttributes `boolean`	Include attributes on root.
options.includeTimespanAttributes `boolean`	Include attributes on timespans.
options.includeGroupAttributes `boolean`	Include attributes on groups.
options.includeFieldAttributes `boolean`	Include attributes on fields.
options.includeValueAttributes `boolean`	Include attributes on values.
options.flat `boolean`	Flatten to key/value (Note: keys may be overwritten).
options.flatTimespan `boolean`	Flatten timespan.
options.flatGroup `boolean`	Flatten group.
options.sortTimespan `boolean`	Sort timespan by start time.
options.timespanAsList `boolean`	Return timespans as list.
options.groupAsList `boolean`	Return groups as list.
options.fieldAsList `boolean`	Return fields as list.
options.arrayOnSingle `boolean` (default `true`)	Return fields as array even if single field.
options.arrayOnSingleValue `boolean` (default `true`)	Return fields as array even if single field value.

Returns

Object: Metadata object parsed according to options.

parseTimespanList

Parses timespanList according to specified options. The attributes can be targeted for each sub-type.

parseTimespanList

Parameters

timespanList

(Array<Object>
            = [])

A timespanList from VidiCore.

options

(Object
            = {})

Options which change how the metadataType is parsed.

Name	Description
options.joinValue `string`	String to join the values, eg ','.
options.includeAttributes `boolean`	Include attributes on all objects.
options.includeMetadataAttributes `boolean`	Include attributes on root.
options.includeTimespanAttributes `boolean`	Include attributes on timespans.
options.includeGroupAttributes `boolean`	Include attributes on groups.
options.includeFieldAttributes `boolean`	Include attributes on fields.
options.includeValueAttributes `boolean`	Include attributes on values.
options.flat `boolean`	Flatten to key/value (Note: keys may be overwritten).
options.flatTimespan `boolean`	Flatten timespan.
options.flatGroup `boolean`	Flatten group.
options.sortTimespan `boolean`	Sort timespan by start time.
options.timespanAsList `boolean`	Return timespans as list.
options.groupAsList `boolean`	Return groups as list.
options.fieldAsList `boolean`	Return fields as list.
options.arrayOnSingle `boolean` (default `true`)	Return fields as array even if single field.
options.arrayOnSingleValue `boolean` (default `true`)	Return fields as array even if single field value.

Returns

Object: Metadata object parsed according to options.

parseTimespan

Parses timespan according to specified options. The attributes can be targeted for each sub-type.

parseTimespan

Parameters

timespan

(Object
            = {})

A timespan from VidiCore.

options

(Object
            = {})

Options which change how the metadataType is parsed.

Name	Description
options.joinValue `string` (default `undefined`)	String to join the values, eg ','.
options.includeAttributes `boolean` (default `false`)	Include attributes on all objects.
options.includeTimespanAttributes `boolean` (default `false`)	Include attributes on timespans.
options.includeGroupAttributes `boolean` (default `false`)	Include attributes on groups.
options.includeFieldAttributes `boolean` (default `false`)	Include attributes on fields.
options.includeValueAttributes `boolean` (default `false`)	Include attributes on values.
options.flat `boolean` (default `false`)	Flatten to key/value (Note: keys may be overwritten).
options.flatTimespan `boolean` (default `false`)	Flatten timespan.
options.flatGroup `boolean` (default `false`)	Flatten group.
options.groupAsList `boolean` (default `false`)	Return groups as list.
options.fieldAsList `boolean` (default `false`)	Return fields as list.
options.arrayOnSingle `boolean` (default `true`)	Return fields as array even if single field.
options.arrayOnSingleValue `boolean` (default `true`)	Return fields as array even if single field value.

Returns

Object: Metadata object parsed according to options.

parseHighlightTimespanList

Parses highlight timespans from VidiCore into key/value object. The attributes can be targeted for each sub-type.

parseHighlightTimespanList

Parameters

highlightTimespanList

(Object
            = [])

A list of timespans from VidiCore.

options

(Object
            = {})

Options which change how the timespans are parsed.

Name	Description
options.arrayOnSingle `boolean` (default `true`)	Return an array if there is a single value.
options.joinValue `string`	String to join the values, eg ','.
options.timespanAsList `boolean` (default `false`)	Return timespans as list.
options.flat `boolean` (default `false`)	Flatten to field-name/field-value (Note: field-values may be overwritten).
options.flatTimespan `boolean` (default `false`)	Flatten timespan to object with start/end as key.
options.joinTimespan `string` (default `_`)	Character to join the start/end timecodes.

parseHighlightTimespan

Parses highlight timespan in VidiCore into key/value object. The attributes can be targeted for each sub-type.

parseHighlightTimespan

Parameters

highlightTimespan

(Array<Object>
            = {})

A VidiCore timespan object.

Name	Description
highlightTimespan.field `any` (default `[]`)
highlightTimespan.start `any`
highlightTimespan.end `any`

options

(Object
            = {})

Options which change how the timespans are parsed.

Name	Description
options.arrayOnSingle `boolean` (default `true`)	Return an array if there is a single value.
options.timespanAsList `boolean` (default `false`)	Return timespans as list.
options.joinValue `string`	String to join the values, eg ','.

metadataTypeToWebVtt

Convert subtitle groups to WebVtt subtitle format

metadataTypeToWebVtt

Parameters

input

(Object
            = {})

Name	Description
input.metadataType `Object`	MetadataType response from API.
input.subtitleGroup `string` (default `stl_subtitle`)	Name of group containing subtitle field/text.
input.subtitleField `string` (default `stl_text`)	Name of field (text) to use for the subtitles.

Returns

string: WebVtt subtitles

TimeBase

TimeBase class representing the TimeBaseType in VidiCore

For more info, see the Time bases section in VidiCore API Docs

new TimeBase(timeCodeType: object)

Parameters

timeCodeType

(object
            = {})

A time base type object

Instance Members

▸ toConstant()

Get TimeBase in a constant representation (e.g. "PAL") if possible, otherwise undefined

toConstant(): string

Returns

string: Constant representation of the TimeBase

▸ toText(options)

Get TimeBase as a VidiCore TimeBaseType string

Default format: denominator(:numerator if > 1) constant has precedence over fraction if both are true (e.g. NTSC > 30000:1001)

toText(options: object): string

Parameters

options

(object
            = {})

For how to display it as text

Name	Description
options.constant `boolean` (default `false`)	Show time base as constant (e.g. PAL)
options.fraction `boolean` (default `false`)	Show time base as fraction (25:1) even when numerator is 1

Returns

string: Text representation of the TimeBase

▸ toRate(options)

Output TimeBase as frame rate (by default max 16 decimal places)

For options.fixed:

true gives two decimal places
false gives max amount of decimal places
number gives that amount of decimal places

Default format: rate with two decimals if needed (i.e. decimals are > 0) Option precedence (when all true): constant > rounded > fixed

toRate(options: object): number

Parameters

options

(object
            = {})

For how to display it as rate

Name	Description
options.fixed `(boolean \| number)` (default `true`)	Amount of decimal places (true gives 2 decimal places)
options.constant `boolean` (default `false`)	Use constant representation (if applicable)
options.rounded `boolean` (default `false`)	Rounded to nearest integer

Returns

number: Rate of the TimeBase

▸ toObject()

Get TimeBase in a object representation

toObject(): object

Returns

object: TimeBase as {denominator, numerator} object

▸ toJson()

toJson(): object

Deprecated: Use toObject instead

Returns

object: TimeBase as {denominator, numerator} object

createTimeBase

Create a TimeBase Instance from a string or object representation of a time base

createTimeBase

Parameters

timeBase ((string | object)) Expressed as "denominator:numerator" or { numerator, denominator }

Returns

TimeBase: A TimeBase instance

formatTimeBaseText

Format a string representation of a time base to a TimeBase Instance

formatTimeBaseText

Parameters

timeBaseText (string) The string to format to a TimeBase instance

Returns

TimeBase: A TimeBase Instance

formatTimeBaseType

Create a TimeBase instance of an object

formatTimeBaseType

Parameters

timeBase (object) A TimeBase object ({ numerator, denominator })

Returns

TimeBase: A TimeBase instance

TimeCode

TimeCode class representing the TimeCodeType in VidiCore

For more info, see the Time Codes section of VidiCore API Docs

new TimeCode(timeCodeType: object, options: object)

Parameters

timeCodeType

(object
            = {})

Object to create TimeCode of

options

(object
            = {})

Options for the timeCode

Instance Members

▸ add(timeCodeType)

Return this TimeCode added with the supplied timeCodeType If time bases differ, it will retain the time base of this TimeCode instance If supplied time code has a more granular time base - it will round down exceeding samples (hasn't reached that sample yet)

Note: This might make you "lose" frames depending on granularity of time bases, e.g. "51@50".add("25@25") => "101@50" while "25@25".add("51@50") => "50@25" (not "101@50")

add(timeCodeType: TimeCode): any

Parameters

timeCodeType (TimeCode) A TimeCode instance you want to add with

Returns

any: A new TimeCode instance with the addition applied

▸ subtract(timeCodeType)

Return this TimeCode subtracted with the supplied timeCodeType If time bases differ, it will retain the time base of the instance time code If supplied time code has a more granular time base - it will round down exceeding samples (hasn't reached that sample yet)

Note: This might make you "lose" frames depending on granularity of time bases, e.g. "101@50".subtract("25@25") => "51@50" while "50@25".subtract("51@50") => "25@25" (not "49@50")

subtract(timeCodeType: TimeCode): any

Parameters

timeCodeType (TimeCode) A TimeCode instance you want to subtract with

Returns

any: A new TimeCode instance with the subtraction applied

▸ conformTimeBase(conformTo)

Creates a new TimeCode instance with specified timeBase and samples adjusted to that.

If it conforms to a less granular time base - it will floor samples (hasn't reached that sample yet)

e.g. "51@50".conformTo("PAL") => "25@PAL" (not "26@PAL")

conformTimeBase(conformTo: (string | object)): any

Parameters

conformTo ((string | object)) The TimeBase it should conform the TimeCode to

Returns

any: A new TimeCode instance with the conformTo timeBase applied

▸ toText(options)

Get TimeCode as a text representation

Default format: samples@denominator(:numerator if > 1) constant has precedence over fraction if both are true

toText(options: object): any

Parameters

options

(object
            = {})

TimeBase toText options

Name	Description
options.includeTimeBaseForSeconds `boolean` (default `false`)	include time base even if seconds
options.constant `boolean` (default `false`)	show as constant (e.g. @PAL)
options.fraction `boolean` (default `false`)	show as fraction (@25:1)

Returns

any: Text representation of TimeCode

▸ toUnits()

Get TimeCode in a units object representation

toUnits(): object

Returns

object: in the format { hours, minutes, seconds, frames }

▸ toTime()

Get TimeCode in a time object representation "milliseconds" is rounded down, if you want another representation use "partialSeconds"

toTime(): object

Returns

object: in the format { hours, minutes, seconds, milliseconds, partialSeconds }

▸ toSeconds()

Get TimeCode in a seconds representation

toSeconds(): number

Returns

number: the seconds

▸ toDuration(options)

Get TimeCode in a duration representation The time unit char keys for the format string are:

"h" for hour
"m" for minute
"s" for seconds
"S" for milliseconds

Any other char will be kept in the duration output string.

Add consecutive chars for zero padding.

By default it:

uses colon delimiter (e.g. for format "hhmmss")
shows "m:ss" or "h:mm:ss" if format is undefined

toDuration(options: object): string

Parameters

options

(object
            = {})

Name	Description
options.format `string`	specify format of duration string, e.g. hh:mm:ss.S for 01:23:04.5

Returns

string: Duration representation of the TimeCode

▸ toSmpte()

Get TimeCode in a smpte representation

toSmpte(): string

Returns

string: Smpte representation of the TimeCode

▸ toObject()

Get TimeCode as a VidiCore TimeCodeType object

toObject(): object

Returns

object: TimeCode as { samples, timeBase }

▸ toJson()

toJson(): object

Deprecated: Use toObject instead

Returns

object: TimeCode as { samples, timeBase }

createTimeCode

Create a TimeCode instance from smpte, seconds/samples, timeCode object or string

createTimeCode

Parameters

timeCode ((object | string | number)) Smpte, seconds/samples, timeCode object or string

options

(object
            = {})

For the format functions

Returns

TimeCode: A TimeCode instance

formatTimeCodeText

Format text to a TimeCode instance

formatTimeCodeText

Parameters

timeCodeText (string) A time code text (e.g. "25@PAL")

options

(object
            = {})

Options for how to format

Name	Description
options.timeBase `(object \| string)`	The time base the returned TimeCode should have

Returns

TimeCode: A TimeCode instance

formatTimeCodeType

Format an object to a TimeCode instance

formatTimeCodeType

Parameters

timeCode (object) To create TimeCode instance of

options (object) For the TimeCode constructor

Returns

TimeCode: A TimeCode instance

formatTimeCodeSeconds

Format seconds to TimeCode object Input time base is always 1:1 since it expects seconds as input

Note: Max 15 digits accuracy (double precision float64), e.g.

10^6 seconds can have 10^9 decimals (nanosecond) precision
10^9 seconds can have 10^6 decimals (microsecond) precision
10^12 seconds can have 10^3 decimals (millisecond) precision

formatTimeCodeSeconds

Parameters

seconds ((string | number)) With or without decimals ("." and "," are both interpreted as decimal)

options

(object
            = {})

Options for how to format the seconds to a TimeCode

Name	Description
options.timeBase `(object \| string)`	What TimeBase the resulting TimeCode should have (if unset and useGCD=false, denominator will be 10^ )
options.useGCD `boolean` (default `false`)	Samples and denominator are divided with GCD (ignored if timeBase is set) (e.g. 1.04 => 104@100 => 26@25)

Returns

TimeCode: A TimeCode instance

formatTimeCodeSmpte

Format smpte text to a TimeCode Instance

exceedingMode:

"overflow" exceeding values will be kept (e.g. PAL and 00:00:00:25 => 00:00:01:00)
"truncate" exceeding values will be truncated (e.g. PAL and 00:00:00:25 => 00:00:00:24)
"error" exceeding values will throw error (e.g. PAL and 00:00:00:25 => Error)

formatTimeCodeSmpte

Parameters

smpte (string) String representation of smpte

options

(object
            = {})

What options to use for creating the time code from smpte (all not specified below are passed to the TimeCode constructor)

Name	Description
options.timeBase `(object \| string \| number)`	TimeBase of smpte (and consequently TimeBase of output TimeCode)
options.exceedingMode `string` (default `error`)	How to handle exceeding values ( `overflow\|truncate\|error` )
options.dropFrame `boolean`	If it should parse and create time code using dropFrame
options.frameSeparator `string`	What frame separator the TimeCode should store (defaults to what the smpte has)

Returns

TimeCode: A TimeCode instance