Namespace easyar

Classes

APIExtend: Extend EasyAR Sense API and Unity API to facilitate operations such as data conversion.

APIKeyAccessData: Authentication data for EasyAR cloud services using API Key. For relevant data, please visit the EasyAR Developer Center (https://www.easyar.cn) to obtain.

ARAssembly: Assembly of AR components. It implements a typical assembly for all EasyAR Sense components.

In the scene, connect the ARCore output of AR Foundation to the custom frame source of EasyAR input. Provide AR Foundation support through the custom camera function of EasyAR Sense.

This frame source is a motion tracking device that outputs motion data in

To use this frame source, ``AR Foundation`` is required. You need to configure AR Foundation according to the official documentation.

ARCoreFrameSource

In the scene, control the ARCore camera device (easyar.ARCoreCameraDevice) of MonoBehaviour, providing function extensions in the Unity environment.

This frame source is a motion tracking device that will output motion data in ARSession.

AREngineFrameSource

Connect the output of the AREngine camera device to the custom frame source of EasyAR input in the scene. Provide Huawei AR Engine support through the custom camera function of EasyAR Sense.

This frame source is a motion tracking device that outputs motion data in ARSession.

This frame source does not use ``Huawei AR Engine Unity SDK`` and no addition is required.

ARFoundationFrameSource

In the scene, connect the output of AR Foundation to the custom frame source for EasyAR input. Provide AR Foundation support through the custom camera feature of EasyAR Sense.

This frame source is a motion tracking device that outputs motion data in ARSession.

To use this frame source, ``AR Foundation`` is required. You need to configure AR Foundation according to the official documentation.

ARKitARFoundationFrameSource

In the scene, connect the ARKit output of AR Foundation to a custom frame source for EasyAR input. Provide AR Foundation support through the custom camera feature of EasyAR Sense.

This frame source is a motion tracking device that outputs motion data in ARSession.

To use this frame source, ``AR Foundation`` is required. You need to configure AR Foundation according to the official documentation.

ARKitFrameSource

Controls the ARKit camera device (easyar.ARKitCameraDevice) in the scene, providing functional extensions in the Unity environment.

This frame source is a motion tracking device that outputs motion data in ARSession.

ARSession

Control the AR session in the scene MonoBehaviour. A session contains a set of components assembled into ARAssembly and controls the data flow throughout the lifecycle. This component is the entry point of AR. Multiple active instances are not allowed at the same time.

All functions of the EasyAR component must be used after StartSession().

The relative transform between Camera and some AR components is controlled by the session. One of the objects is called CenterObject, which does not move in the scene, and other objects move relative to this CenterObject. This object is selected according to the value of CenterMode. For more detailed instructions, refer to the description of ARSession.ARCenterMode.

ARSession.FlipOptions: Mirror rendering options.

ARSessionFactory: ARSession Factory.

ARSessionFactory.Resources: Create resources required for the corresponding component.

ActiveController

Manage activeSelf of MonoBehaviour.

The default strategy is as follows: TargetController by default uses ActiveWhileTracked, and XROriginChildController by default uses ActiveAfterFirstTracked.

Can be used to override the default strategy with OverrideStrategy. Setting MonoBehaviour.enabled to false can disable the control.

AppSecretAccessData: Authorization data for EasyAR cloud service using App Secret. Please visit the EasyAR Developer Center (https://www.easyar.cn) to obtain relevant data.

AssembleOptions: Assembly options for ARSession.

AssembleOptions.DeviceListDownload: Device list download options.

Buffer: Buffer stores a raw byte array, which can be used to access image data. In the Java API, you can get the buffer from Image_ and then copy the data to a Java byte array. In all versions of EasyAR Sense, you can access the image data. Refer to Image_.

BufferDictionary: A map from file paths to `Buffer`_. Used to represent multiple files held in memory.

BufferPool: BufferPool implements a memory pool that can be used for functions such as custom camera access which require repeatedly allocating memory of the same size, reducing memory allocation time.

CameraDeviceDisplay: Display of a regular camera. You can simulate screen rotation in the Unity Editor or on a PC to accommodate special screen placement requirements.

CameraDeviceFrameSource

在场景中控制easyar.CameraDevice的MonoBehaviour，在Unity环境下提供功能扩展。

这个frame source不是运动跟踪设备，在ARSession中不会输出运动数据。

CameraImageRenderer: Control the camera image rendering in the scene's MonoBehaviour. Only valid when the session's frame sourceIsCameraUnderControl is true.

CameraParameters: Camera parameters, including image size, focal length, principal point, camera type, and rotation angle of the camera relative to the device's natural orientation.

CloudLocalizerFrameFilter: Control in the scene and provide functional extensions in the Unity environment.

CloudRecognizationResponse: Response to the recognition request.

CloudRecognizerFrameFilter: In the scene to control the easyar.CloudRecognizer of the MonoBehaviour, provide function extension under the Unity environment.

DenseSpatialMapBlockController: Control in the scene easyar.DenseSpatialMap generated map grid blocks' MonoBehaviour.

DenseSpatialMapBuilderFrameFilter: Control in the scene the MonoBehaviour of DenseSpatialMap, providing function extensions in the Unity environment.

DeviceFrameSourceCamera: The device camera that provides camera frame data in Frame source.

DeviceFrameSourceCamera.CameraExtrinsics: Camera extrinsic parameters, generally a calibrated matrix, represent the physical offset of the camera's pose origin relative to the device/head.

DiagnosticsController: Current diagnostic controller. Make it your development partner rather than the first component to turn off.

DiagnosticsController.MessageOutputOptions: Message output options.

Display: Display device.

DisplayEmulator: Rotation simulator.

EasyARCameraImageRendererFeature: The render feature used to render camera images of AR devices when using URP. This render feature needs to be added to the renderer feature list of the forward renderer asset.

EasyARController: Static proxy of the EasyAR Sense Engine class, mainly used for Sense initialization.

EasyARSettings: EasyAR Sense Unity Plugin的配置信息。

EasyARSettings.LibVariantConfig: EasyAR Sense Library Variant Configuration.

EasyARSettings.Permission: Permission configuration.

EasyARSettings.TargetGizmoConfig: Target's Gizmos configuration.

EasyARSettings.TargetGizmoConfig.ImageTargetConfig: ImageTarget of Gizmos configuration.

EasyARSettings.TargetGizmoConfig.ObjectTargetConfig: ObjectTarget's Gizmos configuration.

EasyARSettings.UnityXROptions: Configuration items related to Unity XR Framework.

EasyARSettings.UnityXROptions.AutoSwitchOptions: Options to automatically switch Unity XR (such as AR Foundation) objects.

EasyARSettings.UnityXROptions.AutoSwitchOptions.EditorOptions: Edit mode options.

EasyARSettings.UnityXROptions.AutoSwitchOptions.PlayerOptions: Run mode options.

EasyARSettings.Workaround: Workaround for Unity.

EditorCameraDeviceFrameSource

Control in the editor easyar.CameraDevice of MonoBehaviour, only used for development diagnosis. Usually, all effects you see when this frame source is in use are different from running on the device. You can use it for application logic development unrelated to AR effects, but you cannot judge the effects of AR operation (detection, tracking, positioning, etc.) by it.

This frame source is not a motion tracking device and will not output motion data in ARSession.

EventDumpRecorder: Event Dump Recorder. Used to save some key diagnostic information into EED files. All members of this class are thread-safe.

ExplicitAddressAccessData: EasyAR Cloud Service authentication data that needs to fill in the access address.

ExternalDeviceFrameSource

Represents the frame source of an external device. Usually represents a head-mounted device, where camera rendering and device tracking are both done by the device SDK.

You can implement a custom camera by inheriting a subtype of ExternalDeviceFrameSource, but you cannot directly inherit ExternalDeviceFrameSource. A custom camera usually represents a new device or a new data input method.

When using trial products (personal license, trial XR license, or trial Mega service, etc.) on a custom camera or headset, EasyAR Sense will stop responding within a fixed limited time after each startup.

ExternalDeviceMotionFrameSource

Indicates the frame source of an external device with motion tracking capability. Usually refers to a head-mounted device, where camera rendering and device tracking are both completed by the device SDK.

This frame source is a motion tracking device that outputs motion data in ARSession.

You can inherit it to implement device input such as head-mounted displays, but you must complete the motion tracking function yourself. EasyAR's motion tracking cannot be directly used on external devices. You need to obtain image and pose data from hardware or other sources yourself and input them into EasyAR. EasyAR does not provide the ability to obtain these data, but provides the ability to run EasyAR functions after these data are input into EasyAR.

When using trial products (personal license, trial XR license, or trial Mega service, etc.) on custom cameras or head-mounted displays, EasyAR Sense will stop responding within a fixed limited time after each startup.

ExternalDeviceRotationFrameSource

Represents the frame source of an external device with 3DOF rotation tracking capability. Usually represents a head-mounted device where both camera rendering and device tracking are done by the device SDK.

This frame source is a 3DOF rotation tracking device that outputs rotation data in ARSession.

You can inherit it to implement head-mounted device and other device inputs, but you must complete the tracking function yourself. EasyAR's 3DOF rotation tracking cannot be directly used on external devices. You need to obtain image and rotation data from hardware or other places by yourself and input them to EasyAR. EasyAR does not provide the ability to obtain these data, but provides the ability to run EasyAR functions after inputting these data to EasyAR.

When using trial products (personal edition license, trial edition XR license or trial edition Mega service, etc.) on a custom camera or head-mounted device, EasyAR Sense will stop responding within a fixed limited time after each startup.

ExternalFrameSource

An external frame source represents a frame source not built-in by EasyAR Sense. It is used to support AR Engine, AR Foundation or headsets, and can also be used to define your own frame source.

You can implement a custom camera by inheriting from some subtypes of ExternalFrameSource, but you cannot directly inherit from ExternalFrameSource. A custom camera usually represents a new device or a new data input method.

When using trial products (personal license, trial XR license or trial Mega service etc.) on custom cameras or headsets, EasyAR Sense will stop responding within a fixed limited time after each startup.

ExternalImageStreamFrameSource

An external frame source that only receives image stream input.

This frame source is not a motion tracking device and will not output motion data in ARSession.

You can inherit it to implement a custom camera with only image input, which cannot be used to implement headset input. You need to obtain images from hardware or other places (such as a USB-connected Android camera) by yourself and input them into EasyAR. EasyAR does not provide the ability to obtain these data, but provides the ability to run EasyAR functions after inputting these data into EasyAR.

When using trial products (personal license, trial XR license or trial Mega service, etc.) on a custom camera or headset, EasyAR Sense will stop responding within a fixed limited time after each start.

FixedAddressAPIKeyAccessData: Authentication data for EasyAR cloud services using API Key. For relevant data, please visit the EasyAR Developer Center (https://www.easyar.cn) to obtain.

FrameFilter: A frame filter represents an EasyAR function that runs using frame input data.

FramePlayer

Control in the scene and easyar.InputFramePlayer and easyar.VideoInputFramePlayer's MonoBehaviour, providing function extensions in the Unity environment.

It will be used when FrameSource is FramePlayer or when 'Frame Player' is selected in the 'Session Validation Tool' in the inspector of DiagnosticsController on the editor.

FrameRecorder: Control the easyar.InputFrameRecorder and easyar.VideoInputFrameRecorder in the scene, providing functional extensions in Unity environment.

FrameRecorder.RecordFinishEvent: The event when recording ends. The callback parameter is false when recording errors.

FrameRecorder.RecordStartEvent: Recording start event. The callback parameter is the recorded file name.

FrameRecorder.RecordingConfiguration: Recording configuration..

FrameRecorder.RecordingConfiguration.FilePathInfo: File path information. The recording file path is Path.Combine(Application.persistentDataPath, FolderPath, Name + extension) when Type is PersistentDataPath, and Path.Combine(FolderPath, Name + extension) when Type is Absolute. Here, extension is determined by Format.

FrameSource

A frame source represents the data source of frame input data, which provides image data or motion data at the same time.

You can implement a custom camera by inheriting some subtypes of FrameSource, but you cannot inherit FrameSource directly. A custom camera usually represents a new device or a new data input method.

When using trial products (personal license, trial XR license, or trial Mega service, etc.) on a custom camera or headset, EasyAR Sense will stop responding for a fixed limited time each time it starts.

FrameSourceCamera: The camera that provides camera frame data in Frame source.

Image

Image stores image data to represent an image in memory. Image provides access to raw data in the form of a byte array and also provides interfaces to access information such as width/height. Image data can be accessed in all versions of EasyAR Sense.

To access it in iOS, you can do the following:
::

    #import <easyar/buffer.oc.h>
    #import <easyar/image.oc.h>

    easyar_OutputFrame * outputFrame = [outputFrameBuffer peek];
    if (outputFrame != nil) {
        easyar_Image * i = [[outputFrame inputFrame] image];
        easyar_Buffer * b = [i buffer];
        char * bytes = calloc([b size], 1);
        memcpy(bytes, [b data], [b size]);
        // use bytes here
        free(bytes);
    }

To access it in Android, you can do the following:
::

    import cn.easyar.*;

    OutputFrame outputFrame = outputFrameBuffer.peek();
    if (outputFrame != null) {
        InputFrame inputFrame = outputFrame.inputFrame();
        Image i = inputFrame.image();
        Buffer b = i.buffer();
        byte[] bytes = new byte[b.size()];
        b.copyToByteArray(0, bytes, 0, bytes.length);
        // use bytes here
        b.dispose();
        i.dispose();
        inputFrame.dispose();
        outputFrame.dispose();
    }

ImageHelper: Image helper class.

ImageMaterial: Material for renderingImage.

ImageTarget: ImageTarget represents the target of a planar image, which can be tracked by `ImageTracker`_. The values in ImageTarget need to be filled in first through methods like create... before they can be read. Then, after successfully loading `ImageTracker`_ through `ImageTracker.loadTarget`, it can be detected and tracked by `ImageTracker`_.

ImageTargetController

Control the ImageTarget's MonoBehaviour in the scene, providing function extension in the Unity environment. After successful loading, you can use Target to access target data.

The target's data is loaded separately. Loading will occur after the session starts successfully. It will only be fully loaded once in the lifecycle. If the session stops halfway through loading, it will be loaded again after the next session starts.

ImageTargetController.ImageFileSourceData: Create image data for target.

ImageTargetController.SourceData: Create data for target.

ImageTargetController.TargetDataFileSourceData: Create target data for the target. Target name and scaling are defined in the etd file.

ImageTargetController.TargetSourceData: Create target's ImageTarget data.

ImageTargetController.Texture2DSourceData: Create the Texture2D data.

ImageTargetParameters: ImageTargetParameters represents the parameters required to create the `ImageTarget`_.

ImageTrackerFrameFilter: In the scene, control the easyar.ImageTracker's MonoBehaviour to provide function extension in the Unity environment.

InertialCameraDeviceFrameSource

Control the easyar.InertialCameraDevice's MonoBehaviour in the scene to provide function extensions in the Unity environment.

This frame source is a 5DOF (rotation + horizontal displacement) tracking device that outputs motion data in ARSession.

InputFrame: Input frame. Contains image, camera parameters, timestamp, camera transformation relative to world coordinate system, and tracking status. Among them, camera parameters, timestamp, camera transformation relative to world coordinate system, and tracking status are all optional, but specific algorithm components have specific requirements for the input.

MegaLandmarkFilterResponse: Response of Mega Landmark filter request.

MegaLandmarkFilterWrapper: Mega Landmark VPS cloud location filtering function.

MegaLocalizationResponse: Response to Mega positioning request.

MegaRequestTimeParameters: Mega request time parameter.

MegaResultPoseTypeParameters: Mega result pose type parameter.

MegaTrackerFrameFilter: Control the easyar.MegaTracker in the scene, and provide functional extensions in the Unity environment.

MotionInputData: Motion input data. Contains, timestamp, transformation relative to the world coordinate system, and tracking status.

MotionTrackerFrameSource: In the scene, control easyar.MotionTrackerCameraDevice of MonoBehaviour, and provide function extension in the Unity environment.

ObjectTarget: ObjectTarget represents a 3D object target, which can be tracked by `ObjectTracker`_ The size of ObjectTarget is determined by the `obj` file. You can modify the size by changing the `scale`. The default value of `scale` is 1. After ObjectTarget is successfully loaded into `ObjectTracker` via `ObjectTracker.loadTarget`, it can be detected and tracked by `ObjectTracker`

ObjectTargetController

Control the ObjectTarget in the scene and the MonoBehaviour, providing function extension in the Unity environment. After successful loading, you can use Target to access target data.

The target data will be loaded separately. Loading will occur after the session starts successfully. It will be fully loaded only once in its lifecycle. If the session stops halfway through loading, it will be loaded again when the next session starts.

ObjectTargetController.ObjFileSourceData: Create obj file data for target.

ObjectTargetController.SourceData: Create data for target.

ObjectTargetController.TargetSourceData: Create the target'sObjectTargetdata.

ObjectTargetParameters: ObjectTargetParameters represents the parameters required to create the `ObjectTarget`_

ObjectTrackerFrameFilter: Control the easyar.ObjectTracker of MonoBehaviour in the scene, and provide functional extensions in the Unity environment.

PicoFrameSource

Connect Pico's output to the custom frame source of EasyAR input in the scene. Provide Pico support through the custom camera function of EasyAR Sense.

This frame source is a motion tracking device that outputs motion data in ARSession.

To use this frame source, the ``PICO Unity Integration SDK`` is required. You need to configure the PICO Unity Integration SDK according to the official documentation.

PoseUtility

RefBase

RokidFrameSource

Connect Rokid's output to the custom frame source of EasyAR input in the scene. Provide Rokid support through the custom camera feature of EasyAR Sense.

This frame source is a motion tracking device that outputs motion data in 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.

SenseLibrary: Tool to get EasyAR Sense library information.

ServiceAccessData: EasyAR Cloud Service Authentication Data

SessionReport: Session report. Used to query component availability or the reasons for session loss, etc.

SessionReport.AvailabilityReport: Availability Report

SessionReport.AvailabilityReport.DeviceListDownloadResult: Device list download result.

SessionReport.AvailabilityReport.Item: Usability item.

SessionReport.SessionBrokenException: Session damage specific exception.

SparseSpatialMapBuildTargetController: Control the map generated by easyar.SparseSpatialMap in the scene for the MonoBehaviour.

SparseSpatialMapBuilderFrameFilter: Control the easyar.SparseSpatialMap in the scene, and provide the mapping function of easyar.SparseSpatialMap.

SparseSpatialMapController: The MonoBehaviour of the map tracked by easyar.SparseSpatialMap in the scene.

SparseSpatialMapController.MapManagerSourceData: Source of MapManager for creating the map.

SparseSpatialMapController.SourceData: Create data for target.

SparseSpatialMapController.SparseSpatialMapInfo: Sparse map information.

SparseSpatialMapPointCloudRenderer: Render sparse spatial map point cloud into particles.

SparseSpatialMapPointCloudRenderer.PointCloudParticleParameter: Parameters for rendering point cloud particles.

SparseSpatialMapTrackerFrameFilter: Control the MonoBehaviour of in the scene, providing the localization and tracking function of

SparseSpatialMapWorkerFrameFilter: Control the UnityEngine.MonoBehaviour under the easyar.SparseSpatialMap in the scene, and provide function extensions in the Unity environment.

SurfaceTargetController: Control the surface target's MonoBehaviour in the scene. The surface target is a virtual node that represents the relative node of camera movement in surface tracking.

SurfaceTrackerFrameFilter: Control the easyar.SurfaceTracker's MonoBehaviour in the scene, and provide functional extensions in the Unity environment.

Target: Target is the base class of all targets in EasyAR that can be tracked by `ImageTracker`_ or other algorithms.

TargetController: Control the tracking target in the scene MonoBehaviour, provide functional extensions in the Unity environment.

ThreeDofCameraDeviceFrameSource

Control a 3DOF camera device (ThreeDofCameraDeviceFrameSource) in the scene, an MonoBehaviour that provides function extension under the Unity environment.

This frame source is a 3DOF rotation tracking device that outputs rotation data in an ARSession.

TokenAccessData: Authentication data for EasyAR Cloud Service using Token. For relevant data, please visit the EasyAR Developer Center (https://www.easyar.cn) to obtain it.

UnityPackage: Tool for getting package information.

VideoRecorder

Control the Recorder in the scene via MonoBehaviour, providing functional extensions in the Unity environment.

The user has full control over the content of video recording. The screen recording function will not silently record the screen or camera output. The recorded video data needs to be continuously passed through RecordFrame(RenderTexture).

Note: Available only in non-enterprise Sense, Android GLES2/3, and when multi-threaded rendering is disabled.

VideoRecorder.AudioProfiles: Audio Configuration.

VideoRecorder.VideoProfiles: Video Configuration

VisionOSARKitFrameSource

In the scene, control the VisionOS ARKit camera device (easyar.VisionOSARKitCameraDevice) of MonoBehaviour, providing function expansion in the Unity environment.

This frame source is a motion tracking device that outputs motion data in ARSession.

When using trial products (personal license, trial XR license, or trial Mega service, etc.) on custom cameras or headsets, EasyAR Sense will stop responding within a fixed limited time each time it starts up.

XREALFrameSource

Control the XREAL camera device (easyar.XREALCameraDevice) in the scene. The MonoBehaviour provides functionality expansion in the Unity environment.

This frame source is a motion tracking device that outputs motion data in ARSession.

When using trial products (personal license, trial XR license, or trial Mega service, etc.) on a custom camera or headset, EasyAR Sense stops responding within a fixed limited time each time it starts.

XROriginChildController

Act as the root node of the XROrigin child object that needs to be controlled in the scene

XROrigin is a virtual node that represents the relative node for camera movement in a motion tracking system. It will be automatically selected or created. If the XROrigin of the Unity XR framework exists, it will be selected.

Structs

ARSessionFactory.FrameSourceSortMethod: Frame source sorting method.

BlockInfo

The model obtained by dense reconstruction uses a triangular mesh representation, called a mesh. Since the mesh is frequently updated, to ensure efficiency, the mesh of the entire reconstruction model is divided into many mesh blocks. A mesh block consists of a cube with a side length of about 1 meter, and has elements such as vertices and indices.

 BlockInfo describes the content of a mesh block. The (x, y, z) are the indices of the mesh block. Multiplying (x, y, z) by the physical size of each mesh block can obtain the origin coordinates of this mesh block in the world coordinate system. The parts that need to be displayed can be pre-filtered through the position of the mesh block in the world to save rendering time.
 </p>

Matrix33F: 3x3 square matrix. The data is arranged in row-major.

Matrix44F: 4x4 square matrix. Data is arranged in row-major order.

Optional<T>

ProximityLocationResult

Adjacent position reading.

 x, y, z are in meters. The origin is the map block origin. y is upward.
 accuracy is in meters.
 timestamp, validTime are in seconds.
 is2d means whether y is not used.
 </p>

Unit

Vec2F: 2D float vector.

Vec2I: Two-dimensional int vector.

Vec3F: 3D float vector.

Vec4F: Four-dimensional float vector.

Interfaces

IDisplay: Display device interface.

Enums

ARCoreCameraDeviceFocusMode

AREngineCameraDeviceFocusMode

ARKitCameraDeviceFocusMode

ARSession.ARCenterMode

AR Center Mode.

*Note: There are a total of four center modes in the EasyAR Sense Unity Plugin. There may be no similar concept in other AR frameworks such as AR Foundation. Usually, the behavior of the relative relationship between objects in them is consistent with the *SessionOrigin* mode here.

Camera and the relative transform between a part of AR components are controlled by the session. One of the objects is called CenterObject, which does not move in the scene, and other objects move relative to this CenterObject. This object is selected according to the value of CenterMode.

CenterObject indicates an object that does not move in the Unity space or the parent node of this object. It may be Origin, Camera or a certain `target`. `Target` can be an object containing TargetController or BlockRootController components. When using sparse spatial maps and EasyAR Mega, the actual center GameObject is the map or block object specifically located under the root node, and CenterObject is the parent node of this object.

In the *FirstTarget* or SpecificTarget mode, when `target` is not recognized or lost in a certain frame, CenterObject may become other `target`. And if `target` is not found in the frame, CenterObject will degenerate into the center of the first available mode in SessionOrigin and Camera in sequence.

The relative position relationship between `Target` and Camera is controlled by the current session. The relative position relationship between Origin and Camera is also controlled by the current session when IsCameraUnderControl is true. When IsCameraUnderControl is false, it is not controlled by the current session and is usually controlled by other AR frameworks such as AR Foundation.

ARSession.ARHorizontalFlipMode

Horizontal mirror rendering mode.

In horizontal flip state, the camera image will be displayed mirrored. To ensure normal object tracking, it will also affect the rendering of 3D objects, thus providing two different methods. Horizontal flip can only work under object perception (such as image tracking or object tracking) algorithms.

ARSession.SessionState: The state of the Session.

ARSessionFactory.ARSessionPreset: ARSession Preset.

ARSessionFactory.FrameSourceSortMethod.ARCoreSortMethod: The sorting method of the ARCore/ARCoreARFoundation frame source.

ARSessionFactory.FrameSourceSortMethod.ARKitSortMethod: Sorting method of ARKit/ARKitARFoundation frame source.

ARSessionFactory.FrameSourceSortMethod.MotionTrackerSortMethod: The sorting method of the EasyAR motion tracker/System SLAM (ARCore, ARKit, AREngine) frame source.

ActiveController.Strategy: activeSelf control strategy.

AndroidCameraApiType

AssembleOptions.FrameFilterSelection: SelectFrameFilter's selection strategy.

AssembleOptions.FrameSourceSelection: Select the selection strategy of FrameSource.

AxisSystemType: Coordinate System Type.

CameraDeviceDisplay.DisplayMode: Display mode.

CameraDeviceFocusMode

CameraDeviceFrameSource.CameraDeviceOpenMethod: easyar.CameraDeviceOpening method.

CameraDevicePreference

CameraDeviceType: Camera device type.

CameraModelType: Camera model type.

CameraState

CameraTransformType: Camera transformation type.

CloudRecognizationStatus

CloudRecognizerFrameFilter.ServiceAccessSourceType: Service access data source type.

DiagnosticsController.DeveloperModeSwitchType: Developer mode switch type.

DiagnosticsController.MessageOutputMode: Message output mode.

DiagnosticsController.SessionDumpOutputMode: Session state dump output mode.

DisplayEmulator.RotationMode: Rotation Mode.

EasyARSettings.ARCoreType: ARCore SDK Configuration.

EasyARSettings.AREngineType: AREngine SDK configuration.

EasyARSettings.LibVariantConfig.AndroidVariant: EasyAR Sense Android library variant.

EasyARSettings.LibVariantConfig.IOSVariant: EasyAR Sense iOS library variant.

ExternalDeviceFrameSource.DeviceOriginType

Device origin type.

Session origin is used to set the transform reference point in the SessionOrigin center mode, and to transform the camera-origin pair simultaneously in other center modes. If your SDK is designed based on the Unity XR framework, you will be familiar with XR.CoreUtils.XROrigin. Origin is similar to XR.CoreUtils.XROrigin, with the render camera as its child node. Users can move the origin in the scene without losing the local motion relationship defined by the camera-origin pair. EasyAR will use the camera-origin pair to handle the target center mode, which is especially useful when running Mega, as Mega defines the real-world coordinate system of the entire Earth, and the camera-origin pair typically defines the VIO coordinate system relative to a starting point.

FrameRecorder.InternalFormat: Internal data format.

FrameRecorder.RecorderStatus: Recording status.

ImageTrackerMode

InertialCameraDeviceFocusMode

LocalizationMode

LogLevel

MegaApiType: MEGA API type.

MegaInputFrameLevel: Equivalent degrees of freedom of the input frame when using the Mega function CameraTransformType.

MegaLandmarkFilterStatus

MegaLocationInputMode: Mega position input mode.

MegaServiceAccessSourceType: Mega service access data source type.

MegaTrackerLocalizationStatus

MotionTrackerCameraDeviceFPS

MotionTrackerCameraDeviceFocusMode

MotionTrackerCameraDeviceQualityLevel

MotionTrackerCameraDeviceResolution

MotionTrackerCameraDeviceTrackingMode

MotionTrackingStatus: Describes the quality of the device's motion tracking.

OptionalTag

PathType: Path type.

PermissionStatus

PixelFormat: PixelFormat denotes the image pixel format. The pixel orientation of all formats is left-to-right and top-to-bottom.

SessionReport.AvailabilityReport.AvailabilityStatus: Availability status.

SessionReport.AvailabilityReport.DeviceListDownloadStatus: Download list status

SessionReport.AvailabilityReport.DeviceListDownloadType: The component type of the download list.

SessionReport.SessionBrokenReason: Reasons for Session Damage

SparseSpatialMapWorkerFrameFilter.ServiceAccessSourceType: Service access data source type.

StorageType: StorageType indicates the storage location of images, json files, videos, or other files. StorageType specifies the root directory where files are stored, and you can use relative paths relative to this root directory in all related interfaces.

ThreeDofCameraDeviceFocusMode

VideoRecorder.RecordProfile: Video configuration.

VideoRecorder.RecordZoomMode: Video scaling mode.

VideoRecorder.VideoOrientation: Screen recording video orientation.

VideoRecorder.VideoSize: Video size

WritablePathType: File output path type.

Table of Contents

Namespace easyar

Classes

Structs

Interfaces

Enums