This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Objects
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine::Plugins::Suit Class

Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Sim SDK edition to use it.
Header: #include <plugins/UnigineTeslaSuit.h>

Suit Class

Enums

TSP_BUFFER_SIZE#

NameDescription
TSP_HIT_POLYGON_SIZE = 24Size of the array of TSPoint2D that form a polygon.
TSP_NODE_COUNT = 12Number of nodes in the array.
TSP_CHANNEL_COUNT = 64Number of channels in the array.
TSP_NODE_MODULES_COUNT = 4Number of node modules in the array.
TSP_MOTION_DATA_BUFFER_SIZE = 10Size of the array of buffered motion data.
TSP_ECG_BUFFER_SIZE = 25Size of the array of buffered ECG data.
TSP_GSR_CHANNELS_BUFFER_SIZE = 16Size of the array of GSR data.

TSP_R_CODE#

NameDescription
TSP_SUCCESS = 1Function execution was successful.
TSP_FAIL = 2Function execution failed due to unknown error.
TSP_FAIL_ARG = 3Wrong parameters were passed. Check for nullptr.
TSP_FAIL_SH_MEM = 4Could not initialize shared memory. Check TESLASUIT.service status. It must be running.
TSP_FAIL_QUEUE_1 = 5Could not send the command.
TSP_FAIL_QUEUE_2 = 6Could not receive the command.
TSP_FAIL_STARTED = 7setConnectionListeners() has already been invoked.
TSP_FAIL_NOT_STARTED = 8setConnectionListeners() has not been invoked. Nothing to stop.
TSP_FAIL_SUIT = 9Could not find suit with given suit ID.
TSP_FAIL_MAPPING = 10Incorrect mapping.
TSP_FAIL_SERVICE_0 = 11Deprecated.
TSP_FAIL_SERVICE_1 = 12OpenSCManager failed.
TSP_FAIL_SERVICE_2 = 13OpenService failed.
TSP_FAIL_SERVICE_3 = 14QueryServiceStatusEx failed.
TSP_FAIL_SERVICE_4 = 15Could not start the TESLASUIT.service, because it has been already running.
TSP_FAIL_SERVICE_5 = 16QueryServiceStatusEx failed.
TSP_FAIL_SERVICE_6 = 17Timeout when changing TESLASUIT.service from stopping to stopped.
TSP_FAIL_SERVICE_7 = 18StartService failed.
TSP_FAIL_SERVICE_8 = 19QueryServiceStatusEx failed.
TSP_FAIL_SERVICE_9 = 20Could not start TESLASUIT.service.
TSP_FAIL_SERVICE_10 = 21Could not stop TESLASUIT.service, because it has been already stopped.
TSP_FAIL_SERVICE_11 = 22Timeout when changing TESLASUIT.service status from stopping to stopped.
TSP_FAIL_SERVICE_12 = 23ControlService failed.
TSP_FAIL_MOCAP_1 = 24Streaming of Mocap data from TESLASUIT has been already started.
TSP_FAIL_MOCAP_2 = 25Streaming of Mocap data from TESLASUIT has been already stopped.
TSP_FAIL_ECG_1 = 26Streaming of ECG data from TESLASUIT has been already started.
TSP_FAIL_ECG_2 = 27 Streaming of ECG data from TESLASUIT has been already stopped.
TSP_FAIL_GSR_1 = 28Streaming of GSR data from TESLASUIT has been already started.
TSP_FAIL_GSR_2 = 29Streaming of GSR data from TESLASUIT has been already stopped.
TSP_FAIL_CURRENT_FEEDBACK_1 = 30Streaming of the current feedback data from TESLASUIT has been already started.
TSP_FAIL_CURRENT_FEEDBACK_2 = 31Streaming of the current feedback data from TESLASUIT has been already stopped.
TSP_HAPTIC_1 = 32Haptic animation is playing.
TSP_UPDATE_FAIL_1 = 33Could not update control unit.
TSP_FAIL_CALIBRATION_1 = 34Haptic calibration is off.
TSP_FAIL_CALIBRATION_2 = 35Haptic calibration is off.
TSP_FAIL_CALIBRATION_3 = 36The minimum value of haptic calibration is not set.
TSP_FAIL_CALIBRATION_4 = 37The maximum value of haptic calibration is not set.
TSP_FAIL_CALIBRATION_5 = 38Sent calibration value exceed the maximum value.
TSP_FAIL_CALIBRATION_6 = 39Sent calibration value is less than the minimum value.
TSP_FAIL_MOCAP_3 = 40The function cannot be used with this version of TESLASUIT hardware. The function requires hardware version 4.5.4 or higher.

