| Package | com.adobe.rtc.sharedManagers |
| Class | public class RoomManager |
| Inheritance | RoomManager  flash.events.EventDispatcher |
| Implements | ISessionSubscriber |
Only a user with an owner role may modify room settings. Many of these settings
can be declared the first time the room is made by using IConnectSession's
initialRoomSettings property and by specifying a RoomSettings
object.
Each IConnectSession handles creation/setup of its own RoomManager instance. Use an IConnectSession's
roomManager property to access it.
Note: You can configure room settings programmatically or via the Developer Console. Some settings are owned by the RoomSettings class, and others by the RoomManager class. Room settings are saved with any templates created from the room.
See also
com.adobe.rtc.session.RoomSettings
com.adobe.rtc.messaging.UserRoles
com.adobe.rtc.events.RoomManagerEvent
com.adobe.rtc.session.IConnectSession
| Property | Defined by | ||
|---|---|---|---|
| autoPromote : Boolean
If true, all users with a viewer role are promoted upon entry to a publisher role.
| RoomManager | ||
| bandwidth : String [read-only]
Returns the actual bandwidth calculated by the room.
| RoomManager | ||
| connectSession : IConnectSession
(Read Only) Specifies the IConnectSession to which this manager is assigned.
| RoomManager | ||
| endMeetingMessage : String
The message to display once a session has ended.
| RoomManager | ||
| guestsHaveToKnock : Boolean
Whether or not guests must knock and get permission before entering a room.
| RoomManager | ||
| guestsNotAllowed : Boolean
Specifies whether the room currently allows guests or not.
| RoomManager | ||
| isSynchronized : Boolean [read-only]
Returns true if the model is synchronized.
| RoomManager | ||
| productName : String [read-only]
The product name.
| RoomManager | ||
| roomLocked : Boolean
Specifies whether the room access state is locked or not.
| RoomManager | ||
| roomName : String [read-only]
The room name, if any.
| RoomManager | ||
| roomState : String
Specifies the room state from among values supplied by RoomSettings constants.
| RoomManager | ||
| roomTimeOut : Number
Specifies a timeout duration (in seconds) for the room after which the room session ends.
| RoomManager | ||
| roomURL : String [read-only]
The room URL.
| RoomManager | ||
| roomUserLimit : Number
Specifies the number of users permitted to enter the room.
| RoomManager | ||
| selectedBandwidth : String
Specifies the bandwidth setting as selected by the user with an owner role.
| RoomManager | ||
| sharedID : String | RoomManager | ||
| Method | Defined by | ||
|---|---|---|---|
| RoomManager | |||
|
getBandwidthString(p_value:String):String
[static]
Returns a display string corresponding to the supplied bandwidth setting.
| RoomManager | ||
| Method | Defined by | ||
|---|---|---|---|
|
onKnockingQueueUpdate(p_evt:UserQueueEvent):void
| RoomManager | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when the value of "auto promote" changes. | RoomManager | |||
| Dispatched when the room bandwidth changes. | RoomManager | |||
| Dispatched when the selected room bandwidth changes. | RoomManager | |||
| Dispatched when the end-meeting message changes. | RoomManager | |||
| Dispatched when the room goes from private to public and vice-versa. | RoomManager | |||
| Dispatched when guests not allowed parameter is changed. | RoomManager | |||
| Dispatched when the room Lock value changes. | RoomManager | |||
| Dispatched when the room state changes. | RoomManager | |||
| Dispatched when the time out for the room changes. | RoomManager | |||
| Dispatched when the user limit for the room changes. | RoomManager | |||
| Dispatched either when the RoomManager has received everything up to the current state of the room or when it has lost connection to the service. | RoomManager | |||
| Constant | Defined by | ||
|---|---|---|---|
| COLLECTION_NAME : String = "RoomManager" [static]
The name of the collectionNode used to represent the RoomManager's shared model.
| RoomManager | ||
| NO_TIME_OUT : Number = -1 [static]
Constant which defines no time out for the RoomManager.roomTimeOut property.
| RoomManager | ||
| NO_USER_LIMIT : Number = -1 [static]
Constant which defines no user limit for the RoomManager.roomUserLimit property.
| RoomManager | ||
| autoPromote | property |
autoPromote:Boolean [read-write]If true, all users with a viewer role are promoted upon entry to a publisher role.
This property can be used as the source for data binding.
Implementation public function get autoPromote():Boolean
public function set autoPromote(value:Boolean):void
| bandwidth | property |
bandwidth:String [read-only]Returns the actual bandwidth calculated by the room.
This property can be used as the source for data binding.
Implementation public function get bandwidth():String
| connectSession | property |
connectSession:IConnectSession [read-write](Read Only) Specifies the IConnectSession to which this manager is assigned.
Implementation public function get connectSession():IConnectSession
public function set connectSession(value:IConnectSession):void
| endMeetingMessage | property |
endMeetingMessage:String [read-write]The message to display once a session has ended. It's important to set this prior to ending the room since no messages may be sent once the session ends.
This property can be used as the source for data binding.
Implementation public function get endMeetingMessage():String
public function set endMeetingMessage(value:String):void
| guestsHaveToKnock | property |
guestsHaveToKnock:Boolean [read-write]Whether or not guests must knock and get permission before entering a room.
This property can be used as the source for data binding.
Implementation public function get guestsHaveToKnock():Boolean
public function set guestsHaveToKnock(value:Boolean):void
| guestsNotAllowed | property |
guestsNotAllowed:Boolean [read-write]Specifies whether the room currently allows guests or not. If this parameter is true, then no new guests are allowed. However, note the following: xxx
public function get guestsNotAllowed():Boolean
public function set guestsNotAllowed(value:Boolean):void
| isSynchronized | property |
isSynchronized:Boolean [read-only]Returns true if the model is synchronized.
This property can be used as the source for data binding.
Implementation public function get isSynchronized():Boolean
| productName | property |
productName:String [read-only]The product name.
Implementation public function get productName():String
| roomLocked | property |
roomLocked:Boolean [read-write]Specifies whether the room access state is locked or not. If a room is locked, no new users other than hosts are allowed to enter the room. However, users who are already inside can return to the room if they get disconnected.
Implementation public function get roomLocked():Boolean
public function set roomLocked(value:Boolean):void
| roomName | property |
roomName:String [read-only]The room name, if any.
Implementation public function get roomName():String
| roomState | property |
roomState:String [read-write]Specifies the room state from among values supplied by RoomSettings constants.
This property can be used as the source for data binding.
Implementation public function get roomState():String
public function set roomState(value:String):void
See also
| roomTimeOut | property |
roomTimeOut:Number [read-write]Specifies a timeout duration (in seconds) for the room after which the room session ends. Only users with role UserRoles.OWNER can set this property. Defaults to NO_TIME_OUT, meaning there is no timeout duration.
Implementation public function get roomTimeOut():Number
public function set roomTimeOut(value:Number):void
| roomURL | property |
roomURL:String [read-only]The room URL.
Implementation public function get roomURL():String
| roomUserLimit | property |
roomUserLimit:Number [read-write]Specifies the number of users permitted to enter the room. Only users with the role UserRoles.OWNER can set this property. Defaults to NO_USER_LIMIT
Implementation public function get roomUserLimit():Number
public function set roomUserLimit(value:Number):void
| selectedBandwidth | property |
selectedBandwidth:String [read-write]Specifies the bandwidth setting as selected by the user with an owner role.
This property can be used as the source for data binding.
Implementation public function get selectedBandwidth():String
public function set selectedBandwidth(value:String):void
| sharedID | property |
sharedID:String [read-write]Implementation
public function get sharedID():String
public function set sharedID(value:String):void
| RoomManager | () | constructor |
public function RoomManager()
| getBandwidthString | () | method |
public static function getBandwidthString(p_value:String):StringReturns a display string corresponding to the supplied bandwidth setting.
Parametersp_value:String — One of the constants supplied by RoomSettings.
|
String — A display string.
|
| onKnockingQueueUpdate | () | method |
| autoPromoteChange | event |
com.adobe.rtc.events.RoomManagerEvent
Dispatched when the value of "auto promote" changes.
| bwActualChange | event |
com.adobe.rtc.events.RoomManagerEvent
Dispatched when the room bandwidth changes. This could happen independently
from bwSelectionChange when the bandwidth is set to AUTO.
| bwSelectionChange | event |
com.adobe.rtc.events.RoomManagerEvent
Dispatched when the selected room bandwidth changes. This could happen independently
than bwActualChange.
| endMeetingMessageChange | event |
com.adobe.rtc.events.RoomManagerEvent
Dispatched when the end-meeting message changes.
| guestsHaveToKnockChange | event |
com.adobe.rtc.events.RoomManagerEvent
Dispatched when the room goes from private to public and vice-versa.
| roomGuestsNotAllowedChange | event |
com.adobe.rtc.events.RoomManagerEvent
Dispatched when guests not allowed parameter is changed.
| roomLockChange | event |
com.adobe.rtc.events.RoomManagerEvent
Dispatched when the room Lock value changes.
| roomStateChange | event |
| roomTimeOutChange | event |
com.adobe.rtc.events.RoomManagerEvent
Dispatched when the time out for the room changes. Defaults to NO_USER_LIMIT meaning no timeout.
| roomUserLimitChange | event |
com.adobe.rtc.events.RoomManagerEvent
Dispatched when the user limit for the room changes. Defaults to NO_TIME_OUT meaning no timeout.
| synchronizationChange | event |
com.adobe.rtc.events.CollectionNodeEvent
Dispatched either when the RoomManager has received everything up to the current state of the room or when it has lost connection to the service.
| COLLECTION_NAME | constant |
public static const COLLECTION_NAME:String = "RoomManager"The name of the collectionNode used to represent the RoomManager's shared model.
| NO_TIME_OUT | constant |
public static const NO_TIME_OUT:Number = -1Constant which defines no time out for the RoomManager.roomTimeOut property.
| NO_USER_LIMIT | constant |
public static const NO_USER_LIMIT:Number = -1Constant which defines no user limit for the RoomManager.roomUserLimit property.
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/rtc/sharedManagers/RoomManager.html