ppt-control.inion commit add config file comments, minor JS refactoring (ae22cb8)
   1[Main]
   2
   3# Logging level
   4# Options: debug, info, warning, error, critical
   5# (see https://docs.python.org/3/howto/logging.html#when-to-use-logging)
   6logging = info
   7
   8# Cache location
   9# Directory to store slide preview images for each presentation
  10cache = C:\Windows\Temp\ppt-cache
  11
  12# Cache format
  13# Can be set to any image filter set in the registry, but most commonly JPG or PNG
  14# (see https://docs.microsoft.com/en-us/office/vba/api/powerpoint.slide.export)
  15cache_format = JPG
  16
  17# Cache timeout
  18# Time after which slides should be exported again to reflect any changes made in the
  19# PowerPoint editor. Set to 0 to never consider the cache stale (not recommended). Value 
  20# is in seconds.
  21cache_timeout = 300
  22
  23# Cache initialisation
  24# Whether to export all slides when a slideshow is started. Can be set to any falsy or
  25# truthy value.
  26cache_init = True
  27
  28# Black-white behaviour
  29# Sets the behaviour when returning from black or white mode. Options: "both", "literal"
  30# In PowerPoint's presenter view, if the slideshow is in black or white screen mode,
  31# attempting to switch to the other mode (white/black) will result in the slideshow
  32# returning to a normal (visible) state, rather than white/black. This behaviour is
  33# also the default for ppt-control, and is invoked by setting "blackwhite" to "both"
  34# (when the slideshow is in black or white mode, requesting either black or white mode 
  35# will return the slideshow to normal). The more intuitive setting is "literal", whereby 
  36# when the slideshow is in black or white mode, pressing the button corresponding to the 
  37# mode that the slideshow is already in will return the slideshow to normal mode, and 
  38# pressing the other button will put the slideshow into that mode explicitly.
  39blackwhite = both
  40
  41# Refresh interval
  42# Describes the number of seconds between backend updates, which consist of:
  43# - synchronisation of PowerPoint's events with the internal state. 
  44# - updating the interface (systray icon) status
  45# - check for PowerPoint files that have been opened in protected view
  46# You could set a shorter value here, but these updates don't have to be instant so
  47# the default value of 2 seconds should work fine.
  48refresh = 2
  49
  50# Disable protecte view
  51# If set to a truthy value, ppt-control will attempt to disable protected view on files
  52# which have been opened in protected view. Obviously this introduces some security risk,
  53# so if you are uncomfortable with this, leave it off and you will have to disable 
  54# protected view for each file manually to be able to control it will ppt-control.
  55disable_protected = True
  56
  57[HTTP]
  58
  59# HTTP interface
  60# The interface to listen for HTTP requests on. Change this if you want to restrict the
  61# HTTP frontend to a specific network. A blank value means all interfaces.
  62interface = 
  63
  64# HTTP port
  65# The port to listen for HTTP requests on. The default value of 80 is the standard 
  66# port for HTTP, so when set to this value you don't need to include the port number
  67# in the URL when navigating to the frontend. For all other values you will need to 
  68# specify the port number in the web browser (except 443, but that's a bad idea).
  69port = 80
  70
  71[WebSocket]
  72# WebSocket interface
  73# The interface to listen for WebSocket requests on. Change this if you want to restrict
  74# the WebSocket interface to a specific network. A value of 0.0.0.0 means all interfaces.
  75interface = 0.0.0.0
  76
  77
  78# WebSocket port
  79# The port to listen for WebSocket requests on. This needs to match the port specified in
  80# whatever frontend you are using (e.g. in the JS code for the HTTP frontend, or in the
  81# script settings for the OBS frontend).
  82port = 5678