Integrating with Jabertel
Software developers and website designers can now make the most of Jabertel by integrating with their own software. Refer to the options below for more information on how to accomplish our suggested methods of integration:Basic Web Integration
The easiest way to provide voice conferencing directly from your website is to provide a hyperlink to the Jabertel Web Client. To accomplish this, add the following hyperlink to your website:
http://jabertel.com/launch/?c=AcmeCommunity
Of course, you'll need to replace the AcmeCommunity name with your own community name that you've
previously created on the Jabertel website.
There are additional URL parameters that can be added to the URL above, but they're completely optional:
| URL Parameter | Description |
|---|---|
| compw | This is the community password. However, if your website is public, adding this to the URL could defeat the purpose of password-protecting your community, since the password will be visible by anyone with HTML knowledge. |
| username | The username of the person connecting to the community. If left blank, and the user has never connected to this community before, he will be prompted by the Jabertel Web Client. |
| tbc | The background color of the Jabertel window. |
| ttc | The text color within the Jabertel window. |
| tlc | The line color within the Jabertel window. |
| tmc | The background color of the Jabertel window, when the Microphone is muted. |
| toc | The background color of the Jabertel window, when the Speaker is muted. |
| tac | The background color of the Jabertel window, when the Microphone and the Speaker are muted. |
http://jabertel.com/launch/?c=AcmeCommunity&tbc=000000&ttc=ffffff
Advanced Web Integration
A more advanced method of integrating Jabertel directly into an area within your existing webpage can be accomplished with a little HTML knowledge. This entails embedding the Jabertel plugin into the HTML source file, using the EMBED or OBJECT tags. Further, you can also add graphical controls to allow the user to toggle mute settings, change output volume, and more. The following functions are available on the plugin object, and can be called directly from Javascript:| Method Signature | Description |
|---|---|
| void cleanup() | Prepares the plugin to be unloaded from memory. Calling this method prior to closing the browser window will reduce memory leaks. |
| void connect() | Connects to the Jabertel community. |
| void disconnect() | Disconnects from the Jabertel community. |
| int getComment() | Returns the comment currently set for this user. |
| int getVersion() | Returns the version number of this Jabertel client. |
| int getVolume() | Returns the volume level currentl set on the Jabertel plugin. |
| void init() | Initializes the Jabertel plugin. Call this before attempting to connect. |
| boolean isInitialized() | Returns true if the Jabertel plugin is initialized. When initialized, the plugin is ready to accept settings such as setUsername(). |
| boolean isMuteMic() | Returns true if the microphone has been muted. When the microphone is muted, no other users will hear this user's voice. |
| boolean isMuteOthers() | Returns true if the speaker has been muted. When the speaker is muted, this user will not hear any voice communication. |
| boolean isUsernameSet() | Returns true if the username has been set. The community cannot be joined without a username set. |
| void setComment(String) | Sets the comment of the user. All other users connected to the community will be able to read this comment. |
| void setCommunity(String) | Sets the community name to which the user will be connected. |
| void setMuteMic(boolean) | Sets the microphone mute setting. Passing in true will mute the microphone input. |
| void setMuteOthers(boolean) | Sets the speaker mute setting. Passing in true will mute the speaker output. |
| void setPassword(String) | Sets the community password to use when connecting to the community. |
| void setProfile(String) | Sets the Jabertel profile. This is a unique name that will be used to save this user's Jabertel settings. We recommend using the community name for the profile name. |
| void setServer(String) | Sets the Jabertel server hostname or IP address. This should only be used when connecting to a licensed server running on an Intranet or private LAN. |
| void setTreeBGColor(String) | Sets the background color of the Jabertel plugin. The accepted color format is RRGGBB, similar to HTML color values. For example, white is FFFFFF. |
| void setTreeLineColor(String) | Sets the line color of the Jabertel plugin. The accepted color format is RRGGBB, similar to HTML color values. For example, white is FFFFFF. |
| void setTreeMuteBothColor(String) | Sets the background color of the Jabertel plugin, when the microphone and speaker are both muted. The accepted color format is RRGGBB, similar to HTML color values. For example, white is FFFFFF. |
| void setTreeMuteMicColor(String) | Sets the background color of the Jabertel plugin, when the microphone is muted. The accepted color format is RRGGBB, similar to HTML color values. For example, white is FFFFFF. |
| void setTreeMuteOthersColor(String) | Sets the background color of the Jabertel plugin, when the speaker is muted. The accepted color format is RRGGBB, similar to HTML color values. For example, white is FFFFFF. |
| void setTreeTextColor(String) | Sets the text color of the Jabertel plugin. The accepted color format is RRGGBB, similar to HTML color values. For example, white is FFFFFF. |
| void setUsername(String) | Sets the username to use when connecting to the community. |
| void setVolume(int) | Sets the volume level. 0 is the lowest and 65 is the maximum. |
| void showAboutBox() | Pops up a window with information about the Jabertel client, including the version. |
| void showChangesBox() | Pops up a window with information about what has changed in this version of the Jabertel client. |
| void showOptions() | Pops up a window that allows the user to adjust the Jabertel client options, such as mute settings, push-to-talk key, and more. |
JabertelBot
JabertelBot is an automated Jabertel client that can connect to a community and provide a gateway to gathering real-time community information, or for playing automated sounds or music streams to the community. Our Jabertel WebBot provides an on-demand export of the community channel list and currently-connected visitors in each channel. This information can be shown on a web page for real-time display of who's currently connected to your community.
If you're interested in adding a Jabertel WebBot to your community for collecting real-time information about your community, please contact us. We can also provide more complex Bots for communities that wish to automate other features or stream music to their community.
Jabertel SDK for C++
Jabertel's core SDK provides the ability to quickly add voice conferencing to your company's existing products. Jabertel has been developed around an optimized software core library, compiled specifically to each operating system platform to obtain the highest performance and eliminate the need for additional third-party applications, such as runtime engines. Integrating with Jabertel for a client application is as simple as linking to a couple Jabertel libraries, the open-source Speex codec library, and making your product invoke a handful of functions to initialize parameters and connect.
Aside from the operating system libraries that products normally link with, the only third-party library that Jabertel requires is the Speex library, which is an LGPL licensed open source audio codec. No other third-party libraries are required, and therefore, there will not be unexpected royalty costs.
Currently, the SDK is available for C++ integration on Windows (client and server), OS X (client and server), and Linux (server only).
If you're interested in embedding the Jabertel client or Jabertel server directly into your product, please contact us to request a copy of the programming API.