TSP_SUIT_HARDWARE_VERSION#

NameDescription
TSP_HV_UNKNOWN = 0Unknown version of TESLASUIT hardware.
TSP_HV_4_5_0_0 = 1Version 4.5.0.0 of TESLASUIT hardware.
TSP_HV_4_5_1_0 = 2Version 4.5.1.0 of TESLASUIT hardware.
TSP_HV_4_5_2_0 = 3Version 4.5.2.0 of TESLASUIT hardware.
TSP_HV_4_5_3_0 = 4Version 4.5.3.0 of TESLASUIT hardware.
TSP_HV_4_5_4_0 = 5Version 4.5.4.0 of TESLASUIT hardware.

TSP_CONNECT_QUALITY#

NameDescription
TSP_NO_CONNECTION = 0There is no connection.
TSP_BAD = 1Connection quality is poor. Some packages were lost during ping.
TSP_GOOD = 2Connection quality is good. All packages were received during ping.

TSP_SUIT_SEX#

NameDescription
TSP_SEX_UNKNOWN = 0Unknown model of TESLASUIT.
TSP_MEN = 1Men suit.
TSP_WOMEN = 2Women suit.
TSP_UNISEX = 3Unisex suit.

TSP_SUIT_SIZE#

NameDescription
TSP_SIZE_UNKNOWN = 0Unknown size of TESLASUIT.
TSP_XS = 1XS size of TESLASUIT.
TSP_S = 2S size of TESLASUIT.
TSP_M = 3M size of TESLASUIT.
TSP_L = 4L size of TESLASUIT.
TSP_XL = 5XL size of TESLASUIT.
TSP_XXL = 62XL size of TESLASUIT.

TSP_SUIT_KIT#

NameDescription
TSP_KIT_UNKNOWN = 0Unknown kit of TESLASUIT.
TSP_JACKET = 1 << 0Jacket is available.
TSP_TROUSES = 1 << 1Pants are available.
TSP_GLOVES = 1 << 2Gloves are available.

TSP_HIT_EVENT#

NameDescription
TSP_ENTER = 0Start playing.
TSP_STAY = 1Continue playing.
TSP_EXIT = 2End playing.
TSP_HIT_EVENT_NONE = 3NULL.

TSP_ASSET_TYPE#

NameDescription
TSP_EMPTY = 0Empty asset.
TSP_ANIMATION = 1Animation.
TSP_PRESET = 2Preset.
TSP_EFFECT = 3Effect.
TSP_SAMPLE = 4Sample
TSP_FEEL = 5Touch.
TSP_MATERIAL = 6Material.

TSP_MOCAP_FREQ#

NameDescription
TSP_FPS_28 = 35Mocap frequency rate of 28 frames per second.
TSP_FPS_50 = 20Mocap frequency rate of 50 frames per second.
TSP_FPS_100 = 10Mocap frequency rate of 100 frames per second
TSP_FPS_200 = 5Mocap frequency rate of 200 frames per second. This rate can be set only for the suits with the 4.5.4 or higher hardware versions.

TSP_ECG_FREQ#

NameDescription
TSP_ECG_FPS_5 = 200ECG frequency rate of 5 frames per second.
TSP_ECG_FPS_10 = 100ECG frequency rate of 10 frames per second.
TSP_ECG_FPS_20 = 50ECG frequency rate of 20 frames per second.

TSP_GSR_FREQ#

NameDescription
TSP_GSR_FPS_10 = 100GSR frequency rate of 10 frames per second
TSP_GSR_FPS_20 = 50GSR frequency rate of 20 frames per second.
TSP_GSR_FPS_40 = 25GSR frequency rate of 40 frames per second.
TSP_GSR_FPS_60 = 16GSR frequency rate of 60 frames per second

CALLBACK_INDEX#

NameDescription
CONNECTED = 0Enables notifications on the suit connection event.
DISCONNECTED = 1Enables notifications on the suit disconnection event.
MOCAP_DATA_UPDATE = 2Callback that is invoked every time when the mocap data changes. It is used when the hardware version of TESLASUIT is 4.5.4 or higher.
MOCAP_UPDATE = 3Callback that is invoked every time when the mocap data changes.
ECG_UPDATE = 4Callback that is invoked every time ECG data changes.
GSR_UPDATE = 5Callback that is invoked every time GSR data changes.
CURRENT_FEEDBACK_UPDATE = 6Type of callback that is invoked every time when the current feedback data is updated.
NUM_CALLBACKS = 7Callback counter.

