[openmeetings-dev] [openmeetings] r2802 committed - Added instant communication plugin code

openmeetings Wed, 20 Jan 2010 07:56:01 -0800

Revision: 2802
Author: [email protected]
Date: Wed Jan 20 07:45:41 2010
Log: Added instant communication plugin code
http://code.google.com/p/openmeetings/source/detail?r=2802


Added:
 /trunk/plugins/instant_communication_plugin/om_as_instant.html

=======================================
--- /dev/null

+++ /trunk/plugins/instant_communication_plugin/om_as_instant.html Wed Jan20 07:45:41 2010

@@ -0,0 +1,195 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<HEAD>
+       <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; 
charset=windows-1251">
+       <TITLE></TITLE>
+       <META NAME="GENERATOR" CONTENT="OpenOffice.org 3.0  (Win32)">
+       <META NAME="AUTHOR" CONTENT="Ðîäèîí Âîëêîâ">
+       <META NAME="CREATED" CONTENT="20091203;15104500">
+       <META NAME="CHANGEDBY" CONTENT="Ðîäèîí Âîëêîâ">
+       <META NAME="CHANGED" CONTENT="20100120;17232500">
+       <META NAME="Ïîëå 1" CONTENT="">
+       <META NAME="Ïîëå 2" CONTENT="">
+       <META NAME="Ïîëå 3" CONTENT="">
+       <META NAME="Ïîëå 4" CONTENT="">
+       <STYLE TYPE="text/css">
+       <!--
+               @page { size: 8.5in 11in; margin: 0.79in }
+               P { margin-bottom: 0.08in }
+               H1 { margin-bottom: 0.08in; page-break-after: avoid }

+ H1.western { font-family: "Arial", sans-serif; font-size: 16pt;font-weight: bold }+ H1.cjk { font-family: "Lucida Sans Unicode"; font-size: 16pt;font-weight: bold }

+               H1.ctl { font-family: "Tahoma"; font-size: 16pt; font-weight: 
bold }
+               H2 { margin-bottom: 0.08in; page-break-after: avoid }

+ H2.western { font-family: "Arial", sans-serif; font-size: 14pt;font-style: italic; font-weight: bold }+ H2.cjk { font-family: "Lucida Sans Unicode"; font-size: 14pt;font-style: italic; font-weight: bold }+ H2.ctl { font-family: "Tahoma"; font-size: 14pt; font-style: italic;font-weight: bold }

+       -->
+       </STYLE>
+</HEAD>
+<BODY LANG="ru-RU" LINK="#000080" VLINK="#800000" DIR="LTR">
+<H1 LANG="en-US" CLASS="western" ALIGN=CENTER>Using OpenMeetings as
+instant communication server.</H1>
+<P LANG="en-US" ALIGN=CENTER><BR><BR>
+</P>
+<H2 LANG="en-US" CLASS="western">Introduction</H2>

+Have

+you ever thought about making a deep integration of OpenMeetings into
+your own site? Like making a registered user being able to conference
+with another one, if they are both reading the same site at the
+moment?</FONT></P>

+With

+the creation of instant communication server script pack you now can
+implement instant communication using OpenMeetings server on any of
+your CMS sites, or anywhere else. The technology is simple &ndash;
+you implement some of the JavaScript functions on the client side,
+such as client behavior in cases of being logged on and off,
+receiving a call(conference request), set some variables in scripts,
+such as server script location, OpenMeetings server location, set up

+a small database using our database creation script, and havefun.

+<H2 LANG="en-US" CLASS="western">Instant communication server script
+pack contents</H2>
+<UL>

+ Our

+       script pack contains:</FONT></P>

+ <LI><SPANLANG="en-US">om_server.php

+       &ndash; </SPAN><FONT FACE="Arial, sans-serif"><SPAN LANG="en-US">a
+       php script that acts as instant communication server, processing
+       logging on and off of  your site's users, and establishing calls
+       between them. After the call has been arranged, it creates a room on
+       the OpenMeetings server scripted inside, and gives the unique links
+       to that room to the users. Uses MySQL as a database for storing
+       data.</SPAN></FONT></P>

+ <LI><SPANLANG="en-US">openMeetingsAjaxClientLibrary.js<SPANLANG="en-US">

+       &ndash; </SPAN><FONT FACE="Arial, sans-serif"><SPAN LANG="en-US">a
+       JavaScript program that is responsible for all the client
+       functionality with the above server, receives commands in the form
+       of  functions, and responds in callbacks.</SPAN></FONT></P>

+ <LI><SPANLANG="en-US">masterSlaveDeterminator.js<SPANLANG="en-US">

+       &ndash; </SPAN><FONT FACE="Arial, sans-serif"><SPAN LANG="en-US">a
+       traffic optimization JavaScript program, that wraps the above
+       JavaScript to decrease the traffic volume. Now, having several
+       windows with the same page opened only one of them will work as a
+       communication client, others will just pass commands and reaction
+       from one to another.</SPAN></FONT></P>

+ <LI><SPANLANG="en-US">jquery.cookies.2.1.0.js+ – this

+       well-known cookies library was used to simplify the work of the
+       JavaScript programs </SPAN></FONT>
+       </P>

+ <LI><SPANLANG="en-US">uuid.js+ – libraryto implement GUID-like string constants generation+ <LI><SPANLANG="en-US">databaseCreationScript.sql<SPANLANG="en-US">

+       &ndash; </SPAN><FONT FACE="Arial, sans-serif"><SPAN LANG="en-US">SQL
+       database creation script for your MySQL database.</SPAN></FONT></P>

+ <LI><SPANLANG="en-US">test_functionality.php,+ user.tmpl<SPANLANG="en-US">,+ invite.tmpl<SPANLANG="en-US">

