Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TamaraGunkel authored Mar 23, 2022
1 parent 4be2ad6 commit 94b5ebb
Showing 1 changed file with 3 additions and 16 deletions.
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,16 @@
moodle-filter_opencast
=====================
The opencast filter can be used to embed opencast videos.
The filter takes in the html pasted by the opencast repository and replaces it by an iframe, which loads the <a href="https://github.com/polimediaupv/paella">Paella player</a> with the respective opencast event.
The filter takes the HTML pasted by the opencast repository and replaces it by an iframe, which loads the [Paella Player 7](https://paellaplayer.upv.es/) with the respective opencast event.
The filter itself has no influence on the embedded content, but simply takes the information created by the repository.
Look into the documentation of [repository_opencast](https://github.com/Opencast-Moodle/moodle-repository_opencast) for details on that.

<img width="800" alt="Filter opencast demonstration" src="https://user-images.githubusercontent.com/28386141/137904963-968fd449-602d-40c8-99ad-c56a40fd03f0.png">

## Requirements

- [tool_opencast](https://github.com/Opencast-Moodle/moodle-tool_opencast)
- [mod_opencast](https://github.com/Opencast-Moodle/moodle-mod_opencast)
- [repository_opencast](https://github.com/Opencast-Moodle/moodle-repository_opencast): The filter can be installed without the repository
but it is necessary to enable teachers to insert opencast videos.
## Documentation ##

## Configuration
The filter has two global configurations that can be modified by the administrator.

<img width="800" alt="Filter opencast configuration" src="https://user-images.githubusercontent.com/28386141/137904968-cacaf48f-35c0-4d15-b6d7-001ded49afc9.png">

The first configuration "URL template for filtering" specifies the URL type that is replaced by the filter. This URL should correspond to the URLs inserted by the repository plugin. In the config, you must use the placeholder [EPISODEID] to indicate where the episode id is contained in the link, e.g. `http://stable.opencast.de/play/[EPISODEID]`.

The second configuration "URL to Paella config.json" specifies the path to the Paella player config. This config can be adapted if you want to modify the look or behavior of the Paella player.

Notice: Make sure to configure [mod_opencast](https://github.com/Opencast-Moodle/moodle-mod_opencast) before using the filter. If [mod_opencast](https://github.com/Opencast-Moodle/moodle-mod_opencast) isn't configured correctly, the paella player won't be able to display the video.
The full documentation of the plugin can be found [here](https://moodle.docs.opencast.org/#filter/about/).

## License ##

Expand Down

0 comments on commit 94b5ebb

Please sign in to comment.