Specifies an action to take place within an action set.
Syntax
VBScript call sequencerObj( "actionsetname" ).At( time, "script", [loop, interval, tiebreak, drop threshold] ) JScript sequencerObj.item( "actionsetname" ).At( time, "script", [loop, interval, tiebreak, drop threshold] );
Parameters
- actionsetname
- Name of the action set.
- time
- Required. Double value in seconds.milliseconds (SS.MSS) format. Sets the start time for the specified action.
- script
- Required. Text string identifying the named procedure to be called. Can pass parameters as part of the script call, for example, script(param1)
- loop
- Optional. Integer. Sets the loop count for this action. The default is 1. If set to 1, looping is infinite. Any negative number other than 1 will be treated as 0. Zero loop count value prevents execution. You can use this to programmatically halt action set execution.
- interval
- Optional. Double value in seconds.milliseconds (SS.MSS) format. Sets the delay between iterations of the specified action. Minimum interval resolution is 20 milliseconds (00.020). The default is 33 milliseconds (00.033), equivalent to 30 frames per second.
- tiebreak
- Optional. Integer whose value can be 1, 0, or a positive integer. The default is 1. Sets the priority for the action. In the event that two actions happen at the same time, the action with the lower tiebreak number will be performed first. Zero is the highest priority action that can be dropped; 1 is the lowest-priority action and will be executed last.
- drop threshold
- Optional. Double value in seconds.milliseconds (SS.MSS) format. Sets the time by which the action must be performed before it is dropped from the queue. The default value is for the action to never be dropped (1.000).
Remarks
The drop threshold value is useful for optimizing sequencer performance by streamlining the number of actions that the sequencer has to perform at any given moment, for instance, when starting up a complex action set. Thoughtful use of this value can keep the sequencer from slowing down or speeding up from backlog of actions to be executed, and keep the timing of actions within reasonable tolerances.
Top of Page
© 2000 Microsoft and/or its suppliers. All rights reserved. Terms of Use.