Interface ISynchronizer
Manages a collection of ITimedDataSource instances for the purpose of coordinating their respective data to be presented in a temporally coherent manner.
Namespace: Unity.LiveCapture
Syntax
public interface ISynchronizerProperties
DataSourceCount
Get the number of timed data sources in the synchronization group.
Declaration
int DataSourceCount { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
PresentTime
The time to synchronize to for the current frame.
Declaration
FrameTimeWithRate? PresentTime { get; }Property Value
| Type | Description |
|---|---|
| Nullable<FrameTimeWithRate> |
Remarks
If no TimecodeSource is set, the value is null.
TimecodeSource
The source of the timecodes used for synchronization.
Declaration
ITimecodeSource TimecodeSource { get; set; }Property Value
| Type | Description |
|---|---|
| ITimecodeSource |
Methods
AddDataSource(ITimedDataSource)
Add a timed data source to the synchronization group.
Declaration
bool AddDataSource(ITimedDataSource source)Parameters
| Type | Name | Description |
|---|---|---|
| ITimedDataSource | source | The timed data source to add. |
Returns
| Type | Description |
|---|---|
| Boolean | true if the source is in the synchronization group; otherwise, false. |
GetDataSource(Int32)
Get the timed data source at the specified index.
Declaration
ITimedDataSource GetDataSource(int index)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | index | The index of the timed data source. |
Returns
| Type | Description |
|---|---|
| ITimedDataSource | The timed data source at the index; null if the index is invalid. |
RemoveDataSource(ITimedDataSource)
Remove a timed data source from the synchronization group.
Declaration
bool RemoveDataSource(ITimedDataSource source)Parameters
| Type | Name | Description |
|---|---|---|
| ITimedDataSource | source | The timed data source to remove. |
Returns
| Type | Description |
|---|---|
| Boolean | true if the source was removed from the synchronization group; otherwise, false. |
Update()
Perform synchronized update on synchronized group.
Declaration
void Update()