Skip to content

Windows

To use IDLive Face on Windows you need to:

  1. Install Microsoft Visual C++ Redistributable.
  2. Configure your environment to make IDLive Face libraries discoverable for your application.

Visual C++ Redistributable

The Redistributable can be downloaded from the official website. You need the version for Visual Studio 2019, 64-bit edition.

If you have Visual Studio installed the necessary C++ libraries should already be present on your system. In this case no actions are required.

DLL discovery

To make IDLive Face dynamic-link libraries (DLL) discoverable for your application you have several options:

  1. Copy IDLive Face libraries from SDK's libs directory to your application's directory. This is the simplest option but you need to make sure that all DLLs always come from the same IDLive Face version.

  2. Add libs directory to the Path environment variable in a launch script. This is the preferable option but you need to run your application via .ps1 or .bat script.

  3. Configure the Path environment variable system-wise. The least preferable option but you may need it if you run your application via system services (for example you create a web-application for Microsoft IIS).

Note

From version 3.8 Python does not rely on Path for DLL discovery. If you use the Python API please refer to Using on Windows section in the Getting started guide.

Copy libraries

You need to copy all *.dll files and plugins.xml if it's present:

Copy-Item -Path C:\idliveface\* -Include *.xml,*.dll -Destination application-directory

Launch script

Open Powershell or Command Prompt and add C:\idliveface\libs to the Path environment variable:

$env:Path = "$env:Path;C:\idliveface\libs"
SET Path=%Path%;C:\idliveface\libs

Now you can run your application from the same terminal window. It will work as long as the terminal stays open. To do the setup automatically create a launch script:

$env:Path = "$env:Path;C:\idliveface\libs"

.\application.exe
@ECHO OFF
SETLOCAL
SET Path=%Path%;C:\idliveface\libs

application.exe

This script will update the Path environment variable and run your application.

System configuration

The Path environment variable can be globally configured either for a current user or for all users. Use the second option only if your service is started by a system user.

You will need to update a key in the Registry. Make sure that you have access. Execute the following commands in Powershell:

$PropertyPath = "HKCU:\Environment"
$PropertyValue = (Get-ItemProperty -Path $PropertyPath -Name Path).Path
Set-ItemProperty -Path $PropertyPath -Name Path -Value "$PropertyValue;C:\idliveface\libs"
$PropertyPath = "HKLM:\System\CurrentControlSet\Control\Session Manager\Environment"
$PropertyValue = (Get-ItemProperty -Path $PropertyPath -Name Path).Path
Set-ItemProperty -Path $PropertyPath -Name Path -Value "$PropertyValue;C:\idliveface\libs"

Afterwards open a new Powershell window and check that the Path environment variable was updated:

$env:PATH -split ';'

If you don't see the change you may need to logout first (or reboot in case of a system service).

Manual setup

If you can't use Powershell you can configure the Path environment variable via the Windows interface.

  1. Open Run dialog box. Type sysdm.cpl and press enter. This will open the System Properties window.

  2. Select the Advanced tab and click on the Environment Variables button. This will open an editor for the environment variables.

  3. Find the Path entry in a list. For the current user use the top list, for all users use the bottom list. Select the list entry and press Edit.

  4. Add new entry to the Path value with the New button and put C:\idliveface\libs in it.

  5. Press OK in all open windows.