Return the archiving sub-sampling interval in frames.

Arguments: (none)

(none)

Example 1:

The following example shows an example of how a command can restore the previous archive interval after changing it temporarily.

  command fire_noise_cal() {
    Count old = $archiving_interval
    archive interval=1
    noise_cal on
    until $elapsed > 10s
    archive combine=$old
  }

Context:

This function is intended for library commands that need to change the archiving interval termporarily, then restore it to its original value before returning to the caller.