Overview
Requirements
Installing from Git
Upgrading from Git
Installing from ZIP
Upgrading from ZIP
Plugin Setup
Important Upgrade Notes
Along with the Ensemble Video Moodle Filter Plugin, this plugin makes it easier for Moodle users to add videos and playlists to content without having to navigate to Ensemble Video and copy/paste complicated embed codes. Once setup, you should see an additional repository option under Insert Moodle media in the Moodle content editor, allowing you to choose videos and playlists to insert from the configured Ensemble Video installation.
In addition to this documentation, also see our Setup the Moodle Plugin and Using the Moodle Plugin support articles.
- Ensemble Video version of 4.3 or higher.
- Moodle version 3.9 or higher.
- Internet Explorer 11 or higher. No known issues with other browsers.
- Depends on the Ensemble Video Moodle Filter Plugin for embed code rendering.
These installation instructions are based off the strategy endorsed by Moodle for installing contributed extensions via Git.
$ cd /path/to/your/moodle
$ cd repository
$ git clone https://github.com/ensembleVideo/moodle-repository_ensemble.git ensemble
$ cd ensemble
$ git checkout -b MOODLE_39_STABLE origin/MOODLE_39_STABLE
As a Moodle administrator, navigate to Settings -> Site Administration -> Notifications and click Upgrade Moodle database now to install the plugin.
To upgrade the plugin do the following:
$ cd /path/to/your/moodle/repository/ensemble
$ git pull
As a Moodle administrator, navigate to Settings -> Site Administration -> Notifications and click Upgrade Moodle database now to upgrade the plugin.
$ wget https://github.com/ensembleVideo/moodle-repository_ensemble/archive/MOODLE_39_STABLE.zip
$ unzip MOODLE_39_STABLE.zip
$ mv moodle-repository_ensemble-MOODLE_39_STABLE /path/to/your/moodle/repository/ensemble
As a Moodle administrator, navigate to Settings -> Site Administration -> Notifications and click Upgrade Moodle database now to install the plugin.
To upgrade the plugin delete the /path/to/your/moodle/repository/ensemble directory, then repeat the installation steps above.
As a Moodle administrator, navigate to Settings -> Site Administration -> Notifications and click Upgrade Moodle database now to upgrade the plugin.
Navigate to Settings -> Site Administration -> Plugins -> Repositories -> Manage repositories and set the Ensemble Video repository to Enabled and visible.
Repository instances can be added site-wide or within a course context.
Required. Must point to the application root of your Ensemble Video installation. If, for example, the url for your Ensemble install is https://cloud.ensemblevideo.com/app/library.aspx, you would use https://cloud.ensemblevideo.com. In the case of a url like https://server.myschool.edu/ensemble/app/library.aspx you would use https://server.myschool.edu/ensemble.
Required. The Consumer Key copied from the appropriate LTI configuration in Ensemble Video -> Administration -> Institution -> LTI Configurations.
Required. The Shared Secret copied from the appropriate LTI configuration in Ensemble Video -> Administration -> Institution -> LTI Configurations.
Optional. Any additional parameters to be passed in the LTI tool launch in order to override default launch and tool UI behavior. Each value should be on a new line and be in the format {parameter}={value}, for e.g.
custom_ensemble_username_param=lis_person_contact_email_primary
custom_ensemble_default_video_width=640
custom_ensemble_video_setting_download=true
Available optional parameters:
- custom_ensemble_username_param: Tells the launch handler to use the given LTI launch parameter (e.g. "lis_person_contact_email_primary"), rather than the default ("custom_moodle_user_login_id"), when performing username mapping.
- custom_ensemble_username_domain: If the username value being mapped from Moodle requires a domain-qualification (e.g. "username@example.edu") in order to match the username within EV, this parameter can be set to provide that domain (e.g. "example.edu").
- custom_ensemble_default_video_width: The default video width embed option is set to the value of the given encoding. This parameter can be passed to override that with a specific static selected width value (must match one of the available selection options).
- custom_ensemble_video_setting_{setting}: Override default selected video embed
options (e.g. "custom_ensemble_video_setting_download"). Available options and
default values are listed below.
- showtitle: true
- autoplay: false
- showcaptions: false
- hidecontrols: false
- socialsharing: false
- annotations: true
- captionsearch: true
- attachments: true
- links: true
- metadata: true
- dateproduced: true
- embedcode: false
- download: false
- custom_ensemble_playlist_setting_{setting}: Override default selected
playlist embed options (e.g. "custom_ensemble_playlist_setting_embedcode").
Available options and default values are listed below.
- layout: 'playlist'
- playlistLayout_playlistSortBy: 'videoDate'
- playlistLayout_playlistSortDirection: 'desc'
- showcaseLayout_categoryList: true
- showcaseLayout_categoryOrientation: 'horizontal'
- embedcode: false
- statistics: true
- duration: true
- attachments: true
- annotations: true
- links: true
- credits: true
- socialsharing: false
- autoplay: false
- showcaptions: false
- dateproduced: true
- audiopreviewimage: false
- captionsearch: true
If you are upgrading from a version older than 3.0, there are some important changes to be aware of.
Whereas prior versions of this plugin used a locally-hosted UI along with proxying of EV API requests, this version leverages LTI in order to render a similar EV-hosted UI. Among the advantages of this approach is improved plugin security, the ability to immediately use UI improvements shipped with EV upgrades/hotfixes without the additional plugin maintainence overhead, and improvements to the authentication process.
Unlike prior versions which required and only supported two site-wide instance configurations, one for an EV videos repository and one for an EV playlists repository, this version provides searching of videos and playlists within a single repository instance as well as configuration of instances at the course and/or site level.
Note: As a result of the above changes, the existing repository instances are removed on upgrade to this version and the plugin is disabled. Re-enable the plugin and add repository instances where appropriate.
Note: Prior versions allowed access to view the configured site-wide repositories to any authenticated user. This version limits access to configured instances to the coursecreator, teacher, editingteacher and manager roles. However, this access is not granted or removed on plugin upgrade. Therefore it is highly recommended that you explicitly modify access to the repository/ensemble:view capability for these and the original user role.