FrameSource Class¶

Description¶

Abstracts frame source, used when assemble, to provide input frame data to the algorithms.

MonoBehaviour Messages¶

protected virtual void Awake()

protected virtual void OnEnable()

protected virtual void OnDisable()

Properties¶

Type¶

C#: public virtual abstract Optional< InputFrameSourceType > Type { get; }

Frame source type. Usually can be used only after device created.

IsAvailable¶

C#: public virtual abstract Optional<bool> IsAvailable { get; }

If the frame source is available.

If the value equals null, FrameSource.CheckAvailability must be called and the value can be accessed after Coroutine finish. This property is used by ARComponentPicker when picking frame source.

AvailableCenterMode¶

C#: public virtual IReadOnlyList< ARSession.ARCenterMode > AvailableCenterMode { get; }

Available center mode of the frame source.

Camera¶

C#: public virtual Camera Camera { get; set; }

Camera used by the frame source in an ARSession .

Each type of frame source has its own method to check if the camera is usable, and will reject value set if the camera is not usable by the frame source. This property is used by ARComponentPicker when picking frame source to determine if the frame source is available, and some frame source will automatic pick a usable Camera from active objects in the scene in the process if the value is not set. You can set this value to a usable Camera before session start. The value cannot be changed after ARSession is ready if the frame source is selected in the session.

Origin¶

C#: public virtual GameObject Origin { get; }

Origin of ARSession if the frame source can output motion tracking data.

Each type of motion tracking frame source has its own method to set the origin object containing some specific component. Some frame source will automatic pick a usable object from active objects in the scene or generate an object if the value is not set.

Methods¶

IsCustomCamera¶

C#: public static bool IsCustomCamera(FrameSource source)

If the frame source is custom camera.

All user defined frame sources are treated as custom camera. AR Engine, Nreal and ARFoundation support are also implemented as custom camera.

For personal edition, you can use custom camera 100 seconds per run.

CheckAvailability¶

C#: public virtual System.Collections.IEnumerator CheckAvailability()

Coroutine to check frame source availability when FrameSource.IsAvailable equals null.