mocopi mobile SDK
Loading...
Searching...
No Matches
Mocopi.Mobile.Sdk.Common Namespace Reference

Classes

class  ConstMocopiMobileSdk
 Class that summarizes constants used in mocopi Mobile SDK
.
 

Enumerations

enum  EnumRunMode { Default = 0 , Stub = 1 }
 Select the operating mode for the mocopi Mobile SDK itself.
. More...
 
enum  EnumTargetBodyType : int { FullBody = 0 , UpperBody = 4 , LowerBody = 5 }
 Tracking type of the mocopi sensor.
. More...
 
enum  EnumCallbackStatus { Success , Error , Disconnected }
 Result of MocopiManager class callback function.
. More...
 
enum  EnumCalibrationCallbackStatus {
  Stay , StepForward , Success , Warning ,
  Error , Cancel , CancelFailed
}
 Result of MocopiManager class calibration callback function.
. More...
 
enum  EnumParts {
  Head = MocopiSdkPluginConst.PartsIndex.HEAD , LeftUpperArm = MocopiSdkPluginConst.PartsIndex.LEFT_UPPER_ARM , LeftWrist = MocopiSdkPluginConst.PartsIndex.LEFT_WRIST , RightUpperArm = MocopiSdkPluginConst.PartsIndex.RIGHT_UPPER_ARM ,
  RightWrist = MocopiSdkPluginConst.PartsIndex.RIGHT_WRIST , Hip = MocopiSdkPluginConst.PartsIndex.HIP , LeftUpperLeg = MocopiSdkPluginConst.PartsIndex.LEFT_UPPER_LEG , RightUpperLeg = MocopiSdkPluginConst.PartsIndex.RIGHT_UPPER_LEG ,
  LeftAnkle = MocopiSdkPluginConst.PartsIndex.LEFT_FOOT , RightAnkle = MocopiSdkPluginConst.PartsIndex.RIGHT_FOOT
}
 List of body parts to which the mocopi sensor can be connected.
. More...
 
enum  SensorParts {
  Head = MocopiSdkPluginConst.PartsIndex.HEAD , LeftWrist = MocopiSdkPluginConst.PartsIndex.LEFT_WRIST , RightWrist = MocopiSdkPluginConst.PartsIndex.RIGHT_WRIST , Hip = MocopiSdkPluginConst.PartsIndex.HIP ,
  LeftAnkle = MocopiSdkPluginConst.PartsIndex.LEFT_FOOT , RightAnkle = MocopiSdkPluginConst.PartsIndex.RIGHT_FOOT
}
 List of body part labels on the mocopi sensor body. More...
 
enum  EnumHeightUnit { Meter = 0 , Inch = 1 }
 Measurement unit for setting height.
. More...
 
enum  EnumAuthorizationStatus { ON = 0 , OFF = 1 , DISABLE = 2 }
 Status indicating OS settings and permissions.
. More...
 
enum  EnumOsSettingType { Bluetooth = 0 , Location = 1 }
 Type of OS setting.
. More...
 
enum  EnumPermissionType { Bluetooth = 0 , Location = 1 , ExternalStorage = 3 }
 Type of permission for the application.
. More...
 
enum  EnumSensorStatus {
  None = 0 , Discovery = 1 << 0 , PairedPart = 1 << 1 , UnpairedPart = 1 << 2 ,
  Connected = 1 << 3 , ConnectError = 1 << 4 , Disconnecting = 1 << 5 , Disconnected = 1 << 6 ,
  DisableDisconnection = 1 << 7 , SafeBattery = 1 << 8 , LowBattery = 1 << 9 , BatteryError = 1 << 10 ,
  AllSensorReady = 1 << 11 , AllSensorReadyError = 1 << 12 , FirmwareLatest = 1 << 13 , FirmwareOlder = 1 << 14 ,
  FirmwareNewer = 1 << 15 , FirmwareError = 1 << 16
}
 Status of each mocopi sensor.
. More...
 
enum  EnumFirmwareStatus { Error = 0 , Latest = 1 , Older = 2 , Newer = 3 }
 Status of the firmware installed in the mocopi sensor.
. More...
 
enum  EnumRecordingMotionAllStatus : int {
  RecordingCompleted , RecordingStarted , ErrorRecordingAlreadyStarted , ErrorRecordingNotStarted ,
  ErrorRecordingNotStopped , ErrorStartRecordingFailed , ErrorStorageNoSpace , ErrorWritingFailed ,
  ErrorCurrentlyConverting , ErrorMotionCreationFailed , ErrorRecordableTimeReached
}
 Status of motion recording. More...
 
enum  EnumRecordingMotionStatus : int {
  RecordingStarted , RecordingStopped , Converting , ConvertingCompleted ,
  RecordingCompleted , Error
}
 Motion recording status (simplified version).
