Platforms to show: All Mac Windows Linux Cross-Platform

Back to LTCFrameMBS class.

LTCFrameMBS.Clone as LTCFrameExtMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Timecode MBS Tools Plugin 20.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Clones the frame.

Returns always LTCFrameExtMBS object.
Extended fields may not be set if LTCFrameMBS is cloned.

LTCFrameMBS.Constructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Timecode MBS Tools Plugin 20.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The constructor to create a new frame.

Internally calls Reset to set soem default values.

See also:

LTCFrameMBS.Constructor(InputTimecode as LTCSMPTETimecodeMBS, TVStandard as Integer, Flags as Integer = 0)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Timecode MBS Tools Plugin 20.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Translate SMPTETimecode into its binary LTC representation and set the LTC frame's parity bit accordingly.

InputTimecode: timecode input
TVStandard: the TV standard to use for parity bit assignment
Flags: flags binary combination of flag values - here only LTC_USE_DATE and LTC_NO_PARITY are relevant.
If LTC_USE_DATE is given, user-fields in LTCFrame will be set from the date in SMPTETimecode, otherwise the user-bits are not modified. All non-timecode fields remain untouched - except for the parity bit unless LTC_NO_PARITY is given.

See also:

LTCFrameMBS.Constructor(other as LTCFrameMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Timecode MBS Tools Plugin 20.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Initializes a frame with copying data from existing frame.

See also:

LTCFrameMBS.FrameDecrement(fps as integer, TVStandard as integer, Flags as integer = 0) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Timecode MBS Tools Plugin 20.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Decrement the timecode by one Frame (1/framerate seconds) and set the Frame's parity bit accordingly (see SetParity)

fps: integer framerate (for drop-frame-timecode set frame->dfbit and round-up the fps).
TVStandard: the TV standard to use for parity bit assignment. If set to 1 the 25fps standard is enabled and LTC Frame bit 59 instead of 27 is used for the parity. It only has only has effect flag bit 4 (LTC_NO_PARITY) is cleared.
Flags: binary combination of flags - here only LTC_USE_DATE and LTC_NO_PARITY are relevant.

If the bit 0 is set (1) interpret user-data as date and decrement date if timecode wraps at 24h.
(Note: leap-years are taken into account, but since the year is two-digit only, the 100,400yr rules are ignored. "00" is assumed to be year 2000 which was a leap year.) bit 3 (8) indicates that the parity bit should not be touched.

Returns true if timecode was wrapped around at 23:59:59:ff, false otherwise.

LTCFrameMBS.FrameIncrement(fps as integer, TVStandard as integer, Flags as integer = 0) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Timecode MBS Tools Plugin 20.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Increment the timecode by one Frame (1/framerate seconds) and set the Frame's parity bit accordingly (see SetParity)

fps integer framerate (for drop-frame-timecode set frame->dfbit and round-up the fps).
TVStandard: the TV standard to use for parity bit assignment. If set to 1 the 25fps standard is enabled and LTC Frame bit 59 instead of 27 is used for the parity. It only has only has effect flag bit 4 (LTC_NO_PARITY) is cleared.
flags: binary combination of LTC_BG_FLAGS - here only LTC_USE_DATE and LTC_NO_PARITY are relevant.

If the bit 0 (1) is set (1) interpret user-data as date and increment date if timecode wraps after 24h.
(Note: leap-years are taken into account, but since the year is two-digit only, the 100,400yr rules are ignored. "00" is assumed to be year 2000 which was a leap year.)

Returns true if timecode was wrapped around after 23:59:59:ff, false otherwise

LTCFrameMBS.ParseBCGFlags(TVStandard as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Timecode MBS Tools Plugin 20.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Parse Binary Group Flags into standard independent format.

bit 0 (1) - BGF 0,
bit 1 (2) - BGF 1,
bit 2 (4) - BGF 2

TVStandard: the TV standard to use -- see LTCFrameMBS class for BGF assignment.
Returns LTC Binary Group Flags.

LTCFrameMBS.Reset

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Timecode MBS Tools Plugin 20.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Reset all values of a LTC FRAME to zero, except for the sync-word (0x3FFD) at the end.

The sync word is set according to architecture (big/little endian).
Also set the Frame's parity bit accordingly (see SetParity)

LTCFrameMBS.SetParity(TVStandard as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Timecode MBS Tools Plugin 20.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Set the parity of the LTC frame.

Bi-Phase Mark Phase Correction bit (bit 27 - or 59) may be set or cleared so that that every 80-bit word contains an even number of zeroes. This means that the phase in every Sync Word will be the same.

This is merely cosmetic; the motivation to keep the polarity of the waveform constant is to make finding the Sync Word visibly (on a scope) easier.

There is usually no need to call this function directly. The encoder utility functions TimeToFrame, FrameIncrement and FrameDecrement include a call to it.

Standard: If 1 (aka LTC_TV_625_50) , the 25fps mode (bit 59 - aka binary_group_flag_bit2) is used, otherwise the 30fps, 24fps mode (bit 27 -- biphase_mark_phase_correction) is set or cleared.

The items on this page are in the following plugins: MBS Tools Plugin.


The biggest plugin in space...