get_control_rate


Description:

public ClockTime get_control_rate ()

Obtain the control-rate for this this.

Audio processing Element objects will use this rate to sub-divide their processing loop and call sync_values in between. The length of the processing segment should be up to control-rate nanoseconds.

If the this is not under property control, this will return CLOCK_TIME_NONE. This allows the element to avoid the sub-dividing.

The control-rate is not expected to change if the element is in PAUSED or PLAYING.

Parameters:

this

the object that has controlled properties

Returns:

the control rate in nanoseconds