@pdftron/webviewer-video

This is an addon for WebViewer that allows loading HTML5 videos (.mp4, ogg, webm) so that their video frames can be annotated.

3.0.4
npm

Version published: 4 years ago

Weekly downloads: 6.4K; decreased by-4.21%

Maintainers: 1

Weekly downloads

Created: 5 years ago

Source

WebViewer Video

WebViewer is a powerful JavaScript-based PDF Library that's part of the PDFTron PDF SDK. It allows you to view and annotate PDF files on your web app with a fully customizable UI.

This is an addon for WebViewer that allows loading HTML5 videos (.mp4, ogg, webm) so that their video frames can be annotated. For more information, see this guide.

Also, try out the react sample here. It shows how to integrate WebViewer and WebViewer-Video with a server component for the saving of annotations.

Initial setup

Before you begin, make sure your development environment includes Node.js and npm.

Install

npm install @pdftron/webviewer-video

How to use

Here is an example of how WebViewer and WebViewer-video could be integrated into your application.

import React, { useRef, useEffect } from 'react';
import WebViewer from '@pdftron/webviewer';
import { initializeVideoViewer, renderControlsToDOM } from '@pdftron/webviewer-video';

const App = () => {
    const viewer = useRef(null);

    useEffect(() => {
      WebViewer(
        {
          path: '/webviewer/lib',
          css: '/styles.css',
          selectAnnotationOnCreation: true,
          disabledElements: [
            'searchButton',
            'pageNavOverlay',
            'viewControlsButton',
            'panToolButton',
          ],
        },
        viewer.current,
      ).then(async instance => {
        // Extends WebViewer to allow loading HTML5 videos (.mp4, ogg, webm).
        const {
            loadVideo,
        } = await initializeVideoViewer(
            instance,
            '---- Insert commercial license key here after purchase ----',
        );

        // Load a video at a specific url. Can be a local or public link
        // If local it needs to be relative to lib/ui/index.html.
        // Or at the root. (eg '/video.mp4')
        const videoUrl = 'https://pdftron.s3.amazonaws.com/downloads/pl/video/video.mp4';
        loadVideo(videoUrl);

        instance.docViewer.on('documentLoaded', () => {
          const customContainer =
              instance.iframeWindow.document.querySelector('.custom-container');

          // Inject the video Controls into WebViewer
          renderControlsToDOM(instance, customContainer);
        });
      });
    }, []);

    return (
        <div className="App">
            <div className="webviewer" ref={viewer} />
        </div>
    );
}

export default App;

Also see the React sample, for a complete solution, with further customizations.

Loading as a Script Tag

If your environment can not import WebViewer Video from the module, you can instead include WebViewer Video as a script tag. Simply, take the file node_modules/@pdftron/webviewer-video/dist/main.js and add it to your project's html page.

    <head>
        ...
        <!-- main.js can be renamed -->
        <script src="./main.js"></script>
    </head>

This will add the object WebViewerVideo to the window. This object contains initializeVideoViewer and renderControlsToDOM. So the previous code can be changed to:

    ...
    const {
        loadVideo,
    } = await window.WebViewerVideo.initializeVideoViewer(
        instance,
        '---- Insert commercial license key here after purchase ----',
    );
    ...
    window.WebViewerVideo.renderControlsToDOM(instance, customContainer);

Documentation

See the docs folder provided in the package.

License

WebViewer Video will run in trial mode until a license is provided. For more information on licensing, please visit our website.

Keywords

FAQs

What is @pdftron/webviewer-video?

Is @pdftron/webviewer-video popular?

Is @pdftron/webviewer-video well maintained?

Package last updated on 06 Oct 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install