Copy

Configuration

The module settings, environment variables and Java properties.

On this page

Module settings

In boxlang.json, under modules.bxaudio.settings:

{
  "modules": {
    "bxaudio": {
      "settings": {
        "home": "",
        "autoInstall": true,
        "ffmpeg": ""
      }
    }
  }
}

Setting	Default	Does
`home`	`""`	Where the speech engine, the voices and FFmpeg are downloaded to. Empty means `~/.bxaudio`
`autoInstall`	`true`	May the module download the speech engine, a voice or FFmpeg when you first use something that needs it. `false` makes it fail with a message that says what to install
`ffmpeg`	`""`	Path to an FFmpeg you want it to use (the program, or its folder). Empty finds it from the variable, the home or the `PATH`

Variable	Does
`BX_AUDIO_HOME`	The same as `home`. The setting wins over the variable
`BX_AUDIO_FFMPEG`	The same as `ffmpeg`
`BX_AUDIO_DEBUG`	`1` makes the command line print a stack trace instead of a one line message

-Dbxaudio.home=/path is the same as BX_AUDIO_HOME, for hosts where you control the JVM arguments but not the environment.

See Storage: engine/, voices/, ffmpeg/ and cache/.

A configured path that does not work is an error, not a silent fall back to another FFmpeg.