Class TimecodeSourceState

A class which may be used to manage the timecode updates for an ITimecodeSource.

Inheritance

object

TimecodeSourceState

Namespace: Unity.LiveCapture

Assembly: Unity.LiveCapture.dll

Syntax

public class TimecodeSourceState

Remarks

This handles updating the timecode at the best point in the update loop, and ensures that the timecode source is genlocked when an ISyncProvider is active.

Constructors

TimecodeSourceState(Func<FrameTimeWithRate?>)

Creates a new TimecodeSourceState instance.

Declaration

public TimecodeSourceState(Func<FrameTimeWithRate?> pollFrameTime)

Parameters

Type	Name	Description
Func<FrameTimeWithRate?>	pollFrameTime	A function that polls the timecode source at the start of the frame for the latest timecode. Return null if there is no timecode available.

Exceptions

Type	Condition
ArgumentNullException	Thrown if pollFrameTime is null.

Properties

CurrentTime

The frame time and frame rate to use for the current frame.

Declaration

public FrameTimeWithRate? CurrentTime { get; }

Property Value

Type	Description
FrameTimeWithRate?

Methods

Dispose()

Disposes this instance.

Declaration

public void Dispose()