Class NtpTimecodeSource
A component that gets timecode from an network time protocol (NTP) server.
Inherited Members
UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
UnityEngine.Object.FindFirstObjectByType<T>()
UnityEngine.Object.FindAnyObjectByType<T>()
UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindFirstObjectByType(System.Type)
UnityEngine.Object.FindAnyObjectByType(System.Type)
UnityEngine.Object.FindFirstObjectByType(System.Type, UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType(System.Type, UnityEngine.FindObjectsInactive)
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@4.0/manual/ref-component-ntp-timecode-source.html")]
public class NtpTimecodeSource : TimecodeSource, ITimecodeSource, IRegistrableProperties
FrameRate
The frame rate of the timecode source.
Declaration
public override FrameRate FrameRate { get; }Property Value
| Type | Description |
|---|---|
| FrameRate |
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
Methods
ForceUpdate()
Queries the NTP server to resynchronize the time with the server clock.
Declaration
public void ForceUpdate()OnDisable()
This method is called by Unity when the component becomes disabled.
Declaration
protected override void OnDisable()Overrides
OnEnable()
This method is called by Unity when the component becomes enabled and active.
Declaration
protected override void OnEnable()Overrides
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 |
|---|---|---|
| FrameRate | frameRate | The rate at which the timecode is incremented. |
| Timecode | timecode | The most recent timecode. |
Returns
| Type | Description |
|---|---|
| Boolean |