Interactivity

^{Interactivity 1.0}

Category / Domain :	CommTools
SCOL Voy@ger Compatibility :	V 3.5 or above
Update :	2001/06

Function

This module allows to manage a video/text/audio chat in « one to one » mode (eg in private chat).

- It sets up the relays of events between several users.
- It gives the list of connected people
- The view of the available information in the database about the users is customizable by defining aliases for the visible columns
- It is possible to define types of users. For each of them the user can see a list of available users types.
- Announcement by e-mail : a user can be warned by e-mail that somebody tries to join him. This feature allows to receive a message on its mobile phone if the e-mail corresponds to a box linked to the SMS service (offered free of charge by most of the operators of mobile telephony).
- Sound and video quality are customizable.

Furthermore, it possible to establish several chats at the same time.

Configuration

Figure 1 : Interactivity module Interface

(1) : Video capture	ms update	Indicates the period after which the image of the webcam is updates (in milliseconds)
	pixels width	Size of the video display
	Jpg compression %	Indicates the percentage of compression made on the video 'frames'. The more the percentage is high, the less the quality of the image is good but the more its size is low.

(2) : Audio capture	Hz Frequency	Indicates the sampling of the sound stream. The more the level is high, better is the sound quality, but the more the broadwith is large.
	bits (numerisation)	Indicates the number of bits on which the digitalization is made
	mono/stereo	indicates if the sound stream is monophonic or stereophonic ( better quality)

(3) : Server relay for the communication	In case of impossibility to establish a communication client-client (firewall at both users), it is possible that the server creates the relay for the video, the audio and\or the text. ATTENTION, the audio and video relays are very large user of bandwith at the server side!

(4) : Number of events relays	Determine the relay number used to pass on an event from a client to another one : when the relay.x action of the module is activated by a CLIENT A, the corresponding event relay.x is activated at the CLIENT B selected in the list of the users of the CLIENT A. It is possible to manage n relays.

(5) : Users and User's rights Management	Allows to add, to remove or to modify users' various types with for each a right of visibility : according to his type (defined in the table of the descriptions of users), a user can or can not see the other connected users according to their type. For each of these types, it is necessary to define a name and the list of users' types which he can see. The various types are separated by semicolons (;). For example : the users of type "salesman" can see the other users of type "salesman" or type "customer", we thus have to specify that they can see : " salesman; customer ".
	Reference of the item for the user's type :	Used to indicate the item which marks the type of user; it is this item (followed by the type of user) that is used in the conditions in the links, for example: Salesman userType

(6) : Additionnal Details	Commons Fields	Name of the data base : the table containing the information about the users and the column of logins. This information is necessary for the exploitation of the features which follow. The button Connection allows to establish the link with the database. Announcement by e-mail : the following 2 columns, selected in the database, supply parameters necessary for the announcement by e-mail : e-mail, activation of the announcement by mail: "1" in this field activates the announcement for the user (quite other value keeps it inactive). The following field specifies the address of the sender of the announcement e-mail.
	Additionnal fields	The list which follows contains all the available fields in the users table. If we wish that the contents of one of the fields are visible in the list of the users of the client interface, it is enough to specify one alias closed to it. This alias will serve of column heading. For example : we wish that the user's e-mails appear in a column named "mail". We select in the list of fields the one who contains e-mails and an alias "mail" is entered in the editable field under the list. "Mail" then appears in the Alias column facing the selected field. During the project execution, a column named "mail" will appear in the interface and will contain the user's e-mail adresses.

- Online client Interface :

A click on the button x (Close) does not cancel the module but only hides the window.

Implementation

Open the SCS creation tree. Select the CommTools folder then double-click on Interactivity 1.0.
All the buttons are externalized : it is necessary to create buttons Call and Hang- up linked respectively to the actions call and hangup.
The module GraphicButton module can be used for example.
Create required links for the project.

Action	Function
module.event à interactivity.start	Starts the module at the client side
module.event à interactivity.destroy	Removes the module at the client side
module.event à interactivity.call	Calls the client selected in the list
module.event à interactivity.answer	Take the selected call in the list
module.event à interactivity.show	Displays the client module interface
module.event à interactivity.hide	Hidess the client module interface
module.event à interactivity.chgLogin	take into account the change of client's nickname
module.event à interactivity.emailNotification.enable	Activates the e-mail announcement
module.event à interactivity.emailNotification.disable	Deactivates the e-mail announcement

Evénement	Function
Interactivity.entering à module Action	Launching the module at the client side generates an action
Interactivity.in à module Action	The end of initialization of the client module (Entering) generates an action
Interactivity.out à module Action	Stopping the client module generates an action
Interactivity.ring à module Action	The reception of a call on the client generates an action
Interactivity.log à module Action	Displaying the message of information generates an action
Interactivity.shown à module Action	Displaying the client interface generates an action
Interactivity.hidden à module Action	Hiding the client interface generates an action
Interactivity.sendMail à mail.send	Sends an annoucement e-mail when the user receives a call and generates an action

Zone	Function	Interface	Assignment
Interactivity.userlist	List of users	Client	No