[openmeetings-dev] [openmeetings] r2809 committed - Created wiki page through web user interface.

openmeetings Wed, 20 Jan 2010 08:28:50 -0800

Revision: 2809
Author: volkov.rodion
Date: Wed Jan 20 08:17:43 2010
Log: Created wiki page through web user interface.
http://code.google.com/p/openmeetings/source/detail?r=2809


Added:
 /wiki/InstantCommunication.wiki

=======================================
--- /dev/null
+++ /wiki/InstantCommunication.wiki     Wed Jan 20 08:17:43 2010
@@ -0,0 +1,106 @@
+<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 -
+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>

+Our script pack contains:+<LI><SPANLANG="en-US">om_server.php -a php script thatacts as instant communication server, processing logging on and off ofyour site's users, and establishing calls between them. After the call hasbeen arranged, it creates a room on the OpenMeetings server scriptedinside, and gives the unique links to that room to the users. Uses MySQL asa database for storing data.+<LI><SPANLANG="en-US">openMeetingsAjaxClientLibrary.js<SPANLANG="en-US"> - aJavaScript program that is responsible for all the client functionalitywith the above server, receives commands in the form of functions, andresponds in callbacks.+<LI><SPANLANG="en-US">masterSlaveDeterminator.js<SPANLANG="en-US"> - atraffic optimization JavaScript program, that wraps the above JavaScript todecrease the traffic volume. Now, having several windows with the same pageopened only one of them will work as a communication client, others willjust pass commands and reaction from one to another.+<LI><SPANLANG="en-US">jquery.cookies.2.1.0.js+ - this well-known cookies library was used tosimplify the work of the JavaScript programs +<LI><SPANLANG="en-US">uuid.js - <FONTFACE="Arial, sans-serif">library to implement GUID-likestring constants generation+<LI><SPANLANG="en-US">databaseCreationScript.sql<SPANLANG="en-US"> - <SPANLANG="en-US">SQL database creation script for your MySQLdatabase.+<LI><SPANLANG="en-US">test_functionality.php,<SPANLANG="en-US">user.tmpl,<SPANLANG="en-US">invite.tmpl -a sample clientcode that uses the above <SPANLANG="en-US">functionality, implementation of the similar code on your website will give you the instant communication functionality withOpenMeetings. Has two HTML/JavaScript templates, for entering the requireduser data, and a template for a user page with all the communicationfunctionality.+Override the <SPANLANG="en-US">user.tmpl file if you want to test your variant ofinterface code, then add the code to your page.+ <H2 LANG="en-US" CLASS="western">Required steps tomake 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 JavaScriptcode is displayed you should know which user is being shown, so pleaseinclude this code into the page only if you know the user display name andhis ID (any key, unique for each user). After everything has been scriptedand you've made sure OpenMeetings server is up and running, you should onlyimplement the reaction of the client code on different events, such asincoming call ( conferencing request ), reaction on your own call and such,all those method samples already exist in <SPANSTYLE="text-decoration: none">user.tmplfile, which you can study.+<SPANLANG="en-US">Here is the short description of every method you will need tooverride:+<SPANLANG="ru-RU">function my_onstatuschange(<FONTFACE="Courier New CYR, monospace"><SPANLANG="en-US">status) - <SPANLANG="en-US">Your onlinestatus has changed+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>

-- 
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] r2809 committed - Created wiki page through web user interface.

Reply via email to