FaceFX Commands - get and set



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.
"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.
"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

See the FaceFX Console Variables for a list of variables that can be manipulated.

Version Number: 
2010