Solution Builder API
SPLauncher JavaScript Object

6min
Overview
For background information, see Basic Uploader﻿.
The Basic Uploader JavaScript creates the SPLauncher JavaScript object, which you use to launch ScreenPal and commuicate with it.
You may pass it custom data and specify a callback.  You may also set up a WebHook callback from ScreenPal servers to your servers when a recording is uploaded.
Start the Recorder
Include this in your JavaScript file: 

JS
<script type="text/javascript" src="https://myhost/SP/sp-launcher-3.0.X.js"></script>
<script type="text/javascript" src="https://myhost/SP/sp-launcher-3.0.X.js"></script>
﻿
Then call the SPLauncher.launch(...) function to start the recorder.
Custom Data and Callback
When you embed the JavaScript you can add some extra settings, using customData and callback as seen below:
JS
<script type="text/javascript" id="sp_recorder_RECORDERID" src="//screenpal.com/api/sp.js">
</script><script type="text/javascript">
    SP.Recorder({
        id: "RECORDERID",
        customData:{"key1":"value1", "key2":"value2" ...},
        callback: function(screencast) {...}
        }).embed();
</script>
<script type="text/javascript" id="sp_recorder_RECORDERID" src="//screenpal.com/api/sp.js">
</script><script type="text/javascript">
    SP.Recorder({
        id: "RECORDERID",
        customData:{"key1":"value1", "key2":"value2" ...},
        callback: function(screencast) {...}
        }).embed();
</script>
﻿
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.
Setting a callback function will allow you to receive a JavaScript callback after the ScreenPal Recorder is closed.  If a recording is uploaded, then the function will be called back with a JavaScript object containing details for the upload OR undefined if no recording 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:
JS
{
    "id": "RECORDINGID",
    "title": "Title entered by user",
    "description": "Description entered by the user (or empty string if nothing was given)",
    "customData": { customData you provided if any }
}
{
    "id": "RECORDINGID",
    "title": "Title entered by user",
    "description": "Description entered by the user (or empty string if nothing was given)",
    "customData": { customData you provided if any }
}
﻿
If you enabled the option to "Include links and embed tag in javascript callback", then you will also get links and an embed tag to what was uploaded:
JS
{
    "id": "RECORDINGID",
    "title": "Title entered by user",
    "description": "Description entered by the 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>"
}
{
    "id": "RECORDINGID",
    "title": "Title entered by user",
    "description": "Description entered by the 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 set up a WebHook callback so a POST request is made from the ScreenPal servers back to your servers when an upload is made.  You can supply either an HTTP or HTTPS URL, which can also be prefixed with a 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:
JS
{
    "id": "RECORDINGID",
    "title": "Title entered by user",
    "description": "Description entered by the 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>"
}
{
    "id": "RECORDINGID",
    "title": "Title entered by user",
    "description": "Description entered by the 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.
SPLauncher Properties
When calling SPLauncher.launch(...), you may specify options using properties.  See SPLauncher Properties﻿ for details on those properties.
Updated 18 Mar 2024
Solution Builder API
SPLauncher Properties