w3c / w3c/dapt

Support both referenced and inline embedded audio recordings?

Open
#115 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

CR-exit-must-have question
Dominant language
HTML
Stars
11
Forks
7
PR merge metrics
No merged PRs in 30d

Description

          While working on the specification for adding audio recordings I reminded myself of the various ways in which an audio recording can be embedded and referenced, of which there are at least 5 in total. Requirement R15 of [DAPT](https://www.w3.org/TR/dapt-reqs/#requirements) is clear that both referenced and embedded options need to be available, but should we be syntactically restricting the options for each? Will raise as separate issues.

Originally posted by @nigelmegitt in https://github.com/w3c/dapt/issues/105#issuecomment-1470390924

If we are going to support embedded audio resources, they can either be defined in /tt/head/resources and then referenced, or the data can be included inline.

Do we need both options?

Example of embedded:

<head>
  <resources>
    <audio xml:id="audioRecording1" type="audio/wave">
      <source>
        <data>[base64 encoded audio data]</data>
      </source>
    </audio>
    <data xml:id="audioRecording2" type="audio/wave">
      [base64 encoded audio data]
    </data>
  </resources>
</head>

This would then be referenced in the body content using something like (see also #114):

<audio src="#audioRecording2"/>

Example of inline:

<audio type="audio/wave">
  <source type="audio/wave">
    <data>[base64 encoded audio data]</data>
  </source>
</audio>

Contributor guide

Open the 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.

Research direction

Read DAPT requirement R15 and the related examples in issue #114. Compare the referenced resource forms under /tt/head/resources with the inline audio form shown here, then determine whether both must be supported and what syntax should be specified. Done means the requirement and allowed forms are resolved in the specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.