RayNeo Developer Documentation

https://rayneo-en.gitbook.io/rayneo-devdoc
Admin
RayNeo Developer Documentation provides comprehensive guides and APIs for developing applications...
Tokens:5,768
Snippets:74
Trust Score:9.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Query Documentation Dynamically

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid/device-monitoring

Perform an HTTP GET request with the 'ask' query parameter to dynamically query the documentation for additional information or clarification.

```http
GET https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid/device-monitoring.md?ask=<question>
```

--------------------------------

### Perform HTTP GET Request with 'ask' Parameter

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Use this method to query documentation dynamically. The 'ask' parameter should contain a specific, self-contained question in natural language. The response includes the answer and relevant excerpts.

```http
GET https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule.md?ask=<question>
```

--------------------------------

### Perform HTTP GET Request to Query Documentation

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series

Use this method to ask questions about the documentation when information is not directly available. The question should be specific and self-contained.

```http
GET https://rayneo-en.gitbook.io/rayneo-devdoc/x-series.md?ask=<question>
```

--------------------------------

### Get Glasses Quaternion

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Obtains the 3DoF quaternion information for the current glasses. Returns the Quaternion value representing the current attitude of the glasses.

```csharp
Quaternion GetGlassesQualternion()
```

--------------------------------

### Android Sends Message to Unity

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/android-and-unity-communication

Call this interface in your Android code to send a command response to Unity. Ensure eventType values are registered and do not use reserved values; starting with 1000 is recommended.

```reasonml
AirApi.ins().onCommandRespToUnity(int eventType, String params);
```

--------------------------------

### Get Interpupillary Distance

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Retrieves the interpupillary distance. Returns pupil distance values typically between 60 and 70.

```csharp
float GetInterpupilDistance()
```

--------------------------------

### Obtain NativeModule Instance

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Provides instructions on how to obtain an instance of the NativeModule.

```APIDOC
## Static Public Field

<table><thead><tr><th width="112">Name</th><th width="340">Function</th></tr></thead><tbody><tr><td>Instance</td><td>Obtain NativeModule instance</td></tr></tbody></table>
```

--------------------------------

### Enable Device Monitoring via ADB

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid/device-monitoring

Use this ADB command to enable the system monitoring service. Replace {X} with the appropriate value defined in SystemMonitoringInfoType.

```bash
adb shell am start-foreground-service -n com.ffalcon.rayneo.systemwindows/.FloatingButtonService --el type {X}
```

--------------------------------

### SDKWebview Instance

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/sdkwebview

Obtain the singleton instance of the SDKWebView.

```APIDOC
## Ins

### Description
Obtain the singleton instance of the SDKWebView.

### Usage
```csharp
SDKWebView.Ins
```
```

--------------------------------

### ShowWebView

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/sdkwebview

Opens a webview with a specified title and URL.

```APIDOC
## ShowWebView(string title, string url)

### Description
Opens a webview with the provided title and URL.

### Method
```csharp
Void ShowWebView(string title, string url)
```

### Parameters
* **title** (string) - The title to display for the webview.
* **url** (string) - The URL to load in the webview.
```

--------------------------------

### Enable System Monitoring

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid/app-device-monitoring

Enable specific system monitoring types, such as instantaneous and average current. Ensure you have read the Device Monitoring documentation before use.

```csharp
SystemMonitoring.OpenSystemMonitoring(SystemMonitoring.SystemMonitoringInfoType.ELECTRIC | SystemMonitoring.SystemMonitoringInfoType.AVERAGE_ELECTRIC);
```

--------------------------------

### OpenSystemMonitoring

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid/app-device-monitoring

Enables system monitoring for specified metrics. You can enable instantaneous current and average current monitoring by combining SystemMonitoringInfoType flags.

```APIDOC
## OpenSystemMonitoring

### Description
Enables system monitoring for specified metrics.

### Method Signature
`static void OpenSystemMonitoring(long SystemMonitoringInfoType)`

### Parameters
*   **SystemMonitoringInfoType** (long) - A bitmask representing the types of monitoring to enable. Use flags like `SystemMonitoring.SystemMonitoringInfoType.ELECTRIC` and `SystemMonitoring.SystemMonitoringInfoType.AVERAGE_ELECTRIC`.

### Example
```csharp
SystemMonitoring.OpenSystemMonitoring(SystemMonitoring.SystemMonitoringInfoType.ELECTRIC | SystemMonitoring.SystemMonitoringInfoType.AVERAGE_ELECTRIC);
```
```

--------------------------------

### Add Package Query to Manifest

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid/app-device-monitoring

This XML configuration is required in your Android manifest to enable device monitoring functionalities.

```xml
<queries>
  <package android:name="com.ffalcon.rayneo.systemwindows" />
 </queries>
```

--------------------------------

### System Monitoring Info Types

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid/app-device-monitoring

