Home

Media

Media is a presentation component bundled with the Adapt framework.

The Media component is used to present learners with a short video or audio clip. Video formats are MP4, with older versions of Firefox requiring files in the OGV format. IE8 does require Adobe Flash to be installed in order to play audio/video content.

Visit the page dedicated to Usage and Tips.

Installation

As one of Adapt's core components, Media is included with the installation of the Adapt framework and the installation of the Adapt authoring tool.

• If Media has been uninstalled from the Adapt framework, it may be reinstalled. With the Adapt CLI installed, run the following from the command line:
  adapt install adapt-contrib-media

• If Media has been uninstalled from the Adapt authoring tool, it may be reinstalled using the Plug-in Manager.

Back to Top

Settings

The settings listed below are the properties that may be configured within the authoring tool. Listed first is the name of the property as it is presented in the authoring tool. It is followed in parentheses by the property as it is used in the Media source code. Finally, an explanation is provided to help the course author better utilize the property.

The relationship between Media's properties and the way they are presented in the authoring tool’s interface is governed by properties.schema.

Title (title): A reference title for the component. Title is distinct from the Display Title which, if present, appears above the component. If Display Title is rather long, Title provides the opportunity to use a shortened form in tighter spaces, such as in a menu or in the drawer.

Display Title (displayTitle): Optional text that will display as a title above the component. It can be used as a headline. In the authoring tool, Title and Display Title may be linked for easy input. Click the chain icon to toggle linking.

Body (body): Optional text that appears above the component. It can be used in a variety of ways, including as an introduction to the content in the component. HTML is permitted.

Instruction (instruction): This optional text appears above the component. It is frequently used to guide the learner’s interaction with the component.

Classes (_classes): Custom classes predefined in the theme's Less files may be applied to this component. To do this, enter the name of the CSS class. If using more than one class, separate each with a space.

Layout (_layout): This defines the horizontal position of the component in the block that contains it. This property is set when the component is being added to the block. When Add to left or Add to right is selected, another component can occupy the space next to it. If Add is selected, the component spans the width of the containing block.

Further settings for this component are:

Media options (_media): The media options group will contain different values depending on the type of media: video or audio.

mp4 (mp4): File name (including path) of the video file. Path should be relative to the src folder (e.g., course/en/video/video-1.mp4).

ogv (ogv): File name (including path) of the video file. Path should be relative to the src folder (e.g., course/en/video/video-1.ogv).

poster (poster): File name (including path) of the optional image to be shown while the video is downloading, or until the user hits the play button. If this is not included, the first frame of the video will be used instead. Path should be relative to the src folder (e.g., course/en/images/video-1.jpg).

cc (cc): Closed captions in multiple languages may be provided. Each object in this list contains values for srclang and src.

Limitations

• Flash Player 10 is required for use with IE8.
• MediaElement provides options to customize the media player. Currently, the Adapt authoring tool does not accommodate configuring these options; courses that require _playerOptions must be built directly in the Adapt framework.