Skip to content

12 Kiosk Mode

CraigD edited this page Apr 30, 2023 · 2 revisions

As of version 3.3.0 you can configure the skin to act in Kiosk mode - this disabled access to certain features and allows to fully specify the content's of Material's main menu via actions.json. This feature is mainly designed for OEMs, etc., that wish to provide locked down access to LMS.

This mode is enabled by editing prefs/plugins/material-skin.prefs and adding:

kioskMode: '1'

This kioskMode can take the following values:

Value Description
0 Mode is disabled
1 Enable Kiosk mode, only actions defined in actions.json (see section 07 Customisation) will be in Material's men menu.
2 Enable Kiosk mode, only actions defined in actions.json (see section 07 Customisation) will be in Material's men menu. However, the Settings header will also be added and so will the divider between settings actions and other actions.

By default the following actions are disabled when using Kiosk mode:

  1. Rename (9)
  2. Remove (10)
  3. Edit (11)
  4. Add favourite (manually creating a favourite) (12)
  5. Delete (13)
  6. Add to favourites menu item (14)
  7. Remove from favourites (15)
  8. Pin an item (16)
  9. Rating (20)
  10. Create a favourite folder (25)
  11. Delete a favourite folder (26)
  12. Move item in favourite folder (27)
  13. Unsubscribe a podcast (29)
  14. Move items (30)
  15. Add to playlist (41)
  16. Remove duplicates (42)
  17. Create a virtual library (49)
  18. Download (50)
  19. Sort playlist (56)
  20. Save playlist (57)

The numerical values above correspond to the IDs uses for Materials actions - these can be seen in actions.json

This list of items can be changed by setting the hideForKiosk config item in prefs/plugins/material-skin.prefs, e.g:

hideForKiosk: '9, 10, 11'

This config item takes a string which is a list of the above values. This 'string' is added to Material's javascript code, so it needs to be a valid string of a list of integers.

Clone this wiki locally