ClockController.SpeedRatio Property
Definition
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 or sets the interactive speed of the target Clock.
public:
property double SpeedRatio { double get(); void set(double value); };public double SpeedRatio { get; set; }member this.SpeedRatio : double with get, setPublic Property SpeedRatio As DoubleProperty Value
A finite value greater than zero that describes the interactive speed of the target clock. This value is multiplied against the value of the SpeedRatio of the clock's Timeline. For example, if the timeline's SpeedRatio is 0.5 and the ClockController object's SpeedRatio is 3.0, the timeline moves at 1.5 times normal speed (0.5 * 3.0). The default value is 1.0.
Remarks
Setting this property has no effect until the next tick. If you set this property and then get its value before the next tick occurs, you'll get the old value. This property will return the new value after the next tick.
Setting this property does not change the value of the underlying timeline's SpeedRatio.
Setting this property triggers the target clock's CurrentGlobalSpeedInvalidated event.
