Packagecom.adobe.rtc.session
Classpublic class RoomSettings
InheritanceRoomSettings Inheritance flash.events.EventDispatcher

RoomSettings declares the initial room settings passed to RoomManager through an IConnectSession's initialRoomSettings property. Note that this will only take effect the FIRST time the room receives a connection from a UserRoles.OWNER. RoomSettings is also a class for holding the constant values for various properties within the RoomManager.
Using RoomSettings to configure a room to auto-promote a viewer to a publisher
  <rtc:AdobeHSAuthenticator 
  // Deployed applications DO NOT hard code username and password here.
       userName="AdobeIDusername@example.com" 
       password="AdobeIDpassword" 
       id="auth"/>
  <session:RoomSettings autoPromote="true" roomBandwidth="auto" id="roomSettings"/>
   <session:ConnectSessionContainer 
     roomURL="http://connect.acrobat.com/fakeRoom/" 
    authenticator="{auth}" 
    initialRoomSettings="{roomSettings}">
    <pods:WebCamera width="100%" height="100%"/>
  </session:ConnectSessionContainer>
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.

AFCS room settings

See also

com.adobe.rtc.session.IConnectSession
com.adobe.rtc.sharedManagers.RoomManager
com.adobe.rtc.util.RoomTemplater

Public Properties
 PropertyDefined by
  autoPromote : Boolean
Automatically promotes someone with a viewer role to a publisher role when they enter the room.
RoomSettings
  guestsMustKnock : Boolean
Requires guests to ask for permission before entering the room.
RoomSettings
  roomBandwidth : String
Sets the room bandwidth.
RoomSettings
  roomState : String
Sets the state of the room.
RoomSettings
Public Methods
 MethodDefined by
  
RoomSettings()
RoomSettings
Public Constants
 ConstantDefined by
  AUTO : String = "auto"
[static] Room connection speed constant for automatically calculating speed.
RoomSettings
  DSL : String = "dsl"
[static] Room connection speed constant for DSL.
RoomSettings
  LAN : String = "LAN"
[static] Room connection speed constant for LAN.
RoomSettings
  MODEM : String = "modem"
[static] Room connection speed constant for MODEM.
RoomSettings
  ROOM_STATE_ACTIVE : String = "active"
[static] RoomManager state constant for an open, active room.
RoomSettings
  ROOM_STATE_ENDED : String = "ended"
[static] RoomManager state constant for a room which has been closed.
RoomSettings
  ROOM_STATE_HOST_NOT_ARRIVED : String = "hostNotArrived"
[static] RoomManager state constant for a room with no host.
RoomSettings
  ROOM_STATE_ON_HOLD : String = "onhold"
[static] RoomManager state constant for a room which has been placed on hold.
RoomSettings
Property detail
autoPromoteproperty
autoPromote:Boolean  [read-write]

Automatically promotes someone with a viewer role to a publisher role when they enter the room.

The default value is false.

Implementation
    public function get autoPromote():Boolean
    public function set autoPromote(value:Boolean):void
guestsMustKnockproperty 
guestsMustKnock:Boolean  [read-write]

Requires guests to ask for permission before entering the room.

The default value is false.

Implementation
    public function get guestsMustKnock():Boolean
    public function set guestsMustKnock(value:Boolean):void
roomBandwidthproperty 
roomBandwidth:String  [read-write]

Sets the room bandwidth. Valid values include the following:

The default value is AUTO.

Implementation
    public function get roomBandwidth():String
    public function set roomBandwidth(value:String):void
roomStateproperty 
roomState:String  [read-write]

Sets the state of the room. Valid values include the following:

The default value is active.

Implementation
    public function get roomState():String
    public function set roomState(value:String):void
Constructor detail
RoomSettings()constructor
public function RoomSettings()
Constant detail
AUTOconstant
public static const AUTO:String = "auto"

Room connection speed constant for automatically calculating speed.

DSLconstant 
public static const DSL:String = "dsl"

Room connection speed constant for DSL.

LANconstant 
public static const LAN:String = "LAN"

Room connection speed constant for LAN.

MODEMconstant 
public static const MODEM:String = "modem"

Room connection speed constant for MODEM.

ROOM_STATE_ACTIVEconstant 
public static const ROOM_STATE_ACTIVE:String = "active"

RoomManager state constant for an open, active room.

ROOM_STATE_ENDEDconstant 
public static const ROOM_STATE_ENDED:String = "ended"

RoomManager state constant for a room which has been closed.

ROOM_STATE_HOST_NOT_ARRIVEDconstant 
public static const ROOM_STATE_HOST_NOT_ARRIVED:String = "hostNotArrived"

RoomManager state constant for a room with no host.

ROOM_STATE_ON_HOLDconstant 
public static const ROOM_STATE_ON_HOLD:String = "onhold"

RoomManager state constant for a room which has been placed on hold.




2008-2009 Adobe Systems Incorporated. All rights reserved.

 

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/session/RoomSettings.html