VROEMEvent

VROEMEvent is used to transmit data from the runtime server (includes information of the VIVE Wave™ runtime) to the VROEMService. OEM developers can perform actions after receiving a specific message.

VREventType Enumeration

These are the definitions of VREventType that are transmitted from the runtime server.

  • VREventType_None (0)
No event
  • VREventType_Quit (99)
The app is closing.
  • VREventType_DeviceConnected (100)
A device is connected.
  • VREventType_DeviceDisconnected (101)
The device is disconnected.
  • VREventType_DeviceStatusUpdate (102)
Update status of the device.
  • VREventType_DeviceSuspend (106)
The device is suspended.
  • VREventType_DeviceResume (107)
The device resumes.
  • VREventType_ButtonPressed (200)
A button on the controller is pressed.
  • VREventType_ButtonUnpressed (201)
A button on the controller is not pressed anymore.
  • VREventType_TouchTapped (202)
The touchpad of the controller is pressed.
  • VREventType_TouchUntapped(203)
The touchpad of the controller is not pressed anymore.
  • VREventType_BatteryStatus_Update (30004)
Update the battery status of the device.
  • VREventType_ChargeStatus_Update (30005)
Update the battery charging status of the device.
  • VREventType_DeviceErrorStatus_Update (30006)
Update the error status of the device.
  • VREventType_BatteryTemperatureStatus_Update (30007)
Update the battery temperature status of the device.
  • VREventType_RecenterSuccess (30010)
Recenter was successful for 6DoF.
  • VREventType_RecenterFail (30011)
Recenter failed for 6DoF.
  • VREventType_RecenterSuccess_3DoF (30012)
Recenter was successful for 3DoF.
  • VREventType_RecenterFail_3DoF (30013)
Recenter failed for 3DoF.
  • VREventType_OutOfWall (30100)
Outside the bounds of the virtual wall.
  • VREventType_BackWithinWall (30101)
Back inside virtual wall.
  • VREventType_DeviceLoading (30102)
Device is loading.
  • VREventType_DeviceLoadingDone (30103)
Device has finished loading.
  • VREventType_DevicePoseReady (30104)
Device pose is ready.

VRDeviceErrorStatus Enumeration

These are the error statuses of the device service.

The device service uses bitmask to record a device error as many errors might occur at the same time. Each error status represents that the device has a hardware exception and a restore status means that error status has been fixed.

  • VRDeviceErrorStatus_None (0)
The device is working normally.
  • VRDeviceErrorStatus_BatteryOverheat (1)
The battery temperature is too hot.
  • VRDeviceErrorStatus_BatteryOverheatRestore (2)
The battery temperature has cooled down.
  • VRDeviceErrorStatus_BatteryOvervoltage (4)
Overvoltage has occurred while charging the battery.
  • VRDeviceErrorStatus_BatteryOvervoltageRestore (8)
The overvoltage has been fixed.
  • VRDeviceErrorStatus_DeviceConnectFail (16)
Failed to connect to the device.
  • VRDeviceErrorStatus_DeviceConnectRestore (32)
The connection of the device error has been fixed.
  • VRDeviceErrorStatus_DeviceLostTracking (64)
The tracking device might be out of range.
  • VRDeviceErrorStatus_DeviceTrackingRestore (128)
The tracking device can now be tracked again.
  • VRDeviceErrorStatus_ChargeFail (256)
Device battery is charging but the consumed voltage is larger than the charging voltage.
  • VRDeviceErrorStatus_ChargeRestore (512)
The charging error has been fixed.

Method Introduction

  • VREventType getEventType()
  • Get the event type.
  • Return VREventType
  • int getDeviceId()
  • Get the ID of the device.
  • Return integer
  • VRDeviceType getDeviceType()
  • Get the device type.
  • Return VRDeviceType
  • VRExternalTrackerType getExternalTrackerType()
  • Get the external tracker type.
  • Return VRExternalTrackerType
  • VRDeviceErrorStatus getDeviceErrorStatus()
  • Get the device error status.
  • Return VRDeviceErrorStatus
  • VRInputId getInputId()
  • Get the ID of the input component.
  • Return VRInputId
  • long getTick()
  • Get the timestamp.
  • Return long timestamp