Upgrade Notes

Upgrading from v2.0.0 to v3.0.0

This upgrade carries a lot of new components and changes to the player. This upgrade is backward compatible with v2.0.0 while there are some new props added to the existing components to make them more customizable.

New components

• AutoAdvanceToggle component: related documentation
• MetadataDisplay component: related documentation
• MarkersDisplay component: related documentation
• SupplementalFiles component: related documentation

Changes to the existing components

• IIIFPlayer component:

  Props:

  • 3 new props added to it; they are customErrorMessage, startCanvasId, and startCanvasTime. These are explained in detail in the documentation here.

• MediaPlayer component:

  Props:

  • One new prop for disabling Picture-In-Picture in the player called enablePIP, this prop has a default value of false.

  ** CHANGED DEFAULT BEHAVIOR: This prop changes the default behavior of v2.0.0, which had Picture-In-Picture enabled by DEFAULT.

• Transcript component:

  Props:

  • One new prop for providing a manifestUrl, which is the same Manifest url given to IIIFPlayer component. The component will parse the supplementing annotation for each Canvas in the Manifest and generate a transcripts list. More information is available in the documentation.

  Functionality changes:

  • Transcripts component used to always auto-scroll with playback when there are transcripts with time information. In v3.0.0 the auto-scrolling can be turned on/off using the check box in the component. This only works with transcripts with time information (e.g. WebVTT)
  • Indicates machine generated transcripts in the component. More information can be found in the documentation.