Recorder Settings

The Screenr.Recorder object must be initialized with a settings object. The only property required is "id". This is the ID of your Screenr Business recorder.

Screenr.Recorder({id:"your_recorder_id", subject:"Your Subject"});

Here is the full list of recorder settings

id This is the ID of the recorder you wish to make available. You can find the ID of the recorder by going to the edit recorder screen. This is the only required property
userName This property is used to track the name of the person who recorded the screencast.
userEmail This property is used to track the email of the user who recorded the screencast.
subject Used to give the screencast a subject title.
description Used to give the screencast a description.
showNameField (true or false) Show the user’s name field on the recorder form. Defaults to true
showEmailField (true or false) Show the user’s email field on the recorder form. Defaults to true
showSubjectField (true or false) Show the subject field on the recorder form. Defaults to true
showDescriptionField (true or false) Show the description field on the recorder form. Defaults to true
hideAllFields (true or false) Hide all input fields on the recorder form
showFullScreenRecorderBar (true or false) Show or hide the Recorder Bar during full screen recordings. Defaults to setting on Branding tab.
maxTimeLimit Number in seconds for max recording time. Maximum of 900 seconds (15 minutes).
customData The custom data property allows you to store any custom data required for your workflow by referencing or assigning it a Javascript object. ex, {ticketId:1, product:"widget"}
onComplete
A function, which the Screenr recorder will call once the recording is complete. It will return a screencast object, containing all information about the screencast just created, including URL and embed tag.
{ onComplete: function(screencast) { console.log(screencast.url);  }}
// this is the screencast object passed into the callback function:
 {
   "userName": "Username",
   "userEmail": "Email of user",
   "subject": "Subject of screencast",
   "description": "Description of email",
   "url": "The url where your screencast can be viewed",
   "id": "the id of the screencast",
   "account": "your account name",
   "embed": "the iframe embed tag for your screencast",
   "customData": [{key:'customKey',value:'customValue'}] //your custom data,
   "mp4": "The link to the mp4 video file. This link expires 1 hour after recording"
}
                    
Should I use the Embed code or the MP4?

Recorder Helper Functions

There may be cases when need to set certain recorder properties later in your workflow. If you can't initialize your recorder with all of your settings, the API provides a set of helper functions.

List of available helper functions

setUserName(userName, showField) Takes two parameters, username and showField. The showField parameter is true/false and allows you to hide/show the email field on the recorder form. Defaults to true
setUserEmail(email, showField) Takes two parameters, email and showField. The showField parameter is true/false and allows you to hide/show the email field on the recorder form. Defaults to true
setSubject(subject, showField) Takes two parameters, subject and showField. The showField parameter is true/false and allows you to hide/show the email field on the recorder form. Defaults to true
setDescription(description, showField) Takes two parameters, description and showField. The showField parameter is true/false and allows you to hide/show the email field on the recorder form. Defaults to true
addCustomData(key, value)
Add custom any custom data. Call for each piece of data you would like to save.
var recorder = Screenr.Recorder({id:"recorder_id"});
//add ticketId with value 1
recorder.addCustomData("ticketId", 1);
hideAllFields() Hides all recorder form fields. Any values you set will still be saved.
setOnComplete(callbackFunction) Sets the onComplete callback. If you have complex onComplete callback, using this function may make your code more readable.
setOnCancel(callbackFunction) Sets the onCancel callback.
setMaxTimeLimit(seconds) Sets the maximum recording time in seconds. Maximum of 900 seconds (15 minutes)
showFullScreenRecorderBar(showBar) The showBar parameter is true/false that allows you to hide/show the Recorder Bar during full screen recordings. This overrides the default setting found on the Branding tab.