Skip to content

If enabled, graphics with the file extension below will be replaced by videos.

License

Notifications You must be signed in to change notification settings

cgkineo/adapt-graphicVideo

Repository files navigation

Adapt Graphic Video

Adapt Graphic Video is an extension that renders looping mp4 videos in place of graphics. It works only where graphics are rendered as img tags and not everywhere graphics are rendered as img tags, due to custom styling and behaviour.

Settings Overview

The attributes listed below are used in course.json to configure Adapt Graphic Video, and are properly formatted as JSON in example.json.

Attributes

_graphicVideo (object): It contains values for _isEnabled, _fileExtension, _loops, _autoPlay, _onScreenPercentInviewVertical, _offScreenPause, _offScreenRewind, _showPauseControl and _onPauseRewind

_isEnabled (String): Defaults to true.

_fileExtension (String): The video file extension to use. You can use files of this type in place of images in JSON files. Acceptable value is mp4, avif. Defaults to avif for AAT image picker compatibility.

_loops (Boolean): Controls if the video should loop. Defaults to true.

_autoPlay (Boolean): Should the videos play when on screen. Note: Percentage onscreen determines when autoplay occurs. Defaults to true.

_onScreenPercentInviewVertical (Number): What percentage of the SVG container should be on-screen before the videos are triggered. Defaults to 1.

_offScreenPause (Boolean): Pause when off screen. Defaults to true.

_offScreenRewind (Boolean): Rewind when off screen. Defaults to true.

_showPauseControl (Boolean): Show the play / pause button. Defaults to false.

_onPauseRewind (Boolean): Rewind when the pause button is clicked. Defaults to false.


Author / maintainer: Kineo
Accessibility support: Yes
RTL support: Yes
Cross-platform coverage: Evergreen + IE11