VROEMEvent

VROEMEvent is used to transmit data from runtime server to VROEMService. It invloves information of the VIVE Wave™ runtime. OEM developer can do some actions after receiving specific message.

List

The Enumeration of VREventType

This is the definition of VREventType that is transmitted from runtime server.

  • VREventType_None (0)
None
  • VREventType_Quit (99)
VR app is quitting
  • VREventType_DeviceConnected (100)
Device is connected
  • VREventType_DeviceDisconnected (101)
Device is disconnected
  • VREventType_DeviceStatusUpdate (102)
Update status of device
  • VREventType_DeviceSuspend (106)
Device suspends
  • VREventType_DeviceResume (107)
Device resumes
  • VREventType_ButtonPressed (200)
A button of VR controller is pressed
  • VREventType_ButtonUnpressed (201)
A button of VR controller is unpressed
  • VREventType_TouchTapped (202)
A touchpad of VR controller is tapped
  • VREventType_TouchUntapped(203)
A touchpad of VR controller is untapped
  • VREventType_BatteryStatus_Update (30004)
Update the battery status of device
  • VREventType_ChargeStatus_Update (30005)
Update the charge status of device
  • VREventType_DeviceErrorStatus_Update (30006)
Update the error status of device
  • VREventType_BatteryTemperatureStatus_Update (30007)
Update the status of battery temperature of device
  • VREventType_RecenterSuccess (30010)
Recenter success of 6DoF
  • VREventType_RecenterFail (30011)
Recenter fail of 6DoF
  • VREventType_RecenterSuccess_3DoF (30012)
Recenter success of 3DoF
  • VREventType_RecenterFail_3DoF (30013)
Recenter fail of 3DoF
  • VREventType_OutOfWall (30100)
Out of the wall
  • VREventType_BackWithinWall (30101)
Back with the wall
  • VREventType_DeviceLoading (30102)
Device is loading
  • VREventType_DeviceLoadingDone (30103)
Device finishes loading
  • VREventType_DevicePoseReady (30104)
The pose of device is ready

The Enumeration of VRDeviceErrorStatus

This is error status of device service.

Device service uses bitmask to record device error, because it might occur many errors at the same time. Each error status represents that device has a hardware exception. And restore status means that error status has been fixed.

  • VRDeviceErrorStatus_None (0)
The Error status can not identify.
  • VRDeviceErrorStatus_BatteryOverheat (1)
The battery temperature is too hot.
  • VRDeviceErrorStatus_BatteryOverheatRestore (2)
The battery temperature has been cooled down.
  • VRDeviceErrorStatus_BatteryOvervoltage (4)
The battery is overvoltage charging.
  • VRDeviceErrorStatus_BatteryOvervoltageRestore (8)
The overvoltage has been fixed.
  • VRDeviceErrorStatus_DeviceConnectFail (16)
The error status is failed to connect to USB device.
  • VRDeviceErrorStatus_DeviceConnectRestore (32)
The connection failed error has been fixed.
  • VRDeviceErrorStatus_DeviceLostTracking (64)
The tracking device might be out of range.
  • VRDeviceErrorStatus_DeviceTrackingRestore (128)
The lost tracking has been fixed.
  • VRDeviceErrorStatus_ChargeFail (256)
The error status when device is charging, consuming voltage is larger than charging.
  • VRDeviceErrorStatus_ChargeRestore (512)
The charging failed error has been fixed.

Method Introduction

  • VREventType getEventType()
  • Get the event type
  • return VREventType
  • int getDeviceId()
  • Get the ID of 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 input component
  • return VRInputId
  • long getTick()
  • Get the timestamp
  • return long timestamp