Interface ISyncProvider

An interface for synchronization sources which may be used to control the engine update timing.

Namespace: Unity.LiveCapture

Syntax

public interface ISyncProvider

Remarks

Classes implementing this interface must have the System.SerializableAttribute and SyncProviderAttribute to be assignable from the Live Capture project settings.

Properties

DroppedFrameCount

The number of synchronization signal pulses that have been skipped since starting the synchronization provider.

Declaration

int DroppedFrameCount { get; }

Property Value

Type	Description
Int32

LastPulseCountDelta

The number of synchronization signal pulses between the last two WaitForNextPulse() calls.

Declaration

int? LastPulseCountDelta { get; }

Property Value

Type	Description
Nullable<Int32>

Name

The display name of the synchronization provider.

Declaration

string Name { get; }

Property Value

Type	Description
String

Status

The status of the synchronization provider.

Declaration

SyncStatus Status { get; }

Property Value

Type	Description
SyncStatus

SyncRate

The pulse rate of the synchronization signal.

Declaration

FrameRate SyncRate { get; }

Property Value

Type	Description
FrameRate

Methods

StartSynchronizing()

Begin listening for synchronization pulses.

Declaration

void StartSynchronizing()

StopSynchronizing()

Stop listening for synchronization pulses.

Declaration

void StopSynchronizing()

WaitForNextPulse()

Blocks execution on the current thread until the next synchronization signal pulse is received.

Declaration

bool WaitForNextPulse()

Returns

Type	Description
Boolean	true when a pulse was successfully received; otherwise, false.

Remarks

This is expected to be called once per frame.