Class TimecodeSource
A base class that includes functionality suitable for most ITimecodeSource implementations.
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
Syntax
public abstract class TimecodeSource : MonoBehaviour, ITimecodeSource, IRegistrableProperties
CurrentTime
The frame time and frame rate to use for the current frame, if available.
Declaration
public FrameTimeWithRate? CurrentTime { get; }Property Value
| Type | Description |
|---|---|
| Nullable<FrameTimeWithRate> |
Implements
Remarks
This value is only changed at the beginning of each frame.
FrameRate
The frame rate of the timecode source.
Declaration
public abstract FrameRate FrameRate { get; }Property Value
| Type | Description |
|---|---|
| FrameRate |
Implements
Remarks
This value may change during a frame.
FriendlyName
Get a human-readable name for the instance.
Declaration
public virtual 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.
Methods
OnDisable()
This method is called by Unity when the component becomes disabled.
Declaration
protected virtual void OnDisable()OnEnable()
This method is called by Unity when the component becomes enabled and active.
Declaration
protected virtual void OnEnable()TryPollTimecode(out FrameRate, out Timecode)
Gets the latest timecode from the timecode source.
Declaration
protected abstract 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 |