Defines constants for various system monitoring information types. Use these flags to specify what data to collect.

```csharp
public const long FULL = 0;
public const long ELECTRIC = 1 << 0;
public const long AVERAGE_ELECTRIC = 1 << 1;
public const long BATTERY_CAPACTIY = 1 << 2;
```

--------------------------------

### Set Luminance Mode

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Sets the screen brightness. The 'mode' parameter corresponds to brightness levels: 1 (darkest), 2, 0, 3 (brightest).

```csharp
static void SetLuminanceMode(int mode)
```

--------------------------------

### GetGlobalCpuTemperature

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid

Retrieves the current global CPU temperature.

```APIDOC
## GetGlobalCpuTemperature

### Description
Get current CPU temperature.

### Method
N/A (Static Public Member Function)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **Float** - The current CPU temperature.
```

--------------------------------

### SetScreenBrightness

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid

Sets the screen brightness to a specified level.

```APIDOC
## SetScreenBrightness

### Description
Set screen brightness. 0-1.

### Method
N/A (Static Public Member Function)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **percent** (float) - Required - The desired brightness level (0.0 to 1.0).

### Request Example
N/A

### Response
#### Success Response (200)
None (void function)

#### Response Example
N/A
```

--------------------------------

### Apply 3D Effect to Left and Right Views

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/android-sdk/capabilities-and-api/3d-effect-implementation

Use this method to apply the 3D effect to both left and right views simultaneously. Ensure the views and depth parameters are correctly provided.

```java
// Apply 3D effect to both left and right views simultaneously
make3DEffect(left.slideView, right.slideView, true, 10f)
```

--------------------------------

### GetScreenBrightness

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid

Retrieves the current screen brightness level.

```APIDOC
## GetScreenBrightness

### Description
Get current brightness.

### Method
N/A (Static Public Member Function)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **Float** - The current screen brightness (0.0 to 1.0).
```

--------------------------------

### SetLuminanceMode(int mode)

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Sets the screen brightness mode. Different integer values correspond to different brightness levels.

```APIDOC
## SetLuminanceMode(int mode)

### Description
Set screen brightness.

### Parameters
#### Path Parameters
- **mode** (int) - Description: Enter the corresponding numbers, from darkest to brightest: 1, 2, 0, 3.
```

--------------------------------

### CurActivity

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid

Retrieves the current Android Activity instance.

```APIDOC
## CurActivity

### Description
Get the current Activity.

### Method
N/A (Static Public Member Function)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **AndroidJavaObject** - The current Android Activity object.
```

--------------------------------

### Activate FOV Control View

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Shows and hides the camera FOV interface UI on the home screen. Use 'true' to activate and 'false' to deactivate.

```csharp
void ActiveFovControlView(bool active)
```

--------------------------------

### SetGlassLegTouchEventExchange

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid

Controls whether to swap temple interaction events.

```APIDOC
## SetGlassLegTouchEventExchange

### Description
Set whether to swap temple interaction events.

### Method
N/A (Static Public Member Function)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **isExchanged** (bool) - Required - Controls whether to swap events. `false`: do not swap; `true`: swap.

### Request Example
N/A

### Response
#### Success Response (200)
None (void function)

#### Response Example
N/A
```

--------------------------------

### ActiveFovControlView(bool active)

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Controls the visibility of the camera FOV interface UI on the home screen.

```APIDOC
## ActiveFovControlView(bool active)

### Description
Show and hide the camera fov interface UI on the home screen.

### Parameters
#### Path Parameters
- **active** (bool) - Description: activate it or not
```

--------------------------------

### Unity Registering for Messages from Android

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/android-and-unity-communication

This section explains how Unity applications can register to receive messages from Android. It provides the interface for registration and unregistration, along with important notes on callback overwriting and memory leaks.

```APIDOC
## Unity Registering for Messages from Android

### Description
Interface called in Unity to register a callback for receiving messages from Android.

### Register Callback Signature
`NativeModule.Instance.RegesitNativeMsgDispatchListener(int eventType, Action<string[]> callBack)`

### Parameters
- **eventType** (int) - The type of event to listen for.
- **callBack** (Action<string[]>) - The function to be called when the event occurs.

### Unregister Callback Signature
`NativeModule.Instance.RmNativeMsgDispatchListener(int eventType)`

### Notes
- Unregister the message listener when the interface is destroyed to prevent memory leaks.
- An `eventType` can only have one callback registered. Subsequent registrations will overwrite previous ones.
```

--------------------------------

### SystemMonitoringInfoType

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid/app-device-monitoring

Defines constants for different types of system monitoring information that can be enabled.

