Git Product home page Git Product logo

apmplayer's Introduction

APMPlayer

A javascript media player framework developed to be a single, extensible media playback API for streaming and static audio content.

Description

APMPlayer supports both static audio and live audio streaming, however also contains stubs to facilitate the addition of video playables in the future.

The library has been mostly tested with static MP3 audio files, AAC+ live streaming over RTMP, and MP3 live streaming over HTML5. A variety of playback mechanisms are supported (flash streaming via RTMP, progressive download over flash, and HTML5 audio playback). The player will automatically use the most optimal playback mechanism based on browser, plugins available, and files provided.

The project includes a responsive front-end design, API documentation, a full unit test suite, and several example players.

Example Player Demo

http://common.publicradio.org/media_player/1.2/examples/basic_playlist/

Documentation

Full API docs available ( also bundled w/ library under /docs/ ): http://common.publicradio.org/media_player/1.2/docs/

Required Dependencies

  • jQuery -- tested and works with nearly all versions of jQuery (fully tested against 1.4 - 1.11, 2.1)

Included Dependencies

All third party libraries can be found in directories starting with /lib, and are packaged as part of this release:

  • SoundManager2 -- V2.97a.20131201 is the current release bundled as part of APMPlayer. SoundManager2 handles all of the low-level playback, HTML5, as well as flash streaming mechanisms over RTMP. file: /script/lib/soundmanager2-jsmin.js file: /script/lib/swf/*

  • jQueryUI Slider -- main library used for scrubber and volume bar. file: /script/lib/jquery-ui-slider-1.10.4.custom.min.js

  • Modernizr -- backwards compatibility for non-HTML5 and CSS3 browsers. file: /script/lib/modernizr-2.5.3-custom.min.js

  • QUnit -- javascript unit testing framework.

Project structure

  • /docs/ - API + UML documentation.
  • /examples/ - piles of examples, with relative paths to libs for ease of dev
  • /script/ - location of all js library files, including 3rd-party /lib files
  • /skin/ - location of all css, sprites and files associated with UI.
  • /test/ - project unit tests, using qUnit (jQuery testing framework)
  • /util/ - utility/non-js scripts. currently includes a simple PHP script to force a prompt for file downloads.

Major Components Overview

Player functionality and display generally consists of these three major components:

  • APMPlayer_UI -- handles all of the display-related logic and provides the glue between HTML and APMPlayer. This is a jQuery plugin or 'fn' and requires jQuery to work (see /docs + /examples)

  • APMPlayer -- APMPlayer is a wrapper to SoundManager2 that handles playback based on supported Playable type (eg, audio; live_audio). file: /script/apmplayer.js APMPlayerFactory is also part of apmplayer.js and is a factory pattern which provides a singleton version of APMPlayer, a Playlist, a Playable creator, and a basic Underwriting module (see /docs)

  • SoundManager2 -- handles all of the lower-level playback capabilities. This version includes the soundManager2 V2.97a.20131201 release. located in /script/lib/.

License: BSD-3

APMPlayer was developed by American Public Media and is released under the BSD-3 license. Please see the license.bp for acceptable boilerplates included in the headers of all files throughout the project.

apmplayer's People

Contributors

adamlutz avatar amlutz16 avatar

Stargazers

 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.