Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nypublicradio/nypr-audio-services
https://github.com/nypublicradio/nypr-audio-services
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/nypublicradio/nypr-audio-services
- Owner: nypublicradio
- License: mit
- Created: 2017-04-03T22:03:00.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-11T15:31:07.000Z (5 months ago)
- Last Synced: 2024-12-08T04:35:35.700Z (about 2 months ago)
- Language: JavaScript
- Size: 3.55 MB
- Stars: 2
- Watchers: 20
- Forks: 2
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# nypr-audio-services
[![Maintainability](https://api.codeclimate.com/v1/badges/6afbef5dc3fef59ec322/maintainability)](https://codeclimate.com/github/nypublicradio/nypr-audio-services/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/6afbef5dc3fef59ec322/test_coverage)](https://codeclimate.com/github/nypublicradio/nypr-audio-services/test_coverage)This repo is the home of all audio-related controls in use by the web-clients. It's mostly in the form of components, but there are also a handful of services used in the orchestration of responses to events triggered by ember-hifi.
## components
* `listen-button`
* The primary UI widget through which users will start playback
* Includes multiple variations that are controlled by a type parameter, which controls a set of CSS classes and inheritance
* The bouncing animation is controlled by JS and based on a run-time measurement of the button's DOM dimensions
* Includes a nested component which is configured to replace server-rendered HTML with an ember component
* Includes a callback parameter called `playButtonClickedAction` to be invoked as a callback when `listen-button` is tapped when in a `play` (as opposed to `pause`) state.
* `queue-button`
* The primary UI widget for adding and removing a piece of audio to a local queue
* `player-notification`
* slide up notification bar used to display messages from the player
* `nypr-player-integration`
* translates property names from story and stream model attributes to unified keys that the player can consume
* `stream-banner`
* sophisticated UI widget to display and play stream objects and their metadata
* `clear-history`
* UI for the clearHistory method on the listen-history service
* `player-history`
* `player-queue`
* `queue-history`
* `queue-listitem`
* `text-crawl`## services
* `dj`
* orchestrates play requests and fetches records if passed an id
* `action-queue`
* allows for event listeners to order up by priority and prevent subsequent listeners from running## Installation
```sh
$ npm i nypublicradio/nypr-audio-services
$ ember g nypr-audio-services
```## Development
* `git clone [email protected]:nypublicradio/nypr-audio-services`
* `cd nypr-audio-services`
* `npm install`## Running
* `ember serve`
* Visit your app at [http://localhost:4200](http://localhost:4200).
(this will just be a blank page since there are no templates or routes defined for the dummy app on this addon).## Running Tests
* `npm test` (Runs `ember try:each` to test your addon against multiple Ember versions)
* `ember test`
* `ember test --server`## Building
* `ember build`
For more information on using ember-cli, visit [http://ember-cli.com/](http://ember-cli.com/).
## Publishing
This addon is published to npm using semver. See the [wiki](https://wiki2.wnyc.org/index.php?title=WebClient:Developer_Guide) for more instructions.