- Generated by
1.8.14
|
Avatar SDK Standalone Application
3.1.2
Full Body Avatars
|
It is a command line application that allows generating full body avatars locally on a device. Internet connection is used only to log the number of avatars to the Avatar SDK Cloud. It tries to connect to the server each time before starting calculation. If the Avatar SDK server is unreachable, an error will be returned.
Latest Docker version is 3.1.2: Download for Docker
Latest Windows version is 3.1.2: Download for Windows
Older Releases
Avatar SDK Website
Support email: support@avatarsdk.com
Follow the Installation Guide to run the Standalone Application.
The special license file (res_I7IFyeGGMPc=.bytes) should be placed to the resources directory (Windows version) along with the other resources or the working directory (workdir, Docker version). You can get this license file on your account page.
avatar_sdk_full_body_standalone.exe <inputImageFilename> <outputDir> <resourcesPath>
inputImageFilename: path to an image in JPEG or PNG format.
outputDir: an output folder.
resourcesPath: path to the resources folder.
avatar_sdk_full_body_standalone.sh <workdir> <inputImageFilename> <outputDir>
workdir: a working directory (an absolute path) to be mounted inside the docker container.
inputImageFilename: path to an image in JPEG or PNG format (relative to the workdir).
outputDir: an output folder (relative to the workdir).
Optional arguments:
-intermediateDataPath <path>: a path to a directory for storing "intermediate data". Intermediate data is required for computing additional haircuts and outfits without regenerating the avatar or for saving the avatar in different formats. This data isn't saved on disk by default.
-computationParams <path>: a path to a JSON file with avatar computation parameters. These parameters configure avatar appearance. See the Parameters Description section for details.
-exportParams <path>: a path to a JSON file with parameters that specify an output format and exported assets such as haircuts, outfits and blendshapes. See the Parameters Description section for details.
-apiUrl <url>: Avatar SDK API URL. This parameter allows changing API URL. Default URL is: "https://api.avatarsdk.com". If you have problems with connection to the Avatar SDK server due to Firewall restrictions, you can specify the secondary URL: "https://avatar-api.itseez3d.com".
-license <path>: a path to a license file (res_I7IFyeGGMPc=.bytes by default)
Standalone application allows generating additional assets (haircuts, outfits, blendshapes) for the avatar that is already computed. Use the following arguments for it:
avatar_sdk_full_body_standalone.exe -exportOnly <outputDir> <resourcesPath> -intermediateDataPath <path> -exportParams <path>
-exportOnly: a flag indicates that an additional export is made for the generated avatar. Should be the first argument. outputDir: an output folder.
resourcesPath: a path to the resources folder.
-intermediateDataPath <path>: a path where the intermediate data is stored for the generated avatar.
-exportParams <path>: a path to a JSON file with export parameters.
avatar_sdk_full_body_standalone.sh <workdir> -exportOnly <outputDir> -intermediateDataPath <path> -exportParams <path>
workdir: a working directory (an absolute path) to be mounted inside the docker container.
-exportOnly: a flag indicates that an additional export is made for the generated avatar. outputDir: an output folder.
-intermediateDataPath <path>: a path where the intermediate data is stored for the generated avatar.
-exportParams <path>: a path to a JSON file with export parameters.
Look at the Examples Of Usage (Windows) or/and
Examples Of Usage (Docker) pages to find the most common samples.
Detailed information about parameters provided in a JSON file can be found on the Parameters Description page.
We are using the following 3rd party licenses: https://avatarsdk.com/third-party-licenses/
1.8.14