Additional documentation

1. Configuration and licensing

To use this SDK, you must have a valid license and setup a configuration folder. This information must be provided to the SDK before using it, with a call to Facephi::VoiceSdk::ConfigManager::Initialize, this method has two overloads.

One for providing directly the information as a string:

constexpr auto DATACONTENT_HOSTEDFLOATING = R"(
CONFIG_DIR=./resources
LICENSE_TYPE=SHARED
LICENSE_BEHAVIOUR=ONLINE
LICENSE_KEY=37514F-6923D6-XXXXXX-FE82B3-FBF745-XXXXXX
)";

Facephi::VoiceSdk::Status status = Facephi::VoiceSdk::ConfigManager::GetInstance().Initialize(DATACONTENT_HOSTEDFLOATING, "");

And another for providing a path to a file containing the information:

Facephi::VoiceSdk::Status status = Facephi::VoiceSdk::ConfigManager::GetInstance().Initialize("./config.cfg", "37514F-6923D6-XXXXXX-FE82B3-FBF745-XXXXXX");

The string or file could contain the following information:

CONFIG_DIR= # Path to configuration folder
LICENSE_TYPE= # License type, can be MACHINE, SHARED or LOCAL
LICENSE_BEHAVIOUR= # License behaviour, can be ONLINE or OFFLINE
LICENSE_KEY= # License key
LICENSE_ID= # Product ID
LICENSE_DATA= # Product data
LICENSE_URL= # License server URL. Only needed if LICENSE_TYPE is LOCAL
LICENSE_PATH_OFFLINE= # Path to a local file with data for offline activation. Only needed if LICENSE_TYPE is MACHINE and LICENSE_BEHAVIOUR is OFFLINE

2. Result codes

    NOISY                          = 0
    LONG_REVERBERATION             = 1
    SMALL_SPEECH                   = 2
    OK                             = 3
    NOT_EVALUATED                  = 4
    SPOOF                          = 5
    DUPLICATED_AUDIO               = 6
    DIFFERENT_VOICES               = 7
    EMPTY_AUDIO                    = 8
    TOO_MANY_AUDIOS                = 9
    NOT_ENOUGH_GOOD_AUDIOS         = 10
    CONFIG_MANAGER_ERROR           = 11
    INVALID_LICENSE                = 12
    EXPIRED                        = 13
    SUSPENDED                      = 14
    E_SYSTEM_PERMISSION            = 15
    E_WMIC                         = 16
    E_INET                         = 17
    E_NET_PROXY                    = 18
    E_REVOKED                      = 19
    E_LICENSE_KEY                  = 20
    E_ACTIVATION_LIMIT             = 21
    E_VM                           = 22
    E_COUNTRY                      = 23
    E_IP                           = 24
    E_CONTAINER                    = 25
    DATA_NOT_FOUND                 = 26
    ENVIRONMENT_VARIABLE_NOT_FOUND = 27