Record audio repository plugin

Jump to: navigation, search

This project will create a recording audio feature that will allow users to record and upload audio content easily, without requiring additional software tools or computer skills. GSOC '09

Overview

Abstract

This document is about functional specification for Record audio Repository Plugin, a GSOC2009 project. The recording audio feature will allow users to record and upload audio content easily, without requiring additional software tools or computer skills. The project mentor is Jerome Mouneyrac and the program administrator is Helen Foster

Context

The goal of this GSOC2009 project is to add audio recording features in Moodle, the required support for transmitting and evaluating speaking skills. This feature will target mainly foreign languages classes and art classes, but it could be used for any other type of class, too, because many lectures, course annotations or personal introductions could be done easily in such a manner.

This project will use the Repository plugins API and its own small API for integration of sound recording components and web services with Moodle. The API will allow Moodle developers to integrate various sound recording Java applets (like Nanogong), Flash objects, or even web services (like riffly).

Completion criteria

  • Moodle will allow users to record audio content.
  • Moodle will allow developers to integrate new audio recording components easily.

Schedule

  • April, 20 – May, 23 – discuss required functionality with the mentor; analyze features and APIs of various audio recording components and web-services; collect feedback from the mentor and community.
  • May, 24 – July, 9 – design and implement an API for audio repository plug-ins.
  • July, 10 – August 6 – implement connectors between the audio repository plugin and audio recording components
  • August, 7 – August, 15 – remove reported bugs
  • September, 3 – submit code and resource files to Google

Requirements

  • Administrator should be able to administrate the audio recording plugin
  • Users should be able to record audio files using the audio recording plugin

User interface

Administration page

  • plugin settings (riffly requires an API_KEY field - textbox)

User page

  • plugin will display the embedded object for audio recording (Flash or Java) which will display its UI (usualy record/play buttons).

Use cases

UC001-3 Setup a repository

Please follow the use case UC001-3 Setup a repository

UC005-1 User records an audio item

Base scenario

  1. User goes to the repository page
  2. User selects the audio source
  3. System displays the recording object
  4. User presses the record button and talks
  5. User presses the stop button
  6. User presees send/save

Pre conditions

  • the record audio plugin is Enable
  • the user has permissions in use the repository feature

Post conditions

  • the item is stored in the repository

UC005-2 User cancels recording an audio item

Base scenario

  1. Steps 1-5 as in UC005-1
  2. User presees cancel to drop the recording

Pre conditions

  • the record audio plugin is Enable
  • the user has permissions in use the repository feature

Post conditions

  • the item is not stored in the repository

See also