Recorder API

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 use the Recorder API you need the Recorder API Plan.  Please contact sales@screencast-o-matic.com to purchase your plan.  The 1st month is free and allows you to integrate and test the Recorder API before making payment.

Getting Started

Take a look at our tutorial on Setting up Embedded Recorder which goes over how to get started by:

  1. Creating a Channel on your Screencast-O-Matic.com account
  2. Setting up the recorder to embed.
  3. Copy-and-paste javascript for recorder into your html.

Javascript Settings

When you embed the javascript you can add some extra settings which we highlight in bold below:

<script type="text/javascript" id="som_recorder_RECORDERID" src="//screencast-o-matic.com/api/som.js">
</script><script type="text/javascript">
    SOM.Recorder({
        id: "RECORDERID", 
        customData:{"key1":"value1", "key2":"value2" ...}, 
        callback: function(screencast) {
            ...
        }
    }).embed();
</script>

customData

Setting a customData object with key/value pairs will save the data so it's passed back in the callback function and in JSON for the WebHook if you have one defined (see more about WebHook Callback below).

callback

Setting a callback function will allow you to receive a javascript callback after the recorder is closed.  If a screencast is uploaded from the recorder then the function will be called back with a javascript object containing details for the upload OR undefined if no screencast was uploaded.  

When using the javascript callback, the end user should not navigate away from the page where the recorder is launched or else the javascript callback won't be called.

The javascript object will contain the following details:

{
    "id": "SCREENCASTID",
    "title": "Title entered by user",
    "description": "Desctiption entered by user (or empty string if nothing was given)",
    "customData": { customData you provided if any }
}

If you also check the box in your recorder settings to "Include links and embed tag in javascript callback" then you also get links and an embed tag to what was uploaded:

{
    "id": "SCREENCASTID",
    "title": "Title entered by user",
    "description": "Desctiption entered by user (or empty string if nothing was given)",
    "customData": { customData provided in javascript },
    "watchLink" : "http://link/ to the playback page for the upload",
    "channelLink" : "http://link/ to the channel page for the upload",
    "downloadLink" : "http://link/ to download the mp4 for upload which expires after 1 hour",
    "embedTag" : "<frame>Tag to embed a player for the upload</frame>"
}

WebHook Callback

You can setup a WebHook callback so a POST request is made from our servers back to your system when an upload is made.  You can supply either an HTTP or HTTPS url which can also be prefixed with username and password for basic authentication like:  username:password@http://....

The POST request will contain JSON with the same data provided in the javascript callback with all the links to the upload that was created like:

{
    "id": "SCREENCASTID",
    "title": "Title entered by user",
    "description": "Desctiption entered by user (or empty string if nothing was given)",
    "customData": { customData provided in javascript },
    "watchLink" : "http://link/ to the playback page for the upload",
    "channelLink" : "http://link/ to the channel page for the upload",
    "downloadLink" : "http://link/ to download the mp4 for upload which expires after 1 hour",
    "embedTag" : "<frame>Tag to embed a player for the upload</frame>"
}

If the system fails to post to your server then it will retry until it successfully posts.

Ready to get started?  Contact Us for more details on the Recorder API Plan pricing and start a free 1 month trial.


    • Related Articles

    • 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 ...
    • 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 ...
    • 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 ...
    • 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, ...
    • Using a Channel Recorder Button

      What is a Channel Recorder button? Adding a Channel Recorder button will allow your audience to launch the recorder and submit their content to your channel. The recorder button launches a version of the screen recorder, that contains a simplified ...