Interface ISynchronizationCalibrator
The interface for calibration strategies used to configure a synchronizer.
Namespace: Unity.LiveCapture
Assembly: Unity.LiveCapture.dll
Syntax
public interface ISynchronizationCalibrator
Methods
Execute(ITimecodeSource, IEnumerable<ITimedDataSource>)
Performs calibration on the provided data sources to determine delays and buffer sizes allowing for synchronized presentation of data samples.
Declaration
IEnumerable<CalibrationResult> Execute(ITimecodeSource timecodeSource, IEnumerable<ITimedDataSource> dataSources)
Parameters
Type | Name | Description |
---|---|---|
ITimecode |
timecodeSource | The timecode source that provides the timecodes to present. |
IEnumerable<ITimed |
dataSources | The data sources to be synchronized. |
Returns
Type | Description |
---|---|
IEnumerable<Calibration |
The calibration result for the current frame. |
Remarks
Use calibration to: a) Determine an optimized presentation delay allowing the data source with the highest latency to have time to receive the sample for a frame before presenting it. Ideally keep the delay as small as possible. b) Determine an optimized buffer size for each data source to prevent them from dropping samples that haven't been presented yet.
The result is updated iteratively; the caller should iterate one result each frame.