Class RokidFrameSource
- Namespace
- easyar
- Assembly
- EasyAR.Sense.Ext.Rokid.dll
A custom frame source that connects Rokid output to EasyAR input in the scene. It provides Rokid support through the custom camera feature of EasyAR Sense.
This frame source is a motion tracking device and outputs motion data in ARSession.
To use this frame source, ``Rokid Unity OpenXR Plugin (com.rokid.openxr)`` is required. You need to configure Rokid Unity OpenXR Plugin (com.rokid.openxr) according to the official documentation.
public class RokidFrameSource : ExternalDeviceMotionFrameSource- Inheritance
-
RokidFrameSource
- Inherited Members
Properties
CameraCandidate
public Camera CameraCandidate { get; set; }CameraFrameStarted
Provided only when creating a new frame source. It is accessed throughout the entire lifecycle of ARSession.
Whether camera frame input has started.
protected override bool CameraFrameStarted { get; }DeviceCameras
Provided only when creating a new frame source. It is accessed only when CameraFrameStarted is true.
The device cameras that provide camera frame data. If camera frame data is provided by multiple cameras, the list needs to contain all cameras.
Ensure that the value is correct when CameraFrameStarted is true.
protected override List<FrameSourceCamera> DeviceCameras { get; }Display
Provided only when creating a new frame source. It is accessed only during Assemble().
Provides display system information. You can use DefaultSystemDisplay or DefaultHMDDisplay to get default display information.
protected override IDisplay Display { get; }IsAvailable
Provided only when creating a new frame source. It is accessed only during Assemble().
Whether the current frame source is available.
If the value is null, CheckAvailability() will be called, and the value will be obtained after Coroutine ends.
protected override Optional<bool> IsAvailable { get; }IsHMD
Provided only when creating a new frame source. It is accessed only during Assemble().
Whether the current frame source is a head-mounted display. If it is, diagnostic information will be displayed on a 3D panel in front of the camera.
Some frame filters behave differently when running on the device.
protected override bool IsHMD { get; }OriginType
Device origin type.
protected override ExternalDeviceFrameSource.DeviceOriginType OriginType { get; }Methods
Awake()
protected override void Awake()LateUpdate()
protected virtual void LateUpdate()OnApplicationPause(bool)
protected override void OnApplicationPause(bool pause)Parameters
pause
OnDestroy()
protected override void OnDestroy()OnSessionStart(ARSession)
Provided only when creating a new frame source. It is accessed only during StartSession().
Handles session startup if this frame source has already been assembled into Assembly. This method is designed for lazy initialization. You can perform AR-specific initialization work in this method.
protected override void OnSessionStart(ARSession session)Parameters
session
OnSessionStop()
Provided only when creating a new frame source. It is accessed during StopSession(bool) or another session stop/damage process.
Handles session stop if this frame source has already been assembled into Assembly. You can use this method to destroy resources created by StartSession() and during session running and restore internal state. This method is guaranteed to be called before the session is destroyed. If the frame source is destroyed before the session, it will not be called and the session will be corrupted.
protected override void OnSessionStop()