bitmovin-player-ui
Version:
Bitmovin Player UI Framework
34 lines (33 loc) • 10.3 kB
HTML
<html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>bitmovin-player-ui</title><meta name="description" content="Documentation for bitmovin-player-ui"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">bitmovin-player-ui</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>bitmovin-player-ui</h1></div><div class="tsd-panel tsd-typography"><h1 id="bitmovin-player-ui-npm-version-build-status" class="tsd-anchor-link">Bitmovin Player UI <a href="https://badge.fury.io/js/bitmovin-player-ui"><img src="https://badge.fury.io/js/bitmovin-player-ui.svg" alt="npm version"></a> <a href="https://app.travis-ci.com/bitmovin/bitmovin-player-ui"><img src="https://app.travis-ci.com/bitmovin/bitmovin-player-ui.svg?branch=develop" alt="Build Status"></a><a href="#bitmovin-player-ui-npm-version-build-status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>This repository contains the Bitmovin Player UI framework.
It is designed as a flexible and modularized layer on the player API, enabling customers and users of the player to easily customize the UI to their needs in design, structure, and functionality. It makes it extremely easy and straightforward to add additional control components and we encourage our users to proactively contribute to our codebase.</p>
<p>Read more about the Framework, its usage and customization possibilities in our <a href="https://developer.bitmovin.com/playback/docs/bitmovin-player-ui">developer documentation</a> and the <a href="https://cdn.bitmovin.com/player/ui/4/docs/index.html">API documentation</a>.</p>
<h2 id="installation" class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The UI framework is also available through the following distribution channels:</p>
<h3 id="cdn" class="tsd-anchor-link">CDN<a href="#cdn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>The UI framework and default skin bundled with the latest player release are always available via CDN. This is the recommended way if you just want to work with the predefined UI components. All components will be available in the <code>bitmovin.playerui</code> namespace.</p>
<ul>
<li>JavaScript library: <code>https://cdn.jsdelivr.net/npm/bitmovin-player-ui@4/dist/js/bitmovinplayer-ui.js</code></li>
<li>CSS file: <code>https://cdn.jsdelivr.net/npm/bitmovin-player-ui@4/dist/css/bitmovinplayer-ui.css</code></li>
</ul>
<h3 id="npm" class="tsd-anchor-link">NPM<a href="#npm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>The UI framework is also available in the NPM repository and comes with all source and distributable files, JavaScript modules and TypeScript type definitions.</p>
<ul>
<li><code>npm install bitmovin-player-ui</code></li>
</ul>
<h2 id="getting-started-with-development" class="tsd-anchor-link">Getting Started with Development<a href="#getting-started-with-development" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ol start="0">
<li>Clone Git repository</li>
<li>Install node.js</li>
<li>Install required npm packages: <code>npm ci</code></li>
<li>Run <code>npm run</code> to see available scripts</li>
</ol>
<ul>
<li><code>npm start</code> to open test page in browser, build and reload changed files automatically</li>
<li><code>npm run build</code> to build project into <code>dist</code> directory without minification</li>
<li><code>npm run build:prod</code> to build project with minified files into <code>dist</code> directory</li>
<li><code>npm run lint</code> to lint TypeScript and SASS files</li>
<li><code>npm test</code> to run the test suite</li>
<li><code>npm run format</code> to format all files with prettier</li>
<li><code>npm run docs</code> to generate the HTML documentation</li>
</ul>
<p>To take a look at the project, run <code>npm run start</code>. For changes, check our <a href="media/CHANGELOG.md">CHANGELOG</a>. This UI framework version is for player v8.</p>
<h2 id="ui-playground" class="tsd-anchor-link">UI Playground<a href="#ui-playground" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The UI playground can be launched with <code>npm start</code> and opens a page in a local browser window. On this page, you can switch between different sources and UI styles, trigger API actions and observe events.</p>
<p>This page recompiles and reloads files automatically when any <code>.scss</code> or <code>.ts</code> files are modified. It makes a helpful tool for developing and testing the UI.</p>
<h2 id="contributing" class="tsd-anchor-link">Contributing<a href="#contributing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Pull requests are welcome! Please check the <a href="media/CONTRIBUTING.md">contribution guidelines</a>.</p>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#bitmovin-player-ui-npm-version-build-status"><span>Bitmovin <wbr/>Player <wbr/>UI npm version <wbr/>Build <wbr/>Status</span></a><ul><li><a href="#installation"><span>Installation</span></a></li><li><ul><li><a href="#cdn"><span>CDN</span></a></li><li><a href="#npm"><span>NPM</span></a></li></ul></li><li><a href="#getting-started-with-development"><span>Getting <wbr/>Started with <wbr/>Development</span></a></li><li><a href="#ui-playground"><span>UI <wbr/>Playground</span></a></li><li><a href="#contributing"><span>Contributing</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">bitmovin-player-ui</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>