API (Native)

Version 2 (10/16/2013)

The following options are new in version 2 of the Screenleap API, released fall 2013.

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.

Share Session Options

We have added new configuration options for the new share session request:

  • showScreenleapBranding - Puts the Screenleap logo in the viewer top bar and console title bar, in place of your company name. Non-SSL share sessions 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 share session in a paused state. This ensures that no data is sent to viewers until after the presenter has finished setting up and unpauses the share session.
  • title - if showScreenleapBranding is 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.

Viewer Options

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 share session. This can be useful for later connecting share session viewer connections to records on your system. If passed in, the external ID needs to be unique for each viewer in a share session. Assigning the same external ID to multiple viewers in a share session will break viewing for the share session.
  • fitToWindow - By default, share sessions are shown at their actual size to viewers to ensure the best image quality. Set this option to true to resize the screen to fit within the user's browser window.

Please see Viewer Integration for a complete list of viewer options.

JavaScript Callbacks

JavaScript callbacks can be added to your web page to alert you of events from the presenter app. See Presenter Integration for details. The supported callbacks are:

  • screenleap.onScreenShareStart - Called after the presenter app is successfully initialized.
  • screenleap.onScreenShareEnd() - Called when the share session ends.
  • screenleap.error(action, message, err) - Called when the screen share presenter encounters an error. The action will provide information about the context in which the error occurred; the message may provide more details to help you troubleshoot; the err may be either an Error object or an XmlHttpRequest object, depending on the nature of the error.
  • screenleap.onViewerConnect(externalId, participantId) - Called when a new viewer joins the share session.
  • screenleap.onViewerDisconnect(externalId, participantId) - Called when a viewer leaves the share session.

Please see JavaScript Calls for more details.

JavaScript Library

New in v2 of the API, you will use a Screenleap JavaScript library for most functions, including starting and stopping a share session. Additional new features provided by this library include:

  • screenleap.pauseSharing(successCallback, errorCallback) - Pause an active share.
  • screenleap.resumeSharing(successCallback, errorCallback) - Resume a paused share.

Please see JavaScript Calls for more details.

Account Settings

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 share session. When the share session ends, we will make a POST request to the URL with basic data about the share session in JSON format.
  • Redirect-on-end URL - We will redirect your viewers to this URL when their share session ends.
  • Redirect-on-error URL - We will redirect your viewers to this URL if there is an error loading the share session.


Changes from Version 1

Pricing-Related Changes

New pricing went into effect on July 1, 2013, which bills according to the number of participants in a share session and the features being used. Please see Pricing for more information.

Share Session Options

  • showStopButton is depreceated, replaced with hideStopButton.
  • showPauseButton is deprecated, replaced with hidePauseButton.
  • showScreenToggle is deprecated, replaced with hideScreenToggle.
  • isPaused is deprecated, replaced with startPaused.
  • callbackOnEndUrl is deprecated, replaced with Developer Account Settings.
  • redirectOnEndUrl is deprecated, replaced with Developer Account Settings.
  • redirectOnErrorUrl is deprecated, replaced with Developer Account Settings.

Viewer Options

  • titleLinkUrl has been deprecated, use title instead.
  • resize has been deprecated, use fitToWindow instead.

JavaScript Callbacks

  • screenleap.screenShareEnded has been renamed to screenleap.onScreenShareEnd.
  • screenleap.onScreenShareEnd is no longer passed the share session 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.

Continue to Pricing »
/api/native/update
OK
OK
OK
...