FaceFX Commands - get and set
Get Examples
Set Examples
The get and set commands are used to get and set console variables. Some variables (described below) are used by FaceFX Studio and this is the interface for changing them from their default values.
If you call "set" on a console variable that doesn't exist, a new console variable is created with the default vealue set to the value passed in via the set command. This system can be used to store data accross a FaceFX Studio session, and retrieve it later (for example from a python script).
get Command Syntax
| Flag | Long Flag | Arg | Description |
|---|---|---|---|
| -n | -name | Yes | Specifies the name of the variable to get. "rw_showbindpose" "a_audiomin", "a_audiomax" are examples. |
Get Examples
>>> %get -n "a_audiomin";
>>> %get -name "a_detectspeech";
>>> %get -name "g_audiosystem"
set Command Syntax
| Flag | Long Flag | Arg | Description |
|---|---|---|---|
| -n | -name | Yes | Specifies the name of the variable to get. "rw_showbindpose" "a_audiomin", "a_audiomax" are examples. |
| -v | -value | Yes | Specifies the value of the variable to set. All variables accept a string. Numerical values are converted from the string into a float or integer, etc. |
Set Examples
>>> %set -n "a_audiomin" -v "0.1";
>>> %set -name "a_detectspeech" -value "false";
>>> %set -name "g_audiosystem" -v "directsound"
Accepted Variables
- a_audiomin - Extremely short segments of audio can not always be successfully analyzed by FaceFX Studio. This variable sets the minimum audio duration that can be analyzed without returning an error. The default is 0.5 seconds. Reducing this value to 0.1 may allow more files to analyze correctly, but no guarantee can be made that analysis will be successful for all short files.
- a_audiomax - When using text, extremely long segments of audio can not always be successfully analyzed by FaceFX Studio. Without text, FaceFX can automatically chop up the audio into smaller segments. This variable sets the maximum audio duration for text-based analysis. Files longer than this duration will automatically be chopped up into smaller segments and analyzed without text. The default is 90 seconds.
- a_detectspeech - Determines if speech detection should be used when analyzing audio files. In most cases, speech detection should be on. If audio files are edited such that speech starts at the very beginning of the audio file however, speech detection can cause the beginning of the animation to be incorrectly classified as silence. In these cases, setting a_detectspeech to false will fix the problem.
- g_audiosystem - By default FaceFX uses OpenAL to playback sounds. Not all sound drivers implement the OpenAL specification completely or correctly, so the sound system can be changed to Direct Sound with this variable. Acceptable values include "openal" and "directsound".
Version Number:
2009
