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

Assembly: Unity.LiveCapture.dll

Syntax

public interface ISynchronizer

Properties

CurrentTimecode

The timecode for the current frame to synchronize to.

Declaration

Timecode? CurrentTimecode { get; }

Property Value

Type	Description
Timecode?

Remarks

This is controlled by the assigned TimecodeSource. If no TimecodeSource is set, the value is null.

DataSourceCount

Get the number of timed data sources in the synchronization group.

Declaration

int DataSourceCount { get; }

Property Value

Type	Description
int

FrameRate

The frequency of synchronized updates.

Declaration

FrameRate? FrameRate { get; }

Property Value

Type	Description
FrameRate?

Remarks

This is controlled by the assigned TimecodeSource. If no TimecodeSource is set, the value is null.

TimecodeSource

The source of the timecode to synchronize to.

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
bool	true if added successfully; false if data source is already in the group.

GetDataSource(int)

Get the timed data source at the specified index.

Declaration

ITimedDataSource GetDataSource(int index)

Parameters

Type	Name	Description
int	index	The index of the timed data source.

Returns

Type	Description
ITimedDataSource	The timed data source at the index; null if no source exists at the index.

RemoveDataSource(ITimedDataSource)

Remove a timed data source from the synchronization group.

Declaration

void RemoveDataSource(ITimedDataSource source)

Parameters

Type	Name	Description
ITimedDataSource	source	The timed data source to remove.

Update()

Perform synchronized update on synchronized group.

Declaration

void Update()