Provider

Provider

Choose your operating system:

Windows

macOS

Linux

On this page

Actions

Fetch and Update

Update the state of the provider. Call it to ensure timecode and state are updated. It is suggested to fetch timecode from its source and cache it for the getters.

Target is Timecode Provider

Fetch Timecode

Fetch current timecode from its source. e.g. From hardware/network/file/etc. It is recommended to cache the fetched timecode.

Target is Timecode Provider

Get Delayed Qualified Frame Time

Return current frame time with FrameDelay applied. Only assume valid when GetSynchronizationState() returns Synchronized.

Target is Timecode Provider

Get Delayed Timecode

Return the delayed frame time converted into a timecode value.

Target is Timecode Provider

Get Frame Rate

Return the frame rate of the frame time.

Target is Timecode Provider

Get Qualified Frame Time

Return current frame time. Since it may be called several times per frame, it is suggested to return a cached value.

Target is Timecode Provider

Get Synchronization State

The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid.

Target is Timecode Provider

Get Timecode

Return the frame time converted into a timecode value.

Target is Timecode Provider