```APIDOC
## SystemMonitoringInfoType

### Description
Provides constants for specifying which system monitoring metrics to enable.

### Constants
*   **FULL** (long) = 0: Enables all monitoring types.
*   **ELECTRIC** (long) = 1 << 0: Enables instantaneous current monitoring.
*   **AVERAGE_ELECTRIC** (long) = 1 << 1: Enables average current monitoring.
*   **BATTERY_CAPACTIY** (long) = 1 << 2: Enables current battery level monitoring.
```

--------------------------------

### CloseSystemMonitoring

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid/app-device-monitoring

Disables all currently active system monitoring.

```APIDOC
## CloseSystemMonitoring

### Description
Turns off system monitoring.

### Method Signature
`void CloseSystemMonitoring()`

### Example
```csharp
SystemMonitoring.CloseSystemMonitoring();
```
```

--------------------------------

### CloseWebView

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/sdkwebview

Closes the currently open webview.

```APIDOC
## CloseWebView()

### Description
Closes the currently active webview.

### Method
```csharp
Void CloseWebView()
```
```

--------------------------------

### GetGlassesQualternion()

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Obtains the 3DoF quaternion information for the current glasses, representing the glasses' current attitude.

```APIDOC
## GetGlassesQualternion()

### Description
Obtain 3DoF quaternion information for the current glasses.

### Returns
Quaternion value of the current attitude of the glasses.
```

--------------------------------

### Unity Registers Native Message Listener

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/android-and-unity-communication

Register a callback in Unity to receive messages dispatched from native Android code. Remember to unregister the listener when it's no longer needed to prevent memory leaks. An eventType can only have one callback registered; subsequent registrations will overwrite previous ones.

```reasonml
NativeModule.Instance.RegesitNativeMsgDispatchListener(int eventType,Action<string[]> callBack);
```

```reasonml
NativeModule.Instance.RmNativeMsgDispatchListener(int eventType);
```

--------------------------------

### Reset Mobile Quaternion

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Resets the phone's ray rotation angle to the current orientation. Returns the reset offset.

```csharp
Quaternion ResetMobileQuat()
```

--------------------------------

### Event Parsing in SDK

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/android-and-unity-communication

This table maps Android enum values to C# enum values and provides details on the `typeId` and expected string array values for various events.

```APIDOC
## Event Parsing in the SDK

### Description
This table details the mapping between Android and C# enums for message dispatch, including `typeId` and expected parameters.

| Android Enum AdapterMsgDispatchType | C# Enum MsgDispatchType | typeId | Values (string[])                                  | Description                                      |
| --------------------------------- | -------------------- | ------ | -------------------------------------------- | --------------------------------------- |
| HomePage                          | LauncherEvent        | 100    | RayType : string[0]                         | home button touch event                 |
| Fov_Changed                       | FovChanged           | 101    |                                              |                                         |
| TopBar                            | TopBar               | 102    | string:string[0]="TOP_BAR_BACK_CLICK"    | Click on the "Return" button at the top |
| GLASS                             | GLASS                | 103    | int= 1: Glasses insertion/2: Glasses pullout |                                         |
```

--------------------------------

### Apply 3D Effect

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/android-sdk/capabilities-and-api/3d-effect-implementation

Applies a 3D effect to both left and right views simultaneously. The `enabled` parameter controls whether the effect is active, and `depth` determines the intensity of the 3D effect.

```APIDOC
## make3DEffect

### Description
Applies a 3D effect to both left and right views simultaneously.

### Parameters
- **leftView** (View) - The view from the left layout.
- **rightView** (View) - The view from the right layout.
- **enabled** (Boolean) - Enable/disable the effect. `true` to enable, `false` to disable.
- **depth** (Float) - Depth intensity. Higher values create stronger 3D effects.
```

--------------------------------

### Android Sending Message to Unity

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/android-and-unity-communication

This section details how to send messages from an Android application to a Unity application using the Air SDK. It specifies the interface to call in Android and provides a list of registered event types.

```APIDOC
## Android Sending Message to Unity

### Description
Interface called in Android to send messages to Unity.

### Method Signature
`AirApi.ins().onCommandRespToUnity(int eventType, String params)`

### Parameters
- **eventType** (int) - The type of event being sent. Pre-registered values should not be used; starting with 1,000 is recommended.
- **params** (String) - Additional parameters for the event.

### Registered Event Types
| Class: AdapterMsgDispatchType | Value |
| ---------------------------- | ----- |
| HomePage                     | 100   |
| FovChanged                   | 101   |
| TopBar                       | 102   |
| GLASS                        | 103   |
```

--------------------------------

### ResetMobileQuat()

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Resets the phone's ray rotation angle to the current orientation, returning the reset offset.

```APIDOC
## ResetMobileQuat()

### Description
Reset the phone's ray rotation angle to the current orientation.

### Returns
Reset offset.
```

--------------------------------

### Disable Device Monitoring via ADB

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid/device-monitoring

Use this ADB command to forcefully stop the system monitoring service.

