newton-beey-publish

JavaScript library for publishing Beey transcriptions with recordings on third-party web pages. This version is modified by NEWTON Media and is forked from the public Newton Technologies repository.

🚀 Special features compared to the original version

• Media snippet timeline that can be used to cut out a part of the video or audio file based on the user's selection.

🔌 Include in your project

Install with NPM or Yarn. CDN is not available for this version.

npm install newton-beey-publish

or

yarn add newton-beey-publish

Include the library in your project

import BeeyPublish from '@newton/beey-publish';
import '@newton/beey-publish/dist/beey-publish.css';

📖 Documentation

For the full documentation, please visit the original Beey Publish documentation.

✂️ Media snippet timeline

The media snippet timeline is a feature that allows the user to select a part of the video or audio file. Please note that this feature requires further implementation on the backend side. The modification only provides a basic timeline element used for selecting the start and end of the snippet.

To enable the media snippet tool provide the callback function that will be used to transport snippet metadata to backend.

const callback = (snippetMetadata) => {
  // Handle the snippet cut and send the metadata to the backend
};


const publish = new BeeyPublish(
    {
      playerParent: playerElement,
      transcriptParent: transcriptionElement,
    },
    {
      media: {
        url: mediaUrl,
      },
      callbacks: {
        onMediaSnippetDownload: callback, // <-- Callback function for media snippet metadata transfer
      },
      downloadMedia: true,
    });

The callback metadata object contains the following properties. This object is passed to the callback function when the user selects the start and end of the snippet and clicks the download button.

export interface MediaSnippetData {
  startTime: number;
  endTime: number;
}