Class SystemClockTimecodeSource
A component that generates timecodes using the system clock.
Inheritance
Inherited Members
Namespace: Unity.LiveCapture
Assembly: Unity.LiveCapture.dll
Syntax
[ExecuteAlways]
[CreateTimecodeSourceMenuItem("System Clock Timecode Source", 0)]
[AddComponentMenu("Live Capture/Timecode/System Clock Timecode Source")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.live-capture@4.0/manual/ref-component-system-clock-timecode-source.html")]
public class SystemClockTimecodeSource : TimecodeSource, ITimecodeSource, IRegistrable
Properties
FrameRate
The frame rate of the timecode source.
Declaration
public override FrameRate FrameRate { get; }
Property Value
Type | Description |
---|---|
Frame |
Overrides
Remarks
This value may change during a frame.
FriendlyName
Get a human-readable name for the instance.
Declaration
public override string FriendlyName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Type
The source clock used to generate timecodes.
Declaration
public SystemClockTimecodeSource.ClockType Type { get; set; }
Property Value
Type | Description |
---|---|
System |
Methods
TryPollTimecode(out FrameRate, out Timecode)
Gets the latest timecode from the timecode source.
Declaration
protected override bool TryPollTimecode(out FrameRate frameRate, out Timecode timecode)
Parameters
Type | Name | Description |
---|---|---|
Frame |
frameRate | The rate at which the timecode is incremented. |
Timecode | timecode | The most recent timecode. |