Custom Media Manager players

Digital Experience Accelerator (DXA) provides support for custom Media Manager players, including sample players to get you started.

Example custom players

DXA provides two example custom players:

  • The carousel-mm.js example is for Image Distribution. It allows you to display the Media Manager Image Distribution in form of a carousel.
  • The html5player.js example is for Video. It allows you to customize your video player and it comes with the following set of parameters that you can enable:
    • cusomVideoAutoplay - allows a video to play automatically once a page where it is located opens.
    • customVideoSubtitles - turns on/off the video subtitles.
    • customVideoControls - turns on/off the video controls.

You can find both examples on the DXA GitHub website.

Custom parameters

To see a list of custom parameters for Media Manager players, go to BuildingBlocks/Modules/MediaManager/Editor/Schemas/SDL Media Manager. In the Schema Fields section, you can find the list of all new custom parameters.

Enabling custom parameters

You can enable the custom parameters for each individual Media Manager Item you create using Content Manager Explorer (CME) or Experience Manager (XPM).

To enable a custom parameters for a player, make sure that its playerType parameter is set to Custom. By default, all newly created media Items have their playerType parameters set to Custom. If playerType is set to Standard, you cannot customize any of the players and their custom parameters are ignored.

The following image shows an example of metadata for a custom video player: