wcjs-multiscreen-renderer

0.2.0 • Public • Published

WebChimera.js Renderer

Renderer for WebChimera.js

Prerequisites

Install

npm install wcjs-multiscreen-renderer

Usage example

JS:

var wcjs = require("wcjs-multiscreen-renderer");

JavaScript API

setMainContext( vlc, context ): set main context for render:

  • context context object. It has two keys:
    • canvas - DOM object of desired object
    • window - Window object of this canvas. It uses to render in different windows
  • vlc vlc object, created with webchimera.js`s createPlayer() function

addAdditionalContext( context ): (optional) add another one context for render:

  • context context object. It has three keys:
    • id - unique id. Just for quick found and check already existed context
    • canvas - DOM object of desired object
    • window - Window object of this canvas. It uses to render in different windows

init(): initiate the renderer with all contexts added above.

removeContext( context ): set main context for render:

  • context context object. It has three keys:
    • id - unique id. Just for quick found and check already existed context
    • canvas - DOM object of desired object
    • window - Window object of this canvas. It uses to render in different windows

deinit(): Remove all contexts and execute clearCanvas().

clearCanvas(): draws a single black frame on the canvas, should be used after stopping the player and/or when the media file has changes (otherwise the frame from the previous video will be kept on the canvas)

Package Sidebar

Install

npm i wcjs-multiscreen-renderer

Weekly Downloads

0

Version

0.2.0

License

MIT

Last publish

Collaborators

  • shaienn