config_schema.json

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "$ref": "#/definitions/config",
  "definitions": {
    "config": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "log_level": {
          "type": "string",
          "description": "Logging level for the application",
          "enum": [
            "panic",
            "fatal",
            "error",
            "warn",
            "warning",
            "info",
            "debug",
            "trace"
          ],
          "default": "info"
        },
        "device_id": {
          "type": "string",
          "description": "The device ID in hex",
          "minLength": 40,
          "maxLength": 40
        },
        "device_name": {
          "type": "string",
          "description": "The device name showed in the Spotify UI",
          "default": "go-librespot"
        },
        "device_type": {
          "type": "string",
          "description": "The device type showed in the Spotify UI",
          "enum": [
            "computer",
            "tablet",
            "smartphone",
            "speaker",
            "tv",
            "avr",
            "stb",
            "audio_dongle",
            "game_console",
            "cast_video",
            "cast_audio",
            "automobile",
            "smartwatch",
            "chromebook",
            "car_thing",
            "observer",
            "home_thing"
          ],
          "default": "computer"
        },
        "client_token": {
          "type": "string",
          "description": "The Spotify client token"
        },
        "audio_device": {
          "type": "string",
          "description": "Which audio device should be used for playback, leave empty for default",
          "default": "default"
        },
        "mixer_device": {
          "type": "string",
          "description": "Which audio mixer should be used for volume control, leave empty to disable mixer control",
          "default": ""
        },
        "mixer_control_name": {
          "type": "string",
          "description": "Which control should be used, leave empty for default. Only useful in combination with 'mixer_device'",
          "default": "Master"
        },
        "server": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean",
              "description": "Whether to enable the API server",
              "default": false
            },
            "address": {
              "type": "string",
              "description": "Which address to bind for the API server",
              "default": ""
            },
            "port": {
              "type": "integer",
              "description": "Which port to bind for the API server",
              "default": 0
            },
            "allow_origin": {
              "type": "string",
              "description": "The value for the Access-Control-Allow-Origin header",
              "default": ""
            }
          }
        },
        "zeroconf_enabled": {
          "type": "boolean",
          "description": "Whether Zeroconf discovery should always be enabled (even when logging in with credentials)",
          "default": false
        },
        "credentials": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "The authentication method",
              "enum": [
                "interactive",
                "spotify_token",
                "zeroconf"
              ],
              "default": "zeroconf"
            },
            "interactive": {
              "type": "object",
              "description": "Authenticate with the interactive browser UI",
              "properties": {
                "callback_port": {
                  "type": "integer",
                  "default": 0
                }
              }
            },
            "spotify_token": {
              "type": "object",
              "description": "Authentication with username and access token",
              "properties": {
                "username": {
                  "type": "string",
                  "default": ""
                },
                "access_token": {
                  "type": "string",
                  "default": ""
                }
              }
            }
          }
        },
        "bitrate": {
          "type": "integer",
          "description": "The preferred bitrate for audio playback, default is 160kbps",
          "enum": [
            96,
            160,
            320
          ],
          "default": 160
        },
        "volume_steps": {
          "type": "integer",
          "description": "The number of volume steps",
          "min": 1,
          "default": 100
        },
        "initial_volume": {
          "type": "integer",
          "description": "Initial volume in steps",
          "min": 0,
          "default": 100
        },
        "normalisation_disabled": {
          "type": "boolean",
          "description": "Whether track/album normalisation should be disabled",
          "default": false
        },
        "normalisation_pregain": {
          "type": "number",
          "description": "The normalisation pregain to apply to track/album normalisation factors",
          "default": 0
        },
        "external_volume": {
          "type": "boolean",
          "description": "Whether volume is controlled externally, if true the app will not pre-multiply samples",
          "default": false
        }
      },
      "required": [
      ],
      "title": "config"
    }
  }
}