Hosted Groupworld API

e.g.:

URL parameters can be added, e.g.:

Or use the following URL format if you want to display the math tools at the top of the whiteboard:

Recording Playback

The following base URL is used to display the recordings for a particular room:

http://www.groupworld.net/mp/saved_sessions.cgi

Playback URL Parameters

Displaying Number of Users Connected

You can use the following URL to display the current number of users connected (across all your rooms). Place it inside an iframe to embed in your web page:

http://www.groupworld.net/mp/gwusers.cgi?inst_id=1

(replace 1 with your Groupworld installation ID, and add &brief=true to just print the number of users).

HTML5 Room Configuration

The hosted version of Groupworld provides a control panel, allowing you to create custom configurations for each room. In addition, the HTML5 client allows you to set these options via javascript. Note that you must set these options before calling groupworld.htmlgen(). Also, you must copy the HTML code into your own web page (you can't use the iframe). Bear in mind that if you configure a room via the control panel, those options will override any that you set using javascript calls. Also note that true and false values in the options[] arrays must be set as strings inside quotes.

Conference room options
Video-strip (audio/video) options
Whiteboard options
Chat options
Screen sharing options
Desmos options
Shared text editor options

Methods

The following methods can be used to interact with Groupworld:

Webpage Integration

The simplest way of integrating Groupworld rooms into your web pages is to simply copy the iframe code provided in your control panel.

However, if you want to use the javascript API, you will need to copy the HTML code out of the iframe into your web page. You can then use the API to control room features. Additional features you can control by editing the HTML code include:

• Set the user's username by editing the following line of code:

  var username = '';

• Set the room name by editing the following line of code:

  var object = 'new_conference:newconf';

  (the room name is the string after the colon. DO NOT change new_conference).
  
  
• Control who can enter the room by setting the authorized_users API option.
  
  
• Control what times the room is active by setting the start_time and end_time API options.
  
  
• Ensure that your HTML code can only be hosted from your domain by setting the domain_lock option in the "Server Configuration" of your control panel.
  
  
• You can also optionally create your own scheduling system (using php/mysql, ASP or similar server-side scripting) on your website, authenticate the user yourself, and then generate the Groupworld HTML code if the user is authorized to enter the room. See our example open source tutor scheduler.

Diagnostics

You can optionally capture diagnostics include room logins, WebRTC status, javascript errors, uploaded files, etc. Set:

groupworld.diag = true;

By default the diagnostics are logged to filestore/groupworld_client_log, but you can override groupworld.log_diag to capture the messages:

groupworld.log_diag = function(msg) {}

With the hosted Groupworld, you can simply add

&diag=true

to the room URL, and the diagnostics can be viewed in the server logfile.

Replacing Groupworld icons

We use Font Awesome for most of the user interface icons. You can replace any FA icon by using CSS such as the following (replace /images/tick.png with the url of your replacement icon, which ideally should be svg):

To replace regular icons (non font awesome), you would simply use something like this:

Embedding the Groupworld self-test page

The Groupworld self-test wizard allows users to test their microphone and camera before entering the Groupworld room. You can embed the self-test page in your own web page by using the following code:

On-the-fly Room Creation

If you have copied the Groupworld HTML code into your own web page, you can create new rooms automatically simply by changing the room name in the HTML code (see Webpage Integration section above). Note, however, that some of the default options are different from the default room parameters you get when you manually create room in the hosted Groupworld control panel. (This is because we have changed the default room parameters over the years, but we never change the actual defaults in the javascript code). Here are the default parameters we use when creating a new room:

new_whiteboard.newui = true;
new_whiteboard.options['default_size'] = 3;
new_whiteboard.options['eraser_size'] = 15;
new_whiteboard.options['show_share_video'] = 'true';
new_videostrip.options['show_auto_record'] = 'false';
new_videostrip.options['use_webrtc'] = 'true';
new_whiteboard.options['multi_user_pan'] = 'false';
new_whiteboard.options['auto_zoom'] = 'true';
new_conference.options['use_instance_recording_dir'] = 'true';
new_whiteboard.options['use_scrollbars'] = 'false';

TutorCruncher Integration

Groupworld can be integrated with TutorCruncher, giving access to scheduling and payment processing. For details of how to integrate with TutorCruncher, see our video.

After integration, when a user clicks on the whiteboard in TutorCruncher, they will be directed to a Groupworld room with the name of the room set to the TutorCruncher appointment name, and the user's username is passed in to Groupworld from TutorCruncher.

When TutorCruncher is integrated with Groupworld, the integration URL is set to https://www.groupworld.net/mp/tutorcruncher.cgi in the SSO integration settings in TutorCruncher. You can add the following parameters to this url to change the integration behaviour:

Android ChromeWebView

If using an Android ChromeWebView, you may need to call:

in order to enable audio/video.