Members


unsigned long long getId ( ) #

Returns the ID of TESLASUIT.

Return value

TESLASUIT ID.

String getName ( ) #

Returns the name of TESLASUIT.

Return value

TESLASUIT name.

String getSerial ( ) #

Returns a serial number of TESLASUIT.

Return value

TESLASUIT serial number

String getSSID ( ) #

Returns SSID of TESLASUIT.

Return value

TESLASUIT SSID

String getUserNetworkSSID ( ) #

Returns SSID of the network, to which TESLASUIT is connected.

Return value

SSID of a network, to which TESLASUIT is connected

Suit::TSP_SUIT_HARDWARE_VERSION getHardwareVersion ( ) #

Returns a hardware version of the connected TESLASUIT.

Return value

TESLASUIT hardware version, one of the TSP_SUIT_HARDWARE_VERSION values

String getFirmwareVersion ( ) #

Returns a firmware version of the connected TESLASUIT.

Return value

TESLASUIT firmware version

Suit::TSP_SUIT_SIZE getSize ( ) #

Returns the size of TESLASUIT.

Return value

Size of TESLASUIT, one of the TSP_SUIT_SIZE values

Suit::TSP_SUIT_SEX getSex ( ) #

Returns the model of TESLASUIT.

Return value

Model of TESLASUIT, one of the TSP_SUIT_SEX values

Suit::TSP_SUIT_KIT getKit ( ) #

Returns values of the TESLASUIT parts that are available for TESLASUIT.

Return value

TSP_SUIT_KIT values of the TESLASUIT parts that are available

Suit::suit_info getInfo ( ) #

Returns all available information about the suit including its name, serial number, SSIDs, hardware and firmware version, size, sex, and kit.

Return value

All available information about the suit

Suit::TSP_CONNECT_QUALITY getConnectQuality ( ) #

Returns quality of Wi-Fi connection quality for TESLASUIT.

Return value

Quality of the Wi-Fi connection of TESLASUIT, one of the TSP_CONNECT_QUALITY values

unsigned int playAsset ( unsigned long long id ) #

Plays a loaded haptic asset.

Arguments

  • unsigned long long id - Asset ID

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

unsigned int stopAsset ( unsigned long long id ) #

Stops playback of a haptic asset.

Arguments

  • unsigned long long id - Asset ID

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

unsigned int pausedAsset ( unsigned long long assetId, bool isPaused ) #

Pauses/resumes playback of a haptic asset.

Arguments

  • unsigned long long assetId - Asset ID
  • bool isPaused - true — pause, false — resume playing

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

unsigned int loopedAsset ( unsigned long long assetId, bool isLooped ) #

Enables/disables playback looping of a haptic asset.

Arguments

  • unsigned long long assetId - Asset ID
  • bool isLooped - true — looped playback, false — normal playback

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

bool isPlayingAsset ( unsigned long long assetId ) #

Checks if the haptic asset is currently playing.

Arguments

  • unsigned long long assetId - Asset ID.

Return value

true, if the asset is currently playing, false, if the asset is not playing at the moment.

unsigned int stopAssets ( ) #

Stops playback of all haptic assets for this TESLASUIT.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

unsigned int pausedAssets ( bool isPaused ) #

Pauses/resumes playback of all haptic assets for the TESLASUIT.

Arguments

  • bool isPaused - true — pause, false — resume playing.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

Vector< unsigned long long > getPlayingAsset ( ) #

Returns a list of the haptic assets that are currently played on the TESLASUIT.

Return value

Array of haptic asset IDs

Suit::asset_info getAssetInfo ( unsigned long long assetId ) #

Returns the haptic asset information.

Arguments

  • unsigned long long assetId - ID of a loaded asset

Return value

Information about a haptic asset:
  • ID of the loaded asset
  • Current playback time of the asset
  • Duration of the asset, in milliseconds
  • Flag that defines whether the asset should be removed after being played
  • Flag that defines whether the asset playback is looped
  • Flag that defines whether the asset is played at the moment
  • Type of a loaded asset: Touch, Effect (Fx), Sample, Channel, Preset, Track, Animation, Material

