Class RokidFrameSource

Namespace

easyar

Assembly

EasyAR.Sense.Ext.Rokid.dll

Connects Rokid's output to EasyAR's input as a custom frame source in the scene. Provides Rokid support through EasyAR Sense's custom camera capabilities.

This frame source is a motion-tracking device that outputs motion data within the ARSession.

To use this frame source, the ``Rokid Unity OpenXR Plugin (com.rokid.openxr)`` is required. You need to configure the Rokid Unity OpenXR Plugin according to the official documentation.

public class RokidFrameSource : ExternalDeviceMotionFrameSource

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

FrameSource

ExternalFrameSource

ExternalDeviceFrameSource

ExternalDeviceMotionFrameSource

RokidFrameSource

Inherited Members

ExternalDeviceMotionFrameSource.HandleRenderFrameData(double, Pose, MotionTrackingStatus)

ExternalDeviceMotionFrameSource.HandleCameraFrameData(DeviceFrameSourceCamera, double, Image, CameraParameters, Pose, MotionTrackingStatus)

ExternalDeviceFrameSource.AvailableCenterMode

ExternalDeviceFrameSource.IsCameraUnderControl

ExternalDeviceFrameSource.Camera

ExternalDeviceFrameSource.Origin

ExternalFrameSource.ReceivedFrameCount

ExternalFrameSource.TryAcquireBuffer(int)

FrameSource.CheckAvailability()

Properties

CameraCandidate

public Camera CameraCandidate { get; set; }

CameraFrameStarted

Providedonlywhencreatinganewframesource.Itisaccessedthroughouttheentirelifecycleof.

Whetherthecameraframehasstartedinput.

protected override bool CameraFrameStarted { get; }

DeviceCameras

Providedonlywhencreatinganewframesource.Itisaccessedwhenistrue.

Thedevicecamerathatprovidesthecameraframedata.Ifthecameraframedataisprovidedbymultiplecameras,thelistshouldincludeallofthem.

Ensurethatthevalueiscorrectwhenistrue.

protected override List<FrameSourceCamera> DeviceCameras { get; }

Display

Providedonlywhencreatinganewframesource.ItisaccessedonlyduringtheAssembleprocessof.

Providesdisplaysysteminformation.Youcanuseortoobtaindefaultdisplayinformation.

protected override IDisplay Display { get; }

IsAvailable

Providedonlywhencreatinganewframesource.ItisaccessedonlyduringtheAssembleprocessof.

Whetherthecurrentframesourceisavailable.

Ifthevalueisnull,willbecalled,andthevaluewillbeobtainedaftertheends.

protected override Optional<bool> IsAvailable { get; }

IsHMD

Providedonlywhencreatinganewframesource.ItisaccessedonlyduringtheAssembleprocessof.

Whetherthecurrentframesourceisaheadset.Ifitisaheadset,diagnosticinformationwillbedisplayedona3Dboardinfrontofthecamera.

Someframefiltersmayoperatedifferentlyonthedevice.

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)

Providedonlywhencreatinganewframesource.ItisaccessedonlyduringtheStartSessionprocessof.

Handlessessionstartupifthisframesourcehasbeenassembledinto.Thismethodisdesignedforlazyinitialization;youcanperformAR-specificinitializationworkinthismethod.

protected override void OnSessionStart(ARSession session)

Parameters

session

OnSessionStop()

Providedonlywhencreatinganewframesource.Itisaccessedduringorothersessionsessionstop/corruptionprocesses.

Handlessessionstopifthisframesourcehasbeenassembledinto.Youcanusethismethodtodestroyresourcescreatedduringandsessionoperationandrestoreinternalstate.Thismethodisguaranteedtobecalledbeforesessiondestruction.Iftheframesourceisdestroyedbeforethesession,itwillnotbecalled,andthesessionwillbecorrupted.

protected override void OnSessionStop()