Skip to content

Viewer customization

In addition to the ability to specify view settings when creating a view, each viewer instance may also be customized using URL parameters. This allows you to change the layout, set the background color, and more, without having to make changes to the view itself.

Layout

The viewer layout can be set to either vertical or horizontal. The default layout is vertical, but you can change this by passing the layout parameter in the URL. For example, to set the layout to horizontal, you would use the following URL:

https://sibl.pub/v/choir?layout=horizontal

Playback marker width

The width of the playback marker can be slightly modified by passing the pbmw parameter in the URL. The value of pbmw should be an integer between 1 and 9 inclusively. For example, to set the playback marker width to 5, you would use the following URL:

https://sibl.pub/v/choir?pbmw=5

Background color

To help blend the viewer into your site, you can set the background color of the viewer by passing the bg parameter in the URL. The value of bg should be a color name or hex code. For example, to set the background color to white, you would use the following URL:

https://sibl.pub/v/choir?bg=white

Transport position

Even though the transport position can be set on the view record itself, it can be overridden by passing the tp parameter. Value should either be top or bottom. For example, to set the transport position to the top of the viewer, regardless of the actual view record's value for that, you would use the following URL:

https://sibl.pub/v/choir?tp=top

Language override

Even though the preferred language is defined by the user's browser settings, it can be overridden by passing the lang parameter. Currently supported languages are:

  • German (de)
  • English (en)
  • Spanish (es)
  • French (fr)
  • Italian (it)
  • Japanese (ja)
  • Portuguese (pt)
  • Mandarin Chinese (zh)

For example, to set the locale to italian, you would use the following URL:

https://sibl.pub/v/choir?lang=it

Passing a non-supported language value to the lang will default to US english.