Overview of the Screen Recorder Launcher API

Overview of the Screen Recorder Launcher API



Overview of the Screen Recorder Launcher API

This guide is for customers who have the Enterprise or Solution Builder Plan and want to incorporate the screen recorder software into their network and application(s). The guide can also be used to understand the capabilities provided through the API before purchasing.

The Screen Recorder Launcher API is a lightweight set of JavaScript functions that interface with your instance of the screen recorder and video editing software. The Enterprise or Solution Builder Plan includes a distribution of the software to host in your network. All software callbacks are local to your network and version control is maintained by you in your environment.

To implement the screen recorder into your site, you add our JavaScript Screen Recorder Launcher API code, which enables your users to install and launch the software directly from a button placed on your site. The JavaScript API Launcher also includes call back functionality for user messaging that you can customize, such as messages for downloading progress, successful installation, unsupported OS, etc. 

The API can be implemented through a Basic Uploader or a Custom Uploader. The Basic Uploader uses the standard UI and publishing using push/put to your backend.  The Custom Uploader enables developing a custom user interface (UI) and custom upload endpoint, such as to your backend or a cloud service if not supported in the Basic Uploader. Both methods use the same sequence of events:

  1. The browser launches the recorder.
  2. The recorder is available to record the screen and the user makes a recording.
  3. The raw, fully editable recording is stored on the users computer.
  4. The user provides metadata as part of the publishing process, and then uploads.
  5. The local computer encodes and uploads the video and metadata to the publishing end point.

Recording and encoding is executed on the user's local machine; only the finished product—the specified metadata and the encoded recording—is uploaded. Recordings are encoded in mp4 fomat.

The Basic Uploader is configured by properties specified in the JavaScript. With the Custom Uploader, you can use Java to provide a custom UI to allow the user to enter custom metadata. 

Please see the next article Getting Started with the Screen Recorder Launcher API.


Related Topics

 

    • Related Articles

    • Screen Recorder Launcher API Functions

       Screen Recorder Launcher API Functions Use the Screen Recorder Launcher API to create a global SOMLauncher javascript object. This object exposes the functions contained in this article. First you'll need to download and host the API javascript ...
    • Getting Started with the Screen Recorder Launcher API

       Getting Started with the Screen Recorder Launcher API Use the following information as a guide to integrate the features of the screen recorder and video editor software into your website. Table of Contents Introduction to the Screencast‑O‑Matic ...
    • Questions and Answers about the Screen Recorder Launcher API

       Questions and Answers about the Screen Recorder Launcher API This article contains users' questions and answers regarding the Screencast-O-Matic Recorder Launcher API. Table of Contents Can we specify "screen and webcam," or the desired resolution, ...
    • Recorder API

      Recorder API Overview With the Recorder API you can embed a "Record Screencast" button any where to upload to your Channel on Screencast-O-Matic.com.  For example if you wanted to collect tech support bugs from users on your website. Prerequisite To ...
    • How do I start the tools (screen recorder, screenshots, editing)

      We provide several ways to launch the tools to fit with your work style: Web page Desktop Tool Tray (Windows) or Menu Bar (Mac) Chrome Extension 1. Webpage: you can start the free screen recorder from the screen recorder page (no login required).  ...