CMClock.GetPreferredStartTimePattern(CMTime, CMTime, CMTime) Method

Definition

Namespace:: CoreMedia

Assembly:: Microsoft.iOS.dll

Assembly:: Microsoft.MacCatalyst.dll

Assembly:: Microsoft.macOS.dll

Assembly:: Microsoft.tvOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the pattern of preferred start times for synchronization with an external signal.

public CoreMedia.CMClockError GetPreferredStartTimePattern(out CoreMedia.CMTime clockStartTime, out CoreMedia.CMTime hostClockStartTime, out CoreMedia.CMTime deltaBetweenPreferredStartTimes);

member this.GetPreferredStartTimePattern : CMTime * CMTime * CMTime -> CoreMedia.CMClockError

Parameters

clockStartTime: CMTime

Receives the next preferred start time in this clock's time.

hostClockStartTime: CMTime

Receives the matching preferred start time in host-clock time.

deltaBetweenPreferredStartTimes: CMTime

Receives the interval between successive preferred start times.

Returns

CMClockError

None on success, UnsupportedOperation if unsupported, or PreferredStartTimeNotAvailable if the system is not synchronized to a present signal.

Exceptions

ObjectDisposedException

This clock has been disposed.

Remarks

The output values are meaningful only on success. Add integer multiples of deltaBetweenPreferredStartTimes to both start times to calculate subsequent preferred start times in the near future.

Applies to