Timing Provider API¶
see Timing Provider
-
class
TimingProvider
()¶ Abstract constructor function for timing provider object
Returns object timingProvider: -
TimingProvider.
vector
¶ Get current state vector of timing provider
Returns object vector: current state vector of timing provider.
-
TimingProvider.
skew
¶ Get current skew of timing provider clock - relative to local clock
Returns float skew: current skew
-
TimingProvider.
range
¶ Get current range restrictions of timing provider
Returns Array range: range of timing provider, [low, high]
-
TimingProvider.
update
(vector)¶ Request update to current state vector of timing provider
Arguments: - vector (object) –
update vector
Update vectors may be partially complete. For instance, to change the position, only the new position must be given.
- vector (object) –
-
TimingProvider.
on
(type, callback)¶ Register callback on timingprovider event. Support for Initial Events is not required. Supported eventtypes: skewchange and vectorchange
Arguments: - type (string) – event type
- callback (function) – event callback
-