Survey Design
Advanced Features
Audio Recording

Audio recording lets a form silently or visibly capture audio during a section of a survey. It is useful for recording interviews, ambient sound during field observations, or spoken responses that complement structured answers.


⚠️

Mobile app only. Audio recording requires the rtSurvey mobile app. In the web form the audio-start and audio-end appearances are silently ignored — no recording takes place and no error is shown. Always test on-device when audio recording is required.


How it works

Audio recording is controlled by two text fields acting as markers:

  • A field with appearance audio-start begins recording when the enumerator reaches it.
  • A field with appearance audio-end stops recording and saves the audio file to the submission.

Both marker fields are of type text. They are typically hidden from the enumerator (using relevant = false or placed in a non-interactive position), though they can be visible. The recorded audio is attached to the submission as a file linked to the audio-end field.


Basic example

typenamelabelappearance
textaudio_s_a1audio-start
textq_nameRespondent name
textq_occupationOccupation
integerq_ageAge
textaudio_e_a1audio-end

The app starts recording when the enumerator reaches audio_s_a1 and stops when they reach audio_e_a1. All questions between the two markers are recorded.


Silent recording: audio-start invisible

By default, the mobile app displays a recording indicator while audio is being captured. Adding invisible to the appearance suppresses this indicator, so recording happens without any visible cue to the respondent.

typenamelabelappearance
textaudio_s_a1audio-start invisible
textq_consentDo you agree to participate?
textq_feedbackYour feedback
textaudio_e_a1audio-end

Use invisible only when disclosure requirements have been satisfied through other means (e.g., a separate written consent field before the recording section).


Naming convention

Production forms use a consistent naming pattern for marker fields:

audio_s_{section}{n}   — start marker
audio_e_{section}{n}   — end marker

Where {section} is a short label for the form section and {n} is a sequential number within that section.

Field nameRoleMeaning
audio_s_a1StartFirst recording in section A
audio_e_a1EndEnd of first recording in section A
audio_s_b1StartFirst recording in section B
audio_e_b1EndEnd of first recording in section B
audio_s_a2StartSecond recording in section A
audio_e_a2EndEnd of second recording in section A

Following this convention makes it easy to identify recording boundaries when reviewing form definitions and submission data.


Storage and retrieval

When the enumerator reaches the audio-end field, the app finalises the audio file and attaches it to the submission. The file is:

  • Stored as an audio attachment on the submission, associated with the audio-end field name.
  • Accessible in the rtSurvey back-end submission viewer alongside other media attachments.
  • Downloadable via the standard submission export — audio files appear in the media column corresponding to the audio-end field name.

File format and bitrate depend on the device and app version.


Multiple recording sections

A form can contain several non-overlapping recording sections. Each pair of audio-start / audio-end markers must be fully contained — sections must not interleave.

typenamelabelappearance
textaudio_s_a1audio-start
textq_introIntroduction
textaudio_e_a1audio-end
notesection_break
textaudio_s_b1audio-start invisible
textq_detailDetails
textaudio_e_b1audio-end

Each section produces a separate audio file attached to its respective audio-end field.


Limitations

  • Mobile app only. The feature is not supported in the web form. audio-start and audio-end are silently ignored in a browser.
  • No nesting. Recording sections cannot overlap. Starting a new recording before the previous audio-end marker is reached is not supported.
  • Field type must be text. Using audio-start or audio-end on any other question type is not supported.
  • Upload size. Long recordings produce large files. Be aware of submission size limits and network conditions in the field.
  • No mid-recording pause. The recording runs continuously from the start marker to the end marker; there is no mechanism to pause and resume within a section.