npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@playkit-js/advanced-audio-description

v1.2.8

Published

[![Build Status](https://github.com/Kaltura-PS/playkit-js-advanced-audio-description/actions/workflows/run_canary_full_flow.yaml/badge.svg)](https://github.com/Kaltura-PS/playkit-js-advanced-audio-description/actions/workflows/run_canary_full_flow.yaml) [

Downloads

286

Readme

playkit-js-advanced-audio-description

Build Status

playkit-js-advanced-audio-description is a kaltura player plugin that Audio description gives detail and imagery in order to make visual content accessible to individuals who are blind or have low vision and provide these viewers with a similar experience to a sighted viewer.

It relies on kaltura player core API for managing UI features.

playkit-advanced-audio-description is written in ECMAScript6 (*.js) and TypeScript (*.ts) (strongly typed superset of ES6), and transpiled in ECMAScript5 using Babel and the TypeScript compiler.

Webpack is used to build the distro bundle and serve the local development environment.

Features

Extended Audio Description is a service that pauses the video to allow for longer descriptions when there is not enough space to sufficiently describe the visuals in your video.

“Extended Audio Description“ is a type of audio description that is suitable for videos that have few natural pauses, but that contains a lot of visual content.

“Extended Audio Description“ workflow → when a user press play, the video, and description begin playing. Then, the source video pauses temporarily, while the description continues. After that portion of the description is complete, the video resumes playing again

Getting started with development

# First, checkout the repository and install the required dependencies
git clone https://github.com/Kaltura-PS/playkit-js-advanced-audio-description.git

# Navigate to the repo dir
cd playkit-js-advanced-audio-description

# Run dev-server for demo page (recompiles on file-watch, and write to actual dist fs artifacts)
npm run dev

# Before submitting a PR - Run the pre commit command
npm run pre:commit

# this command will run:

# 1. types check
# 2. lint check
# 3. generate/update types
# 4. generate/update docs

The dev server will host files on port 800x. Once started, the demo can be found running at http://localhost:800x/.

Before submitting a PR, please see our contribution guidelines.

How to config

ui: {
  showAdvancedAudioDescButton: true,    // for showing AAD in Gear setting, default state is off
  translations: {
    en: {
      'plugin-advanced-audio-description': {}
    }
  }
},
plugins: {
  pluginAdvancedAudioDescription: {}    // for adding the plugin
}

Linter (ESlint)

Run linter:

npm run lint:check

Run linter with auto-fix mode:

npm run lint:fix

Formatting Code

Run prettier to format code

npm run prettier:fix

Type Check

Run type-check to verify TypeScript types

npm run types:check

Automated tests (Mocha/Karma)

Run all tests at once:

npm test

Run unit tests in watch mode:

npm run test:watch

Design

An overview of this project's design, can be found here.

API docs

API docs

Usage guide

usage guide

Demo

https://kaltura.github.io/playkit-advanced-audio-description/demo/index.html

External Demo

https://externaltests.dev.kaltura.com/player/sandBox/playerv7/aad/

Compatibility

playkit-advanced-audio-description is only compatible with browsers supporting MediaSource extensions (MSE) API with 'video/MP4' mime-type inputs.

playkit-advanced-audio-description.js is supported on:

  • Chrome 39+ for Android
  • Chrome 39+ for Desktop
  • Firefox 41+ for Android
  • Firefox 42+ for Desktop
  • IE11 for Windows 8.1+
  • Edge for Windows 10+
  • Safari 8+ for MacOS 10.10+
  • Safari for ipadOS 13+

License

playkit-advanced-audio-description.js is released under Apache 2.0 License