Macromedia Flash UI Component ActionScript Objects

This section presents the unique ActionScript Methods and properties used by the Communication UI components .

FCAudioConference Object

The AudioConference component provides two-way ( full-duplex ) audio communication between all clients connected to the application instance. There are no ActionScript methods other than the common methods mentioned above.

FCAVPresence Object

The AVPresence component enables a camera and microphone on the client. Each component can receive and send an audio/video stream to the application instance. Remember to set the Presenter SharedObject property to a unique value in the properties panel. There are no ActionScript methods other than the common methods mentioned above.

FCChat Object

The Chat component provides a live chat window among all communication clients. The component offers a history window and a text input area. This component supports Lurker mode. The component has methods and roperties within the server-side ActionScript object, FCChat .

chat_mc.clearHistory()

This method will delete all chat history from the history window. If the server-side property FCChat.prototype.allowClear is false, this method will not run.

FCChat Server-Side Object

The server-side counterpart to the Chat UI component object controls the operation of the chat history. These settings must be set in the application.onAppStart function. Setting them in application.onConnect will reset the prototype each time a user connects.

FCChat.prototype.clearHistory()

This SSAS method clears all chat history and forces each client to update. It is not subject to the allowClear property.

FCChat.prototype.histlen=maxHistory

This property sets the maximum number of text messages stored on the server. The default value is 250.

FCChat.prototype.persist=true

This property sets the chat history to persist even when the application is reloaded. The default value is true.

FCChat.prototype.allowClear=true

This read/write property defines whether a chat history can be cleared from the client. The values true and false are Boolean values that determine whether the user can clear the history. The default value is true.

FCConnectionLight Object

The ConnectionLight component visually shows a NetConnection status. It is also a button that, when clicked, displays information about the connection. The button has four color states:

Green	Server connection is established.
Yellow	Network congestion (high latency).
Red	Server disconnected.
Gray	Component is not assigned.

The setUserName method is not used with this object.

connectLight_mc.measurementInterval=intervalValue

This property sets the sample rate of bandwidth and latency.

connectLight_mc.latencyThreshold=latencyTValue

This property controls the latency value that will turn the light yellow.

FCCursor Object

The Cursor component is an avatar that represents the mouse pointer of every communication client. The username of the client is shown below the pointer. The client can choose the color of the pointer using the UserColor component.

cursor_mc.setColor(newColor)

This method changes the color of the pointer across all clients. The value of newColor is a hexadecimal color value, such as 0xFC00F3.

FCPeopleList Object

The PeopleList component displays all users connected to the application instance. Lurkers are not displayed here.

peopleList_mc.lurkers

This property returns the number of connected clients that have not supplied a username (in Lurker mode). The value is an integer.

peopleList_mc.users

This property returns the number of connected clients that have supplied a username. The value is an integer.

FCPresentationSWF Object

The PresentationSWF component provides a framework to use a special slideshow SWF movie that is dynamically loaded from a web server on each client. The component has two modes: Presenter and Viewer.

The setUserName method is not used with this object.

presentSWF_mc.loadSWF(swfFile)

This method can be called by the "presenter" application. It dynamically loads a new Flash SWF movie on all subscribed clients. swfFile is the absolute or relative location to load a SWF movie

presentSWF_mc. next ()

This method moves the play head of the slideshow movie one frame forward. If used within the presenter application, all clients are affected. If used within the viewer application, only the local frame is affected.

presentSWF_mc.back()

This method moves the play head of the slideshow movie one frame backward. If used within the presenter application, all clients are affected. If used within the viewer application, only the local frame is affected.

presentSWF_mc.sync()

This method moves the play head of the slideshow movie to the same frame as the presenter. It can be used in the viewer application only.

_global.speakerMode=true

This _global variable is monitored by the component to control what state the Flash movie is in. A value of true enables Speaker (or Presentation) mode.

FCPresentationText Object

The PresentationText component provides a stage to collaboratively produce and deliver a presentation. It operates in two modes: Presenter and Viewer (the default).

presentText_mc.nextSlide()

This method moves the presentation one frame forward. If used within the presenter application, all clients are affected. If used within the viewer application, only the local frame is affected.

presentText_mc.backSlide()

This method moves the presentation one frame backward. If used within the presenter application, all clients are affected. If used within the viewer application, only the local frame is affected.

presentText_mc.newSlide()

This method creates a new slide in the presentation. It is only available in Presenter mode.

presentText_mc.deleteSlide()

This method removes a new slide in the presentation. It is only available in Presenter mode.

FCRoomList Object

The RoomList component provides a management framework for developing Lobby applications. The component requires advanced development of HTML files, JavaScript, and Flash Communication Applications. It offers functions for users to create, delete, and join "room" applications, such as a chat room.

roomList_mc.createRoom()

This method calls the Create Room dialog box. The user is required to enter a new room name to create.

roomList_mc.deleteRoom()

This method removes a room from the Room list.

FCSetBandwidth Object

The SetBandwidth component provides a simple drop-down box to let the client control inbound and outbound bandwidth between the server. There are four options: Modem, DSL, LAN, and custom. This component is useful if you expect a diverse range of connections to use your application.

The setUserName method is not used with this object.

The properties of SetBandwith let you set the upload and download bandwidth manually. Each property has a default integer value that represents a speed in kilobits per second (Kbps).

setBand_mc.modemUp=maxSpeed

This property sets the upload bandwidth for Modem. The default value is 33Kbps.

setBand_mc.modemDown=maxSpeed

This property sets the download bandwidth for Modem. The default value is 33Kbps.

setBand_mc.dslUp=maxSpeed

This property sets the upload bandwidth for DSL. The default value is 128Kbps.

setBand_mc.dslDown=maxSpeed

This property sets the download bandwidth for DSL. The default value is 33Kbps.

setBand_mc.lanUp=maxSpeed

This property sets the upload bandwidth for LAN. The default value is 1000Kbps (1Mbps).

setBand_mc.lanDown=maxSpeed

This property sets the download bandwidth for LAN. The default value is 1000Kbps (1Mbps).

FCSimpleConnect Object

The SimpleConnect component establishes a connection and a user between the Flash player and the server. It can be used with all Flash UI components. Using this component requires no (or very little) ActionScript on the client or the server. This object has no methods and no ActionScript methods or properties.

FCUserColor Object

The UserColor component allows a client to select a color that will identify him. This component can be used with the Chat and the Cursor components. It also sets a global color value that can be used with future Communication components. The setUserName method is not used with this object.

FCVideoConference Object

The VideoConference component reuses the AVPresence component to provide a quick solution for video conferencing. There are no ActionScript methods other then the common methods mentioned previously.

FCWhiteBoard Object

The WhiteBoard component provides a shared drawing space that lets you collaborate with annotations. This can be used as a straight white board or overlaid on an image. The component supports limited drawing tools including text, shape, and line drawing. There are no ActionScript methods other then the common methods mentioned previously. The setUserName method, however, is not used with this object.