You are here: Administration > Customizing with themes > Creating and editing themes

Creating and editing themes

This section describes how to create and edit your own themes, including how to automatically generate the PIN entry screen images, and how to change which themes are associated with which services. There is also a link to an online video tutorial.

Creating a new theme

You can create a new theme by uploading a .ZIP file containing the files you want to be used instead of the default theme.

The .ZIP file does not need to contain the complete set of files, just any files that you want to be used in place of those from the default theme.

To create a new theme:

  1. Ensure that all new sound and image files meet the specified file requirements for themes.
  2. Save all new sound and image files together in a new folder. You can name the folder whatever you like, but within the folder, each new file must be saved with the same file name and extension as the default file being replaced.
  3. Create a .ZIP file of the new folder.
  4. Go to Service configuration > Themes and select Add theme.
  5. In the Name field, enter the name of the new theme.
  6. In the Theme field, select Choose file and go to the .ZIP file you have just created.
  7. In the Service name section, select the Virtual Meeting Rooms, Virtual Auditoriums and Virtual Receptions that will use this new theme.

    Note that if you have more than 10,000 services configured, you cannot select the associated services via this page. Instead you must use another method to assign the theme to a service, such as editing the individual service, using the configuration API, or by using the bulk VMR provisioning facility.

  8. Select Save.
  9. Allow a minute or so for the new theme to be replicated out to all Conferencing Nodes.

You can now test the theme by dialing one of the services (Virtual Meeting Room, Virtual Auditorium, Virtual Reception or Gateway Routing Rule) to which it has been applied.

Editing an existing theme

You can edit an existing theme by uploading a new .ZIP file containing the new set of files.

The .ZIP file does not need to contain the complete set of files, just any files that you want to be used in place of those from the default theme.

Note that when you edit a theme, all existing files in that theme will be deleted and replaced with files from the new theme. This means that if you have an existing theme containing File A and you want to add File B to the theme, you will need to upload a .ZIP file containing both File A and File B.

To edit an existing theme:

  1. If you want to retain files from the existing theme, first download the theme.
  2. Ensure that all new sound and image files meet the specified file requirements for themes.
  3. Save all new sound and image files, along with any existing files, together in a new folder. Each file must be saved with the same file name and extension as the default file being replaced.
  4. Create a .ZIP file of the new folder.
  5. Go to Service configuration > Themes and select the theme you wish to edit.
  6. In the Theme field, select Choose file and go to the .ZIP file you have just created.
  7. Select Save.
  8. Allow a minute or so for the updated theme to be replicated out to all Conferencing Nodes.

You can now test the theme by dialing one of the services (Virtual Meeting Room, Virtual Auditorium, Virtual Reception or Gateway Routing Rule) to which it has been applied.

Downloading an existing theme

You can download a theme to view the files it contains, or to edit it.

To download a theme:

  1. Go to Service configuration > Themes.
  2. Either:
    • to download a copy of the default set of files that are shipped with Pexip Infinity, select Download Base theme
    • to download a copy of the files that make up a customized theme, select the theme and from the Change Theme page select Download theme.

A file with a .ZIP extension will be downloaded.

Automatically generating the PIN entry screen images

To save you from having to create 13 separate images for each of the PIN entry screens (i.e. all Image files with a file name beginning with pin_entry_), Pexip Infinity's themes feature allows you to select a background image and foreground color, and then automatically generates the required images for you.

You could use this option if you want to use the new images as part of an entirely new theme, or if you want to edit the PIN entry screens only.

The background image must be:

  • .JPG format
  • 1920x1080 pixels.

The PIN entry indicators will:

  • begin 634 pixels from the top of the background image
  • be 70 pixels in diameter
  • have 14 pixels of space between each indicator.

You must ensure that the PIN entry indicators use a color that makes them clearly visible when overlaid on the background image.

To change the PIN entry screen images:

  1. Go to Service configuration > Themes.
  2. Select Generate theme.
  3. In the Background image field, select Choose file and select the image you want to appear behind the PIN entry indicators.
  4. In the Foreground color field, enter the hexadecimal value of the color you want to use for the PIN entry indicators.
  5. Select Generate.
  6. A <image name>.ZIP file will be downloaded. This file will contain the 13 new PIN entry images.
  7. If you want to add any other new files to this theme:
    1. Unzip the downloaded .ZIP file to a new folder.
    2. Add the new files to the new folder.
    3. Create a .ZIP file of the new folder.
  8. Go back to Service configuration > Themes and select Add Theme.
  9. In the Name field, enter the name you want to give to this new theme.
  10. In the Theme field, select Choose file and go to the .ZIP file you have just created.
  11. In the Service namesection, select the service(s) that will use this new theme.
  12. Select Save.
  13. Allow a minute or so for the new theme to be replicated out to all Conferencing Nodes.

You can now test the theme by dialing in to one of the VMRs to which it has been applied.

Changing which themes are associated with which services

There are many ways in which you can change the theme that is associated with a service (Virtual Meeting Room, Virtual Auditorium, Virtual Reception or Gateway Routing Rule). You can do this:

  • via the Themes page (go to Service configuration > Themes, select the new theme you want to use, then select the service(s) you want to apply it to). Note that you cannot use this method if you have more than 10,000 services configured
  • by editing the individual service (go to Service configuration, select the service, then select the new theme from the Theme drop-down menu)
  • via the configuration API
  • by using the bulk VMR provisioning facility

Tutorial

Using themes to brand your Virtual Meeting Rooms

How to brand and apply custom themes to Pexip Infinity (15 mins)