```bash
adb shell am force-stop com.ffalcon.rayneo.systemwindows
```

--------------------------------

### ResetGlassQuat()

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Resets the glasses' visual angle to the current orientation, returning the reset offset.

```APIDOC
## ResetGlassQuat()

### Description
Reset the glasses visual angle to the current orientation.

### Returns
Reset offset.
```

--------------------------------

### Disable System Monitoring

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/unity-sdk/x2-api-legacy-sdk-support/platformandroid/app-device-monitoring

Turn off all active system monitoring to stop data collection.

```csharp
SystemMonitoring.CloseSystemMonitoring();
```

--------------------------------

### GetInterpupilDistance()

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Retrieves the current interpupillary distance (IPD).

```APIDOC
## GetInterpupilDistance()

### Description
Get pupil distance.

### Returns
Return pupil distance values between 60 and 70.
```

--------------------------------

### Apply 3D Effect to a Single View

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/android-sdk/capabilities-and-api/3d-effect-implementation

Apply the 3D effect to a single view, specifying whether it belongs to the left or right layout. This is useful for individual element adjustments.

```java
// Apply 3D effect to a single view (specify left/right)
make3DEffectForSide(this.ivSelectHover, isLeft, true)
```

--------------------------------

### SetInterpupilDistance(float val)

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Sets the interpupillary distance (IPD) to a value between 60 and 70. Requires specific Cardboard API calls before use.

```APIDOC
## SetInterpupilDistance(float val)

### Description
Set the pupil distance between 60 and 70.

### Parameters
#### Path Parameters
- **val** (float) - Description: The pupil distance value, ranging from 0 to 1, mapping to 60-70.

### Notes
To call this interface, the following code needs to be written in the update:
```csharp
if (Google.XR.Cardboard.Api.HasNewDeviceParams()) {
    Google.XR.Cardboard.Api.ReloadDeviceParams();
}
Google.XR.Cardboard.Api.UpdateScreenParams();
```
```

--------------------------------

### Reset Glasses Quaternion

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Resets the glasses' visual angle to the current orientation. Returns the reset offset.

```csharp
Quaternion ResetGlassQuat()
```

--------------------------------

### Apply 3D Effect to a Single Side

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/x-series/android-sdk/capabilities-and-api/3d-effect-implementation

Applies a 3D effect to a single view, specifying whether it belongs to the left or right layout. The `enabled` parameter controls the effect's activation, and `depth` adjusts the intensity.

```APIDOC
## make3DEffectForSide

### Description
Applies a 3D effect to a single view, specifying its side (left/right).

### Parameters
- **view** (View) - The view to apply the effect to.
- **isLeft** (Boolean) - Indicates if the view is from the left layout. `true` for left, `false` for right.
- **enabled** (Boolean) - Enable/disable the effect. `true` to enable, `false` to disable.
- **depth** (Float) - Depth intensity. Higher values create stronger 3D effects.
```

--------------------------------

### ChangeFov(int scaleValue)

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Adjusts the Field of View (FOV). Increase FOV for negative numbers and reduce FOV for positive numbers. Requires specific Cardboard API calls before use.

```APIDOC
## ChangeFov(int scaleValue)

### Description
Adjusts fov.0 to the current value. Increase fov for negative numbers and reduce fov for positive numbers.

### Parameters
#### Path Parameters
- **scaleValue** (int) - Description: The value to adjust the FOV by.

### Notes
To call this interface, the following code needs to be written in the update:
```csharp
if (Google.XR.Cardboard.Api.HasNewDeviceParams()) {
    Google.XR.Cardboard.Api.ReloadDeviceParams();
}
Google.XR.Cardboard.Api.UpdateScreenParams();
```
```

--------------------------------

### Change Field of View

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Adjusts the field of view (FOV). Increase FOV for negative numbers and reduce FOV for positive numbers. This interface requires specific calls within the update loop.

```csharp
ChangeFov(int scaleValue)
```

```csharp
if (Google.XR.Cardboard.Api.HasNewDeviceParams()) {
       Google.XR.Cardboard.Api.ReloadDeviceParams();
   }

   Google.XR.Cardboard.Api.UpdateScreenParams();
```

--------------------------------

### Set Interpupillary Distance

Source: https://rayneo-en.gitbook.io/rayneo-devdoc/air-series/unity-sdk/api/nativemodule

Sets the interpupillary distance. The 'val' parameter should be between 0 and 1, mapping to pupil distances of 60-70. This interface requires specific calls within the update loop.

```csharp
void SetInterpupilDistance(float val)
```

```csharp
if (Google.XR.Cardboard.Api.HasNewDeviceParams()){
Google.XR.Cardboard.Api.ReloadDeviceParams();
}
Google.XR.Cardboard.Api.UpdateScreenParams();
```
Tokens:
Raw