https://github.com/jbroadway/asl-player
A sign language video player for Apache Cordova that embeds into the corner of your screen, allowing for simultaneous playback with another video.
https://github.com/jbroadway/asl-player
accessibility asl cordova ios lsq objective-c player plugin sign-language video video-player
Last synced: 13 days ago
JSON representation
A sign language video player for Apache Cordova that embeds into the corner of your screen, allowing for simultaneous playback with another video.
- Host: GitHub
- URL: https://github.com/jbroadway/asl-player
- Owner: jbroadway
- License: mit
- Created: 2016-07-12T07:15:57.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-07-20T13:23:07.000Z (almost 9 years ago)
- Last Synced: 2025-04-09T21:50:55.954Z (13 days ago)
- Topics: accessibility, asl, cordova, ios, lsq, objective-c, player, plugin, sign-language, video, video-player
- Language: Objective-C
- Homepage: https://www.npmjs.com/package/asl-player
- Size: 12.7 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ASL Plugin for Apache Cordova
This plugin places a secondary video player in the bottom right corner of your
app that will play sign language (ASL) videos alongside your main video content,
for accessibility.
The plugin works around the iOS limitation of only playing one video at a time,
by using the AVFoundation framework to do so.
Browser platform support is not implemented, but should silently fail. If you
would like to add support for this or other additional platforms, I would gladly
accept the additions into the project.
## Installation
To install, run the following command:
cordova plugin add https://github.com/jbroadway/asl-player.git
## Usage
This plugin defines a Javascript object by the name of `ASLPlayer` with the
following methods:
* `ASLPlayer.create(file)` - Create a new ASL player with the specified file.
* `ASLPlayer.play()` - Play the currently set video after it's been created.
* `ASLPlayer.pause()` - Pause the currently playing video.
* `ASLPlayer.seek(to)` - Change the seek time of the currently playing video.
* `ASLPlayer.hide()` - Hide the ASL player, pausing if it's currently playing.
Please note that the files should be `.mp4` and the file name sent to
`ASLPlayer.create(file)` should omit the file extension.
For example, if your ASL videos are located in the folder `assets/asl`, then
you would specify the files like this:
ASLPlayer.create('assets/asl/video_01')
This will load the video file `assets/asl/video_01.mp4`.
## Dimensions
The player is shown in the bottom right 220x235 corner of the screen. This is
the width-to-height ratio your video files should be set to.
## Credits
This plugin was originally created for an exhibit at the [Canadian Museum for
Human Rights](https://humanrights.ca/) and was developed by [The Campfire
Union](https://www.campfireunion.com/).