unsigned int clearAssets ( ) #

Removes all loaded haptic assets for the TESLASUIT.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

unsigned long long getSourceMapId ( ) #

Returns ID of a source mapping.

Return value

ID of a source mapping

unsigned int removeHitMap ( unsigned long long mapId ) #

Removes a hit mapping for TESLASUIT with the given ID.

Arguments

  • unsigned long long mapId - ID of the hit mapping to be removed

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

unsigned int buildAssetForMap ( unsigned long long mapId, unsigned long long assetId ) #

Builds an asset for a loaded mapping.

Arguments

  • unsigned long long mapId - ID of a loaded mapping
  • unsigned long long assetId - ID of a loaded asset

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

unsigned int getMapPolyCount ( unsigned long long mapId, short layer ) #

Returns the count of mapping polygons.

Arguments

  • unsigned long long mapId - ID of a loaded mapping, from which the count of polygons should be received
  • short layer - ID of a layer of the mapping

Return value

Count of mapping polygons

Vector< Suit::poly_2d > getMapPolygons ( unsigned long long mapId, short layer ) #

Returns mapping polygons.

Arguments

  • unsigned long long mapId - ID of a loaded mapping, from which the count of polygons should be received
  • short layer - ID of a layer of the mapping

Return value

Array of polygons

unsigned long long cachePoly ( unsigned long long mapId, const Vector< Math::vec2 > & points ) #

Caches a polygon shape for further processing.

Arguments

  • unsigned long long mapId - ID of a loaded mapping.
  • const Vector< Math::vec2 > & points - Points of the polygon.

Return value

ID of cached polygon shape.

unsigned long long cacheCircle ( unsigned long long mapId, const Math::vec2 & center, float radius ) #

Caches a circle shape for further processing.

Arguments

  • unsigned long long mapId - ID of a loaded mapping
  • const Math::vec2 & center - Coordinates of the center of a circle
  • float radius - A value of a circle radius

Return value

ID of cached shape

unsigned long long cachePoint ( unsigned long long mapId, const Math::vec2 & point ) #

Caches a point for further processing.

Arguments

  • unsigned long long mapId - ID of a loaded mapping
  • const Math::vec2 & point - Coordinates of the point

Return value

ID of cached shape.

unsigned int hapticPointHit ( unsigned long long mapId, const Vector< Suit::point_hit > & hits ) #

Hit event. Plays haptic feedback basing on the point, mapping and material.

Arguments

  • unsigned long long mapId - ID of a loaded mapping
  • const Vector< Suit::point_hit > & hits - A buffer of points, in which the hit should be played

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

unsigned int hapticCircleHit ( unsigned long long mapId, const Vector< Suit::circle_hit > & hits ) #

Hit event. Plays haptic feedback basing on circle shapes, mapping and material.

Arguments

  • unsigned long long mapId - ID of a loaded mapping
  • const Vector< Suit::circle_hit > & hits - A buffer of circle shapes, in which the hit should be played

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

unsigned int hapticPolyHit ( unsigned long long mapId, const Vector< Suit::poly_hit > & hits ) #

Hit event. Plays haptic feedback basing on polygon shapes, mapping and material.

Arguments

  • unsigned long long mapId - ID of a loaded mapping
  • const Vector< Suit::poly_hit > & hits - A buffer of polygon shapes, in which the hit should be played

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

unsigned int hapticCacheHit ( unsigned long long mapId, const Vector< Suit::cache_hit > & hits ) #

Hit event. Plays haptic feedback basing on the cached shapes.

Arguments

  • unsigned long long mapId - ID of a loaded mapping
  • const Vector< Suit::cache_hit > & hits - A buffer of cashed shapes

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

unsigned int updateMul ( unsigned long long mapId, unsigned long long assetId, const Suit::mul_conf & mul ) #

Sets multipliers for frequency, amplitude and pulse width parameters of the haptic asset. All multipliers should lie in the [0, 1] interval.

Arguments

  • unsigned long long mapId - Loaded mapping ID
  • unsigned long long assetId - ID of a haptic asset, for which the multipliers should be set
  • const Suit::mul_conf & mul - Structure that stores multipliers

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2.

unsigned int mocapUpdatableStart ( const Suit::mocap_opt & opt ) #

