undercut-f1/config.schema.json at master · JustAman62/undercut-f1 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{
  "description": "Options specific to the console app part of UndercutF1.",
  "type": "object",
  "properties": {
    "dataDirectory": {
      "type": "string"
    },
    "logDirectory": {
      "type": "string"
    },
    "apiEnabled": {
      "type": "boolean"
    },
    "verbose": {
      "type": "boolean"
    },
    "notify": {
      "type": "boolean"
    },
    "formula1AccessToken": {
      "type": [
        "null",
        "string"
      ]
    },
    "preferFfmpegPlayback": {
      "type": "boolean",
      "description": "Prefer to use FFmpeg (\u003Cc\u003Effplay\u003C/c\u003E) for audio playback (e.g. Team Radio) instead of more native options\nsuch as \u003Cc\u003Empg123\u003C/c\u003E or \u003Cc\u003Eafplay\u003C/c\u003E. FFmpeg is always used on Windows.\nDefaults to \u003Csee langword=\u0022false\u0022 /\u003E ."
    },
    "forceGraphicsProtocol": {
      "enum": [
        "iTerm",
        "Kitty",
        "Sixel",
        null
      ],
      "description": "If provided, forces the app to output images using the given protocol.\nOtherwise, heuristics and queries will be used to determine if graphics are supported, and which protocol to use."
    },
    "preventDisplaySleep": {
      "type": "boolean",
      "description": "Whwther the app should try to prevent the display from turning off/sleeping whilst running.\nThis is similar to running \u003Cc\u003Ecaffeinate -d undercutf1\u003C/c\u003E on macOS."
    },
    "externalPlayerSync": {
      "description": "Options to configure the external player synchronisation service",
      "type": [
        "null",
        "object"
      ],
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether the player sync is enabled or not."
        },
        "serviceType": {
          "description": "What the external service we\u0027re syncing against is.\nThis determines what API calls undercutf1 will be making, and how it will make them.",
          "enum": [
            "Kodi"
          ]
        },
        "url": {
          "type": [
            "null",
            "string"
          ],
          "format": "uri",
          "description": "The URL where the external players API can be found."
        },
        "webSocketConnectInterval": {
          "type": "integer",
          "description": "The amount of time, in milliseconds, to wait between attempts to connect to the external services\nWebSocket interface."
        }
      }
    }
  }
}