Options
All
  • Public
  • Public/Protected
  • All
Menu

basjoo.js

basjoo.js

JavaScript Library for MPEG-DASH supporting IPTV Forum Japan regulation profile
Japanese Document

Overview

"basjoo.js" is the reference software for stable playback of MPEG-DASH(an international standard video distribution technology) on "Hybridcast" that is standardized by IPTV Forum Japan. It supports the VOD (Video on Demand) technology method in the "Hybridcast Operational Guideline version 2.0" defined by the IPTV Forum, and has the following features.

  • Management of video playback to absorb fluctuations in Internet connection speed
  • Program structure that operates with a minimum amount of memory
  • Function to insert video in the middle of a program without interruption
  • Playback on devices with HTML5 browser

"basjoo.js" can stably play high quality Internet videos such as Ultra High Definition Television on TV receivers with low memory capacity. It is also easy to customize the viewing behavior according to the service requirements of the broadcaster, such as swapping spots according to individual preferences. In addition, it can be used not only on TVs but also on PCs and smartphones support HTML5 browser, enabling video distribution to a variety of devices.

Reference

Environment

Quick Start for Developers

  1. Install Core Dependencies

  2. Checkout project repository

    git clone https://github.com/nhkrd/basjoo.js.git
    
  3. Install dependencies

    npm install
    
  4. Builddistribution files (all or minification)

    • Build basjoo.all.js
    npm run dev
    
    • Build basjoo.min.js
    npm run build
    
  5. Using sample player

    http://[IP Address]/basjoo/samples/player.html?url=[mpd_URL]
    

    See sampledoc.md.

Usage

IDE setting

  1. Install VSCode
  2. Start VSCode, and select "Open Workspace" from the menu
  3. Select "basjoo.code-workspace"
  4. Install all Extensions recommended by the workspace

Generate API typescript doc

npm run doc

Build distribution files

  • Build basjoo.all.js
npm run dev
  • Build basjoo.all.js, and delete comments(/******/)
npm run dev:rm

Build and watch distribution files

npm run watch

Build distribution files (minification included)

npm run build

Launch the sample player

Usage: npm run sample -- [options]

Options:
-u, --url <URL> Add MPD URL.
-m, --mode <default | ttml > Select sample player mode.
-p, --port <number> Change the port number.
-h, --help display help for command

License

See LICENSE.md.


Sample player includes other oss packages due to some reasons.

  • RobotoCondensed-Regular.ttf (https://fonts.google.com/specimen/Roboto+Condensed, Apache License, Version 2.0)

    Sample Player uses RobotoCondensed-Regular.ttf to make it look the same layout on the display of various TV devices. See License in samples/fonts/LICENSE.txt.

Generated using TypeDoc