Browse Source

Update README.md

philippe44 5 years ago
parent
commit
0470fddc69
1 changed files with 8 additions and 0 deletions
  1. 8 0
      README.md

+ 8 - 0
README.md

@@ -39,6 +39,14 @@ I2C|SPI,width=<pixels>,height=<pixels>[,address=<i2c_address>][,HFlip][,VFlip]
 ```
 - VFlip and HFlip are optional can be used to change display orientation
 
+The NVS parameter "metadata_config" sets how metadata is displayed for AirPlay and Bluetooth. Syntax is
+```
+[format=<display_content>][,speed=<speed>]
+```
+- 'speed' is the scrolling speed in ms (default is 33ms)
+
+- 'format' can contain free text and any of the 3 keywords %artist%, %album%, %title%. Using that format string, the keywords are replaced by their value string is displayed as is. Note that if the plain text following a keyword that happens to be empty during playback will be removed. For example, if you have set format=%artist% - %title% and there is no artist in the metadata then only <title> will be displayed not " - <title>".
+
 ### Vcc GPIO
 The parameter "Vcc_GPIO" is a comma-separated list of GPIO that will be configured as output with their value set to 1 (Vcc) at boot. Be careful because there is no conflict checks being made wrt which GPIO you're changing, so you might damage your board or create a conflict here.