What's New in Version 2
The following options are new in version 2 of the Screenleap API, released fall 2013. For v1 documentation, see https://www.screenleap.com/api/v1.
Presenter App Types
Two new presenter app types are available for sharing:
- Native app - These presenter apps run natively on your users' machines, which means it is not necessary for your users to install additional third-party software (such as Java).
- Browser extension - The browser extension takes seconds to install and allows your users to easily share the contents of a web browser without downloading any additional software.
Screen Share Options
We have added new configuration options for the new screen share request:
showScreenleapBranding- Puts the Screenleap logo in the viewer top bar and console title bar, in place of your company name. Non-SSL screen shares with this option are billed at a discounted rate.
hideStopButton- Hide the stop button on the presenter console.
hidePauseButton- Hide the pause button on the presenter console.
hideScreenToggle- Hide the drop-down for toggling between partial and full screen mode.
startPaused- Launch the screen share in a paused state. This ensures that no data is sent to viewers until after the presenter has finished setting up and unpauses the screen share.
false, you can provide a title to use in the viewer top bar and console title bar, in place of your company name.
language- Localization is now available for both the presenter console and viewer page. Contact us for more details.
You can view a complete list of available options in the API Reference.
The following new viewer options can be added to the viewer URL as query string parameters:
externalId- You may now pass in an external ID of up to 32 characters to save with the viewer data in a screen share. This can be useful for later connecting screen share viewer connections to records on your system. If passed in, the external ID needs to be unique for each viewer in a screen share. Assigning the same external ID to multiple viewers in a screen share will break viewing for the screen share.
fitToWindow- By default, screen shares are shown at their actual size to viewers to ensure the best image quality. Set this option to
trueto resize the screen to fit within the user's browser window.
Please see Viewer Integration for a complete list of viewer options.
screenleap.onScreenShareStart- Called after the presenter app is successfully initialized.
screenleap.onScreenShareEnd()- Called when the screen share ends.
screenleap.error(action, message, err)- Called when the screen share presenter encounters an error. The
actionwill provide information about the context in which the error occurred; the
messagemay provide more details to help you troubleshoot; the
errmay be either an
Errorobject or an
XmlHttpRequestobject, depending on the nature of the error.
screenleap.onViewerConnect(externalId, participantId)- Called when a new viewer joins the screen share.
screenleap.onViewerDisconnect(externalId, participantId)- Called when a viewer leaves the screen share.
screenleap.pauseSharing(successCallback, errorCallback)- Pause an active share.
screenleap.resumeSharing(successCallback, errorCallback)- Resume a paused share.
There are several options that now configured from your Developer Account Settings, rather than be passed in to requests as query string parameters:
- Logo - If you upload a logo, the logo will be used in the viewer top bar in place of your company name.
- Callback on end URL - Enter the URL where you would like to receive data about a screen share. When the screen share ends, we will make a POST request to the URL with basic data about the screen share in JSON format.
- Redirect-on-end URL - We will redirect your viewers to this URL when their viewing session ends.
- Redirect-on-error URL - We will redirect your viewers to this URL if there is an error loading the screen share.
Changes from Version 1
New pricing went into effect on July 1, 2013, which bills according to the number of participants in a screen share and the features being used. Please see Pricing for more information.
Screen Share Options
showStopButtonis depreceated, replaced with
showPauseButtonis deprecated, replaced with
showScreenToggleis deprecated, replaced with
isPausedis deprecated, replaced with
callbackOnEndUrlis deprecated, replaced with Developer Account Settings.
redirectOnEndUrlis deprecated, replaced with Developer Account Settings.
redirectOnErrorUrlis deprecated, replaced with Developer Account Settings.
titleLinkUrlhas been deprecated, use
resizehas been deprecated, use
screenleap.screenShareEndedhas been renamed to
screenleap.onScreenShareEndis no longer passed the screen share data as a JSON object. Instead, you should implement the callback on end URL in the Developer Account Settings. This is both more reliable (since it is not dependent on the user web page or internet connection) and more accurate, since the data comes from our servers.