abox-ws

Release 1.0.2

Amber box video controls through web sockets

Homepage Repository npm JavaScript Download

Keywords
tv-manager, abox
License
MIT
Install
npm install abox-ws@1.0.2

Documentation

ABox-ws

Description

ABox-ws is used for controlling video playback through web sockets. It only works in an STB environment, where the sockets are available. This module supports AMD and CommonJS module loaders.

Usage

Video sizing

For video sizing use the setVideoSize function.

It uses 4 parameters as follows:

  1. x - horizontal offset in pixels
  2. y - vertical offset in pixels
  3. width - width of the video display in pixels
  4. height - height of the video display in pixels All 4 parameters must be provided in an integer format (no floating points)

The following example will display video 200 pixels from left, 50 from top and resized to a resolution of 800x200: js AboxWs.setVideoSize(200, 50, 800, 200) .then(function() { console.log('size set'); }) .catch(function(error) { console.error(error); });

Video playing

To play available videos a player must be initialized. Using initPlayer will start a new player and return a promise. The promise returns an object which contains play and clear functions.

play function is a promise, which throws an error on playback failure and returns on playback start. It accepts these parameters:

  1. url - the location of the video
  2. volume - the volume of the video (-1 to leave default), defaults to -1
  3. callback - a callback function called once the video finishes or when another video is called

clear function stops the player from playing and executes stop callbacks. It is useful to cancel playback.

Example: js var player; AboxWs.initPlayer() .then(function(initializedPlayer) { player = initializedPlayer; player.play('usb://video.mp4', -1, function() { console.log('Video finished playing.'); }) .then(function() { console.log('playback has started'); }) .catch(function() { console.error('error playing video'); }); }) .catch(function(error) { console.error(error); });

Note: on error the player will automatically retry to play the video.

Stats

Dependencies
0
Dependent packages
0
Dependent repositories
0
Total releases
12
Latest release
First release
Forks
0
Watchers
2
Contributors
0
Repository size
430 KB
SourceRank
8

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

2.3.0
2.2.0
2.1.0
2.0.4
2.0.3
2.0.2
2.0.1
2.0.0
1.0.3
1.0.2
See all 12 releases

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2022-06-13 04:12:12 UTC

Login to resync this project