Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bbc/bigscreen-player
Simplified media playback for bigscreen devices
https://github.com/bbc/bigscreen-player
dash javascript live live-streaming media-player playback player tv video video-playback video-streaming vod
Last synced: about 2 months ago
JSON representation
Simplified media playback for bigscreen devices
- Host: GitHub
- URL: https://github.com/bbc/bigscreen-player
- Owner: bbc
- License: apache-2.0
- Created: 2018-10-03T16:01:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T15:47:48.000Z (4 months ago)
- Last Synced: 2024-05-29T06:23:21.497Z (4 months ago)
- Topics: dash, javascript, live, live-streaming, media-player, playback, player, tv, video, video-playback, video-streaming, vod
- Language: JavaScript
- Homepage: https://bbc.github.io/bigscreen-player/
- Size: 9.41 MB
- Stars: 77
- Watchers: 51
- Forks: 14
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-video - bigscreen-player - Simplify video and audio playback on a wide range of 'bigscreen' devices (TVs, set-top boxes, games consoles, and streaming devices). (Players)
README
[](https://github.com/bbc/bigscreen-player/actions/workflows/npm-publish.yml) [](https://www.npmjs.com/package/bigscreen-player) [](https://github.com/bbc/bigscreen-player/blob/master/LICENSE)
> Simplified media playback for bigscreen devices.
## Introduction
_Bigscreen Player_ is an open source project developed by the BBC to simplify video and audio playback on a wide range of 'bigscreen' devices (TVs, set-top boxes, games consoles, and streaming devices).
For documentation on using this library, please see our [Getting Started guide](https://bbc.github.io/bigscreen-player/api/tutorial-00-getting-started.html).
## Running Locally
Install dependencies:
```bash
npm install
```
You can run Bigscreen Player locally in a dev environment by running:
```bash
npm run start
```
This will open a web page at `localhost:8080`.
## Testing
The project is unit tested using [Jest](https://jestjs.io/). To run the tests:
```bash
npm test
```
This project currently has unit test coverage but no integration test suite. This is on our Roadmap to address.
## Releasing
1. Create a PR.
2. Label the PR with one of these labels; `semver prerelease`, `semver patch`, `semver minor` or `semver major`
3. Get a review from the core team.
4. If the PR checks are green. The core team can merge to master.
5. Automation takes care of the package versioning.
6. Publishing to NPM is handled with our [GitHub Actions CI integration](https://github.com/bbc/bigscreen-player/blob/master/.github/workflows/npm-publish.yml).
## Documentation
Bigscreen Player uses JSDocs to autogenerate API documentation. To regenerate the documentation run:
```bash
npm run docs
```
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## License
Bigscreen Player is available to everyone under the terms of the Apache 2.0 open source license. Take a look at the LICENSE file in the code for more information.