TrueConf VideoSDK Guide

# Activation

# Activation using API

The PRO version can be obtained by executing the corresponding API methods:

Notifications will be received in this case:

# Online activation

When you have access to the Internet and the registration server reg.trueconf.com (opens new window), it is possible to activate VideoSDK/Room online using the API method activateLicense. Request example:

{
    "method" : "activateLicense",
    "key" : "RM7SK-BE11-6667-FAVD"
}

The key parameter value in this case contains the key obtained from the support service, for example RM7SK-BE11-6667-FAVD. As a result of a successful command execution, we will receive the following response:

{
    "method" : "activateLicense",
    "status" : "processing",
    "result" : true
}

The value of "status" : "processing" means that the key has a valid format, the connection to the registration server is established, and the request has been successfully sent for processing. If the key is valid, VideoSDK/Room will receive a PRO license, which will be saved for subsequent launches, i.e. there is no need to send an activation request each time. This is accompanied by a notification licenseActivation.

# Offline activation

Activation in case of working in a closed network without Internet access is carried out in several stages.

  1. First, we call the corresponding API method to generate a file that will be used for offline activation file creation - activateLicense. Request example:
{
    "method" : "activateLicense",
    "key" : "RM7SK-BE11-6667-FAVD"
}

The key parameter value in this case contains the key obtained from the support service, for example RM7SK-BE11-6667-FAVD. As a result of a successful command execution, we will receive the following response:

{
    "method": "activateLicense",
    "status": "offline",
    "fileId": 164458388,
    "result": true
}

The value of the fileId parameter in this case contains the identifier of the file on the http server VideoSDK/Room that needs to be sent to the support service. To obtain this file, you can use the GET request.

  1. Send the file obtained in step 1 to the support service. Then receive from them a file for offline activation, which was generated based on the file sent to them.

  2. Load the file received in step 2 onto the http server VideoSDK/Room using the [POST] method (builtinhttpserver.md#filePostMethodDescription), and upon a successful request, obtain the value of the fileId parameter, which identifies this file on this server.

  3. Call the corresponding API method for offline activation - productRegistrationOffline. Request example:

{
    "method" : "productRegistrationOffline",
    "fileId" : 164458666
}

The value of the fileId parameter in this case is what we received in step 3. Upon successful execution of the command, VideoSDK/Room will receive the PRO version. In subsequent launches, nothing else needs to be specified, the license will be saved.

# Activation via command line

<p>For all types of activations (online and offline) you need to first obtain a key from support service.</p>

# Online activation

When there is access to the network and registration server, it is possible to perform online activation of VideoSDK/Room using corresponding command line keys during startup: --filepath and --license-key. Example:

TrueConfRoom --license-key --filepath C:\Users\UserName\Desktop\license.key

In this case, license.key contains the key obtained from customer support, for example RM7SK-BE11-6667-FAVD. After launching VideoSDK/Room, it will be immediately in the PRO version, and in subsequent launches, it will not be necessary to specify anything else, the license will be saved.

# Offline activation

If there is no network access or connection to the registration server is unavailable, it is possible to perform offline activation. This is done using the corresponding command line keys: --filepath, --hardware-key and --license-key. The process consists of 3 stages.

  1. Obtaining a license key from the support service, as indicated above (example key - RM7SK-BE11-6667-FAVD)
  2. Launch VideoSDK/Room using appropriate command line keys: --filepath, --hardware-key and --license-key. Example:
TrueConfRoom --hardware-key --license-key --filepath C:\Users\UserName\Desktop\license.key

license.key in this case contains the key received in step 1. After launching VideoSDK/Room, it will generate a file regoffline.rrg located in the same directory as the one specified in step 1. This file needs to be sent to the support service to obtain a corresponding file for offline generation, which is made based on this sent file.

  1. Using the file obtained in step 2, as well as command-line keys --filepath and --license-key when launching, we perform offline activation. Example:
TrueConfRoom --license-key --filepath C:\Users\UserName\Desktop\regoffline2.rrg

regoffline2.rrg in this case contains the key obtained from customer support (see step 2). After launching VideoSDK/Room, it will immediately be in the PRO version, and in subsequent launches there is no need to specify anything else, the license will be saved.