+       &ndash; </SPAN><FONT FACE="Arial, sans-serif"><SPAN LANG="en-US">a

+ sample client code that uses the above functionality,

+       implementation of the similar code on your web site will give you
+       the instant communication functionality with OpenMeetings. Has two
+       HTML/JavaScript templates, for entering the required user data, and a
+       template for a user page with all the communication functionality.

+ Override the <SPANLANG="en-US">user.tmpl

+        </B></I></SPAN><FONT FACE="Arial, sans-serif"><SPAN LANG="en-US">file
+       if you want to test your variant of interface code, then add the
+       code to your page.</SPAN></FONT></P>
+</UL>
+<P LANG="en-US"><BR><BR>
+</P>
+<H2 LANG="en-US" CLASS="western">Required steps to make everything
+work</H2>

+In

+order for everything to work, you need to have the following data
+scripted:</FONT></P>

+<SPANLANG="en-US">in

+<I><B>om_server.php:</B></I></P>

+define("OM_ADMIN_LOGIN",+OpenMeetings Admin Login);+define("OM_ADMIN_PASS",+OpenMeetings AdminPassword

+</SPAN>);</FONT></FONT></P>

+define("OM_SERVER_ADDRESS",+<SPANLANG="en-US">OpenMeetings+Server Address+);+$link

+= mysql_connect(<FONT COLOR="#ff0000">MySql

+server address - the one that has a database created with<SPANLANG="en-US">+<SPANLANG="en-US">databaseCreationScript.sql<SPANLANG="en-US">

+, </SPAN><FONT COLOR="#ff0000"><SPAN LANG="en-US">username</SPAN></FONT>,

+password<SPANLANG="en-US">

+</SPAN>);</FONT></FONT></P>

+ <SPANLANG="en-US">in+ <SPANLANG="en-US">openMeetingsAjaxClientLibrary.js:+<FONTSIZE=2 STYLE="font-size: 9pt"> var+server_address = <FONTFACE="Courier New, monospace"><SPANLANG="en-US">URL+with location of+<SPANLANG="ru-RU">om_server.php

+</P>

+in

+client code (sample:</FONT>

+user.tmpl):+<FONTSIZE=2 STYLE="font-size: 9pt"> sv_setserveraddress(+URL+with location of<SPANLANG="ru-RU">om_server.php<FONTFACE="Courier New, monospace">);+<FONTSIZE=2 STYLE="font-size: 9pt"> sv_setuserinfo(+User ID, <FONTCOLOR="#ff0000">User

+display name</SPAN></FONT><SPAN LANG="en-US"> </SPAN>);</FONT></FONT></P>
+       <P LANG="en-US"></P>

+ <FONTSIZE=3>As you see,+ by the time the client JavaScript code is displayed you should know whichuser is being shown, so please+ include this code into the page only if you know the user display nameand his ID (any key, unique for each user).

+       After everything has been scripted and you've made sure OpenMeetings
+       server is up and running, you should only implement the reaction of
+       the client code on different events, such as incoming call (
+       conferencing request ), reaction on your own call and such, all

+ those method samples already exist in<FONTFACE="Courier New, monospace"><SPANLANG="en-US">+ user.tmpl

+       <FONT FACE="Arial, sans-serif"><SPAN LANG="en-US">file, which you
+       can study.</SPAN></FONT></P>

+ <SPANLANG="en-US">Here+ is the short description of every method you will need tooverride:+ <SPANLANG="ru-RU">function+ my_onstatuschange(status)+ - <FONTSIZE=2 STYLE="font-size: 9pt"><SPANLANG="en-US">Your

+       online status has changed</SPAN></FONT></FONT></P>

+function+my_onmakecall( result ) <SPANLANG="en-US">-+You have made a call, false result means user you called isoffline+function

+my_onincomingcall( callerName, link )</B><SPAN STYLE="font-weight: normal">
+</SPAN><SPAN LANG="en-US"><SPAN STYLE="font-weight: normal">-
+Incoming call from callerName, if you want to start conferencing, go
+to the link</SPAN></SPAN></FONT></FONT></P>

+function

+my_oncallanswered( calleeName, link )</B><SPAN STYLE="font-weight: normal">
+</SPAN><SPAN LANG="en-US"><SPAN STYLE="font-weight: normal">- Your

+call to calleeName has been answered – you can go to thelink+function

+my_oncallrejected( calleeName )</B><SPAN STYLE="font-weight: normal">
+</SPAN><SPAN LANG="en-US"><SPAN STYLE="font-weight: normal">- Your
+call to calleeName has been rejected</SPAN></SPAN></FONT></FONT></P>

+function+my_onstatusmessage(message)–

+You have a debug status message</SPAN></SPAN></FONT></FONT></P>

+function+my_masterstatuschanged( masterStatus ) -

+</SPAN><SPAN LANG="en-US"><SPAN STYLE="font-weight: normal">Your page
+in browser has become a master. This means only code in this page

+works with the server, others reflect it(to save thetraffic)+function+my_clearincoming() <SPANLANG="en-US">-

+Clear information about last incoming call</SPAN></SPAN></FONT></FONT></P>

+function+my_clearanswered() -

+Clear information about last answered call</SPAN></SPAN></FONT></FONT></P>

+function+my_clearrejected() -

+Clear information about last rejected call</SPAN></SPAN></FONT></FONT></P>
+<UL>
+       <P STYLE="margin-top: 0.17in"></P>
+</UL>
+</BODY>
+</HTML>

-- 
You received this message because you are subscribed to the Google Groups 
"OpenMeetings developers" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/openmeetings-dev?hl=en.

[openmeetings-dev] [openmeetings] r2802 committed - Added instant communication plugin code

Reply via email to