. More...
 
enum  EnumSensorConnectionErrorStatus : int {
  ConnectionFailed = -1 , RemovedPairingKey = 0 , BondingFailed = 1 , NotBonded = 2 ,
  NotFoundSensor = 3 , NotStartSensor = 4 , BluetoothOff = MocopiSdkPluginConst.SENSOR_CONNECTION_ERROR_CODE + 0x05 , ConnectSensorFailed = MocopiSdkPluginConst.SENSOR_CONNECTION_ERROR_CODE + 0x06
}
 Callback status at the time of sensor connection error. More...
 
enum  EnumSensorConnectedStably : int { Failed = 1 , Succeeded = 2 }
 Calibration process results when connecting with the mocopi sensor.
. More...
 
enum  EnumNotificationReason : int {
  AcceptDisconnectedSensor = 0 , DisplayedPairingScreen = 1 , DisplayedSensorConnectionScreen = 2 , DisplayedCalibrationScreen = 3 ,
  DisplayedTrackingScreen = 4 , DisplayedRecordingMotionScreen = 5 , AuthorizationNotAllowed = 6 , EndPairingSettings = 7 ,
  IncorrectFirmwareVersion = 8 , CalibrationFailsContinuously = 9 , TurnedOffBluetooth = 10 , TurnedOffLocation = 11
}
 Notification from Prefab.
. More...
 
enum  EnumCalibrationStatus : int {
  CalibrationCompleted = MocopiSdkPluginConst.CALIBRATION_SUCCESS_CODE , CalibrationFailed = MocopiSdkPluginConst.CALIBRATION_ERROR_CODE + 0x00 , InsufficientStorageFreeSpace = MocopiSdkPluginConst.CALIBRATION_ERROR_CODE + 0x10 , NotEnoughSensorData = MocopiSdkPluginConst.CALIBRATION_ERROR_CODE + 0x20 ,
  StepTimeTooShort = MocopiSdkPluginConst.CALIBRATION_ERROR_CODE + 0x31 , InsufficientCalibrationSamples = MocopiSdkPluginConst.CALIBRATION_ERROR_CODE + 0x32 , InvalidPreferencePointValue = MocopiSdkPluginConst.CALIBRATION_ERROR_CODE + 0x40 , InvalidMaximumMovementPointValue = MocopiSdkPluginConst.CALIBRATION_ERROR_CODE + 0x41 ,
  InvalidEndPointValue = MocopiSdkPluginConst.CALIBRATION_ERROR_CODE + 0x42 , StepTimeTooLong = MocopiSdkPluginConst.CALIBRATION_ERROR_CODE + 0x43 , InvalidStepYawValue = MocopiSdkPluginConst.CALIBRATION_ERROR_CODE + 0x44 , EarlyToStep = MocopiSdkPluginConst.CALIBRATION_ERROR_CODE + 0x50 ,
  LateToStep = MocopiSdkPluginConst.CALIBRATION_ERROR_CODE + 0x60 , InvalidStepAngleValue = MocopiSdkPluginConst.CALIBRATION_WARNING_CODE + 0x70
}
 Status of calibration execution results.
. More...
 
enum  EnumMotionStreamingStatus {
  Reading = 0 , Stopped = 1 , ReadingFrame = 2 , StartFailed = 3 ,
  StopFailed = 4 , ReadingFrameFailed = 5
}
 Motion loading status
. More...
 
enum  EnumFirmwareVersionResultForStableCalibration { Supported = 0 , NotSupported = 1 , Error = 2 }
 StableCalibration support status
. More...
 
enum  EnumMotionFormat : int { Error = -1 , Mocopi = 0 , Other = 1 }
 Format of motion file. More...
 

Enumeration Type Documentation

◆ EnumAuthorizationStatus

Status indicating OS settings and permissions.
.

Use inside MocopiManager class to manage the status of OS settings (Bluetooth/location information). Not to be used by standard users.

Enumerator
ON 

Setting is On or permission is granted.
.

OFF 

Setting is Off or permission is not granted.
.

DISABLE 

(iOS only) Unable to determine

◆ EnumCalibrationCallbackStatus

Result of MocopiManager class calibration callback function.
.

Used to assess the result of the callback function when the MocopiManager class calibration is performed. Normal calibration sequence is Stand still -> 1 step forward -> Stand still -> Success.

Enumerator
Stay 

A state that stimulates an initial posture.
.

StepForward 

A state that stimulates one step forward.
.

Success 

Calibration successful.
.

Warning 

Calibration warning.
.

Error 

Calibration failed.
.

Cancel 

Calibration canceled.
.

CancelFailed 

Failed to cancel calibration.
.

