Gitlab CSE Unil

Commit df74e390 authored by M. Chardon's avatar M. Chardon
Browse files

Update README.md

parent 4dc7dd08
# Annotate audio files, Moodle actiity module
# Annotate audio files, Moodle activity module
This module is developed and maintained by RISET/University of Lausanne.
......@@ -8,20 +8,20 @@ Compatible with Moodle versions: 3.7+
## Description
This tool is a Moodle activity wich allows:
This tool is a Moodle activity that allows:
- as a student:
- to give audio assignement (one or several audio files)
- to annotate its own assignement
- to give an audio assignement (one or more audio files)
- to annotate its own work
- to annotate pair assignement
- to have a feedback and see all annotations on its assignement
- to have a feedback and see all annotations on its work
- to give feedback to annotations on its assignement
- as a teacher:
- to annotate an audio file, in a write and/or audio way
- to ask question or feedback to student on a specific point
- to create different custom categories of annotations to grade work
- to manage favorite set of annotation's caregories
- to create different caegories of custom annotations to evaluate work
- to manage favorite set of annotation caregories
See this <a href="https://gitlabriset.unil.ch/Marion.Chardon/moodle-mod_audioannotation/wikis/home">wiki page</a> for screenshots.
......@@ -35,48 +35,48 @@ See this <a href="https://gitlabriset.unil.ch/Marion.Chardon/moodle-mod_audioann
## Configuration
You need to specify ffmpeg library location.
You must specify the location of ffmpeg library.
## Tips
In player, in write mode (pairing, teacher in edit mode and student in edit mode), there are some shortcuts you can use:
- 'space' for playing/pausing sound
- 'b' for going back from 2 seconds
- 'n' for create a new annotation
In the reader, in writing mode (pairing, teacher in editing mode and student in editing mode), yyou can use some shortcuts:
- 'space' to play/pause the sound
- 'b' to go back 2 seconds
- 'n' to create a new annotation
## What's next?
Upcoming developments may include:
- annotation on an time interval
Upcoming developments could include:
- annotation over a time interval
- audio feedback in student side
## Technical part
### Global schema
### Global scheme
See this <a href="https://gitlabriset.unil.ch/Marion.Chardon/moodle-mod_audioannotation/wikis/Technical-explanations">wiki page</a> for schema.
### ffmpeg
All audio file are converted in mp3 format, for more compatibilty and browser display, as mp3 is the only one (for now) to be displayed in all browsers and devices.
All audio files are converted in mp3 format, for compatibilty and browser display, as mp3 is the only one (currently) to be displayed in all browsers and devices.
If a user inserts an unrecognazie audio format, you can add it on your Moodle configuration (file types pages, in Moodle administration).
If a user inserts an unrecognized audio format, you can add it to your Moodle configuration (file types pages, in Moodle administration).
### Web RTC
### RTC Web
Module use javascript web RTC technology. By careful, there is a lof of different comportement between browsers and devices. All web RTC developements are include in record.js and recordsManager.js
Module uses javascript web RTC technology. Be careful, there are many different behaviors between browsers and devices. All RTC web developments are included in record.js and recordsManager.js
### JustWave
Thanks to this tool https://github.com/beotiger/justwave , with some modifications and adaptations, the module can generate:
- a picture of the sound (which is set in cache to Moodle, and clear with a cron task)
- a multi function player
- an imge of the sound (which is cached to Moodle, and erased with a cron task)
- a multi-function player
## Contributors and Licenses
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment