Class ExternalDeviceFrameSource

Namespace

easyar

Assembly

EasyAR.Sense.dll

Represents the frame source of an external device. Typically refers to a head-mounted device, where both camera rendering and device tracking are handled by the device SDK.

You can implement custom cameras by inheriting subtypes of ExternalDeviceFrameSource, but you cannot directly inherit from ExternalDeviceFrameSource. Custom cameras usually represent a new device or a new data input method.

When using trial products (Personal License, Trial XR License, or Trial Mega Service, etc.) with a custom camera or headset, EasyAR Sense will stop responding after a fixed limited time upon each startup.

public abstract class ExternalDeviceFrameSource : ExternalFrameSource

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

FrameSource

ExternalFrameSource

ExternalDeviceFrameSource

Derived

ExternalDeviceMotionFrameSource

ExternalDeviceRotationFrameSource

Inherited Members

ExternalFrameSource.ReceivedFrameCount

ExternalFrameSource.Awake()

ExternalFrameSource.OnApplicationPause(bool)

ExternalFrameSource.OnDestroy()

ExternalFrameSource.OnSessionStart(ARSession)

ExternalFrameSource.OnSessionStop()

ExternalFrameSource.TryAcquireBuffer(int)

FrameSource.IsHMD

FrameSource.Display

FrameSource.IsAvailable

FrameSource.CameraFrameStarted

FrameSource.DeviceCameras

FrameSource.CheckAvailability()

Properties

AvailableCenterMode

Providedonlywhencreatinganewframesource.ItisaccessedonlyduringtheAssembleprocessof.

Allcentermodesthatcanbeused.

protected override IReadOnlyList<ARSession.ARCenterMode> AvailableCenterMode { get; }

Camera

Providedonlywhencreatinganewframesource.ItisaccessedonlyduringtheAssembleprocessof.

Ondesktopdevicesorphones,thiscameracorrespondstotheinthevirtualworldthatrepresentsthecameradeviceintherealenvironment;itsprojectionmatrixandpositionwillcorrespondtotherealcamerasandbecontrolledbyEasyAR.Onheadsets,thiscameraisonlyusedtodisplaysomediagnostictextinfrontoftheeyesandisnotusedforrendering;thecameraisnotcontrolledbyEasyAR.

protected override Camera Camera { get; }

IsCameraUnderControl

Providedonlywhencreatinganewframesource.ItisaccessedonlyduringtheAssembleprocessof.

Whenthevalueistrue,thesessionwillupdatethecamera'stransformandrenderthecameraimage.

Whencreatingaheadsetextension,itshouldbefalse.Youshouldhavefullcontroloverthe3Dcamerainthescene.Youshouldhandlecamerarendering,especiallyinVSTmode.

protected override bool IsCameraUnderControl { get; }

Origin

Device origin. You need to define your own origin only when the OriginType is Custom; it is not necessary to redefine it otherwise.

protected virtual GameObject Origin { get; }

OriginType

Device origin type.

protected abstract ExternalDeviceFrameSource.DeviceOriginType OriginType { get; }