◆ EnumCalibrationStatus

Status of calibration execution results.
.

Enumerator
CalibrationCompleted 

Calibration completed.
.

CalibrationFailed 

Calibration failed.
.

InsufficientStorageFreeSpace 

Calibration failed due to insufficient free storage space.
.

NotEnoughSensorData 

Calibration failed due to insufficient data from the mocopi sensor.
.

To resolve this error, it is necessary to reconnect the mocopi sensor that is causing the error.

StepTimeTooShort 

Calibration failed because the movement was not enough to determine whether the user walked or not.
.

InsufficientCalibrationSamples 

Calibration failed because the calibration time was too short (the user entered the stopped state too late).
.

InvalidPreferencePointValue 

Calibration failed because the user was walking before coming to a stop.
.

InvalidMaximumMovementPointValue 

Calibration failed because stop/walk/stop status was not obtained.
.

InvalidEndPointValue 

Calibration failed because the calibration completion judgment failed
.

StepTimeTooLong 

Calibration failed because the user walked too much.
.

InvalidStepYawValue 

Calibration failed because the sensor was rotating when stepping forward.
.

EarlyToStep 

Calibration failed because the time taken to take a step was short (step was taken too quickly).
.

LateToStep 

Calibration failed because the time taken to take a step was long (step was taken too slowly).
.

InvalidStepAngleValue 

It is successful, but the sensor rotates 30 degrees or more when taking a step.
.

◆ EnumCallbackStatus

Result of MocopiManager class callback function.
.

Enumerator
Success 

Success
.

Error 

Failure
.

Disconnected 

Disconnection
.

◆ EnumFirmwareStatus

Status of the firmware installed in the mocopi sensor.
.

Enumerator
Error 

Failed to obtain the firmware version of the mocopi sensor or the version is invalid.
.

Latest 

The firmware version of the mocopi sensor is up to date (mocopi sensor firmware version == SDK).
.

Older 

The firmware version of the mocopi sensor needs to be updated (firmware version of the mocopi sensor < SDK).
.

Newer 

The firmware version of the mocopi sensor is newer than the SDK (mocopi sensor firmware version > SDK).
.

◆ EnumFirmwareVersionResultForStableCalibration

StableCalibration support status
.

Enumerator
Supported 
NotSupported 
Error 

◆ EnumHeightUnit

Measurement unit for setting height.
.

Enumerator
Meter 

Use meters (m).
.

Inch 

Use feet/inch.
.

◆ EnumMotionFormat

Format of motion file.

Enumerator
Error 

Irregular format file.
.

Mocopi 

File recorded by mocopi.
.

Other 

File not recorded by mocopi.
.

◆ EnumMotionStreamingStatus

Motion loading status
.

Enumerator
Reading 
Stopped 
ReadingFrame 
StartFailed 
StopFailed 
ReadingFrameFailed 

◆ EnumNotificationReason

Notification from Prefab.
.

Enumerator
AcceptDisconnectedSensor 

Received a notification that the mocopi sensor has been disconnected.
.

DisplayedPairingScreen 

Pairing screen display.
.

DisplayedSensorConnectionScreen 

mocopi sensor connection screen display.

DisplayedCalibrationScreen 

Calibration screen display.
.

DisplayedTrackingScreen 

Tracking screen display.
.

DisplayedRecordingMotionScreen 

Motion recording screen display.
.

AuthorizationNotAllowed 

OS permissions are not granted.
.

EndPairingSettings 

Pairing settings are completed.
.

IncorrectFirmwareVersion 

The firmware version of the mocopi sensor is not up to date.
.

CalibrationFailsContinuously 

Calibration failed a certain number of times in a row.
.

TurnedOffBluetooth 

Bluetooth setting of OS is OFF.
.

TurnedOffLocation 

OS location information setting is OFF.
.

◆ EnumOsSettingType

Type of OS setting.
.

Enumerator
Bluetooth 

Bluetooth
.

Location 

Location information
.

◆ EnumParts

List of body parts to which the mocopi sensor can be connected.
.

Enumerator
Head 

Head
.

LeftUpperArm 

Left upper arm
.

LeftWrist 

Left wrist
.

RightUpperArm 

Right upper arm
.

RightWrist 

Right wrist
.

Hip 

Hip
.

LeftUpperLeg 

Left thigh
.

RightUpperLeg 

Right thigh
.

LeftAnkle 

Left ankle
.

RightAnkle 

Right ankle
.

◆ EnumPermissionType

Type of permission for the application.
.

Enumerator
Bluetooth 

Bluetooth
.

Location 

Location information
.

ExternalStorage 

Storage utilization
.

◆ EnumRecordingMotionAllStatus

Status of motion recording.

