Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.
| Class | Package | Description | |
|---|---|---|---|
| AbstractAuthenticator
| com.adobe.rtc.authentication | Abstract superclass of any AFCS authenticator. | |
| AccountManager
| com.adobe.rtc.util | The AccountManager class enables the developer to build Flex applications which dynamically create rooms, list templates and rooms, and delete templates and rooms. | |
| AccountManagerEvent
| com.adobe.rtc.events | AccountManagerEvent details the set of event types dispatched by an AccountManager, and includes properties concerning the events. | |
| AdobeHSAuthenticator
| com.adobe.rtc.authentication | AdobeHSAuthenticator is used to log users into a AFCS hosted room with the requisite parameters for the given log in scenario. | |
| AudioConfigurationEvent
| com.adobe.rtc.events |
Emitted by AudioPublisher, this event class notifies changes to audio configuration. |
|
| AudioPublisher
| com.adobe.rtc.collaboration | AudioPublisher is the collaboration component responsible for publishing VOIP audio to others in the room. | |
| AudioSubscriber
| com.adobe.rtc.collaboration | AudioSubscriber is the foundation class for receiving and playing VOIP audio in a AFCS room. | |
| AuthenticationEvent
| com.adobe.rtc.events | Event class sent by com.adobe.rtc.authentication classes (such as AdobeHSAuthenticator) to indicate login success or failure. | |
| Baton
| com.adobe.rtc.sharedModel | Baton is a model class which provides a workflow between users. | |
| BatonProperty
| com.adobe.rtc.sharedModel | BatonProperty is a model component which manages a property of any type that only one user can edit at a time. | |
| BinaryPublisher
| com.adobe.rtc.collaboration | BinaryPublisher is a specialized FilePublisher used in submitting ByteArray data via HTTP for file-sharing. | |
| BinarySubscriber
| com.adobe.rtc.collaboration | BinarySubscriber is a simple variant of FileSubscriber that allows the developer to download a given FileDescriptor as a ByteArray in memory rather than as a file to be saved on the user's file system. | |
| CameraConfigurationEvent
| com.adobe.rtc.events |
Emitted by WebcamPublisher, this event class notifies changes to camera configuration. |
|
| CameraModel
| com.adobe.rtc.pods.cameraClasses | CameraModel is a model component which drives the WebCamera pod and keeps the shared properties of the WebCamera pod synchronized across multiple users. | |
| CameraModelEvent
| com.adobe.rtc.events |
Emitted by CameraModel and WebCamera this event class notifies changes in either the layout or quality settings on image
|
|
| ChatEvent
| com.adobe.rtc.events | Event class dispatched by com.adobe.rtc.pods.simpleChatClasses.SimpleChatModel. | |
| ChatMessageDescriptor
| com.adobe.rtc.pods.simpleChatClasses | ChatMessageDescriptor is a simple value-object to describe chat message properties. | |
| CollectionNode
| com.adobe.rtc.sharedModel | CollectionNode is the foundation class for building shared models requiring publish and subscribe messaging. | |
| CollectionNodeEvent
| com.adobe.rtc.events | CollectionNodeEvent describes all the events dispatched by CollectionNodes. | |
| ConnectSession
| com.adobe.rtc.session |
ConnectSession is the "headless" variant of IConnectSession, responsible for the concrete implementation of the interface. |
|
| ConnectSessionContainer
| com.adobe.rtc.session | ConnectSessionContainer is a Container-based tag which implements IConnectSession. | |
| ConnectSessionEvent
| com.adobe.rtc.events | The event class sent for events sent by ConnectSession. | |
| DebugUtil
| com.adobe.rtc.util | Utility class for debugging. | |
| FileDescriptor
| com.adobe.rtc.sharedManagers.descriptors | Describes the set of properties for a file present in the room for upload and download. | |
| FileManager
| com.adobe.rtc.sharedManagers | One of the "4 pillars" of a room, the FileManager represents the shared model for files available for download for the client. | |
| FileManagerEvent
| com.adobe.rtc.events | The event class sent by com.adobe.rtc.sharedManagers.FileManager. | |
| FilePublisher
| com.adobe.rtc.collaboration | FilePublisher is a foundation component for supporting file uploads as well as notification to other users that a file has been uploaded. | |
| FileShare
| com.adobe.rtc.pods | FileShare is a high level pod component which offers a full mini-application for uploading files, viewing lists of files, and downloading files. | |
| FileSubscriber
| com.adobe.rtc.collaboration | FileSubscriber is a simple helper class that enables file download as specified by a FileDescriptor. | |
| HorizontalRoster
| com.adobe.rtc.pods | The HorizontalRoster is a component for displaying the set of users horizontally. | |
| IConnectSession
| com.adobe.rtc.session | IConnectSession is the interface responsible for representing a user session connected to a real-time collaboration room. | |
| Invalidator
| com.adobe.rtc.util | nvalidator is a utility component that helps in invalidating properties together. | |
| ISessionSubscriber
| com.adobe.rtc.session |
ISessionSubscriber is the interface which real-time collaboration (RTC) components expose in order to:
|
|
| ISO9075
| com.adobe.rtc.util | Implements the encode and decode routines as specified in ISO 9075-14:2003. | |
| IValueObjectEncodable
| com.adobe.rtc.messaging | IValueObjectEncodable describes a set of functions required to allow class instances to be serialized and deserialized as value objects. | |
| LocalAuthenticator
| com.adobe.rtc.authentication | LocalAuthenticator is a development-only authenticator for use with the LocalConnectionServer which enables offline development of AFCS applications. | |
| MeetingInfoEvent
| com.adobe.rtc.events | Event class dispatched by com.adobe.rtc.session.sessionClasses.MeetingInfoService | |
| MessageItem
| com.adobe.rtc.messaging | MessageItem is a "descriptor" for the properties of messages sent, received, and stored by a CollectionNode. | |
| MessageNodeError
| com.adobe.rtc.messaging.errors | MessageNodeError is an Error class containing the constants for various messaging error descriptions. | |
| MicrophoneManager
| com.adobe.rtc.clientManagers | MicrophoneManager is a utility component that provides features such as MicrophoneIndex, silence timeout, echo suppression, gain, and so on. | |
| NodeConfiguration
| com.adobe.rtc.messaging | NodeConfiguration is a "descriptor" for describing the properties of a node's configuration. | |
| Note
| com.adobe.rtc.pods | The Note component is a high-level pod component which allows multiple users to collaboratively edit within a text editor. | |
| NoteEvent
| com.adobe.rtc.events | The event class for constants relating to com.adobe.rtc.pods.Note. | |
| NoteModel
| com.adobe.rtc.pods.noteClasses | NoteModel is a model component which drives the Note pod. | |
| NoteUndoRedo
| com.adobe.rtc.pods.noteClasses | UndoRedo Component used in Note, Whiteboard to undo and redo commands Developers can use this component to perform their undo's and redo's in their application on various string inputs | |
| On2ParametersDescriptor
| com.adobe.rtc.sharedManagers.descriptors | Defines the set of parameters used for setting quality of ON2 video; for example, the webcamera stream. | |
| PlayerCapabilities
| com.adobe.rtc.clientManagers | PlayerCapabilities is a utility component that provides properties like the cureent OS, if it's debug version of Flash Player etc. | |
| RoomCleaner
| com.adobe.rtc.util | RoomCleaner is a simple utility class primarily used during development in order to restore a room to its pristine state. | |
| RoomManager
| com.adobe.rtc.sharedManagers | One of the "4 pillars" of a room, the RoomManager is responsible for handling all runtime configuration changes to the room. | |
| RoomManagerEvent
| com.adobe.rtc.events | The event class dispatched by the RoomManager. | |
| RoomSettings
| com.adobe.rtc.session |
RoomSettings declares the initial room settings passed to RoomManager through
an IConnectSession's initialRoomSettings property. |
|
| RoomTemplateEvent
| com.adobe.rtc.events |
Emitted by RoomTemplater, this event class notifies saves of a Room to a Template. |
|
| RoomTemplater
| com.adobe.rtc.util | RoomTemplater allows developers to create templates from their existing rooms. | |
| RootCollectionNode
| com.adobe.rtc.util | RootCollectionNode is a simple class which allows developers to inspect the state of a room's root. | |
| Roster
| com.adobe.rtc.pods | The Roster is a simple vertically-oriented list of users in the room which can be optionally delimited by their roles. | |
| RTCEvent
| com.adobe.rtc.events |
Emitted by Roster this event class notifies changes in data of the Roster. |
|
| SessionContainerProxy
| com.adobe.rtc.session.sessionClasses | SessionContainerProxy is a specialized IConnectSession implementor used by UIComponent-based ISessionSubscribers to find the IConnectSession to which they should be associated. | |
| SessionEvent
| com.adobe.rtc.events | These events are emitted by various Session classes | |
| SharedCollection
| com.adobe.rtc.sharedModel | SharedCollection is a simple ListCollectionView which is shared across the AFCS services. | |
| SharedCursorPane
| com.adobe.rtc.collaboration |
SharedCursorPane is a UIComponent that, when stretched over a region, tracks the cursor positions
of any user with role of UserRoles.PUBLISHER or higher within it and reports that position to
other users. |
|
| SharedModelEvent
| com.adobe.rtc.events | The event class dispatched by SharedProperties and BatonProperty. | |
| SharedProperty
| com.adobe.rtc.sharedModel |
SharedProperty is a model (and ui-less component) that manages a
variable of any type and which is shared amongst all users connected to the room. |
|
| SharedPropertyEvent
| com.adobe.rtc.events | The event class sent for events sent by SharedProperty. | |
| SharedWBModel
| com.adobe.rtc.pods.sharedWhiteBoardClasses | SharedWhiteBoardModel is a model component which drives the SharedWhiteBoard pod. | |
| SharedWhiteBoard
| com.adobe.rtc.pods | The SharedWhiteBoard is a UIComponent that allows multiple users to collaboratively draw on a shared canvas. | |
| SimpleChat
| com.adobe.rtc.pods | The SimpleChat component is a high-level pod component which allows multiple users to chat in a way that is similar to an instant messenger client. | |
| SimpleChatModel
| com.adobe.rtc.pods.simpleChatClasses | SimpleChatModel is a model component which drives the SimpleChat pod. | |
| StreamDescriptor
| com.adobe.rtc.sharedManagers.descriptors | StreamDescriptor defines the set of a streams audio and video properties. | |
| StreamEvent
| com.adobe.rtc.events | Event Class dispatched by the StreamManager | |
| StreamManager
| com.adobe.rtc.sharedManagers | One of the "4 pillars" of a room, the StreamManager represents the shared model for files available for client download. | |
| UserDescriptor
| com.adobe.rtc.sharedManagers.descriptors | A UserDescriptor is an object used to represent the details of a given user or entity in a room. | |
| UserEvent
| com.adobe.rtc.events | UserEvent is the generic class pertaining to users. | |
| UserManager
| com.adobe.rtc.sharedManagers | UserManager is one of the "four pillars" of a room and is tasked with maintaining a list of the set of users in the room, along with their descriptors. | |
| UserQueue
| com.adobe.rtc.sharedModel | UserQueue is a model class that can be used to create and manage queues of users who are making requests. | |
| UserQueueEvent
| com.adobe.rtc.events | UserQueueEvent describes events dispatched by UserQueue. | |
| UserQueueItem
| com.adobe.rtc.sharedModel.userQueueClasses | UserQueueItem is a "descriptor" for describing the properties of a user request in a UserQueue. | |
| UserRoles
| com.adobe.rtc.messaging | UserRoles is a class for holding the constant values for standard user roles. | |
| WBCanvas
| com.adobe.coreUI.controls.whiteboardClasses | This is a standalone whiteboard canvas component. | |
| WBModel
| com.adobe.coreUI.controls.whiteboardClasses | This class represents the model for the standalone whiteboard. | |
| WBShapeDescriptor
| com.adobe.coreUI.controls.whiteboardClasses | Descriptor class for a shape | |
| WebCamera
| com.adobe.rtc.pods | The WebCamera component is a high level "pod" component which allows multiple users to publish and display webcam video. | |
| WebcamPublisher
| com.adobe.rtc.collaboration | WebcamPublisher is the component responsible for publishing webcam video to other room members. | |
| WebcamSubscriber
| com.adobe.rtc.collaboration | WebcamSubscriber is the foundation class for receiving and displaying webcam video in a meeting room. | |
| WhiteBoard
| com.adobe.coreUI.controls | This is a standalone whiteboard component. |