Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates mp3 resource previewer metadata to include has captions and s… #3999

Merged

Conversation

LianaHarris360
Copy link
Member

…ubtitles

Summary

Description of the change(s) you made

This PR updates the previewer to correctly display 'Accessibility' and 'Captions and Subtitles' data for audio resources.

  • The AccessibilityCategoriesMap has been updated to include the content kind audio and maps to CAPTIONS_SUBTITLES.
  • The ResourcePanel has been updated to display 'Captions and Subtitles' for audio resources as as well as video resources.
  • Resource edit form now includes the Accessibility section with the option 'includes captions or subtitles' for .mp3 resources.

Manual verification steps performed

  1. Create or edit an .mp3 audio resource.
  2. Verify the 'Accessibility' section with the option 'includes captions or subtitles' is underneath the 'Audience' section.
  3. Select the 'has captions or subtitles' option.
  4. Under 'Captions and subtitles', select the 'add captions' option, choose a language, and save the resource.
  5. Click the resource to open the previewer.
  6. Verify the previewer lists 'Accessibility' and 'Captions and Subtitles' data.

Screenshots (if applicable)

mp3resourceaccessibility

mp3resourcecaptionsandsubtitles

References

Fixes #3876

Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time

Studio-specifc:

  • All user-facing strings are translated properly
  • All UI components are LTR and RTL compliant

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@LianaHarris360 LianaHarris360 added the changelog Needs to be added to the changelog (remove once added) label Mar 21, 2023
@LianaHarris360 LianaHarris360 marked this pull request as ready for review March 21, 2023 19:45
@bjester
Copy link
Member

bjester commented Mar 22, 2023

@LianaHarris360 Another thing that would be good to tackle is to do a similar migration that we performed when we automatically set 'has captions' for videos. You could update the existing command to operate on audio nodes instead, because we already ran it in production and won't need to run it again. Note: I believe the preset is still format_presets.VIDEO_SUBTITLE despite being audio

@LianaHarris360
Copy link
Member Author

@bjester The command has been updated to handle audio nodes now 👍

Copy link
Member

@bjester bjester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good!

@bjester bjester merged commit 4d02221 into learningequality:unstable Mar 23, 2023
@pcenov
Copy link
Member

pcenov commented Mar 24, 2023

@radinamatic no issues observed - the metadata info for audio accessibility is displayed correctly now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog Needs to be added to the changelog (remove once added)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Previewer metadata - Missing 'Captions and subtitles' info for an .mp3 resource
3 participants