Enumerator
RecordingCompleted 

Saving of motion recording results is completed.
.

RecordingStarted 

Start motion recording.
.

ErrorRecordingAlreadyStarted 

Motion recording has already started.
.

ErrorRecordingNotStarted 

Motion recording has not started.
.

ErrorRecordingNotStopped 

Motion recording has not stopped.
.

ErrorStartRecordingFailed 

Failed to start motion recording.
.

ErrorStorageNoSpace 

Failed to save motion recording due to insufficient storage capacity.
.

ErrorWritingFailed 

Writing process failed when saving the motion recording.
.

ErrorCurrentlyConverting 

Writing process of the motion recording is in progress.
.

ErrorMotionCreationFailed 

Failed to generate BVH file.
.

ErrorRecordableTimeReached 

Maximum recording time reached.
.

◆ EnumRecordingMotionStatus

Motion recording status (simplified version).
.

Enumerator
RecordingStarted 

Motion recording started.
.

RecordingStopped 

Motion recording stopped.
.

Converting 

Motion recording results are being saved.
.

ConvertingCompleted 

Saving of motion recording results is completed.
.

RecordingCompleted 

Writing of the BVH file is completed.
.

Error 

An error occurred during one of the phases of the motion recording flow.
.

◆ EnumRunMode

Select the operating mode for the mocopi Mobile SDK itself.
.

Enumerator
Default 

Actual operation (using the mocopi sensor).
.

Stub 

Stub mode for debugging UnityEditor, etc. Operating part of the sensor operates while stub is implemented.
.

◆ EnumSensorConnectedStably

Calibration process results when connecting with the mocopi sensor.
.

Enumerator
Failed 

mocopi sensor calibration failed.

Succeeded 

mocopi sensor calibration successful.

◆ EnumSensorConnectionErrorStatus

Callback status at the time of sensor connection error.

Enumerator
ConnectionFailed 

Failed to connect to the mocopi sensor.
.

RemovedPairingKey 

The pairing key for the mocopi sensor does not exist.
.

BondingFailed 

Connection failed when pairing with the mocopi sensor.
.

NotBonded 

Already connected with the mocopi sensor.
.

NotFoundSensor 

Cannot find the mocopi sensor.
.

NotStartSensor 

mocopi sensor is not ready yet.

BluetoothOff 

State where the bluetooth setting of the device is OFF.
.

ConnectSensorFailed 

The return value of ConnectSensor is false.
.

◆ EnumSensorStatus

Status of each mocopi sensor.
.

Enumerator
None 

mocopi sensor has been found.

Discovery 

mocopi sensor has been found.

PairedPart 

mocopi sensor is linked to one of the body parts.

UnpairedPart 

The body part linked to the mocopi sensor is released.
.

Connected 

mocopi sensor is connected to one of the body part.

ConnectError 

Failed to connect to the mocopi sensor.
.

Disconnecting 

Disconnection with the mocopi sensor is in progress.
.

Disconnected 

Disconnection from the mocopi sensor.
.

DisableDisconnection 

State where it is not possible to disconnect from the mocopi sensor.
.

SafeBattery 

Remaining battery level of the mocopi sensor is sufficient.
.

LowBattery 

Remaining battery level of the mocopi sensor is insufficient.
.

BatteryError 

Failed to acquire the battery level of the mocopi sensor.
.

AllSensorReady 

With respect to the connection mode, all mocopi sensors are connected.
.

AllSensorReadyError 

With respect to the connection mode, all mocopi sensors are disconnected.
.

FirmwareLatest 

The firmware version of the mocopi sensor is up to date (mocopi sensor firmware version == SDK).
.

FirmwareOlder 

The firmware version of the mocopi sensor needs to be updated (firmware version of the mocopi sensor < SDK).

FirmwareNewer 

The firmware version of the mocopi sensor is newer than the SDK (mocopi sensor firmware version > SDK).
.

FirmwareError 

Failed to obtain the firmware version of the mocopi sensor or the version is invalid.
.

◆ EnumTargetBodyType

Tracking type of the mocopi sensor.
.

Enumerator
FullBody 

6-point connection mode of the mocopi sensor. This is the basic connection mode. The body parts are head, hip, both wrists, and both feet.

UpperBody 

6-points connection mode. parts:head, waist, wrists, hands

LowerBody 

Lower body 6-point connection mode of the mocopi sensor. This is the connection mode for VR. The body parts are head, hip, both thighs, and both legs.
.

◆ SensorParts

List of body part labels on the mocopi sensor body.

Enumerator
Head 

Head
.

LeftWrist 

Left wrist
.

RightWrist 

Right wrist
.

Hip 

Hip
.

LeftAnkle 

Left leg
.

RightAnkle 

Right leg
.