From 24134e0422943f48c9e37b5bdd86e7ba0c23e7a6 Mon Sep 17 00:00:00 2001 From: TamaraGunkel Date: Wed, 23 Mar 2022 16:23:00 +0100 Subject: [PATCH] Update README.md --- README.md | 54 ++++-------------------------------------------------- 1 file changed, 4 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 18159e8..8d46408 100644 --- a/README.md +++ b/README.md @@ -3,60 +3,14 @@ moodle-mod_opencast This activity can be used to display and view Opencast episodes and series in Moodle. Users with respective privileges (in the following called teacher) can specify the ID of an existing Opencast episode/series to add it to their course. An embedded player allows students to watch the videos directly in Moodle. As with every activity, the teachers can restrict the access to the videos for students based on e.g. dates, grades or user profiles. -The Paella player is used to play the videos. +The Paella player is used to play the videos. The integration with the Opencast Videos block makes the handling and access restriction of Opencast videos very simple. -Videos can be uploaded via the block and made available via this activity. -The block offers the functionality to add activities so that teachers don't have to explicitly specify the Opencast IDs. -Therefore, it is recommended to use the block for adding activities. Futher information can be found in the documentation of the block. - -System requirements ------------------- - -* Min. Moodle Version: 3.8 -* Min. PHP Version: 7.3 -* Opencast API level: - * Minimum: v1.1.0 - -* Installed plugin: tool_opencast - -Usage scenarios ---------------- -In the following, the two usage scenarios, providing a series or an episode, are described. - -### Use case 1 - Provide a series ### -The teacher wants to provide a series for students. For example, this series contains all lecture recordings. - -Steps to add the activity: -1. Add a new "Video (Opencast)" activity. -2. Enter the Opencast id of the series you want to display:
-
-3. If you want, you can specify further configurations like access restrictions. -4. The videos in the series can be either displayed in a list view or in a preview view:
- - - - -### Use case 2 - Provide an episode ### -The teacher wants to provide a single episode for students. For example, this episode belongs to a specific lecture. -1. Add a new "Video (Opencast)" activity. -2. Enter the Opencast id of the episode you want to display as in the previous use case. The activity automatically recognizes that the entered id is an episode. -3. If you want, you can specify further configurations like access restrictions. -4. The activity directly displays a player that shows the video:
-
- -Configuration -------------- -The activity has two global configurations that can be modified by the administrator. -
- -The first configuration "Opencast Channel" specifies the Opencast channel to which the videos are published. Only videos published in this channel can be displayed with this activity. The publication must include media files, e.g. `.mp4` files, that can be served to the paella player. - - -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. - +Videos can be uploaded via the block and made available via this activity. +## Documentation ## +The full documentation of the plugin can be found [here](https://moodle.docs.opencast.org/#mod/about/). ## License ##