File ManusSDK.cpp
FileList > api > cppSDK > SDKBase > ManusSDK.cpp
Go to the source code of this file
#include "ManusSDKTypes.h"#include "ManusSDKExtendedTypes.h"#include "ManusSDK.h"#include "ManusSDKExtended.h"#include "ManusSDKIntegrationPartner.h"#include <cstdio>#include <memory>#include <thread>#include "CoreConnection.hpp"#include "Logging.hpp"
Public Attributes
| Type | Name |
|---|---|
| std::unique_ptr< ManusSDK::CoreConnection > | s_CoreConnection |
Public Functions
| Type | Name |
|---|---|
| SDKReturnCode | CoreSdk_AddChainToSkeletonSetup (uint32_t p_SkeletonSetupIndex, ChainSetup p_Chain) Add a chain to a SkeletonSetup at a given index. |
| SDKReturnCode | CoreSdk_AddColliderToSkeletonSetup (uint32_t p_SkeletonSetupIndex, ColliderSetup p_Collider) Add a collider to a SkeletonSetup at a given index. |
| SDKReturnCode | CoreSdk_AddMeshSetupToSkeletonSetup (uint32_t p_SkeletonSetupIndex, uint32_t p_NodeID, uint32_t * p_MeshSetupIndex) Add a mesh setup to a SkeletonSetup at a given index. |
| SDKReturnCode | CoreSdk_AddNodeToSkeletonSetup (uint32_t p_SkeletonSetupIndex, NodeSetup p_Node) Add a node to a SkeletonSetup at a given index. |
| SDKReturnCode | CoreSdk_AddTriangleToMeshSetup (uint32_t p_SkeletonSetupIndex, uint32_t p_MeshSetupIndex, Triangle p_Triangle) Add a Triangle to a mesh setup at a given index. |
| SDKReturnCode | CoreSdk_AddUser (char * p_Name, uint32_t * p_UserID) Create a new user in Core with the specified name and get its ID. This function only works if Auto-Assignment is disabled. |
| SDKReturnCode | CoreSdk_AddVertexToMeshSetup (uint32_t p_SkeletonSetupIndex, uint32_t p_MeshSetupIndex, Vertex p_Vertex) Add a Vertex to a mesh setup at a given index. |
| SDKReturnCode | CoreSdk_AllocateChainsForSkeletonSetup (uint32_t p_SkeletonSetupIndex) Allocate chains for a SkeletonSetup at a given index. |
| SDKReturnCode | CoreSdk_ApplyProfile (uint32_t p_Id, CompleteType * p_Message) |
| SDKReturnCode | CoreSdk_AreDongleChannelsPersistent (bool * p_IsPersistent) |
| SDKReturnCode | CoreSdk_AreVirtualDonglesEnabled (bool * p_IsEnabled) |
| SDKReturnCode | CoreSdk_AssignDongleToUser (uint32_t p_Id, uint32_t p_DongleId) Assign a dongle to a user. This function only works if Auto-Assignment is disabled. |
| SDKReturnCode | CoreSdk_AssignGloveToUser (uint32_t p_UserId, uint32_t p_GloveId, Side p_Side) Assign a glove to a user. This function only works if Auto-Assignment is disabled. |
| SDKReturnCode | CoreSdk_AssignProfileToUser (UserProfileArgs p_UserProfileArgs, CompleteType * p_Message) |
| SDKReturnCode | CoreSdk_AssignRoleToTracker (TrackerId p_TrackerId, TrackerType p_TrackerType) |
| SDKReturnCode | CoreSdk_AssignTrackerToUser (TrackerId p_TrackerId, uint32_t p_UserId) |
| SDKReturnCode | CoreSdk_AutoAssignTrackers (uint32_t p_UserId) |
| SDKReturnCode | CoreSdk_AutoGroupTrackers () |
| SDKReturnCode | CoreSdk_CalibrateHapticsModule (uint32_t p_DongleId, Side p_HandType) |
| SDKReturnCode | CoreSdk_CalibrationBegin (CalibrationArgs p_Args, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_CalibrationDataGet (CalibrationArgs p_Args, CalibrationData * p_CalibrationData) |
| SDKReturnCode | CoreSdk_CalibrationDataSet (CalibrationArgs p_Args, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_CalibrationEnd (CalibrationArgs p_Args, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_CalibrationSetMax (CalibrationArgs p_Args, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_CalibrationSetMin (CalibrationArgs p_Args, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_CalibrationStore (CalibrationArgs p_Args, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_ChangeUserForRole (TrackerType p_Role, uint32_t p_CurrentUser, uint32_t p_TargetUser) |
| SDKReturnCode | CoreSdk_ClearAllTemporarySkeletons () Clear all temporary skeletons associated to the current session both in the sdk and core. All skeleton setups will no longer be valid after this call. |
| SDKReturnCode | CoreSdk_ClearTemporarySkeleton (uint32_t p_SkeletonSetupIndex, uint32_t p_SessionId) Clear a SkeletonSetup at a given index and sessionId in Manus Core and the SDK. The given setup index will no longer be valid after this call. |
| SDKReturnCode | CoreSdk_CompressTemporarySkeletonAndGetSize (uint32_t p_SkeletonSetupIndex, uint32_t p_SessionId, uint32_t * p_TemporarySkeletonLengthInBytes) Send a temporary skeleton to Core to compress it (convert it into an array of bytes) and then get the compressed data back in the SDK, the skeleton compressed data are stored internally. It returns the length of the bytes array for correct memory allocation. This function must be called before CoreSdk_GetCompressedTemporarySkeletonData. |
| SDKReturnCode | CoreSdk_ConnectGRPC () Connect to the preset GRPC address. |
| SDKReturnCode | CoreSdk_ConnectToHost (ManusHost p_Host) Connect to a host using the given host information. |
| SDKReturnCode | CoreSdk_CreateSkeletonSetup (SkeletonSetupInfo p_Skeleton, uint32_t * p_SkeletonSetupIndex) Create a new SkeletonSetup with the given information and returns the index on which it is saved. |
| SDKReturnCode | CoreSdk_Disconnect () Disconnects from the current host. |
| SDKReturnCode | CoreSdk_DoesSkeletonGloveSupportHaptics (uint32_t p_SkeletonId, Side p_HandType, bool * p_IsHaptics) Identifies if the glove associated to the skeleton with given id and side is a haptic one. |
| SDKReturnCode | CoreSdk_EnablePlayback (bool * p_Success) |
| SDKReturnCode | CoreSdk_GetAvailableHostsFound (ManusHost * p_AvailableHostsFound, const uint32_t p_NumberOfHostsThatFitInArray) Fill the given array with information on the hosts that were found. This is the third and final function to call when looking for hosts to connect to. |
| SDKReturnCode | CoreSdk_GetBandScan (BandScanArgs p_BandScanArgs, int32_t * p_BandScanType, unsigned char * p_BandScanData) BANDSCAN. |
| SDKReturnCode | CoreSdk_GetCalibrationProfile (uint32_t p_UserId, CalibrationProfile * p_CalibrationProfile) |
| SDKReturnCode | CoreSdk_GetCompressedTemporarySkeletonData (unsigned char * p_TemporarySkeletonData, uint32_t p_TemporarySkeletonLengthInBytes) Get the compressed temporary skeleton data which are stored internally when calling function CoreSdk_CompressTemporarySkeletonAndGetSize. The size of p_TemporarySkeletonData must match with p_TemporarySkeletonLengthInBytes. |
| SDKReturnCode | CoreSdk_GetCurrentRecordingProperties (PlaybackRecordingProperties * p_RecordingProperties) |
| SDKReturnCode | CoreSdk_GetDataForDongle (uint32_t p_DongleId, DongleLandscapeData * p_DongleData) Gets the data for a dongle with the given id. |
| SDKReturnCode | CoreSdk_GetDataForGlove_UsingGloveId (uint32_t p_GloveId, GloveLandscapeData * p_GloveData) Get data for the glove with the given glove ID. |
| SDKReturnCode | CoreSdk_GetDataForTracker_UsingIdAndType (uint32_t p_UserId, uint32_t p_TrackerType, TrackerData * p_TrackerData) Get data for the tracker with the given user id and type. |
| SDKReturnCode | CoreSdk_GetDataForTracker_UsingTrackerId (TrackerId p_TrackerId, TrackerData * p_TrackerData) Get data for the tracker with the given tracker Id. |
| SDKReturnCode | CoreSdk_GetDebuggingData (uint32_t p_StartIndex, DebuggingData * p_DebuggingData) |
| SDKReturnCode | CoreSdk_GetDongleIds (uint32_t * p_DongleIds, uint32_t p_NumberOfIdsThatFitInArray) Fill the given array with the IDs of all available dongles. The size of the given array must match the number of available dongles. Note that the number of available dongles can change at any time. |
| SDKReturnCode | CoreSdk_GetExtraDeviceData (uint32_t p_ExtraDeviceDataIndex, ExtraDeviceData * p_Data) |
| SDKReturnCode | CoreSdk_GetGestureLandscapeData (GestureLandscapeData * p_LandscapeDataArray, uint32_t p_ArraySize) Get the landscape data for all the gestures in the latest landscape. |
| SDKReturnCode | CoreSdk_GetGestureStreamData (uint32_t p_GestureStreamDataIndex, uint32_t p_StartDataIndex, GestureProbabilities * p_GestureProbabilitiesCollection) The start data index allows you to get more data if there are more than MAX_GESTURE_DATA_CHUNK_SIZE gestures. |
| SDKReturnCode | CoreSdk_GetGloveCalibration (unsigned char * p_CalibrationBytes, uint32_t p_Size) |
| SDKReturnCode | CoreSdk_GetGloveCalibrationSize (uint32_t p_GloveId, uint32_t * p_Size) |
| SDKReturnCode | CoreSdk_GetGloveCalibrationSizeForUser (uint32_t p_UserId, Side p_Side, GloveProfileType p_ProfileType, uint32_t * p_Size) |
| SDKReturnCode | CoreSdk_GetGloveIdOfUser_UsingUserId (uint32_t p_UserId, Side p_HandType, uint32_t * p_GloveId) Get a glove ID for the given hand of the given user identified by its Id. |
| SDKReturnCode | CoreSdk_GetGlovesForDongle (uint32_t p_DongleId, uint32_t * p_LeftGloveId, uint32_t * p_RightGloveId) Get glove id's for given dongle id. |
| SDKReturnCode | CoreSdk_GetHapticsDongleIds (uint32_t * p_HapticsDongleIds, uint32_t p_NumberOfIdsThatFitInArray) Fill the given array with the IDs of all available haptics dongles. The size of the given array must match the number of available haptics dongles. Note that the number of available haptics dongles can change at any time. |
| SDKReturnCode | CoreSdk_GetIdsOfAvailableGloves (uint32_t * p_IdsOfAvailableGloves, uint32_t p_NumberOfIdsThatFitInArray) Fill the given array with the IDs of all available gloves. The size of the given array must match the number of available gloves. Note that the number of available gloves can change at any time. |
| SDKReturnCode | CoreSdk_GetIdsOfAvailableTrackers (TrackerId * p_IdsOfAvailableTrackers, uint32_t p_NumberOfIdsThatFitInArray) Fill the given array with the IDs of available trackers. The size of the given array must match the number of available trackers. Note that the number of available trackers can change at any time. |
| SDKReturnCode | CoreSdk_GetIdsOfAvailableTrackersForUserId (TrackerId * p_IdsOfAvailableTrackers, uint32_t p_UserId, uint32_t p_NumberOfIdsThatFitInArray) Fill the given array with the IDs of available trackers for a user with given Id. The size of the given array must match the number of available trackers. Note that the number of available trackers can change at any time. |
| SDKReturnCode | CoreSdk_GetIdsOfAvailableTrackersForUserIndex (TrackerId * p_IdsOfAvailableTrackers, uint32_t p_UserIndex, uint32_t p_NumberOfIdsThatFitInArray) Fill the given array with the IDs of available trackers for a user with given Id. The size of the given array must match the number of available trackers. Note that the number of available trackers can change at any time. |
| SDKReturnCode | CoreSdk_GetIdsOfAvailableUsers (uint32_t * p_IdsOfAvailableUsers, uint32_t p_NumberOfIdsThatFitInArray) Fill the given array with the IDs of all available users. The size of the given array must match the number of available users. Note that the number of available users can change at any time depending on the landscape. |
| SDKReturnCode | CoreSdk_GetIsConnectedToCore (bool * p_ConnectedToCore) Check if the wrapper is connected to ManusCore. |
| SDKReturnCode | CoreSdk_GetLtcChannel (int32_t * p_Channel) |
| SDKReturnCode | CoreSdk_GetMeshSetupInfo (uint32_t p_SkeletonSetupIndex, uint32_t p_MeshSetupIndex, MeshSetupInfo * p_MeshSetupInfo) |
| SDKReturnCode | CoreSdk_GetNetDeviceAutoconnectPolicy (bool & p_Autoconnect) |
| SDKReturnCode | CoreSdk_GetNetDeviceMode (bool & p_Client) |
| SDKReturnCode | CoreSdk_GetNumberOfAvailableGloves (uint32_t * p_NumberOfAvailableGloves) Get the number of gloves that are available. |
| SDKReturnCode | CoreSdk_GetNumberOfAvailableHostsFound (uint32_t * p_NumberOfAvailableHostsFound) Get the number of hosts running Manus Core that were found. This is the second function to call when looking for hosts to connect to. |
| SDKReturnCode | CoreSdk_GetNumberOfAvailableTrackers (uint32_t * p_NumberOfAvailableTrackers) Get the number of available trackers. |
| SDKReturnCode | CoreSdk_GetNumberOfAvailableTrackersForUserId (uint32_t * p_NumberOfAvailableTrackers, uint32_t p_UserId) Get the number of available trackers for a user with given Id. |
| SDKReturnCode | CoreSdk_GetNumberOfAvailableTrackersForUserIndex (uint32_t * p_NumberOfAvailableTrackers, uint32_t p_UserIndex) Get the number of available trackers for a user with given Id. |
| SDKReturnCode | CoreSdk_GetNumberOfAvailableUsers (uint32_t * p_NumberOfAvailableUsers) Get the number of available users. Note that this is reliant on the landscape, and the first second after connecting the client to the core it will not yet have landscape data, so the number of users wil be 0. Since there will always be a default users, just wait until the count is above 0 and then proceed. |
| SDKReturnCode | CoreSdk_GetNumberOfDongles (uint32_t * p_NumberOfDongles) Get the number of available dongles. |
| SDKReturnCode | CoreSdk_GetNumberOfHapticsDongles (uint32_t * p_NumberOfHapticsDongles) Get the number of available haptics dongles. |
| SDKReturnCode | CoreSdk_GetRawDeviceData (uint32_t p_RawDeviceDataIndex, RawDeviceData * p_RawDeviceData) Get raw device data for the device with given index. |
| SDKReturnCode | CoreSdk_GetRawSkeletonCasingCompensation (float * p_FilterStength) Get raw skeleton casing compensation for the metaglove pro. |
| SDKReturnCode | CoreSdk_GetRawSkeletonData (uint32_t p_SkeletonIndex, SkeletonNode * p_Nodes, uint32_t p_NodeCount) Get data for the raw skeleton with given index. The size of the given array must match the nodes count. Note that the nodes count can change at any time. |
| SDKReturnCode | CoreSdk_GetRawSkeletonHandMotion (HandMotion * p_HandMotion) Get the raw skeleton hand motion type. |
| SDKReturnCode | CoreSdk_GetRawSkeletonInfo (uint32_t p_SkeletonIndex, RawSkeletonInfo * p_Info) Get information about the raw skeleton data with given index. |
| SDKReturnCode | CoreSdk_GetRawSkeletonNodeCount (uint32_t p_GloveId, uint32_t & p_NodeCount) Get the amount of nodes for the raw skeleton with given id. |
| SDKReturnCode | CoreSdk_GetRawSkeletonNodeInfo (uint32_t p_GloveId, NodeInfo * p_NodeInfo) Get the information for nodes of the raw skeleton with given id The size of the given array p_NodeInfo must match the node count retrieved from CoreSdk_GetRawSkeletonNodeCount. |
| SDKReturnCode | CoreSdk_GetRawSkeletonNodeInfoArray (uint32_t p_GloveId, NodeInfo * p_NodeInfoArray, uint32_t p_ArraySize) Get the information for nodes of the raw skeleton with given id The size of the given array p_NodeInfo and p_NodeCount must match the node count retrieved from CoreSdk_GetRawSkeletonNodeCount. |
| SDKReturnCode | CoreSdk_GetRawSkeletonPinchCompensation (bool * p_Enabled) Get raw skeleton pinch compensation for the metaglove. |
| SDKReturnCode | CoreSdk_GetRecordingData (unsigned char * p_RecordingData, uint32_t p_RecordingLengthInBytes) |
| SDKReturnCode | CoreSdk_GetSequenceState (uint32_t p_Id, SequenceStateValue * p_SequenceStateValue) |
| SDKReturnCode | CoreSdk_GetSessionId (uint32_t * p_SessionId) Get the current session Id. |
| SDKReturnCode | CoreSdk_GetSettingIgnoreNonThumbFingerIMU (bool * p_IgnoreNonThumbFingerIMU) |
| SDKReturnCode | CoreSdk_GetSettingIgnoreThumbIMU (bool * p_IgnoreThumbIMU) |
| SDKReturnCode | CoreSdk_GetSettingsRawSkeletonStream (bool & p_StreamActive) |
| SDKReturnCode | CoreSdk_GetSkeletonData (uint32_t p_SkeletonIndex, SkeletonNode * p_Nodes, uint32_t p_NodeCount) Get data for the final animated skeleton with given index. The size of the given array must match the nodes count. Note that the nodes count can change at any time. |
| SDKReturnCode | CoreSdk_GetSkeletonInfo (uint32_t p_SkeletonIndex, SkeletonInfo * p_Info) Get information about the final animated skeleton with given index. |
| SDKReturnCode | CoreSdk_GetSkeletonSetupArraySizes (uint32_t p_SkeletonSetupIndex, SkeletonSetupArraySizes * p_SkeletonInfo) Get the skeleton info (number of nodes and chains) for a SkeletonSetup at a given index. |
| SDKReturnCode | CoreSdk_GetSkeletonSetupChains (uint32_t p_SkeletonSetupIndex, ChainSetup * p_SDK) Get setup chains for a SkeletonSetup at a given index. The size of the given array must match the chains count. Note that the chains count can change at any time. |
| SDKReturnCode | CoreSdk_GetSkeletonSetupChainsArray (uint32_t p_SkeletonSetupIndex, ChainSetup * p_ChainSetupArray, uint32_t p_ArraySize) Get setup chains for a SkeletonSetup at a given index. The size of the given array must match the chains count. Note that the chains count can change at any time. |
| SDKReturnCode | CoreSdk_GetSkeletonSetupColliders (uint32_t p_SkeletonSetupIndex, ColliderSetup * p_SDK) Get setup colliders for a SkeletonSetup at a given index. The size of the given array must match the colliders count. Note that the colliders count can change at any time. |
| SDKReturnCode | CoreSdk_GetSkeletonSetupInfo (uint32_t p_SkeletonSetupIndex, SkeletonSetupInfo * p_SDK) Get setup info for a SkeletonSetup at a given index. |
| SDKReturnCode | CoreSdk_GetSkeletonSetupNodes (uint32_t p_SkeletonSetupIndex, NodeSetup * p_SDK) Get setup nodes for a SkeletonSetup at a given index. The size of the given array must match the nodes count. Note that the nodes count can change at any time. |
| SDKReturnCode | CoreSdk_GetSkeletonSetupNodesArray (uint32_t p_SkeletonSetupIndex, NodeSetup * p_NodeSetupArray, uint32_t p_ArraySize) Get setup nodes for a SkeletonSetup at a given index. The size of the given array must match the nodes count. Note that the nodes count can change at any time. |
| SDKReturnCode | CoreSdk_GetStatistics (StatisticsStream * p_Data) |
| SDKReturnCode | CoreSdk_GetStepData (uint32_t p_Id, StepData * p_StepData) |
| SDKReturnCode | CoreSdk_GetTemporarySkeleton (uint32_t p_SkeletonSetupIndex, uint32_t p_SessionId) Get a SkeletonSetup at a given index and sessionId from Manus Core. This function does NOT return a loaded skeleton! |
| SDKReturnCode | CoreSdk_GetTemporarySkeletonCountForAllSessions (TemporarySkeletonCountForAllSessions * p_TemporarySkeletonCountForAllSessions) Get temporary skeleton counts for all sessions connected to Core. |
| SDKReturnCode | CoreSdk_GetTemporarySkeletonFromCompressedData (uint32_t p_SkeletonSetupIndex, uint32_t p_SessionId, unsigned char * p_TemporarySkeletonData, uint32_t p_TemporarySkeletonLengthInBytes) Send the compressed data (an array of bytes) retrieved from a file to Core to be decompressed and converted back into a temporary skeleton. The received temporary skeleton is saved internally with the given index and to the given session id. The size of p_TemporarySkeletonData must match with p_TemporarySkeletonLengthInBytes. |
| SDKReturnCode | CoreSdk_GetTemporarySkeletonsInfoForSession (uint32_t p_SessionId, TemporarySkeletonsInfoForSession * p_TemporarySkeletonsInfoForSession) Get information (name and index) for the SkeletonSetups of the specified session. |
| SDKReturnCode | CoreSdk_GetTimecodeAutoStart (bool * p_Enabled) |
| SDKReturnCode | CoreSdk_GetTimecodeDeviceKeepAlive (bool * p_Enabled) |
| SDKReturnCode | CoreSdk_GetTimecodeGenlock (bool * p_Enabled) |
| SDKReturnCode | CoreSdk_GetTimecodeNonRealTime (bool * p_Enabled) |
| SDKReturnCode | CoreSdk_GetTimestampInfo (ManusTimestamp p_Timestamp, ManusTimestampInfo * p_Info) Gets the timestamp info (more readable form of timestamp). |
| SDKReturnCode | CoreSdk_GetTrackerData (uint32_t p_TrackerIndex, TrackerData * p_TrackerData) Get data for a tracker at a given index in the TrackerStream callback. |
| SDKReturnCode | CoreSdk_GetTrackerServiceSettings (bool * p_UseTimeout, float * p_Timeout, bool * p_KeepLastPosition) |
| SDKReturnCode | CoreSdk_GetTrackerSystemsSettings (TrackerSystem * p_TrackerSystems, uint32_t * p_TrackerSystemCount) |
| SDKReturnCode | CoreSdk_GetTrackingSystems (TrackingSystemInfo * p_Current, TrackingSystemInfo * p_Systems) |
| SDKReturnCode | CoreSdk_GetTriangleData (uint32_t p_SkeletonSetupIndex, uint32_t p_MeshSetupIndex, uint32_t p_TriangleIndex, Triangle * p_Triangle) |
| SDKReturnCode | CoreSdk_GetVersionsAndCheckCompatibility (ManusVersion * p_SdkVersion, ManusVersion * p_CoreVersion, bool * p_AreVersionsCompatible) Get the SDK and Core version used and check if they are compatible with each other. |
| SDKReturnCode | CoreSdk_GetVertexData (uint32_t p_SkeletonSetupIndex, uint32_t p_MeshSetupIndex, uint32_t p_VertexIndex, Vertex * p_Vertex) |
| SDKReturnCode | CoreSdk_GloveCalibrationFinish (GloveCalibrationArgs p_CalibrationArgs, bool * p_Result) Finish the calibration for a glove with the id that is specified in the arguments. |
| SDKReturnCode | CoreSdk_GloveCalibrationGetNumberOfSteps (GloveCalibrationArgs p_CalibrationArgs, uint32_t * p_NumberOfSteps) Get the number of steps in a glove calibration sequence. |
| SDKReturnCode | CoreSdk_GloveCalibrationGetStepData (GloveCalibrationStepArgs p_CalibrationStepArgs, GloveCalibrationStepData * p_Data) Get information data about a specific calibration step for a glove. |
| SDKReturnCode | CoreSdk_GloveCalibrationStart (GloveCalibrationArgs p_CalibrationArgs, bool * p_Result) Glove calibration. |
| SDKReturnCode | CoreSdk_GloveCalibrationStartStep (GloveCalibrationStepArgs p_CalibrationStepArgs, bool * p_Result) Start a specific calibration step for a glove. |
| SDKReturnCode | CoreSdk_GloveCalibrationStop (GloveCalibrationArgs p_CalibrationArgs, bool * p_Result) Stop the calibration for a glove with the id that is specified in the arguments. |
| SDKReturnCode | CoreSdk_InitializeCoordinateSystemWithDirection (CoordinateSystemDirection p_CoordinateSystem, bool p_UseWorldCoordinates) Initialize a coordinate system of type CoordinateSystemDirection . This has to be called before a connection is made. |
| SDKReturnCode | CoreSdk_InitializeCoordinateSystemWithVUH (CoordinateSystemVUH p_CoordinateSystem, bool p_UseWorldCoordinates) Initialize a coordinate system of type CoordinateSystemVUH . (View Up Handedness) This has to be called before a connection is made. |
| SDKReturnCode | CoreSdk_InitializeCore () Initialize Core wrapper. Call this before using the wrapper. |
| SDKReturnCode | CoreSdk_InitializeIntegrated () Initialize Core Integrated wrapper. Call this before using the wrapper. |
| SDKReturnCode | CoreSdk_IsTimecodeRunning (bool * p_Running) |
| SDKReturnCode | CoreSdk_IsUserUsingHMD (bool * p_IsUsingHMD, uint32_t p_UserId) |
| SDKReturnCode | CoreSdk_IsUsingTimecodeTimestamps (bool * p_Enabled) |
| SDKReturnCode | CoreSdk_KeepLastPosition (bool p_UseLastPosition) |
| SDKReturnCode | CoreSdk_LoadRecordingFromClientFile (unsigned char * p_RecordingData, uint32_t p_RecordingLengthInBytes, bool * p_Success) |
| SDKReturnCode | CoreSdk_LoadRecordingFromFile (char * p_PathName, bool * p_Success) |
| SDKReturnCode | CoreSdk_LoadSkeleton (uint32_t p_SkeletonSetupIndex, uint32_t * p_SkeletonId) Sends a skeleton setup to core to become a skeleton upon which data is applied. Returns the skeleton ID of the loaded skeleton, this ID is used to identify the skeleton in the SkeletonStreamCallback. Loading a skeleton into core for retargetting removes it from the temporary skeletons array, thus causing the p_SkeletonSetupIndex to no longer be valid after this call. |
| SDKReturnCode | CoreSdk_LookForHosts (uint32_t p_WaitSeconds=1, bool p_LoopbackOnly=false) Start a background task that looks for hosts running Manus Core. Call this first when looking for hosts to connect to. Underlying function will sleep for p_WaitSeconds to allow servers to reply. |
| SDKReturnCode | CoreSdk_MoveUserDown (uint32_t p_Id) Move a user one spot down in the list. This is especially relevant for applications that only support one user at a time as they often only use the first user in the list. This function only works if Auto-Assignment is disabled. |
| SDKReturnCode | CoreSdk_MoveUserUp (uint32_t p_Id) Move a user one spot up in the list. This is especially relevant for applications that only support one user at a time as they often only use the first user in the list. This function only works if Auto-Assignment is disabled. |
| SDKReturnCode | CoreSdk_NetDeviceConnect (ManusHost p_Host) |
| SDKReturnCode | CoreSdk_NetDeviceDisconnect (ManusHost p_Host) |
| SDKReturnCode | CoreSdk_NetDeviceGetAvailableHosts (ManusHost * p_Hosts, const uint32_t p_NumberOfAvailableHosts) |
| SDKReturnCode | CoreSdk_NetDeviceGetNumberOfAvailableHosts (uint32_t & p_NumberOfAvailableHosts) |
| SDKReturnCode | CoreSdk_OverwriteChainToSkeletonSetup (uint32_t p_SkeletonSetupIndex, ChainSetup p_Chain) Overwrite a chain in a SkeletonSetup, the chain to be overwritten is idenfified by p_Chain.id. |
| SDKReturnCode | CoreSdk_OverwriteNodeToSkeletonSetup (uint32_t p_SkeletonSetupIndex, NodeSetup p_Node) Overwrite a node in a SkeletonSetup, the node to be overwritten is identified by p_Node.id. |
| SDKReturnCode | CoreSdk_OverwriteSkeletonSetup (uint32_t p_SkeletonSetupIndex, SkeletonSetupInfo p_SkeletonSetup) Overwrite an existing SkeletonSetup at a given index. This will remove all chains and nodes from the current skeleton at this index. |
| SDKReturnCode | CoreSdk_PairGlove (uint32_t p_GloveID, bool * p_Success) Pairing. |
| SDKReturnCode | CoreSdk_PairGloveToDongle (uint32_t p_GloveID, uint32_t p_DongleID, bool * p_Result) Try to pair a glove to a specific dongle. |
| SDKReturnCode | CoreSdk_PrepareSkeletonSetup (uint32_t p_SkeletonSetupIndex) |
| SDKReturnCode | CoreSdk_RefreshTimecodeInterfaces (bool p_Reconnect, bool * p_Success) |
| SDKReturnCode | CoreSdk_RefreshTrackingSystems () |
| SDKReturnCode | CoreSdk_RegisterCallbackForDebuggingStream (DebuggingStreamCallback_t p_DebuggingCallback) |
| SDKReturnCode | CoreSdk_RegisterCallbackForErgonomicsStream (ErgonomicsStreamCallback_t p_ErgonomicsStreamCallback) Register the callback function that is called when ergonomics data comes in. |
| SDKReturnCode | CoreSdk_RegisterCallbackForExtraDataStream (ExtraDataStreamCallback_t p_ExtraDataCallback) |
| SDKReturnCode | CoreSdk_RegisterCallbackForGestureStream (GestureStreamCallback_t p_GestureStreamCallback) Gestures. |
| SDKReturnCode | CoreSdk_RegisterCallbackForLandscapeStream (LandscapeStreamCallback_t p_LandscapeStreamCallback) Register the callback function that is called when the landscape data comes in. |
| SDKReturnCode | CoreSdk_RegisterCallbackForOnConnect (ConnectedToCoreCallback_t p_ConnectedCallback) Register the callback function that is called when manus core gets connected to the sdk. |
| SDKReturnCode | CoreSdk_RegisterCallbackForOnDisconnect (DisconnectedFromCoreCallback_t p_DisconnectedCallback) Register the callback function that is called when manus core gets disconnected from the sdk. |
| SDKReturnCode | CoreSdk_RegisterCallbackForOnLog (LoggingCallback_t p_LoggingCallback) Register the callback function that is called when something is logged in the SDK. |
| SDKReturnCode | CoreSdk_RegisterCallbackForRawDeviceDataStream (RawDeviceDataStreamCallback_t p_RawDeviceDataStreamCallback) Register the callback function that is called when raw device data comes in. |
| SDKReturnCode | CoreSdk_RegisterCallbackForRawSkeletonStream (RawSkeletonStreamCallback_t p_RawSkeletonStreamCallback) Register the callback function that is called when skeleton data comes in. |
| SDKReturnCode | CoreSdk_RegisterCallbackForSkeletonStream (SkeletonStreamCallback_t p_SkeletonStreamCallback) Register the callback function that is called when skeleton data comes in. |
| SDKReturnCode | CoreSdk_RegisterCallbackForStatisticsStream (StatisticsStreamCallback_t p_StatisticsCallback) |
| SDKReturnCode | CoreSdk_RegisterCallbackForSystemStream (SystemStreamCallback_t p_SystemStreamCallback) Register the callback function that is called when core system related data comes in. |
| SDKReturnCode | CoreSdk_RegisterCallbackForTrackerStream (TrackerStreamCallback_t p_TrackerStreamCallback) Register the callback function that is called when tracker data comes in. |
| SDKReturnCode | CoreSdk_RemoveUser (uint32_t p_Id) Delete a user in Core with the specified ID. This function only works if Auto-Assignment is disabled. |
| SDKReturnCode | CoreSdk_ReportExportCSVFeatureUsage (ExportCSVFeatureReport p_Report, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_ReportExportFeatureUsage (ExportFeatureReport p_Report, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_ReportFeatureUsage (FeatureUsed p_Feature, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_ReportOpenXRFeatureUsage (OpenXRFeatureReport p_Report, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_ResetTrackerAssignment (uint32_t p_UserId) |
| SDKReturnCode | CoreSdk_SaveRecordingToFile (char * p_PathName, bool * p_Success) |
| SDKReturnCode | CoreSdk_SaveTemporarySkeleton (uint32_t p_SkeletonSetupIndex, uint32_t p_SessionId, bool p_IsSkeletonModified) Save a SkeletonSetup at a given index and sessionId into Manus Core for use in the Dev Tools. p_IsSkeletonModified is intended to be used mainly by the Dev Tools, it is set to true after saving any modification to the skeleton, this triggers the OnSyStemCallback which is used in the SDK to be notified about a change to its temporary skeletons. |
| SDKReturnCode | CoreSdk_SeekFrame (SeekFrameInfo p_SeekFrameInfo, ManusTimestamp * p_Timestamp) |
| SDKReturnCode | CoreSdk_SendDataForTrackers (const TrackerData * p_TrackerData, uint32_t p_NumberOfTrackers) Send data to Core for a tracker. |
| SDKReturnCode | CoreSdk_SetAutoUserAssignment (bool p_Enabled) Disable or re-enable Auto-Assignment of gloves. With this setting enabled, when new devices are connected these are automatically assigned. Users are automatically created and deleted as needed. This setting is on by default. |
| SDKReturnCode | CoreSdk_SetChannel (uint32_t p_Channel, uint32_t p_DongleId, bool * p_Success) |
| SDKReturnCode | CoreSdk_SetDonglePolygon (DonglePolygonArgs p_Args, SetPolygonDongleResponse * p_SetPolygonDongleResponse) |
| SDKReturnCode | CoreSdk_SetEnableVirtualDongles (bool p_Enable) |
| SDKReturnCode | CoreSdk_SetGloveCalibration (uint32_t p_GloveId, unsigned char * p_CalibrationBytes, uint32_t p_BytesLength, SetGloveCalibrationReturnCode * p_Result) |
| SDKReturnCode | CoreSdk_SetGloveCalibrationForUser (uint32_t p_UserId, unsigned char * p_CalibrationBytes, uint32_t p_BytesLength, SetGloveCalibrationReturnCode * p_Result) |
| SDKReturnCode | CoreSdk_SetLtcChannel (int32_t p_Channel, bool * p_Success) |
| SDKReturnCode | CoreSdk_SetNetDeviceAutoconnectPolicy (bool p_Autoconnect) |
| SDKReturnCode | CoreSdk_SetNetDeviceMode (bool p_Client) |
| SDKReturnCode | CoreSdk_SetPersistentDongleChannels (bool p_SetPersistent) |
| SDKReturnCode | CoreSdk_SetRawSkeletonCasingCompensation (float p_FilterStength) Set raw skeleton casing compensation for the metaglove pro. |
| SDKReturnCode | CoreSdk_SetRawSkeletonHandMotion (HandMotion p_HandMotion) Determine how the raw data should be moving. |
| SDKReturnCode | CoreSdk_SetRawSkeletonPinchCompensation (bool p_Enable) Set raw skeleton pinch compensation for the metaglove. |
| SDKReturnCode | CoreSdk_SetSessionType (SessionType p_SessionType) Set the session type This has to be called before a connection is made. |
| SDKReturnCode | CoreSdk_SetSessionTypeID (uint32_t p_SessionTypeID, const char * p_Secret) Set the session type ID and the secret This has to be called before a connection is made. |
| SDKReturnCode | CoreSdk_SetSettingIgnoreNonThumbFingerIMU (bool p_IgnoreNonThumbFingerIMU) |
| SDKReturnCode | CoreSdk_SetSettingIgnoreThumbIMU (bool p_IgnoreThumbIMU) |
| SDKReturnCode | CoreSdk_SetSettingsLocation (const char * p_SettingsLocation) Set the settings location The path can be a absolute (C:/[Path]) or relative (./[Path] or ../[Path]) All slashes have to be forward This has to be called before a connection is made. |
| SDKReturnCode | CoreSdk_SetSettingsRawSkeletonStream (bool p_StreamActive) Estimation Data. |
| SDKReturnCode | CoreSdk_SetTimecodeAutoStart (bool p_Enabled, bool * p_Success) |
| SDKReturnCode | CoreSdk_SetTimecodeDeviceKeepAlive (bool p_Enabled, bool * p_Success) |
| SDKReturnCode | CoreSdk_SetTimecodeGenlock (bool p_Enabled, bool * p_Success) |
| SDKReturnCode | CoreSdk_SetTimecodeNonRealTime (bool p_Enabled, bool * p_Success) |
| SDKReturnCode | CoreSdk_SetTimeout (float p_TimeOut) |
| SDKReturnCode | CoreSdk_SetTimestampInfo (ManusTimestamp * p_Timestamp, ManusTimestampInfo p_Info) Sets the timestamp according to the info (more readable form of timestamp). |
| SDKReturnCode | CoreSdk_SetTrackerOffset (uint32_t p_UserId, const TrackerOffset * p_TrackerOffset) Sets the offset of a tracker for a specified user. |
| SDKReturnCode | CoreSdk_SetTrackerSystemsSettings (TrackerSystem * p_TrackerSystems) |
| SDKReturnCode | CoreSdk_SetUserName (uint32_t p_Id, char * p_Name) Change the username of the user with the specified ID. This function only works if Auto-Assignment is disabled. |
| SDKReturnCode | CoreSdk_ShutDown () Shut down the wrapper. This needs to be called last. |
| SDKReturnCode | CoreSdk_StartNextStep (uint32_t p_Id, CompleteType * p_Message) |
| SDKReturnCode | CoreSdk_StartPlayback (bool * p_Success) |
| SDKReturnCode | CoreSdk_StartPlaybackFromSpecificTime (uint32_t p_PlaybackStartingTime, bool * p_Success) |
| SDKReturnCode | CoreSdk_StartQuantumCalibration (StartQuantumCalibrationArgs p_Args, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_StartQuantumCalibrationStep (StartQuantumCalibrationStepArgs p_Args, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_StartRecording (bool * p_Success) |
| SDKReturnCode | CoreSdk_StartSequence (StartSequenceArg p_Args, SequenceData * p_SequenceData) |
| SDKReturnCode | CoreSdk_StartTimecode (StartTimecodeArgs p_Args, bool * p_Success) |
| SDKReturnCode | CoreSdk_StopPlayback (bool * p_Success) |
| SDKReturnCode | CoreSdk_StopQuantumCalibration (uint32_t p_GloveID, bool * p_CommandResponse) |
| SDKReturnCode | CoreSdk_StopRecording (bool * p_Success) |
| SDKReturnCode | CoreSdk_StopSequence (uint32_t p_Id, CompleteType * p_Message) |
| SDKReturnCode | CoreSdk_StopTimecode (bool * p_Success) |
| SDKReturnCode | CoreSdk_UndoStep (uint32_t p_Id, CompleteType * p_Message) |
| SDKReturnCode | CoreSdk_UnloadRecording (bool * p_Success) |
| SDKReturnCode | CoreSdk_UnloadSkeleton (uint32_t p_SkeletonId) Unload a skeleton with a certain ID from Manus Core, so data will no longer be generated for it. |
| SDKReturnCode | CoreSdk_UnpairGlove (uint32_t p_GloveID, bool * p_Result) Try to unpair a glove to a dongle. |
| SDKReturnCode | CoreSdk_UpdateCore (bool p_CheckOnly, UpdateCoreResponse * p_UpdateResponse) |
| SDKReturnCode | CoreSdk_UpdateDongleFirmware (DongleUpdateArgs p_Args, DongleUpdateResponse * p_DongleUpdateResponse) |
| SDKReturnCode | CoreSdk_UseTimecodeTimestamps (bool p_Enabled) |
| SDKReturnCode | CoreSdk_UseTimeout (bool p_UseTimeOut) |
| SDKReturnCode | CoreSdk_VibrateFingers (uint32_t p_DongleId, Side p_HandType, const float * p_Powers) Vibrate the motor on the given fingers of a haptic glove. The order of the fingers is Thumb, Index, Middle, Ring, Pinky. |
| SDKReturnCode | CoreSdk_VibrateFingersForGlove (uint32_t p_GloveId, const float * p_Powers) Vibrate the motor on the given fingers of a haptic glove. The order of the fingers is Thumb, Index, Middle, Ring, Pinky. |
| SDKReturnCode | CoreSdk_VibrateFingersForSkeleton (uint32_t p_SkeletonId, Side p_HandType, const float * p_Powers) Vibrate the motor on the fingers of a haptic glove associated to skeleton with given id. The order of the fingers is Thumb, Index, Middle, Ring, Pinky. |
| SDKReturnCode | CoreSdk_WasDllBuiltInDebugConfiguration (bool * p_WasBuiltInDebugConfiguration) Check if the wrapper DLL was built in the debug configuration. |
| SDKReturnCode | CoreSdk_ZipRecordingDataAndGetSize (uint32_t * p_RecordingLengthInBytes) |
Public Attributes Documentation
variable s_CoreConnection
Public Functions Documentation
function CoreSdk_AddChainToSkeletonSetup
Add a chain to a SkeletonSetup at a given index.
Parameters:
p_SkeletonSetupIndexp_Chain
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_AddColliderToSkeletonSetup
Add a collider to a SkeletonSetup at a given index.
SDKReturnCode CoreSdk_AddColliderToSkeletonSetup (
uint32_t p_SkeletonSetupIndex,
ColliderSetup p_Collider
)
Parameters:
p_SkeletonSetupIndexp_Collider
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_AddMeshSetupToSkeletonSetup
Add a mesh setup to a SkeletonSetup at a given index.
SDKReturnCode CoreSdk_AddMeshSetupToSkeletonSetup (
uint32_t p_SkeletonSetupIndex,
uint32_t p_NodeID,
uint32_t * p_MeshSetupIndex
)
Parameters:
p_SkeletonSetupIndexp_NodeIDp_MeshSetupIndex
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_AddNodeToSkeletonSetup
Add a node to a SkeletonSetup at a given index.
Parameters:
p_SkeletonSetupIndexp_Node
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_AddTriangleToMeshSetup
Add a Triangle to a mesh setup at a given index.
SDKReturnCode CoreSdk_AddTriangleToMeshSetup (
uint32_t p_SkeletonSetupIndex,
uint32_t p_MeshSetupIndex,
Triangle p_Triangle
)
Parameters:
p_SkeletonSetupIndexp_MeshSetupIndexp_Triangle
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_AddUser
Create a new user in Core with the specified name and get its ID. This function only works if Auto-Assignment is disabled.
Parameters:
p_Namep_UserID
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_AddVertexToMeshSetup
Add a Vertex to a mesh setup at a given index.
SDKReturnCode CoreSdk_AddVertexToMeshSetup (
uint32_t p_SkeletonSetupIndex,
uint32_t p_MeshSetupIndex,
Vertex p_Vertex
)
Parameters:
p_SkeletonSetupIndexp_MeshSetupIndexp_Vertex
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_AllocateChainsForSkeletonSetup
Allocate chains for a SkeletonSetup at a given index.
Parameters:
p_SkeletonSetupIndex
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_ApplyProfile
function CoreSdk_AreDongleChannelsPersistent
function CoreSdk_AreVirtualDonglesEnabled
function CoreSdk_AssignDongleToUser
Assign a dongle to a user. This function only works if Auto-Assignment is disabled.
Parameters:
p_Idp_DongleId
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_AssignGloveToUser
Assign a glove to a user. This function only works if Auto-Assignment is disabled.
Parameters:
p_UserIdp_GloveIdp_Side
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_AssignProfileToUser
SDKReturnCode CoreSdk_AssignProfileToUser (
UserProfileArgs p_UserProfileArgs,
CompleteType * p_Message
)
function CoreSdk_AssignRoleToTracker
function CoreSdk_AssignTrackerToUser
function CoreSdk_AutoAssignTrackers
function CoreSdk_AutoGroupTrackers
function CoreSdk_CalibrateHapticsModule
function CoreSdk_CalibrationBegin
function CoreSdk_CalibrationDataGet
SDKReturnCode CoreSdk_CalibrationDataGet (
CalibrationArgs p_Args,
CalibrationData * p_CalibrationData
)
function CoreSdk_CalibrationDataSet
function CoreSdk_CalibrationEnd
function CoreSdk_CalibrationSetMax
function CoreSdk_CalibrationSetMin
function CoreSdk_CalibrationStore
function CoreSdk_ChangeUserForRole
SDKReturnCode CoreSdk_ChangeUserForRole (
TrackerType p_Role,
uint32_t p_CurrentUser,
uint32_t p_TargetUser
)
function CoreSdk_ClearAllTemporarySkeletons
Clear all temporary skeletons associated to the current session both in the sdk and core. All skeleton setups will no longer be valid after this call.
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK,
function CoreSdk_ClearTemporarySkeleton
Clear a SkeletonSetup at a given index and sessionId in Manus Core and the SDK. The given setup index will no longer be valid after this call.
SDKReturnCode CoreSdk_ClearTemporarySkeleton (
uint32_t p_SkeletonSetupIndex,
uint32_t p_SessionId
)
Parameters:
p_SkeletonSetupIndexp_SessionId
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_CompressTemporarySkeletonAndGetSize
Send a temporary skeleton to Core to compress it (convert it into an array of bytes) and then get the compressed data back in the SDK, the skeleton compressed data are stored internally. It returns the length of the bytes array for correct memory allocation. This function must be called before CoreSdk_GetCompressedTemporarySkeletonData.
SDKReturnCode CoreSdk_CompressTemporarySkeletonAndGetSize (
uint32_t p_SkeletonSetupIndex,
uint32_t p_SessionId,
uint32_t * p_TemporarySkeletonLengthInBytes
)
Parameters:
p_SkeletonSetupIndexp_SessionIdp_TemporarySkeletonLengthInBytes
Returns:
function CoreSdk_ConnectGRPC
Connect to the preset GRPC address.
Returns:
SDKReturnCode_Success SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_ConnectToHost
Connect to a host using the given host information.
Parameters:
p_Host
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_SdkIsTerminating if the sdk is being terminated, SDKReturnCode_FunctionCalledAtWrongTime if the function was not intended to be called at this time, SDKReturnCode_NoCoordinateSystemSet if the user tried to connect without first setting up the coordinate system settings.
function CoreSdk_CreateSkeletonSetup
Create a new SkeletonSetup with the given information and returns the index on which it is saved.
SDKReturnCode CoreSdk_CreateSkeletonSetup (
SkeletonSetupInfo p_Skeleton,
uint32_t * p_SkeletonSetupIndex
)
Parameters:
p_SkeletonThe SkeletonSetup information used by this skeleton.p_SkeletonSetupIndexThe index which is used by this SkeletonSetup.
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_ArgumentSizeMismatch if the maximum number of temporary skeletons per session has been reached, when this happens the user can either load or clear a temporary skeleton in order to create a new skeleton setup.
function CoreSdk_Disconnect
Disconnects from the current host.
Returns:
SDKReturnCode_Success SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_DoesSkeletonGloveSupportHaptics
Identifies if the glove associated to the skeleton with given id and side is a haptic one.
SDKReturnCode CoreSdk_DoesSkeletonGloveSupportHaptics (
uint32_t p_SkeletonId,
Side p_HandType,
bool * p_IsHaptics
)
Parameters:
p_SkeletonIdp_HandTypep_IsHaptics
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_DataNotAvailable if the requested glove is not found or if the skeleton does not have any user associated to it, SDKReturnCode_InvalidArgument if the provided p_HandType is neither Left nor Right.
function CoreSdk_EnablePlayback
function CoreSdk_GetAvailableHostsFound
Fill the given array with information on the hosts that were found. This is the third and final function to call when looking for hosts to connect to.
SDKReturnCode CoreSdk_GetAvailableHostsFound (
ManusHost * p_AvailableHostsFound,
const uint32_t p_NumberOfHostsThatFitInArray
)
Parameters:
p_AvailableHostsFoundp_NumberOfHostsThatFitInArray
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_FunctionCalledAtWrongTime if the function was not intended to be called at this time SDKReturnCode_ArgumentSizeMismatch if p_NumberOfHostsThatFitInArray does not match the number of available hosts found in the network, SDKReturnCode_InvalidArgument if the provided p_AvailableHostsFound is a null pointer, SDKReturnCode_InternalError if the number of available hosts found is higher than the defined MAX_NUMBER_OF_HOSTS, SDKReturnCode_UnsupportedStringSizeEncountered if the name of a host is higher than the defined MAX_NUM_CHARS_IN_HOST_NAME, SDKReturnCode_Error if copying the string representing the host name was not successful, SDKReturnCode_NullPointer if invalid host data was found.
function CoreSdk_GetBandScan
SDKReturnCode CoreSdk_GetBandScan (
BandScanArgs p_BandScanArgs,
int32_t * p_BandScanType,
unsigned char * p_BandScanData
)
function CoreSdk_GetCalibrationProfile
SDKReturnCode CoreSdk_GetCalibrationProfile (
uint32_t p_UserId,
CalibrationProfile * p_CalibrationProfile
)
function CoreSdk_GetCompressedTemporarySkeletonData
Get the compressed temporary skeleton data which are stored internally when calling function CoreSdk_CompressTemporarySkeletonAndGetSize. The size of p_TemporarySkeletonData must match with p_TemporarySkeletonLengthInBytes.
SDKReturnCode CoreSdk_GetCompressedTemporarySkeletonData (
unsigned char * p_TemporarySkeletonData,
uint32_t p_TemporarySkeletonLengthInBytes
)
Parameters:
p_TemporarySkeletonDatap_TemporarySkeletonLengthInBytes
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_GetCurrentRecordingProperties
SDKReturnCode CoreSdk_GetCurrentRecordingProperties (
PlaybackRecordingProperties * p_RecordingProperties
)
function CoreSdk_GetDataForDongle
Gets the data for a dongle with the given id.
Parameters:
p_DongleIdp_DongleData
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_DataNotAvailable if no dongle with the provided p_DongleId was found in the landscape.
function CoreSdk_GetDataForGlove_UsingGloveId
Get data for the glove with the given glove ID.
SDKReturnCode CoreSdk_GetDataForGlove_UsingGloveId (
uint32_t p_GloveId,
GloveLandscapeData * p_GloveData
)
Parameters:
p_GloveIdp_GloveData
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_DataNotAvailable if no glove with the provided p_GloveId was found in the landscape.
Deprecated
Get this through the Landscape instead
function CoreSdk_GetDataForTracker_UsingIdAndType
Get data for the tracker with the given user id and type.
SDKReturnCode CoreSdk_GetDataForTracker_UsingIdAndType (
uint32_t p_UserId,
uint32_t p_TrackerType,
TrackerData * p_TrackerData
)
Parameters:
p_UserIdp_TrackerTypep_TrackerData
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_DataNotAvailable if no tracker with the given p_TrackerId and the given p_TrackerType was found in the landscape.
function CoreSdk_GetDataForTracker_UsingTrackerId
Get data for the tracker with the given tracker Id.
SDKReturnCode CoreSdk_GetDataForTracker_UsingTrackerId (
TrackerId p_TrackerId,
TrackerData * p_TrackerData
)
Parameters:
p_TrackerIdp_TrackerData
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_DataNotAvailable if no tracker with the given p_TrackerId was found in the landscape.
function CoreSdk_GetDebuggingData
function CoreSdk_GetDongleIds
Fill the given array with the IDs of all available dongles. The size of the given array must match the number of available dongles. Note that the number of available dongles can change at any time.
Parameters:
p_DongleIdsp_NumberOfIdsThatFitInArray
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_ArgumentSizeMismatch if p_NumberOfIdsThatFitInArray does not match with the number of dongles found, SDKReturnCode_InvalidArgument if p_NumberOfIdsThatFitInArray is zero or higher than the defined MAX_NUMBER_OF_HAPTICS_DONGLES.
Deprecated
Get this through the Landscape instead
function CoreSdk_GetExtraDeviceData
SDKReturnCode CoreSdk_GetExtraDeviceData (
uint32_t p_ExtraDeviceDataIndex,
ExtraDeviceData * p_Data
)
function CoreSdk_GetGestureLandscapeData
Get the landscape data for all the gestures in the latest landscape.
SDKReturnCode CoreSdk_GetGestureLandscapeData (
GestureLandscapeData * p_LandscapeDataArray,
uint32_t p_ArraySize
)
Parameters:
p_LandscapeDataArrayp_ArraySize
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_ArgumentSizeMismatch if p_ArraySize is higher than the total number of gestures in the landscape stream.
function CoreSdk_GetGestureStreamData
The start data index allows you to get more data if there are more than MAX_GESTURE_DATA_CHUNK_SIZE gestures.
SDKReturnCode CoreSdk_GetGestureStreamData (
uint32_t p_GestureStreamDataIndex,
uint32_t p_StartDataIndex,
GestureProbabilities * p_GestureProbabilitiesCollection
)
Parameters:
p_GestureStreamDataIndexp_StartDataIndexp_GestureProbabilitiesCollection
Returns:
SDKReturnCode_Success if successful, or if there is no more data to get SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_ArgumentSizeMismatch if p_ArraySize is higher than the total number of gestures in the landscape stream.
function CoreSdk_GetGloveCalibration
function CoreSdk_GetGloveCalibrationSize
function CoreSdk_GetGloveCalibrationSizeForUser
SDKReturnCode CoreSdk_GetGloveCalibrationSizeForUser (
uint32_t p_UserId,
Side p_Side,
GloveProfileType p_ProfileType,
uint32_t * p_Size
)
function CoreSdk_GetGloveIdOfUser_UsingUserId
Get a glove ID for the given hand of the given user identified by its Id.
SDKReturnCode CoreSdk_GetGloveIdOfUser_UsingUserId (
uint32_t p_UserId,
Side p_HandType,
uint32_t * p_GloveId
)
Parameters:
p_UserIdp_HandTypep_GloveId
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidArgument if the provided p_HandType was neither left nor right, SDKReturnCode_InvalidID if no user with the provided p_UserId was found in the landscape.
function CoreSdk_GetGlovesForDongle
Get glove id's for given dongle id.
SDKReturnCode CoreSdk_GetGlovesForDongle (
uint32_t p_DongleId,
uint32_t * p_LeftGloveId,
uint32_t * p_RightGloveId
)
Parameters:
p_DongleIdp_LeftGloveIdp_RightGloveId
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core.
Deprecated
Get this through the Landscape instead
function CoreSdk_GetHapticsDongleIds
Fill the given array with the IDs of all available haptics dongles. The size of the given array must match the number of available haptics dongles. Note that the number of available haptics dongles can change at any time.
SDKReturnCode CoreSdk_GetHapticsDongleIds (
uint32_t * p_HapticsDongleIds,
uint32_t p_NumberOfIdsThatFitInArray
)
Parameters:
p_HapticsDongleIdsp_NumberOfIdsThatFitInArray
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_ArgumentSizeMismatch if p_NumberOfIdsThatFitInArray does not match with the number of haptic dongles found, SDKReturnCode_InvalidArgument if p_NumberOfIdsThatFitInArray is zero or higher than the defined MAX_NUMBER_OF_HAPTICS_DONGLES.
Deprecated
Get this through the Landscape instead
function CoreSdk_GetIdsOfAvailableGloves
Fill the given array with the IDs of all available gloves. The size of the given array must match the number of available gloves. Note that the number of available gloves can change at any time.
SDKReturnCode CoreSdk_GetIdsOfAvailableGloves (
uint32_t * p_IdsOfAvailableGloves,
uint32_t p_NumberOfIdsThatFitInArray
)
Parameters:
p_IdsOfAvailableGlovesp_NumberOfIdsThatFitInArray
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_ArgumentSizeMismatch if p_NumberOfIdsThatFitInArray does not match with the number of available gloves found, SDKReturnCode_InvalidArgument if p_NumberOfIdsThatFitInArray is zero or is higher than the defined MAX_NUMBER_OF_GLOVES.
function CoreSdk_GetIdsOfAvailableTrackers
Fill the given array with the IDs of available trackers. The size of the given array must match the number of available trackers. Note that the number of available trackers can change at any time.
SDKReturnCode CoreSdk_GetIdsOfAvailableTrackers (
TrackerId * p_IdsOfAvailableTrackers,
uint32_t p_NumberOfIdsThatFitInArray
)
Parameters:
p_IdsOfAvailableTrackersp_NumberOfIdsThatFitInArray
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidArgument if p_NumberOfIdsThatFitInArray is zero or higher than the defined MAX_NUMBER_OF_TRACKERS, or if p_IdsOfAvailableTrackers is a null array. SDKReturnCode_ArgumentSizeMismatch if p_NumberOfIdsThatFitInArray does not match with the number of available trackers found.
function CoreSdk_GetIdsOfAvailableTrackersForUserId
Fill the given array with the IDs of available trackers for a user with given Id. The size of the given array must match the number of available trackers. Note that the number of available trackers can change at any time.
SDKReturnCode CoreSdk_GetIdsOfAvailableTrackersForUserId (
TrackerId * p_IdsOfAvailableTrackers,
uint32_t p_UserId,
uint32_t p_NumberOfIdsThatFitInArray
)
Parameters:
p_IdsOfAvailableTrackersp_UserIdp_NumberOfIdsThatFitInArray
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidArgument if p_NumberOfIdsThatFitInArray is zero or higher than the defined MAX_NUMBER_OF_TRACKERS, or if p_IdsOfAvailableTrackers is a null array. SDKReturnCode_ArgumentSizeMismatch if p_NumberOfIdsThatFitInArray does not match with the number of available trackers found.
function CoreSdk_GetIdsOfAvailableTrackersForUserIndex
Fill the given array with the IDs of available trackers for a user with given Id. The size of the given array must match the number of available trackers. Note that the number of available trackers can change at any time.
SDKReturnCode CoreSdk_GetIdsOfAvailableTrackersForUserIndex (
TrackerId * p_IdsOfAvailableTrackers,
uint32_t p_UserIndex,
uint32_t p_NumberOfIdsThatFitInArray
)
Parameters:
p_IdsOfAvailableTrackersp_UserIndexp_NumberOfIdsThatFitInArray
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidArgument if p_NumberOfIdsThatFitInArray is zero or higher than the defined MAX_NUMBER_OF_TRACKERS, or if p_IdsOfAvailableTrackers is a null array. SDKReturnCode_ArgumentSizeMismatch if p_NumberOfIdsThatFitInArray does not match with the number of available trackers found.
function CoreSdk_GetIdsOfAvailableUsers
Fill the given array with the IDs of all available users. The size of the given array must match the number of available users. Note that the number of available users can change at any time depending on the landscape.
SDKReturnCode CoreSdk_GetIdsOfAvailableUsers (
uint32_t * p_IdsOfAvailableUsers,
uint32_t p_NumberOfIdsThatFitInArray
)
Parameters:
p_IdsOfAvailableUsersarray of ids that will get filledp_NumberOfIdsThatFitInArray
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidArgument if p_NumberOfIdsThatFitInArray is null or higher than the defined MAX_NUMBER_OF_USERS, or if p_IdsOfAvailableUsers is a null array. SDKReturnCode_ArgumentSizeMismatch if p_NumberOfIdsThatFitInArray does not match with number of available users found.
function CoreSdk_GetIsConnectedToCore
Check if the wrapper is connected to ManusCore.
Parameters:
p_ConnectedToCore
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_GetLtcChannel
function CoreSdk_GetMeshSetupInfo
SDKReturnCode CoreSdk_GetMeshSetupInfo (
uint32_t p_SkeletonSetupIndex,
uint32_t p_MeshSetupIndex,
MeshSetupInfo * p_MeshSetupInfo
)
function CoreSdk_GetNetDeviceAutoconnectPolicy
function CoreSdk_GetNetDeviceMode
function CoreSdk_GetNumberOfAvailableGloves
Get the number of gloves that are available.
Parameters:
p_NumberOfAvailableGloves
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InternalError if the number of available gloves found is higher than the defined MAX_NUMBER_OF_GLOVES.
function CoreSdk_GetNumberOfAvailableHostsFound
Get the number of hosts running Manus Core that were found. This is the second function to call when looking for hosts to connect to.
Parameters:
p_NumberOfAvailableHostsFound
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_FunctionCalledAtWrongTime if the function was not intended to be called at this time.
function CoreSdk_GetNumberOfAvailableTrackers
Get the number of available trackers.
Parameters:
p_NumberOfAvailableTrackers
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InternalError if the number of trackers found is higher than the defined MAX_NUMBER_OF_TRACKERS.
function CoreSdk_GetNumberOfAvailableTrackersForUserId
Get the number of available trackers for a user with given Id.
SDKReturnCode CoreSdk_GetNumberOfAvailableTrackersForUserId (
uint32_t * p_NumberOfAvailableTrackers,
uint32_t p_UserId
)
Parameters:
p_NumberOfAvailableTrackersp_UserId
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InternalError if the number of trackers found is higher than the defined MAX_NUMBER_OF_TRACKERS.
function CoreSdk_GetNumberOfAvailableTrackersForUserIndex
Get the number of available trackers for a user with given Id.
SDKReturnCode CoreSdk_GetNumberOfAvailableTrackersForUserIndex (
uint32_t * p_NumberOfAvailableTrackers,
uint32_t p_UserIndex
)
Parameters:
p_NumberOfAvailableTrackersp_UserIndex
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InternalError if the number of trackers found is higher than the defined MAX_NUMBER_OF_TRACKERS.
function CoreSdk_GetNumberOfAvailableUsers
Get the number of available users. Note that this is reliant on the landscape, and the first second after connecting the client to the core it will not yet have landscape data, so the number of users wil be 0. Since there will always be a default users, just wait until the count is above 0 and then proceed.
Parameters:
p_NumberOfAvailableUsers
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InternalError if the number of available users found is higher than the defined MAX_NUMBER_OF_USERS.
function CoreSdk_GetNumberOfDongles
Get the number of available dongles.
Parameters:
p_NumberOfDongles
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InternalError if the number of dongles found is higher than the defined MAX_NUMBER_OF_DONGLES.
Deprecated
Get this through the Landscape instead
function CoreSdk_GetNumberOfHapticsDongles
Get the number of available haptics dongles.
Parameters:
p_NumberOfHapticsDongles
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InternalError if the number of haptic dongles found is higher than the defined MAX_NUMBER_OF_HAPTICS_DONGLES.
Deprecated
Get this through the Landscape instead
function CoreSdk_GetRawDeviceData
Get raw device data for the device with given index.
SDKReturnCode CoreSdk_GetRawDeviceData (
uint32_t p_RawDeviceDataIndex,
RawDeviceData * p_RawDeviceData
)
Parameters:
p_RawDeviceDataIndexp_RawDeviceData
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_ArgumentSizeMismatch if p_SkeletonIndex is higher than the total number of device data received from the raw device data stream.
function CoreSdk_GetRawSkeletonCasingCompensation
Get raw skeleton casing compensation for the metaglove pro.
Parameters:
p_FilterStength
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_GetRawSkeletonData
Get data for the raw skeleton with given index. The size of the given array must match the nodes count. Note that the nodes count can change at any time.
SDKReturnCode CoreSdk_GetRawSkeletonData (
uint32_t p_SkeletonIndex,
SkeletonNode * p_Nodes,
uint32_t p_NodeCount
)
Parameters:
p_SkeletonIndexp_Nodesp_NodeCount
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_ArgumentSizeMismatch if p_SkeletonIndex is higher than the total number of skeletons received from the skeleton stream or if the provided p_NodeCount is different from the node count of that skeleton.
function CoreSdk_GetRawSkeletonHandMotion
Get the raw skeleton hand motion type.
Parameters:
p_HandMotion
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core,
function CoreSdk_GetRawSkeletonInfo
Get information about the raw skeleton data with given index.
Parameters:
p_SkeletonIndexp_Info
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_ArgumentSizeMismatch if p_SkeletonIndex is higher than the total number of skeletons received from the skeleton stream.
function CoreSdk_GetRawSkeletonNodeCount
Get the amount of nodes for the raw skeleton with given id.
Parameters:
p_GloveIdp_NodeCount
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided glove id does not match any skeleton in core
function CoreSdk_GetRawSkeletonNodeInfo
Get the information for nodes of the raw skeleton with given id The size of the given array p_NodeInfo must match the node count retrieved from CoreSdk_GetRawSkeletonNodeCount.
Parameters:
p_GloveIdp_NodeInfo
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided glove id does not match any skeleton in core
Deprecated
Use CoreSdk_GetRawSkeletonNodeInfoArray instead
function CoreSdk_GetRawSkeletonNodeInfoArray
Get the information for nodes of the raw skeleton with given id The size of the given array p_NodeInfo and p_NodeCount must match the node count retrieved from CoreSdk_GetRawSkeletonNodeCount.
SDKReturnCode CoreSdk_GetRawSkeletonNodeInfoArray (
uint32_t p_GloveId,
NodeInfo * p_NodeInfoArray,
uint32_t p_ArraySize
)
Parameters:
p_GloveIdp_NodeInfoArrayp_ArraySize
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided glove id does not match any skeleton in core, SDKReturnCode_ArgumentSizeMismatch if p_ArraySize does not match node count retrieved from CoreSdk_GetRawSkeletonNodeCount.
function CoreSdk_GetRawSkeletonPinchCompensation
Get raw skeleton pinch compensation for the metaglove.
Parameters:
p_SetPinchCompensation
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_GetRecordingData
SDKReturnCode CoreSdk_GetRecordingData (
unsigned char * p_RecordingData,
uint32_t p_RecordingLengthInBytes
)
function CoreSdk_GetSequenceState
function CoreSdk_GetSessionId
Get the current session Id.
Parameters:
p_SessionId
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_InvalidID if the session id is zero, which means it was not correctly assigned.
function CoreSdk_GetSettingIgnoreNonThumbFingerIMU
function CoreSdk_GetSettingIgnoreThumbIMU
function CoreSdk_GetSettingsRawSkeletonStream
function CoreSdk_GetSkeletonData
Get data for the final animated skeleton with given index. The size of the given array must match the nodes count. Note that the nodes count can change at any time.
SDKReturnCode CoreSdk_GetSkeletonData (
uint32_t p_SkeletonIndex,
SkeletonNode * p_Nodes,
uint32_t p_NodeCount
)
Parameters:
p_SkeletonIndexp_Nodesp_NodeCount
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_ArgumentSizeMismatch if p_SkeletonIndex is higher than the total number of skeletons received from the skeleton stream or if the provided p_NodeCount is different from the node count of that skeleton.
function CoreSdk_GetSkeletonInfo
Get information about the final animated skeleton with given index.
Parameters:
p_SkeletonIndexp_Info
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_ArgumentSizeMismatch if p_SkeletonIndex is higher than the total number of skeletons received from the skeleton stream.
function CoreSdk_GetSkeletonSetupArraySizes
Get the skeleton info (number of nodes and chains) for a SkeletonSetup at a given index.
SDKReturnCode CoreSdk_GetSkeletonSetupArraySizes (
uint32_t p_SkeletonSetupIndex,
SkeletonSetupArraySizes * p_SkeletonInfo
)
Parameters:
p_SkeletonSetupIndexp_SkeletonInfo
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_GetSkeletonSetupChains
Get setup chains for a SkeletonSetup at a given index. The size of the given array must match the chains count. Note that the chains count can change at any time.
Parameters:
p_SkeletonSetupIndexp_SDK
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_NullPointer if the provided p_SDK (used to store the setup chains) is a null pointer, it should be initialized to an array with size equal to the chains count, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
Deprecated
Use GetSkeletonSetupChainsArray() instead
function CoreSdk_GetSkeletonSetupChainsArray
Get setup chains for a SkeletonSetup at a given index. The size of the given array must match the chains count. Note that the chains count can change at any time.
SDKReturnCode CoreSdk_GetSkeletonSetupChainsArray (
uint32_t p_SkeletonSetupIndex,
ChainSetup * p_ChainSetupArray,
uint32_t p_ArraySize
)
Parameters:
p_SkeletonSetupIndexp_ChainSetupArrayp_ArraySize
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_NullPointer if the provided p_ChainSetupArray (used to store the setup chains) is a null pointer, it should be initialized to an array with size equal to the chains count, SDKReturnCode_ArgumentSizeMismatch if the provided p_ArraySize is not equal to the chains count, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_GetSkeletonSetupColliders
Get setup colliders for a SkeletonSetup at a given index. The size of the given array must match the colliders count. Note that the colliders count can change at any time.
SDKReturnCode CoreSdk_GetSkeletonSetupColliders (
uint32_t p_SkeletonSetupIndex,
ColliderSetup * p_SDK
)
Parameters:
p_SkeletonSetupIndexp_SDK
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_NullPointer if the provided p_SDK (used to store the setup colliders) is a null pointer, it should be initialized to an array with size equal to the colliders count, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
Deprecated
function CoreSdk_GetSkeletonSetupInfo
Get setup info for a SkeletonSetup at a given index.
SDKReturnCode CoreSdk_GetSkeletonSetupInfo (
uint32_t p_SkeletonSetupIndex,
SkeletonSetupInfo * p_SDK
)
Parameters:
p_SkeletonSetupIndexp_SDK
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, /// SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_GetSkeletonSetupNodes
Get setup nodes for a SkeletonSetup at a given index. The size of the given array must match the nodes count. Note that the nodes count can change at any time.
Parameters:
p_SkeletonSetupIndexp_SDK
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_NullPointer if the provided p_SDK (used to store the setup nodes) is a null pointer, it should be initialized to an array with size equal to the nodes count, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
Deprecated
Use GetSkeletonSetupNodesArray() instead
function CoreSdk_GetSkeletonSetupNodesArray
Get setup nodes for a SkeletonSetup at a given index. The size of the given array must match the nodes count. Note that the nodes count can change at any time.
SDKReturnCode CoreSdk_GetSkeletonSetupNodesArray (
uint32_t p_SkeletonSetupIndex,
NodeSetup * p_NodeSetupArray,
uint32_t p_ArraySize
)
Parameters:
p_SkeletonSetupIndexp_NodeSetupArrayp_ArraySize
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_NullPointer if the provided p_SDK (used to store the setup nodes) is a null pointer, it should be initialized to an array with size equal to the nodes count, SDKReturnCode_ArgumentSizeMismatch if the provided p_ArraySize is not equal to the nodes count, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_GetStatistics
function CoreSdk_GetStepData
function CoreSdk_GetTemporarySkeleton
Get a SkeletonSetup at a given index and sessionId from Manus Core. This function does NOT return a loaded skeleton!
Parameters:
p_SkeletonSetupIndexp_SessionId
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK,
function CoreSdk_GetTemporarySkeletonCountForAllSessions
Get temporary skeleton counts for all sessions connected to Core.
SDKReturnCode CoreSdk_GetTemporarySkeletonCountForAllSessions (
TemporarySkeletonCountForAllSessions * p_TemporarySkeletonCountForAllSessions
)
Parameters:
p_temporarySkeletonSessionsData
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_GetTemporarySkeletonFromCompressedData
Send the compressed data (an array of bytes) retrieved from a file to Core to be decompressed and converted back into a temporary skeleton. The received temporary skeleton is saved internally with the given index and to the given session id. The size of p_TemporarySkeletonData must match with p_TemporarySkeletonLengthInBytes.
SDKReturnCode CoreSdk_GetTemporarySkeletonFromCompressedData (
uint32_t p_SkeletonSetupIndex,
uint32_t p_SessionId,
unsigned char * p_TemporarySkeletonData,
uint32_t p_TemporarySkeletonLengthInBytes
)
Parameters:
p_SkeletonSetupIndexp_SessionIdp_TemporarySkeletonDatap_TemporarySkeletonLengthInBytes
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK,
function CoreSdk_GetTemporarySkeletonsInfoForSession
Get information (name and index) for the SkeletonSetups of the specified session.
SDKReturnCode CoreSdk_GetTemporarySkeletonsInfoForSession (
uint32_t p_SessionId,
TemporarySkeletonsInfoForSession * p_TemporarySkeletonsInfoForSession
)
Parameters:
p_SessionIdp_temporarySkeletonSessionsData
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_GetTimecodeAutoStart
function CoreSdk_GetTimecodeDeviceKeepAlive
function CoreSdk_GetTimecodeGenlock
function CoreSdk_GetTimecodeNonRealTime
function CoreSdk_GetTimestampInfo
Gets the timestamp info (more readable form of timestamp).
Parameters:
p_TimestampTimestamp to get info fromp_InfoInfo of the timestamp
Returns:
SDKReturnCode_Success if successful.
function CoreSdk_GetTrackerData
Get data for a tracker at a given index in the TrackerStream callback.
Parameters:
p_TrackerIndexp_TrackerData
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_ArgumentSizeMismatch if p_TrackerIndex is higher than the total number of trackers received from the tracker stream.
function CoreSdk_GetTrackerServiceSettings
SDKReturnCode CoreSdk_GetTrackerServiceSettings (
bool * p_UseTimeout,
float * p_Timeout,
bool * p_KeepLastPosition
)
function CoreSdk_GetTrackerSystemsSettings
SDKReturnCode CoreSdk_GetTrackerSystemsSettings (
TrackerSystem * p_TrackerSystems,
uint32_t * p_TrackerSystemCount
)
function CoreSdk_GetTrackingSystems
SDKReturnCode CoreSdk_GetTrackingSystems (
TrackingSystemInfo * p_Current,
TrackingSystemInfo * p_Systems
)
function CoreSdk_GetTriangleData
SDKReturnCode CoreSdk_GetTriangleData (
uint32_t p_SkeletonSetupIndex,
uint32_t p_MeshSetupIndex,
uint32_t p_TriangleIndex,
Triangle * p_Triangle
)
function CoreSdk_GetVersionsAndCheckCompatibility
Get the SDK and Core version used and check if they are compatible with each other.
SDKReturnCode CoreSdk_GetVersionsAndCheckCompatibility (
ManusVersion * p_SdkVersion,
ManusVersion * p_CoreVersion,
bool * p_AreVersionsCompatible
)
Parameters:
p_SdkVersionp_CoreVersionp_AreVersionsCompatible
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_GetVertexData
SDKReturnCode CoreSdk_GetVertexData (
uint32_t p_SkeletonSetupIndex,
uint32_t p_MeshSetupIndex,
uint32_t p_VertexIndex,
Vertex * p_Vertex
)
function CoreSdk_GloveCalibrationFinish
Finish the calibration for a glove with the id that is specified in the arguments.
SDKReturnCode CoreSdk_GloveCalibrationFinish (
GloveCalibrationArgs p_CalibrationArgs,
bool * p_Result
)
Parameters:
p_CalibrationArgsp_Result
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core
function CoreSdk_GloveCalibrationGetNumberOfSteps
Get the number of steps in a glove calibration sequence.
SDKReturnCode CoreSdk_GloveCalibrationGetNumberOfSteps (
GloveCalibrationArgs p_CalibrationArgs,
uint32_t * p_NumberOfSteps
)
Parameters:
p_CalibrationArgsp_NumberOfSteps
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core
function CoreSdk_GloveCalibrationGetStepData
Get information data about a specific calibration step for a glove.
SDKReturnCode CoreSdk_GloveCalibrationGetStepData (
GloveCalibrationStepArgs p_CalibrationStepArgs,
GloveCalibrationStepData * p_Data
)
Parameters:
p_CalibrationStepArgsp_Data
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core
function CoreSdk_GloveCalibrationStart
Glove calibration.
SDKReturnCode CoreSdk_GloveCalibrationStart (
GloveCalibrationArgs p_CalibrationArgs,
bool * p_Result
)
Start the calibration for a glove with the id that is specified in the arguments.
function CoreSdk_GloveCalibrationStartStep
Start a specific calibration step for a glove.
SDKReturnCode CoreSdk_GloveCalibrationStartStep (
GloveCalibrationStepArgs p_CalibrationStepArgs,
bool * p_Result
)
Parameters:
p_CalibrationStepArgsp_Result
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core
function CoreSdk_GloveCalibrationStop
Stop the calibration for a glove with the id that is specified in the arguments.
SDKReturnCode CoreSdk_GloveCalibrationStop (
GloveCalibrationArgs p_CalibrationArgs,
bool * p_Result
)
Parameters:
p_CalibrationArgsp_Result
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core
function CoreSdk_InitializeCoordinateSystemWithDirection
Initialize a coordinate system of type CoordinateSystemDirection . This has to be called before a connection is made.
SDKReturnCode CoreSdk_InitializeCoordinateSystemWithDirection (
CoordinateSystemDirection p_CoordinateSystem,
bool p_UseWorldCoordinates
)
Parameters:
p_CoordinateSystemp_UseWorldCoordinatesif true all data will be defined with respect to a world coordinate system, if false all data will be defined with respect to a local one,
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_InitializeCoordinateSystemWithVUH
Initialize a coordinate system of type CoordinateSystemVUH . (View Up Handedness) This has to be called before a connection is made.
SDKReturnCode CoreSdk_InitializeCoordinateSystemWithVUH (
CoordinateSystemVUH p_CoordinateSystem,
bool p_UseWorldCoordinates
)
Parameters:
p_CoordinateSystemp_UseWorldCoordinatesif true all data will be defined with respect to a world coordinate system, if false all data will be defined with respect to a local one,
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_InitializeCore
Initialize Core wrapper. Call this before using the wrapper.
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_FunctionCalledAtWrongTime if the function was not intended to be called at this time.
function CoreSdk_InitializeIntegrated
Initialize Core Integrated wrapper. Call this before using the wrapper.
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_FunctionCalledAtWrongTime if the function was not intended to be called at this time.
function CoreSdk_IsTimecodeRunning
function CoreSdk_IsUserUsingHMD
function CoreSdk_IsUsingTimecodeTimestamps
function CoreSdk_KeepLastPosition
function CoreSdk_LoadRecordingFromClientFile
SDKReturnCode CoreSdk_LoadRecordingFromClientFile (
unsigned char * p_RecordingData,
uint32_t p_RecordingLengthInBytes,
bool * p_Success
)
function CoreSdk_LoadRecordingFromFile
function CoreSdk_LoadSkeleton
Sends a skeleton setup to core to become a skeleton upon which data is applied. Returns the skeleton ID of the loaded skeleton, this ID is used to identify the skeleton in the SkeletonStreamCallback. Loading a skeleton into core for retargetting removes it from the temporary skeletons array, thus causing the p_SkeletonSetupIndex to no longer be valid after this call.
Parameters:
p_SkeletonSetupIndexThe SkeletonSetup's index, will become invalid after this function.p_SkeletonIdThis is the ID of the loaded skeleton.
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_LookForHosts
Start a background task that looks for hosts running Manus Core. Call this first when looking for hosts to connect to. Underlying function will sleep for p_WaitSeconds to allow servers to reply.
Parameters:
p_WaitSecondsdefines the time the function will sleep for to allow servers to reply,p_LoopbackOnlyif true it looks for hosts only locally, if false it looks for hosts anywhere in the network,
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_FunctionCalledAtWrongTime if the function was not intended to be called at this time.
function CoreSdk_MoveUserDown
Move a user one spot down in the list. This is especially relevant for applications that only support one user at a time as they often only use the first user in the list. This function only works if Auto-Assignment is disabled.
Parameters:
p_Id
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_MoveUserUp
Move a user one spot up in the list. This is especially relevant for applications that only support one user at a time as they often only use the first user in the list. This function only works if Auto-Assignment is disabled.
Parameters:
p_Id
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_NetDeviceConnect
function CoreSdk_NetDeviceDisconnect
function CoreSdk_NetDeviceGetAvailableHosts
SDKReturnCode CoreSdk_NetDeviceGetAvailableHosts (
ManusHost * p_Hosts,
const uint32_t p_NumberOfAvailableHosts
)
function CoreSdk_NetDeviceGetNumberOfAvailableHosts
function CoreSdk_OverwriteChainToSkeletonSetup
Overwrite a chain in a SkeletonSetup, the chain to be overwritten is idenfified by p_Chain.id.
SDKReturnCode CoreSdk_OverwriteChainToSkeletonSetup (
uint32_t p_SkeletonSetupIndex,
ChainSetup p_Chain
)
Parameters:
p_SkeletonSetupIndexThe SkeletonSetup's index, not to be confused by the Chain's ID.p_ChainThe chain to replace the matching (via id) chain with.
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_OverwriteNodeToSkeletonSetup
Overwrite a node in a SkeletonSetup, the node to be overwritten is identified by p_Node.id.
SDKReturnCode CoreSdk_OverwriteNodeToSkeletonSetup (
uint32_t p_SkeletonSetupIndex,
NodeSetup p_Node
)
Parameters:
p_SkeletonSetupIndexThe SkeletonSetup's index, not to be confused by the Chain's ID.p_NodeThe node to replace the matching (via id) node with.
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_OverwriteSkeletonSetup
Overwrite an existing SkeletonSetup at a given index. This will remove all chains and nodes from the current skeleton at this index.
SDKReturnCode CoreSdk_OverwriteSkeletonSetup (
uint32_t p_SkeletonSetupIndex,
SkeletonSetupInfo p_SkeletonSetup
)
Parameters:
p_SkeletonSetupIndexp_SkeletonSetup
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup, SDKReturnCode_NullPointer if the skeleton setup was not correctly saved, thus the new skeleton setup is a null pointer.
function CoreSdk_PairGlove
Pairing.
Try to pair a glove to a dongle.
function CoreSdk_PairGloveToDongle
Try to pair a glove to a specific dongle.
SDKReturnCode CoreSdk_PairGloveToDongle (
uint32_t p_GloveID,
uint32_t p_DongleID,
bool * p_Result
)
Parameters:
p_GloveIDp_DongleID
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_PrepareSkeletonSetup
function CoreSdk_RefreshTimecodeInterfaces
function CoreSdk_RefreshTrackingSystems
function CoreSdk_RegisterCallbackForDebuggingStream
SDKReturnCode CoreSdk_RegisterCallbackForDebuggingStream (
DebuggingStreamCallback_t p_DebuggingCallback
)
function CoreSdk_RegisterCallbackForErgonomicsStream
Register the callback function that is called when ergonomics data comes in.
SDKReturnCode CoreSdk_RegisterCallbackForErgonomicsStream (
ErgonomicsStreamCallback_t p_ErgonomicsStreamCallback
)
Parameters:
p_ErgonomicsStreamCallback
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_RegisterCallbackForExtraDataStream
SDKReturnCode CoreSdk_RegisterCallbackForExtraDataStream (
ExtraDataStreamCallback_t p_ExtraDataCallback
)
function CoreSdk_RegisterCallbackForGestureStream
Gestures.
SDKReturnCode CoreSdk_RegisterCallbackForGestureStream (
GestureStreamCallback_t p_GestureStreamCallback
)
Register the callback function that is called when gesture data comes in.
function CoreSdk_RegisterCallbackForLandscapeStream
Register the callback function that is called when the landscape data comes in.
SDKReturnCode CoreSdk_RegisterCallbackForLandscapeStream (
LandscapeStreamCallback_t p_LandscapeStreamCallback
)
Parameters:
p_LandscapeStreamCallback
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_RegisterCallbackForOnConnect
Register the callback function that is called when manus core gets connected to the sdk.
SDKReturnCode CoreSdk_RegisterCallbackForOnConnect (
ConnectedToCoreCallback_t p_ConnectedCallback
)
Parameters:
p_ConnectedCallback
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_RegisterCallbackForOnDisconnect
Register the callback function that is called when manus core gets disconnected from the sdk.
SDKReturnCode CoreSdk_RegisterCallbackForOnDisconnect (
DisconnectedFromCoreCallback_t p_DisconnectedCallback
)
Parameters:
p_DisconnectedCallback
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_RegisterCallbackForOnLog
Register the callback function that is called when something is logged in the SDK.
Parameters:
p_LoggingCallback
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_RegisterCallbackForRawDeviceDataStream
Register the callback function that is called when raw device data comes in.
SDKReturnCode CoreSdk_RegisterCallbackForRawDeviceDataStream (
RawDeviceDataStreamCallback_t p_RawDeviceDataStreamCallback
)
Parameters:
p_RawDeviceDataStreamCallback
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_RegisterCallbackForRawSkeletonStream
Register the callback function that is called when skeleton data comes in.
SDKReturnCode CoreSdk_RegisterCallbackForRawSkeletonStream (
RawSkeletonStreamCallback_t p_RawSkeletonStreamCallback
)
Parameters:
p_SkeletonStreamCallback
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_RegisterCallbackForSkeletonStream
Register the callback function that is called when skeleton data comes in.
SDKReturnCode CoreSdk_RegisterCallbackForSkeletonStream (
SkeletonStreamCallback_t p_SkeletonStreamCallback
)
Parameters:
p_SkeletonStreamCallback
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_RegisterCallbackForStatisticsStream
SDKReturnCode CoreSdk_RegisterCallbackForStatisticsStream (
StatisticsStreamCallback_t p_StatisticsCallback
)
function CoreSdk_RegisterCallbackForSystemStream
Register the callback function that is called when core system related data comes in.
SDKReturnCode CoreSdk_RegisterCallbackForSystemStream (
SystemStreamCallback_t p_SystemStreamCallback
)
Parameters:
p_SystemStreamCallback
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_RegisterCallbackForTrackerStream
Register the callback function that is called when tracker data comes in.
SDKReturnCode CoreSdk_RegisterCallbackForTrackerStream (
TrackerStreamCallback_t p_TrackerStreamCallback
)
Parameters:
p_TrackerStreamCallback
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_RemoveUser
Delete a user in Core with the specified ID. This function only works if Auto-Assignment is disabled.
Parameters:
p_Id
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_ReportExportCSVFeatureUsage
SDKReturnCode CoreSdk_ReportExportCSVFeatureUsage (
ExportCSVFeatureReport p_Report,
bool * p_CommandResponse
)
function CoreSdk_ReportExportFeatureUsage
SDKReturnCode CoreSdk_ReportExportFeatureUsage (
ExportFeatureReport p_Report,
bool * p_CommandResponse
)
function CoreSdk_ReportFeatureUsage
function CoreSdk_ReportOpenXRFeatureUsage
SDKReturnCode CoreSdk_ReportOpenXRFeatureUsage (
OpenXRFeatureReport p_Report,
bool * p_CommandResponse
)
function CoreSdk_ResetTrackerAssignment
function CoreSdk_SaveRecordingToFile
function CoreSdk_SaveTemporarySkeleton
Save a SkeletonSetup at a given index and sessionId into Manus Core for use in the Dev Tools. p_IsSkeletonModified is intended to be used mainly by the Dev Tools, it is set to true after saving any modification to the skeleton, this triggers the OnSyStemCallback which is used in the SDK to be notified about a change to its temporary skeletons.
SDKReturnCode CoreSdk_SaveTemporarySkeleton (
uint32_t p_SkeletonSetupIndex,
uint32_t p_SessionId,
bool p_IsSkeletonModified
)
Parameters:
p_SkeletonSetupIndexp_SessionIdp_IsSkeletonModified
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_InvalidID if the provided p_SkeletonSetupIndex does not correspond to any skeleton setup.
function CoreSdk_SeekFrame
function CoreSdk_SendDataForTrackers
Send data to Core for a tracker.
SDKReturnCode CoreSdk_SendDataForTrackers (
const TrackerData * p_TrackerData,
uint32_t p_NumberOfTrackers
)
Parameters:
p_TrackerDatap_NumberOfTrackersamount of trackers for which we send the information
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NullPointer if the provided p_TrackerData is a null pointer, SDKReturnCode_InvalidArgument if p_NumberOfTrackers is null or higher than the defined MAX_NUMBER_OF_TRACKERS.
function CoreSdk_SetAutoUserAssignment
Disable or re-enable Auto-Assignment of gloves. With this setting enabled, when new devices are connected these are automatically assigned. Users are automatically created and deleted as needed. This setting is on by default.
Parameters:
p_Enabled
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_SetChannel
function CoreSdk_SetDonglePolygon
SDKReturnCode CoreSdk_SetDonglePolygon (
DonglePolygonArgs p_Args,
SetPolygonDongleResponse * p_SetPolygonDongleResponse
)
EXTENDED FUNCTIONS FOR DASHBOARD SUPPORT Extended Gloves/Dongles
function CoreSdk_SetEnableVirtualDongles
function CoreSdk_SetGloveCalibration
SDKReturnCode CoreSdk_SetGloveCalibration (
uint32_t p_GloveId,
unsigned char * p_CalibrationBytes,
uint32_t p_BytesLength,
SetGloveCalibrationReturnCode * p_Result
)
function CoreSdk_SetGloveCalibrationForUser
SDKReturnCode CoreSdk_SetGloveCalibrationForUser (
uint32_t p_UserId,
unsigned char * p_CalibrationBytes,
uint32_t p_BytesLength,
SetGloveCalibrationReturnCode * p_Result
)
function CoreSdk_SetLtcChannel
function CoreSdk_SetNetDeviceAutoconnectPolicy
function CoreSdk_SetNetDeviceMode
function CoreSdk_SetPersistentDongleChannels
function CoreSdk_SetRawSkeletonCasingCompensation
Set raw skeleton casing compensation for the metaglove pro.
Parameters:
p_FilterStength
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_SetRawSkeletonHandMotion
Determine how the raw data should be moving.
Parameters:
p_HandMotion
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core,
function CoreSdk_SetRawSkeletonPinchCompensation
Set raw skeleton pinch compensation for the metaglove.
Parameters:
p_SetPinchCompensation
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_SetSessionType
Set the session type This has to be called before a connection is made.
Parameters:
p_SessionType
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_SetSessionTypeID
Set the session type ID and the secret This has to be called before a connection is made.
Parameters:
p_SessionTypeIDp_Secret
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_SetSettingIgnoreNonThumbFingerIMU
function CoreSdk_SetSettingIgnoreThumbIMU
function CoreSdk_SetSettingsLocation
Set the settings location The path can be a absolute (C:/[Path]) or relative (./[Path] or ../[Path]) All slashes have to be forward This has to be called before a connection is made.
Parameters:
p_SettingsLocation
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_SetSettingsRawSkeletonStream
function CoreSdk_SetTimecodeAutoStart
function CoreSdk_SetTimecodeDeviceKeepAlive
function CoreSdk_SetTimecodeGenlock
function CoreSdk_SetTimecodeNonRealTime
function CoreSdk_SetTimeout
function CoreSdk_SetTimestampInfo
Sets the timestamp according to the info (more readable form of timestamp).
Parameters:
p_Timestampthe Timestamp to set info ofp_InfoInfo to get info from
Returns:
SDKReturnCode_Success if successful.
function CoreSdk_SetTrackerOffset
Sets the offset of a tracker for a specified user.
Parameters:
p_UserIdp_TrackerOffset
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_SetTrackerSystemsSettings
function CoreSdk_SetUserName
Change the username of the user with the specified ID. This function only works if Auto-Assignment is disabled.
Parameters:
p_Idp_Name
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_ShutDown
Shut down the wrapper. This needs to be called last.
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_StartNextStep
function CoreSdk_StartPlayback
function CoreSdk_StartPlaybackFromSpecificTime
SDKReturnCode CoreSdk_StartPlaybackFromSpecificTime (
uint32_t p_PlaybackStartingTime,
bool * p_Success
)
function CoreSdk_StartQuantumCalibration
SDKReturnCode CoreSdk_StartQuantumCalibration (
StartQuantumCalibrationArgs p_Args,
bool * p_CommandResponse
)
function CoreSdk_StartQuantumCalibrationStep
SDKReturnCode CoreSdk_StartQuantumCalibrationStep (
StartQuantumCalibrationStepArgs p_Args,
bool * p_CommandResponse
)
function CoreSdk_StartRecording
function CoreSdk_StartSequence
function CoreSdk_StartTimecode
function CoreSdk_StopPlayback
function CoreSdk_StopQuantumCalibration
function CoreSdk_StopRecording
function CoreSdk_StopSequence
function CoreSdk_StopTimecode
function CoreSdk_UndoStep
function CoreSdk_UnloadRecording
function CoreSdk_UnloadSkeleton
Unload a skeleton with a certain ID from Manus Core, so data will no longer be generated for it.
Parameters:
p_SkeletonIdThe Skeleton's ID which is assigned by Manus Core.
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_StubNullPointer if the stub has been reset but someone is trying to use it anyway. This usually happens after a shutdown of the SDK, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_UnpairGlove
Try to unpair a glove to a dongle.
Parameters:
p_GloveID
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available.
function CoreSdk_UpdateCore
function CoreSdk_UpdateDongleFirmware
SDKReturnCode CoreSdk_UpdateDongleFirmware (
DongleUpdateArgs p_Args,
DongleUpdateResponse * p_DongleUpdateResponse
)
function CoreSdk_UseTimecodeTimestamps
function CoreSdk_UseTimeout
function CoreSdk_VibrateFingers
Vibrate the motor on the given fingers of a haptic glove. The order of the fingers is Thumb, Index, Middle, Ring, Pinky.
SDKReturnCode CoreSdk_VibrateFingers (
uint32_t p_DongleId,
Side p_HandType,
const float * p_Powers
)
Parameters:
p_DongleIdp_HandTypep_Powersstrength of the vibration, should be an array of 5 values
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core.
Deprecated
Use CoreSdk_VibrateFingersForGlove or CoreSdk_VibrateFingersForSkeleton instead
function CoreSdk_VibrateFingersForGlove
Vibrate the motor on the given fingers of a haptic glove. The order of the fingers is Thumb, Index, Middle, Ring, Pinky.
Parameters:
p_GloveIdp_Powersstrength of the vibration, should be an array of 5 values
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_VibrateFingersForSkeleton
Vibrate the motor on the fingers of a haptic glove associated to skeleton with given id. The order of the fingers is Thumb, Index, Middle, Ring, Pinky.
SDKReturnCode CoreSdk_VibrateFingersForSkeleton (
uint32_t p_SkeletonId,
Side p_HandType,
const float * p_Powers
)
Parameters:
p_SkeletonIdp_HandTypep_Powersstrength of the vibration, should be an array of 5 values
Returns:
SDKReturnCode_Success if successful, SDKReturnCode_SdkNotAvailable if the Core SDK is not available, SDKReturnCode_NotConnected if there is no connection to core.
function CoreSdk_WasDllBuiltInDebugConfiguration
Check if the wrapper DLL was built in the debug configuration.
Parameters:
p_WasBuiltInDebugConfiguration
Returns:
SDKReturnCode_Success if successful.
function CoreSdk_ZipRecordingDataAndGetSize
The documentation for this class was generated from the following file api/cppSDK/SDKBase/ManusSDK.cpp