DATASTREAM SDK
Access real-time Vicon data for feedback and control
A flexible and easy way for users to stream in real time to 3rd party programs and Plug-Ins.
Created for the data streams from Nexus, Blade, Shōgun, and Tracker applications to use with third-party applications and plugins.
Datastream SDK
features
Vicon virtual system
SDK has an associated utility – the Vicon Virtual System (VVS). This utility makes the development process easier by simulating a live Vicon system and streaming data to Vicon Nexus, Tracker, Shōgun, and Blade applications.
Create custom applications
SDK and VVS make it easier to create custom applications by providing greater flexibility and easy access to Vicon data in real time.
This allows you to maximize time and work efficiency during data collection and processing. Additionally, SDK and VVS are available for free to existing customers.
Increased 3rd party compatibility
Vicon provides a flexible and powerful SDK solution that is available in three different formats across multiple operating systems, including Unity and Unreal engines for use in VR applications.
Modeling options
Use the SDK to create models in other packages and languages including; MATLAB, Labview, C++ and .Net
Latency compensation
Whilst Vicon Tracker produces data with the lowest possible latency, game engines add latency before the image gets to the eyes in an HMD and this can impact the sense of immersion. From version 1.8 there is a brand-new API for obtaining data in applications where reducing apparent latency is key, in particular location based VR and VR gaming experiences, by correcting for the delays introduced when the engine renders the image to the VR headset.
The source code for the DataStream SDK is provided and is licensed under an MIT license agreement.
Technical information
What is the recommended PC specification to run my Datastream SDK System?
Datastream SDK is compatible with:
Windows x86 or x64 Linux x86 or x64 OSX 10.9.
Requires: connection to Blade 3.x, Tracker 3.x, Nexus 2.x, Shogun 1.x, Evoke 1.x *Some methods may not be available to all applications.
Full requirements and different OS versions supported by language can be found in the documentation.
What operating system (OS) can I use with my Vicon Software?
| Current release version | Windows 10 | Windows 7 | Linux | OSX |
| Shōgun 1.2.1 | 64 bit | 64 bit* | x | x |
| Nexus 2.8.1 | 64 bit | 64 bit* | x | x |
| Tracker 3.7.0 | 64 bit | 64 bit* | x | x |
| Polygon 4.4.2 | 64 bit | 64 bit* | x | x |
| CaraLive 1.3.0 | 64 bit | 64 bit* | x | x |
| CaraPost 1.2.0 | 64 bit | 64 bit* | x | x |
| Pegasus 1.2.1 | 64 bit | 64 bit* | x | x |
| ProCalc 1.2.1 | 64 bit | 64 bit* | x | x |
| ProEclipse 1.2.1 | 64 bit | 64 bit* | x | x |
| DataStream SDK 1.8.0 | 64 bit | 64 bit* | 64 bit | 10.11 |
| Bodybuilder 3.6.4 | 64 bit | 64 bit* | x | x |
Please do note:
- Recommended and fully supported in Windows 10 (64bit) — with .NET Framework 4.5 and above
- * Although Vicon Software may install and function under other Microsoft Windows operating systems
(Compatibility tested only Windows 7 (64bit) — with .NET Framework 4.5) , this is not officially supported or recommended by Vicon. - For Legacy version please contact Vicon Support
How do I set up my network card?
1. Open the Network and Sharing Center and navigate to Change Adapter Settings. Vicon Vantage/Vero cameras are designated to one port. For each Vue (or Bonita Video) camera connected, there will be additional network port used.
2. Right click on the proper port and go into the Properties. The Local Area Connection Properties window will open. Make sure only Internet Protocol Version 4 (TCP/IPv4) is selected.
3. Select Internet Protocol Version 4 (TCP/IPv4) from the list and select Properties to assign the proper IP address.
a .Vantage/Vero cameras will have the following IP Address: 192.168.10.1 and Subnet Mask of: 255.255.255.0
b. The first VUE camera will have the following IP Address: 192.168.10.2 and Subnet Mask of 255.255.255.0
c. Any additional VUE cameras the last IP value is incrementally increased by one. For example, the second VUE camera will be 192.168.10.3.
Select OK to close out of the Internet Protocol Version 4 (TCP/IPv4) Properties. And OK again to close out of the Local Area Connection Properties. This will make sure all changes have been saved.
4. Feel free to rename the network port so it is easily identifiable. Such as ViconMX, VUE1 or VUE2
For further assistance please refer to the Configuring Ports section of the PCSetupforViconSystems.pdf found in Downloads > Documentation
DataStream documentation
Visit the DataStream documentation pages for information including:
- What’s new in DataStream SDK
- Quick start guides
Download Datastream SDK
Datastream SDK 1.12.0
Vicon DataStream SDK 1.12.0 (Software Development Kit).The Vicon DataStream Software Development Kit (SDK) allows easy programmable access to the information contained in the Vicon DataStream. The function calls within the SDK allow users to connect to and request data from the Vicon DataStream.
DataStream SDK 1.12 includes:
* Additional data for video camera information such as lens parameters, focal length, and camera transform
* Connection timeout length significantly reduced and users can now manually set this value
More info on this release can be found here: What’s New?
Full documentation on the full features in the Datastream can be found here: https://docs.vicon.com/display/DSSDK112
Note: MATLAB support changed to use .NET : Native MATLAB integration has been replaced by .NET as Mathsworks support the use of .NET directly in MATLAB (https://uk.mathworks.com/help/matlab/using-net-libraries-in-matlab.html). To make use of Datastream SDK 1.10 onwards, update legacy MATLAB scripts to .NET. To continue using native MATLAB integration, refer to support in Datastream SDK 1.9.
The source package has been updated and is now included within this distribution under an MIT license, allowing for unlimited use and redistribution of the SDK, whilst limiting liability.
Requirements
Windows x86 or x64 Linux x86 or x64 OSX 10.14.
Blade 3.x, Tracker 3.x, Nexus 2.x, Shogun 1.x, Evoke 1.x *Some methods may not be available to all applications.
Datastream SDK 1.11.0
Vicon DataStream SDK 1.11.0 (Software Development Kit).The Vicon DataStream Software Development Kit (SDK) allows easy programmable access to the information contained in the Vicon DataStream. The function calls within the SDK allow users to connect to and request data from the Vicon DataStream.
DataStream SDK 1.11 includes:
* Additional new data types to support Vantage+ High Speed Mode
* Extends Python support to Python 3.2 onwards, from Python 2.7 & 3.7 only previously
* Support for Tobii Eye Tracking
Full documentation on the full features in the Datastream can be found here: Documentation
Note: MATLAB support changed to use .NET : Native MATLAB integration has been replaced by .NET as Mathsworks support the use of .NET directly in MATLAB (https://uk.mathworks.com/help/matlab/using-net-libraries-in-matlab.html). To make use of Datastream SDK 1.10 onwards, update legacy MATLAB scripts to .NET. To continue using native MATLAB integration, refer to support in Datastream SDK 1.9.
The source package has been updated and is now included within this distribution under an MIT license, allowing for unlimited use and redistribution of the SDK, whilst limiting liability.
Requirements
Windows x86 or x64 Linux x86 or x64 OSX 10.9.
Blade 3.x, Tracker 3.x, Nexus 2.x, Shogun 1.x, Evoke 1.x *Some methods may not be available to all applications.
Full requirements can be found in the documentation.
Datastream SDK 1.10.0
File Name: Vicon_Datastream_1.10_123216h.zip
Vicon DataStream SDK 1.10.0 (Software Development Kit).The Vicon DataStream Software Development Kit (SDK) allows easy programmable access to the information contained in the Vicon DataStream. The function calls within the SDK allow users to connect to and request data from the Vicon DataStream.
DataStream SDK 1.10.0 extends on the functionality of 1.9.0, with additional language support for Python 2.7 and Python 3.7.
Full documentation on the full features in the datastream can be found here: https://docs.vicon.com/spaces/viewspace.action?key=DSSDK110
Python 2.7 is included in the SDK 1.10 installer. Python 3.7 .zip packages are included in the download.
Note: MATLAB support changed to use .NET : Native MATLAB integration has been replaced by .NET as Mathsworks support the use of .NET directly in MATLAB (https://uk.mathworks.com/help/matlab/using-net-libraries-in-matlab.html). To make use of Datastream SDK 1.10, update legacy MATLAB scripts to .NET. To continue using native MATLAB integration, refer to support in Datastream SDK 1.9.
The source package has been updated and is now included within this distribution under an MIT license, allowing for unlimited use and redistribution of the SDK, whilst limiting liability.
Requirements
Windows x86 or x64 Linux x86 or x64 OSX 10.9.
Blade 3.x, Tracker 3.x, Nexus 2.x, Shogun 1.x, Evoke 1.x *Some methods may not be available to all applications.
Full requirements can be found in the documentation.
Important note: Users of Matlab SDK must uninstall previous versions of the Vicon DataStream SDK before installing Vicon DataStream SDK 1.9.0.
Datastream SDK 1.9.0
Datastream SDK 1.8.0
Abstract
File Name: ViconDataStreamSDK_1.8.0_105615h.zip
Vicon DataStream SDK 1.8.0 (Software Development Kit).
The Vicon DataStream Software Development Kit (SDK) allows easy programmable access to the information contained in the Vicon DataStream. The function calls within the SDK allow users to connect to and request data from the Vicon DataStream.
DataStream SDK 1.8.0 incorporates many changes, the most significant of these is a new “Retiming API”. This allows for client applications to request estimated data in non-blocking fashion. i.e. data is returned immediately rather than waiting for a fresh frame. This means that perceived latency is reduced – ideal for VR. Additionally, a small amount of additional prediction can be added to allow the estimate to be predicted into the future to account for rendering delays in game engines.
The source package has been updated and is now included within this distribution under an MIT license, allowing for unlimited use and redistribution of the SDK, whilst limiting liability.
New plugins for Unity 3d and Unreal Engine are now available that take advantage of this new API.
New documentation, using Doxygen is provided.
Requirements
Windows x86 or x64 Linux x86 or x64 OSX 10.11
Blade 3.x, Tracker 3.x, Nexus 2.x *Some methods may not be available to all applications.
Important note: Users of Matlab SDK must uninstall previous versions of the Vicon DataStream SDK before installing Vicon DataStream SDK 1.8.0.
Datastream SDK 1.7.1
Abstract
File Name: ViconDataStreamSDK_1.7.1_96542h.zip
Vicon DataStream SDK 1.7.1 (Software Development Kit).
The Vicon DataStream Software Development Kit (SDK) allows easy programmable access to the information contained in the Vicon DataStream. The function calls within the SDK allow users to connect to and request data from the Vicon DataStream.
New functions that Expose Marker Labels per Centroid information are now implemented. These allow the user to obtain data on the camera contributions of each marker within a client based upon the SDK.
New function calls:
EnableMarkerRayData() DisableMarkerRayData() IsMarkerRayDataEnabled() GetMarkerRayContributionCount() GetMarkerRayContribution()
An experimental version of the SDK built for Android using the NDK is included.
Requirements
Windows x86 or x64 Linux x86 or x64 OSX 10.11
Blade 3.x, Tracker 3.x, Nexus 2.x *Some methods may not be available to all applications.
Important note: Users of Matlab SDK must uninstall previous versions of the Vicon DataStream SDK before installing Vicon DataStream SDK 1.7.1.
FAQs
What is Vicon DataStream SDK?
The Vicon DataStream Software Development Kit (SDK) allows easy programmable access to the information contained in the Vicon DataStream. The function calls within the SDK allow users to connect to and request data from the Vicon DataStream.
How do I configure LabView to connect to Vicon DataStream SDK?
Below you will find an explanation on how to get started with the Vicon Datastream SDK and Labview.
You will also need to download the LabVIEW.exe.config:
The LabVIEW.exe.config file needs to be placed in the root Labview folder for example:
C:\Program Files\National Instruments\LabVIEW 2017 this my change depending on your operating system and Labview version (2010, 2013, 2014 and 2017 supported).
More details with regards to the config file can be found on the National Instruments website:
Steps to Configure Labview
1. Install:
2. Create a Folder on your PC to contain all your LabView Projects for example:
C:\Users\Public\Documents\08 ThirdParty Software\Labview\LabviewProjects
3. Copy all the DataStream SDK files from C:\Program Files\Vicon\DataStream SDK\Win64\dotNET and place in C:\Users\Public\Documents\08 ThirdParty Software\Labview\LabviewProjects
4. Launch LabView 2017 (64bit)
5. Select Create Project
6. Double click Blank Project
7. Save your Project in the C:\Users\Public\Documents\08 ThirdParty Software\Labview\LabviewProjects folder created in Step 2
8. In the Project select File > New VI
9. In the New pop-up Window select Blank VI
10. In the Block Diagram Panel, right mouse click > select Connectivity > .NET > Constructor …
11. Place the .NET Constructor in the Block Diagram
12. In the Assembly, select Browse and in the Look in: option browse to C:\Users\Public\Documents\08 ThirdParty Software\Labview\LabviewProjects
13. Select ViconDataStreamSDK_DotNET.dll
14. The .NET Constructor in the Block Diagram will now display ViconDataStreamSDK_DotNET(0.0.0.0)
Related hardware
Valkyrie
Valkyrie is the most powerful motion capture camera ever brought to market, offered with four different specs with four different focuses: resolution, speed, value, and strobeless.
Vero
With the best resolution/speed/price offering on the market, Vicon Vero is the latest optical camera from Vicon. Building on the success of Vantage, Vero combined market-leading resolution and speed at an unrivaled price point. Like its bigger brother, Vantage, Vero has on-board sensors that monitor camera position and temperature to ensure optimal performance at all times.
GET IN TOUCH
Vicon are here to support you on your Motion Capture journey. We’re happy to provide more information, answer questions and help you find the solution you need. Get in touch with our experts today.