Starts updatable streaming of mocap data from TESLASUIT. When you use this function, all data is streamed in the TSMocapData struct. To stream data from earlier hardware versions, use mocapStart() or mocapStartExtended() instead. To get motion data, pass the callback that is invoked each time when the mocap data is updated. Call mocapStop() to stop updatable streaming of mocap data.
Notice
To use this function, the hardware version of the suit should be 4.5.4 or higher.

Arguments

  • const Suit::mocap_opt & opt - Structure that stores frame rate and sensors mask of the mocap data

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2, TS_FAIL_MOCAP_1, TS_FAIL_MOCAP_3.

unsigned int mocapStart ( ) #

Starts streaming of Mocap data from TESLASUIT. When you use this function, only mocap_bone_index and quat (9-axis) are streamed in the TSFifoData struct. To stream all data, use mocapStartExtended() instead. To get motion data, pass the callback that is invoked each time that Mocap data is updated. Call mocapStop() to stop Mocap data streaming. It is recommended to stop streaming of extended Mocap data from the same suit before calling the function, as well as streaming of GSR and ECG data.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2, TS_FAIL_MOCAP_1.

unsigned int mocapStartExtended ( ) #

Starts streaming of Mocap extended data from TESLASUIT. When you use this function, all data is streamed in the TSFifoData struct. To stream only mocap_bone_index and quat (9-axis), use mocapStart() instead. To get motion data, pass the callback that is invoked each time that Mocap data is updated. Call ts_mocap_stop_extended() to stop Mocap extended data streaming. It is recommended to stop streaming of Mocap data from the same suit before calling the function, as well as streaming of GSR and ECG data.
Notice
This function is available only for TESLASUITs with hardware version 4.5.2 or earlier.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2, TS_FAIL_MOCAP_1.

unsigned int mocapStop ( ) #

Stops streaming of Mocap data from TESLASUIT.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2, TS_FAIL_MOCAP_2.

unsigned int mocapStopExtended ( ) #

Stops streaming of mocap extended data from TESLASUIT.
Notice
This function is available only for TESLASUITs with hardware version 4.5.2 or earlier.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2, TS_FAIL_MOCAP_2.

unsigned int updateMocapFreq ( Suit::TSP_MOCAP_FREQ freq ) #

Sets frames per second rate of the mocap data streaming for TESLASUIT.

Arguments

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT.

unsigned int updateMocapOptions ( const Suit::mocap_opt & opt ) #

Sets the frame rate and sensors mask of the mocap data streaming from TESLASUIT. To use this function, the hardware version of the suit must be 4.5.4 or higher.

Arguments

  • const Suit::mocap_opt & opt - Structure that stores frame rate and sensors mask of the mocap data

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG.

unsigned int biometryStartEcg ( ) #

Starts streaming of ECG data from TESLASUIT. To get ECG data, pass the callback that is invoked each time that ECG data is updated. Call biometryStopEcg() to stop ECG data streaming.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2, TS_FAIL_ECG_1.

unsigned int biometryStopEcg ( ) #

Stops streaming of ECG data from TESLASUIT.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2, TS_FAIL_ECG_2.

unsigned int biometryStartGsr ( ) #

Starts streaming of GSR data from TESLASUIT. To get GSR data, pass the callback that is invoked each time that GSR data is updated. Call biometryStopGsr() to stop GSR data streaming.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2, TS_FAIL_GSR_1.

unsigned int biometryStopGsr ( ) #

Stops streaming of GSR data from TESLASUIT.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_SUIT, TS_FAIL_SH_MEM, TS_FAIL_QUEUE_1, TS_FAIL_QUEUE_2, TS_FAIL_GSR_2.

unsigned int updateEcgFreq ( Suit::TSP_ECG_FREQ freq ) #

Sets frames per second rate of ECG data streaming for TESLASUIT.

Arguments

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT.

unsigned int updateGsrFreq ( Suit::TSP_GSR_FREQ freq ) #

Sets frames per second rate of GSR data streaming for TESLASUIT.

Arguments

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_SUIT.

unsigned int subCurrentFeedback ( ) #

Creates a subscription on the current feedback callbacks. Every time a measurement is taken, the TSOnCurrentFeedbackUpdate callback occurs.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_CURRENT_FEEDBACK_1.

unsigned int unsubCurrentFeedback ( ) #

Deletes a subscription on the current feedback callbacks.

Return value

A code that describes the result of function execution, one of the following TSP_ values: TS_SUCCESS, TS_FAIL_ARG, TS_FAIL_CURRENT_FEEDBACK_2.
Last update: 2021-04-09
Build: ()