Skip to main content
Version: 1.3.x

Project Set up

In this chapter, you will learn how to create and register UserKey and AppId, etc. required for authentication for using AI Human SDK.

1. Create an account​

Create an account on the AI Human SDK Website.


2. Add a project to My workspace​

Create a project in My workspace, enter App Id of Windows and click confirm. Then User Key will be issued.

The appId, userKey, uuid, and platform information will be used as arguments for AuthStart(), an authentication function.

info
  • appId is a unique Id of the project, and is generally created like "com.example.project.appname".
  • userkey can be obtained by creating a project on the AIHuman website and registering the appId.
  • uuid refers to the unique ID of the device where the application is installed. It is created by calling Guid.NewGuid(), and saved and reused after initial creation so that it does not change each time it is called.
  • platform argument uses "wnds", which means windows.

3. Create a new project in Visual Studio​

Create solutions and projects to use the AI Human SDK in the Visual Studio.

: Create New Project > WPF Application > Target Framework > .NET 5.0 (or .NET Core 3.1 or later WPF support target)​

We will use the default project name, WpfApp1.​

Requirements​

AIHuman.SDK.Core​

AIHuman.SDK.WPF​

To develop or run an application using AIHuman.SDK.WPF.dll, you must install .NET Core 3.1 or later.

You can also use AIHuman.SDK.Core.dll to develop a target framework or UI other than WPF in an environment that supports NET Standard 2.0. In this case, you will need to implement View (such as UserControl) directly. Development difficulty may increase.

info
  • Case of developing WPF as target: AIHuman.SDK.Core and AIHuman.SDK.WPF reference required
  • In an environment that supports .NET Standard 2.0, other UI Frameworks are used: Implement View after referring to AIHuman.SDK.Core only

Library Dependencies Guide​

You should refer to the below assemblies with SDK in your project or install Packages from nuget.

Assemblies​

  • AIHuman.SDK.Core.dll (1.4.2)
  • AIHuman.SDK.WPF.dll (1.4.2)
  • JWT.dll (9.0.3)
  • Newtonsoft.Json.dll (13.0.2)
  • SocketIOClient.dll (3.0.3)
  • SocketIOClient.Newtonsoft.Json.dll (3.0.0)

Packages​


4. Set up the project​

Prepare library files necessary for the use of AI Human SDK in the previously created project.

4.1. Download the SDK for Windows from the AI Human SDK website.​

4.3. In Solution Explorer, right-click Project > Right-click > Add > Create a new folder with a name.​

You can configure the libraries referenced in the solution through the created folder > right-click > Add > Existing item.

info

The screenshot and the actual assemblies provided may be different. Please refer to the README.md file in the SDK archive file you downloaded.

4.4. Add the downloaded AIHuman SDK library to the solution item.​

Right-click the project at the top of the Solution Explorer > Add > Project Reference > Reference Manager > Browse > AIHuman.Add SDK.Core.dll and Newtonsoft.Json.dll, etc. You can see that references have been added to the Dependencies > Assembly in the project tree.

(Add all the libraries included in the downloaded file.)