Class NtpTimecodeSource
A component that gets timecode from an network time protocol (NTP) server.
Inherited Members
Namespace: Unity.LiveCapture.Ntp
Syntax
[ExecuteAlways]
[CreateTimecodeSourceMenuItem("NTP Timecode Source", 0)]
[AddComponentMenu("Live Capture/Timecode/NTP Timecode Source")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.live-capture@3.0/manual/ref-component-ntp-timecode-source.html")]
public class NtpTimecodeSource : MonoBehaviour, ITimecodeSource, IRegistrable
Properties
FrameRate
The rate at which timecodes are generated.
Declaration
public FrameRate FrameRate { get; }
Property Value
Type | Description |
---|---|
FrameRate |
Implements
FriendlyName
Get a human-readable name for the instance.
Declaration
public string FriendlyName { get; }
Property Value
Type | Description |
---|---|
String |
Implements
Id
Get the unique identifier for this instance.
Declaration
public string Id { get; }
Property Value
Type | Description |
---|---|
String |
Implements
Remarks
The ID should not be null or empty, and is expected to remain constant for the life of the instance.
Now
The latest timecode available at the source.
Declaration
public Timecode Now { get; }
Property Value
Type | Description |
---|---|
Timecode |
Implements
Methods
ForceUpdate()
Queries the NTP server to resynchronize the time with the server clock.
Declaration
public void ForceUpdate()