Overview of the Screen Recorder Launcher API

1min

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 user's 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 endpoint.

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ļ»æļ»æ

Updated 01 Sep 2023
NEXT
Getting Started with the Screen Recorder Launcher API
Docs powered byĀ Archbee