Audio question type - recording implementation

Open
#695 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
typescript
Domain
frontend, web-dev

Research direction

No implementation files, entry points, or tests are identified. Start by resolving the missing UI/UX, API, state-flow, and test-plan details and reviewing related issue #703; done means audio responses support recording, playback, replacement, upload, quality presets, and background recording.

Written by the indexing model from the issue text.

Description

In Collect In Enketo needs ui/ux design
Description

Implement the audio question type (specs) and investigate how to develop the key functionalities outlined below.

This feature should support built-in recording by default, providing users with controls to record, play, replace and upload audio files . Key functionalities include:

  • Recording Quality: Support for the audio-quality appearance with low, normal, and voice-only presets to optimize file size and clarity.
  • Background Recording: Implementation of the background appearance to allow continuous audio capture throughout the form-filling process.
  • Standard Interface: A default widget featuring a record button that integrates seamlessly with the device's native or built-in audio capabilities.

Checklist
  • Does it need UI/UX design?
    • Yes. Describe the UI/UX requirements or attach a Figma link in the "Design" section.
    • No
  • Does it need API design?
    • Yes. Specify the endpoints, methods, or data structures needed.
    • No
  • Does it need design around state flow?
    • Yes. Outline the state flow requirements.
    • No
  • Does it need a test plan?
    • Yes. Add the test plan as a comment in this task or attach the document.
    • No

User Stories
  • As a data collector, I want to record audio responses directly within the form so that I don't have to switch to an external application.
  • As a form designer, I want to set the audio quality to "voice-only" so that I can minimize data usage while maintaining high-quality speech recordings.
  • As a researcher, I want to enable background recording so that the entire interview context is captured automatically while I navigate through questions.
  • As a user, I want to listen to my recording before submitting the form to ensure the audio is clear and correctly captured.

Design
  • Figma: [Insert URL]
  • Design Docs: [Insert URL]

Related Issues
Dominant language
TypeScript
Stars
38
Forks
24
PR merge metrics
No merged PRs in 30d

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getodk/web-forms

All issues in getodk/web-forms

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.