InputFrameThrottler Class¶

This type is an EasyAR Sense API in C#: InputFrameThrottler . Some descriptions may not apply to Unity environment on this page.

This type is fully wrapped into Unity components: ARAssembly . There is no need to use this type directly.

Description¶

Input frame throttler.

There is a input frame input port and a input frame output port. It can be used to prevent incoming frames from entering algorithm components when they have not finished handling previous workload.

InputFrameThrottler occupies one buffer of camera. Use setBufferCapacity of camera to set an amount of buffers that is not less than the sum of amount of buffers occupied by all components. Refer to Overview .

All members of this class is thread-safe.

It shall be noticed that connections and disconnections to signalInput shall not be performed during the flowing of data, or it may stuck in a state that no frame can be output. (It is recommended to complete dataflow connection before start a camera.)

Methods¶

input¶

C#: public virtual InputFrameSink input()

Input port.

bufferRequirement¶

C#: public virtual int bufferRequirement()

Camera buffers occupied in this component.

output¶

C#: public virtual InputFrameSource output()

Output port.

signalInput¶

C#: public virtual SignalSink signalInput()

Input port for clearance signal.

create¶

C#: public static InputFrameThrottler create()

Creates an instance.