Skip to main content
Skip table of contents

Processing via the Command Line

To process a batch via the command line, use sgx.exe with arguments. For help with this you may use SGX-GUI to specify arguments and print out the command

Command Syntax

If you type sgx.exe --help you will see the following usage information:

CODE
sgx.exe -h   
sgx.exe -v   
sgx.exe -i <input_path> -r <resources_path> -c <character_name> 
[-l <language_name>] [-t <transcripts_path>] [-o <output-path>] 
[-m <markup>] [-f] [-n] [-P <pre-roll>] [-Q <post-roll>] [-N] 
[-e] [-x <custom_parameters>] 

Options

-h | --help

Display help text.

-v | --version

Display the SGX version number.

-i | --input ARG

The path of the input directory containing audio and text files, or the path of a text file containing a list of input files.

-r | --resources ARG

The path of the directory containing character and language resources.

-c | --character ARG

The name of the character you want to animate. 

-l | --language ARG

The language module for the language (and dialect) heard in the input audio. (Optional but recommended for best results.)

-t | --transcripts ARG

The path of a text file containing the transcripts in list form. (Optional.)

-o | --output ARG

The path of the directory to which to save output. (Optional unless --input is a list file rather than a directory.)

-m | --markup ARG

Markup for the whole batch. (Optional.)

-f | --overwrite

Force overwriting of output from previous processing jobs. (Optional.)

-n | --non_deterministic

Get non-deterministic processing outcome. (Optional.)

-P | --pre_roll ARG

Add pre-roll to each animation. Enter fixed time (in ms) or 0 for auto-calculation. Will report pre-roll duration per file in batch report. (Optional.)

-Q | post_roll ARG

Add post-roll to each animation. Enter fixed time(in ms) or 0 for auto-calculation. Will report post-roll duration per file in batch report. (Optional.)

-N | --neutral_finish ARG

Return to neutral at end of animation. Best used in conjunction with post-roll to see the full finish. (Optional.)

-e | --extract_animation

Output animation as plain-text .rts files in addition to .event files. (Optional.)

-x | --custom ARG

List of custom parameters in the form 'xxx;xxx;xxx'. Each 'xxx' can be either a single term or a key-value pair in the form 'key,value'. (Optional.)

Examples

Example processing command including only the required arguments:

CODE
sgx -i C:\Path\to\input -r C:\Path\to\SGX_resource_directory -c Marie

Example processing command including optional arguments as well:

CODE
sgx -i C:\Path\to\input -r C:\Path\to\SGX_resource_directory -c Marie -l English_US -t C:\Path\to\transcripts_file -o C:\Path\to\output_directory -m serious,1.0,0.9 -P 0 -Q 0 -N -e -f -n

Exit Codes

The sgx.exe command has these exit codes:

CODE
0 - success
1 - license error
2 - input error
3 - processing error    

Print Command

Generate a command automatically from current options in SGX-GUI, using the "Print Command" button. 

Copy/paste the command printed in the command field into your command-line prompt or script.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.