Gitlab CSE Unil

README.md 2.63 KB
Newer Older
M. Chardon's avatar
M. Chardon committed
1
# Annotate audio files, Moodle activity module
M. Chardon's avatar
M. Chardon committed
2 3 4 5 6 7 8 9 10

This module is developed and maintained by RISET/University of Lausanne.

Author: Marion Chardon, <marion.chardon@unil.ch>

Compatible with Moodle versions: 3.7+

## Description

M. Chardon's avatar
M. Chardon committed
11
This tool is a Moodle activity that allows:
M. Chardon's avatar
M. Chardon committed
12 13

 - as a student:
M. Chardon's avatar
M. Chardon committed
14 15
  - to give an audio assignement (one or more audio files)
  - to annotate its own work
M. Chardon's avatar
M. Chardon committed
16
  - to annotate pair assignement
M. Chardon's avatar
M. Chardon committed
17
  - to have a feedback and see all annotations on its work
M. Chardon's avatar
M. Chardon committed
18 19 20 21 22
  - 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
M. Chardon's avatar
M. Chardon committed
23 24
  - to create different caegories of custom annotations to evaluate work
  - to manage favorite set of annotation caregories
M. Chardon's avatar
M. Chardon committed
25 26 27 28 29 30 31 32 33 34 35 36 37

See this <a href="https://gitlabriset.unil.ch/Marion.Chardon/moodle-mod_audioannotation/wikis/home">wiki page</a> for screenshots.


## Installation

 1. Download as a ZIP file
 2. Extract the ZIP file in '<your-moodle-root-directory>/mod/' directory
 3. Rename the extracted root directory to 'audioannotation'


## Configuration

M. Chardon's avatar
M. Chardon committed
38
You must specify the location of ffmpeg library.
M. Chardon's avatar
M. Chardon committed
39 40 41 42


## Tips

M. Chardon's avatar
M. Chardon committed
43 44 45 46
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
M. Chardon's avatar
M. Chardon committed
47 48 49 50


## What's next?

M. Chardon's avatar
M. Chardon committed
51 52
Upcoming developments could include:
 - annotation over a time interval
M. Chardon's avatar
M. Chardon committed
53
 - audio feedback in student side
M. Chardon's avatar
M. Chardon committed
54 55 56 57


## Technical part

M. Chardon's avatar
M. Chardon committed
58
### Global scheme
M. Chardon's avatar
M. Chardon committed
59

M. Chardon's avatar
M. Chardon committed
60
See this <a href="https://gitlabriset.unil.ch/Marion.Chardon/moodle-mod_audioannotation/wikis/Technical-explanations">wiki page</a> for schema.
M. Chardon's avatar
M. Chardon committed
61 62 63 64


### ffmpeg

M. Chardon's avatar
M. Chardon committed
65
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.
M. Chardon's avatar
M. Chardon committed
66

M. Chardon's avatar
M. Chardon committed
67
If a user inserts an unrecognized audio format, you can add it to your Moodle configuration (file types pages, in Moodle administration).
M. Chardon's avatar
M. Chardon committed
68 69


M. Chardon's avatar
M. Chardon committed
70
### RTC Web
M. Chardon's avatar
M. Chardon committed
71

M. Chardon's avatar
M. Chardon committed
72
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
M. Chardon's avatar
M. Chardon committed
73 74 75 76


### JustWave

M. Chardon's avatar
M. Chardon committed
77
Thanks to this tool https://github.com/beotiger/justwave , with some modifications and adaptations, the module can generate:
M. Chardon's avatar
M. Chardon committed
78 79
 - an imge of the sound (which is cached to Moodle, and erased with a cron task)
 - a multi-function player
M. Chardon's avatar
M. Chardon committed
80 81 82 83 84 85 86 87

## Contributors and Licenses

Copyright: University of Lausanne, RISET
Author: Marion Chardon, <marion.chardon@unil.ch>

'Audio annotation' is a free software released under the GNU GPL licence, version 3.