Packagecom.adobe.rtc.collaboration
Classpublic class ScreenShareSubscriberComplex
InheritanceScreenShareSubscriberComplex Inheritance ScreenShareSubscriber Inheritance mx.core.UIComponent
Implementsmx.managers.IFocusManagerComponent

ScreenShareSubscriberComplex is the foundation class for receiving and displaying screen share in a meeting room. By default, ScreenShareSubscriberComplex simply subscribes to StreamManager notifications and plays screen share in the room with default publisherID or it can also accept an publisherID which restricts the screen share publisher that can publish to this subscriber. ScreenShareSubscriberComplex is a advance screen share subscriber component, it does ScreenShareSubscriber's task of subscribing to the screen share. but ScreenShareSubscriberComplex also has feature to add with zoom and annotations white board. Example: _ssSubscriber = new ScreenShareSubscriberComplex(); _ssSubscriber.publisherID = myScreenSharePublisherID; //OPTIONAL, if there is only one publisher in the room, then that publisherID is default. _ssSubscriber.connectSession = _cSession; _ssSubscriber.graphics.drawRect(0, 0, stage.width, stage.height); addChild(_ssSubscriber);

See also

com.adobe.rtc.collaboration.ScreenSharePublisher
com.adobe.rtc.collaboration.ScreenShareSubscriber
com.adobe.rtc.pods.WebCamera
com.adobe.rtc.sharedManagers.StreamManager
com.adobe.rtc.sharedManagers.descriptors.StreamDescriptor

Public Properties
 PropertyDefined by
  allowSave : Boolean = true
ScreenShareSubscriberComplex
  annotateOnPause : Boolean = false
ScreenShareSubscriberComplex
  autoScroll : Boolean = false
ScreenShareSubscriberComplex
 InheritedconnectSession : IConnectSession
return the connectSession object
ScreenShareSubscriber
  controllerUserID : String
[read-only]
ScreenShareSubscriberComplex
 InheritedfitToWidthPercent : Number
ScreenShareSubscriber
 InheritedgroupName : String
Components (pods) are assigned to a group via groupName; if not specified, the component is assigned to the default, public group (the room at large).
ScreenShareSubscriber
 InheritediAmPreparingToShare : Boolean
returns true if you are preparing to share or if someone else is preparing
ScreenShareSubscriber
 InheritediAmSharing : Boolean
returns true if you or someone else is sharing
ScreenShareSubscriber
  isScrollable : Boolean
[read-only]
ScreenShareSubscriberComplex
 InheritedisSynchronized : Boolean
ScreenShareSubscriber
 InheritedpublisherID : String
getting the publisher id for whom you like to view their screen share stream
ScreenShareSubscriber
 InheritedscaleToFitPercent : Number
ScreenShareSubscriber
 InheritedsharedID : String
Defines the logical location of the component on the service; typically this assigns the sharedID of the collectionNode used by the component.
ScreenShareSubscriber
 InheritedsharerUserID : String
getting the publisher's id, this is the default streampublisher id
ScreenShareSubscriber
 InheritedshowMouse : Boolean = true
ScreenShareSubscriber
 InheritedshowMyStream : Boolean
ScreenShareSubscriber
 InheritedsomeoneElseIsPreparingToShare : Boolean
returns true if you are preparing to share or if someone else is preparing
ScreenShareSubscriber
 InheritedsomeoneElseIsSharing : Boolean
returns true if you are preparing to share or if someone else is sharing
ScreenShareSubscriber
 InheritedvideoPercentage : Number
ScreenShareSubscriber
 InheritedzoomMode : uint
ScreenShareSubscriber
Protected Properties
 PropertyDefined by
  _annotationPropsBar : UIComponent
ScreenShareSubscriberComplex
  _annotationShapesBar : UIComponent
ScreenShareSubscriberComplex
  _annotationWB : SharedWhiteBoard
ScreenShareSubscriberComplex
 Inherited_autoHideCursorTimer : Timer
ScreenShareSubscriber
  _autoscrollTween : Tween
ScreenShareSubscriberComplex
 Inherited_background : Canvas
ScreenShareSubscriber
  _controlOutStream : NetStream
ScreenShareSubscriberComplex
 Inherited_controlStreamID : String
ScreenShareSubscriber
  CURSOR_HAND_CLOSED : Class
ScreenShareSubscriberComplex
  CURSOR_HAND_OPEN : Class
ScreenShareSubscriberComplex
 Inherited_fitToWidthPercent : Number = 0
ScreenShareSubscriber
  _focusRect : HaloFocusRect
ScreenShareSubscriberComplex
 Inherited_ignoreAutoScrollTimer : Timer
ScreenShareSubscriber
  _imeTextField : TextArea
ScreenShareSubscriberComplex
  _initialDragPt : Point
ScreenShareSubscriberComplex
  _initialScrollPos : Point
ScreenShareSubscriberComplex
 Inherited_invShowMyStream : Boolean = false
ScreenShareSubscriber
  _isControlling : Boolean
ScreenShareSubscriberComplex
 Inherited_lastCursorData : Object
ScreenShareSubscriber
 Inherited_lastPositionSet : Boolean = false
ScreenShareSubscriber
  _lastPropsBarPt : Point
ScreenShareSubscriberComplex
 Inherited_lastX : Number
ScreenShareSubscriber
 Inherited_lastY : Number
ScreenShareSubscriber
 Inherited_phase : uint = 0
ScreenShareSubscriber
 Inherited_publisherID : String
ScreenShareSubscriber
  _remoteControlDescriptor : StreamDescriptor
ScreenShareSubscriberComplex
  _remoteControlNetStream : NetStream
ScreenShareSubscriberComplex
 Inherited_requestStreamName : String
ScreenShareSubscriber
 Inherited_scaleToFitPercent : Number = 0
ScreenShareSubscriber
 Inherited_screenShareDescriptor : StreamDescriptor
ScreenShareSubscriber
 Inherited_screenShareNetStream : NetStream
ScreenShareSubscriber
 Inherited_screenShareNet_streamIDchanged : Boolean = false
ScreenShareSubscriber
 Inherited_shareCursor : ScreenShareSubscriberCursor
ScreenShareSubscriber
 Inherited_shareCursorMove : Move
ScreenShareSubscriber
 Inherited_sharerUserID : String
ScreenShareSubscriber
 Inherited_showMyStream : Boolean = false
ScreenShareSubscriber
  _specialKeyPressed : Boolean = false
ScreenShareSubscriberComplex
  _specialKeyReleased : Boolean = false
ScreenShareSubscriberComplex
 Inherited_streamID : String
ScreenShareSubscriber
 Inherited_streamManager : StreamManager
ScreenShareSubscriber
  _toggleSpecialKey : Boolean = false
ScreenShareSubscriberComplex
 Inherited_userManager : UserManager
ScreenShareSubscriber
 Inherited_videoComponent : VideoComponent
ScreenShareSubscriber
 Inherited_videoPercentage : Number
ScreenShareSubscriber
 Inherited_zoomMode : uint = 1
ScreenShareSubscriber
 Inherited_zoomModeChanged : Boolean = true
ScreenShareSubscriber
Public Methods
 MethodDefined by
  
ScreenShareSubscriberComplex()
Constructor.
ScreenShareSubscriberComplex
  
canIControl():Boolean
ScreenShareSubscriberComplex
 Inherited
close():void
ScreenShareSubscriber
  
createTextField():void
ScreenShareSubscriberComplex
  
cursorData(p_x:Number, p_y:Number, p_type:Number, p_isDown:Boolean):void
ScreenShareSubscriberComplex
 Inherited
cursorDataNull(p_x:Number, p_y:Number, p_type:Number, p_isDown:Boolean):void
ScreenShareSubscriber
  
onHorizontalTweenEnd(p_value:Number):void
ScreenShareSubscriberComplex
  
onHorizontalTweenUpdate(p_value:Number):void
ScreenShareSubscriberComplex
  
onVerticalTweenEnd(p_value:Number):void
ScreenShareSubscriberComplex
  
onVerticalTweenUpdate(p_value:Number):void
ScreenShareSubscriberComplex
  
startControlling():void
ScreenShareSubscriberComplex
  
stopControlling():void
ScreenShareSubscriberComplex
 Inherited
subscribe():void
Subscribes to a particular stream.
ScreenShareSubscriber
Protected Methods
 MethodDefined by
  
calculateZoom(zoomType:Number, p_width:Number, p_height:Number, p_isAdvanceCalculate:Boolean = false):void
ScreenShareSubscriberComplex
  
cleanUpVideo():void
ScreenShareSubscriberComplex
  
clearAnnotation():void
ScreenShareSubscriberComplex
  
commitProperties():void
ScreenShareSubscriberComplex
  
dealWithStreamPause(p_desc:StreamDescriptor):void
ScreenShareSubscriberComplex
  
deleteIME():void
ScreenShareSubscriberComplex
 Inherited
doInitialSetup():void
ScreenShareSubscriber
  
getNextKey(p_event:KeyboardEvent):Boolean
ScreenShareSubscriberComplex
 Inherited
onAutoHide(p_evt:TimerEvent):void
ScreenShareSubscriber
 Inherited
onBackgroundScroll(p_evt:ScrollEvent = null):void
ScreenShareSubscriber
 Inherited
onDimensionsChange(p_evt:StreamEvent):void
ScreenShareSubscriber
  
onDragVideo(p_evt:MouseEvent):void
ScreenShareSubscriberComplex
  
onIMEComposition(event:IMEEvent):void
ScreenShareSubscriberComplex
  
onKeyDown(p_evt:KeyboardEvent):void
ScreenShareSubscriberComplex
  
onKeyUp(p_evt:KeyboardEvent):void
ScreenShareSubscriberComplex
  
onMouseDown(p_evt:MouseEvent):void
ScreenShareSubscriberComplex
  
onMouseMove(p_evt:MouseEvent):void
ScreenShareSubscriberComplex
  
onMouseOut(p_evt:MouseEvent):void
ScreenShareSubscriberComplex
  
onMouseOver(p_evt:MouseEvent):void
ScreenShareSubscriberComplex
  
onMouseUp(p_evt:MouseEvent):void
ScreenShareSubscriberComplex
  
onPropertiesToolBarChange(p_evt:WBCanvasEvent):void
ScreenShareSubscriberComplex
  
onReleaseVideo(p_evt:MouseEvent):void
ScreenShareSubscriberComplex
  
onRightMouseDown(p_evt:MouseEvent):void
ScreenShareSubscriberComplex
  
onRightMouseUp(p_evt:MouseEvent):void
ScreenShareSubscriberComplex
 Inherited
onStreamDelete(p_evt:StreamEvent):void
ScreenShareSubscriber
  
onStreamPause(p_evt:StreamEvent):void
Returns the ID of the current sharer, or null if there is none.
ScreenShareSubscriberComplex
 Inherited
onStreamReceive(p_evt:StreamEvent):void
ScreenShareSubscriber
 Inherited
onSynchronizationChange(p_evt:CollectionNodeEvent):void
ScreenShareSubscriber
  
onWBToolBarClick(p_evt:WBToolBarEvent):void
ScreenShareSubscriberComplex
  
sendKeyboardEvent(p_eventName:String, p_keyCode:uint):void
ScreenShareSubscriberComplex
  
sendMouseEvent(p_eventName:String, p_x:Number, p_y:Number):void
ScreenShareSubscriberComplex
  
setShapeBarPosition():void
ScreenShareSubscriberComplex
  
setUpFromDescriptor(p_desc:StreamDescriptor):void
ScreenShareSubscriberComplex
Events
 EventSummaryDefined by
  
controlStarted
 ScreenShareSubscriberComplex
 Inherited
controlStarted
 ScreenShareSubscriber
  
controlStopped
 ScreenShareSubscriberComplex
 Inherited
controlStopped
 ScreenShareSubscriber
  
screenSharePaused
 ScreenShareSubscriberComplex
 Inherited
screenSharePaused
 ScreenShareSubscriber
  
screenShareStarted
 ScreenShareSubscriberComplex
 Inherited
screenShareStarted
 ScreenShareSubscriber
  
screenShareStarting
 ScreenShareSubscriberComplex
 Inherited
screenShareStarting
 ScreenShareSubscriber
  
screenShareStopped
 ScreenShareSubscriberComplex
 Inherited
screenShareStopped
 ScreenShareSubscriber
  
synchronizationChange
Dispatched when the component either loses its connection to the session or regains it and has finished re-synchronizing itself to the rest of the room.ScreenShareSubscriberComplex
 Inherited
synchronizationChange
Dispatched when the component either loses its connection to the session or regains it and has finished re-synchronizing itself to the rest of the room.ScreenShareSubscriber
  
videoPercentageChange
 ScreenShareSubscriberComplex
 Inherited
videoPercentageChange
 ScreenShareSubscriber
  
videoSnapShot
 ScreenShareSubscriberComplex
 Inherited
videoSnapShot
 ScreenShareSubscriber
Public Constants
 ConstantDefined by
  ACTUAL_SIZE : uint = 100
[static]
ScreenShareSubscriberComplex
  FIT_TO_WIDTH : uint = 1
[static]
ScreenShareSubscriberComplex
  IME_CARET_FREQUENCY : String = "imeCaretMessageFrequency"
[static]
ScreenShareSubscriberComplex
  IME_INPUT : String = "imeInput"
[static]
ScreenShareSubscriberComplex
  IME_POSITION : String = "imePosition"
[static]
ScreenShareSubscriberComplex
  RIGHT_MOUSE_DOWN : String = "rightMouseDown"
[static]
ScreenShareSubscriberComplex
  RIGHT_MOUSE_UP : String = "rightMouseUp"
[static]
ScreenShareSubscriberComplex
  SCALE_TO_FIT : uint = 0
[static]
ScreenShareSubscriberComplex
Protected Constants
 ConstantDefined by
 InheriteddisplayInvalidator : Invalidator
ScreenShareSubscriber
 InheritedPHASE_I_AM_PREPARING_TO_SHARE : uint = 1
ScreenShareSubscriber
 InheritedPHASE_I_AM_SHARING : uint = 2
ScreenShareSubscriber
 InheritedPHASE_IDLE : uint = 0
ScreenShareSubscriber
 InheritedPHASE_SOMEONE_ELSE_PREPARING : uint = 3
ScreenShareSubscriber
 InheritedPHASE_SOMEONE_ELSE_SHARING : uint = 4
ScreenShareSubscriber
Property detail
allowSaveproperty
public var allowSave:Boolean = true
annotateOnPauseproperty 
public var annotateOnPause:Boolean = false
_annotationPropsBarproperty 
protected var _annotationPropsBar:UIComponent
_annotationShapesBarproperty 
protected var _annotationShapesBar:UIComponent
_annotationWBproperty 
protected var _annotationWB:SharedWhiteBoard
autoScrollproperty 
public var autoScroll:Boolean = false
_autoscrollTweenproperty 
protected var _autoscrollTween:Tween
controllerUserIDproperty 
controllerUserID:String  [read-only]Implementation
    public function get controllerUserID():String
_controlOutStreamproperty 
protected var _controlOutStream:NetStream
CURSOR_HAND_CLOSEDproperty 
protected var CURSOR_HAND_CLOSED:Class
CURSOR_HAND_OPENproperty 
protected var CURSOR_HAND_OPEN:Class
_focusRectproperty 
protected var _focusRect:HaloFocusRect
_imeTextFieldproperty 
protected var _imeTextField:TextArea
_initialDragPtproperty 
protected var _initialDragPt:Point
_initialScrollPosproperty 
protected var _initialScrollPos:Point
_isControllingproperty 
protected var _isControlling:Boolean
isScrollableproperty 
isScrollable:Boolean  [read-only]Implementation
    public function get isScrollable():Boolean
_lastPropsBarPtproperty 
protected var _lastPropsBarPt:Point
_remoteControlDescriptorproperty 
protected var _remoteControlDescriptor:StreamDescriptor
_remoteControlNetStreamproperty 
protected var _remoteControlNetStream:NetStream
_specialKeyPressedproperty 
protected var _specialKeyPressed:Boolean = false
_specialKeyReleasedproperty 
protected var _specialKeyReleased:Boolean = false
_toggleSpecialKeyproperty 
protected var _toggleSpecialKey:Boolean = false
Constructor detail
ScreenShareSubscriberComplex()constructor
public function ScreenShareSubscriberComplex()

Constructor.

Method detail
calculateZoom()method
protected override function calculateZoom(zoomType:Number, p_width:Number, p_height:Number, p_isAdvanceCalculate:Boolean = false):voidParameters
zoomType:Number
 
p_width:Number
 
p_height:Number
 
p_isAdvanceCalculate:Boolean (default = false)
canIControl()method 
public function canIControl():Boolean

Returns
Boolean
cleanUpVideo()method 
protected override function cleanUpVideo():void
clearAnnotation()method 
protected function clearAnnotation():void
commitProperties()method 
protected override function commitProperties():void
createTextField()method 
public function createTextField():void
cursorData()method 
public override function cursorData(p_x:Number, p_y:Number, p_type:Number, p_isDown:Boolean):voidParameters
p_x:Number
 
p_y:Number
 
p_type:Number
 
p_isDown:Boolean
dealWithStreamPause()method 
protected function dealWithStreamPause(p_desc:StreamDescriptor):voidParameters
p_desc:StreamDescriptor
deleteIME()method 
protected function deleteIME():void
getNextKey()method 
protected function getNextKey(p_event:KeyboardEvent):BooleanParameters
p_event:KeyboardEvent

Returns
Boolean
onDragVideo()method 
protected function onDragVideo(p_evt:MouseEvent):voidParameters
p_evt:MouseEvent
onHorizontalTweenEnd()method 
public function onHorizontalTweenEnd(p_value:Number):voidParameters
p_value:Number
onHorizontalTweenUpdate()method 
public function onHorizontalTweenUpdate(p_value:Number):voidParameters
p_value:Number
onIMEComposition()method 
protected function onIMEComposition(event:IMEEvent):voidParameters
event:IMEEvent
onKeyDown()method 
protected function onKeyDown(p_evt:KeyboardEvent):voidParameters
p_evt:KeyboardEvent
onKeyUp()method 
protected function onKeyUp(p_evt:KeyboardEvent):voidParameters
p_evt:KeyboardEvent
onMouseDown()method 
protected function onMouseDown(p_evt:MouseEvent):voidParameters
p_evt:MouseEvent
onMouseMove()method 
protected function onMouseMove(p_evt:MouseEvent):voidParameters
p_evt:MouseEvent
onMouseOut()method 
protected function onMouseOut(p_evt:MouseEvent):voidParameters
p_evt:MouseEvent
onMouseOver()method 
protected function onMouseOver(p_evt:MouseEvent):voidParameters
p_evt:MouseEvent
onMouseUp()method 
protected function onMouseUp(p_evt:MouseEvent):voidParameters
p_evt:MouseEvent
onPropertiesToolBarChange()method 
protected function onPropertiesToolBarChange(p_evt:WBCanvasEvent):voidParameters
p_evt:WBCanvasEvent
onReleaseVideo()method 
protected function onReleaseVideo(p_evt:MouseEvent):voidParameters
p_evt:MouseEvent
onRightMouseDown()method 
protected function onRightMouseDown(p_evt:MouseEvent):voidParameters
p_evt:MouseEvent
onRightMouseUp()method 
protected function onRightMouseUp(p_evt:MouseEvent):voidParameters
p_evt:MouseEvent
onStreamPause()method 
protected override function onStreamPause(p_evt:StreamEvent):void

Returns the ID of the current sharer, or null if there is none.

Parameters
p_evt:StreamEvent
onVerticalTweenEnd()method 
public function onVerticalTweenEnd(p_value:Number):voidParameters
p_value:Number
onVerticalTweenUpdate()method 
public function onVerticalTweenUpdate(p_value:Number):voidParameters
p_value:Number
onWBToolBarClick()method 
protected function onWBToolBarClick(p_evt:WBToolBarEvent):voidParameters
p_evt:WBToolBarEvent
sendKeyboardEvent()method 
protected function sendKeyboardEvent(p_eventName:String, p_keyCode:uint):voidParameters
p_eventName:String
 
p_keyCode:uint
sendMouseEvent()method 
protected function sendMouseEvent(p_eventName:String, p_x:Number, p_y:Number):voidParameters
p_eventName:String
 
p_x:Number
 
p_y:Number
setShapeBarPosition()method 
protected function setShapeBarPosition():void
setUpFromDescriptor()method 
protected override function setUpFromDescriptor(p_desc:StreamDescriptor):voidParameters
p_desc:StreamDescriptor
startControlling()method 
public function startControlling():void
stopControlling()method 
public function stopControlling():void
Event detail
controlStartedevent 
Event object type: com.adobe.rtc.events.ScreenShareEvent

controlStoppedevent  
Event object type: com.adobe.rtc.events.ScreenShareEvent

screenSharePausedevent  
Event object type: com.adobe.rtc.events.ScreenShareEvent

screenShareStartedevent  
Event object type: com.adobe.rtc.events.ScreenShareEvent

screenShareStartingevent  
Event object type: com.adobe.rtc.events.ScreenShareEvent

screenShareStoppedevent  
Event object type: com.adobe.rtc.events.ScreenShareEvent

synchronizationChangeevent  
Event object type: com.adobe.rtc.events.CollectionNodeEvent

Dispatched when the component either loses its connection to the session or regains it and has finished re-synchronizing itself to the rest of the room.

videoPercentageChangeevent  
Event object type: com.adobe.rtc.events.ScreenShareEvent

videoSnapShotevent  
Event object type: com.adobe.rtc.events.ScreenShareEvent

Constant detail
ACTUAL_SIZEconstant
public static const ACTUAL_SIZE:uint = 100
FIT_TO_WIDTHconstant 
public static const FIT_TO_WIDTH:uint = 1
IME_CARET_FREQUENCYconstant 
public static const IME_CARET_FREQUENCY:String = "imeCaretMessageFrequency"
IME_INPUTconstant 
public static const IME_INPUT:String = "imeInput"
IME_POSITIONconstant 
public static const IME_POSITION:String = "imePosition"
RIGHT_MOUSE_DOWNconstant 
public static const RIGHT_MOUSE_DOWN:String = "rightMouseDown"
RIGHT_MOUSE_UPconstant 
public static const RIGHT_MOUSE_UP:String = "rightMouseUp"
SCALE_TO_FITconstant 
public static const SCALE_TO_FIT:uint = 0



2008-2010 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/collaboration/ScreenShareSubscriberComplex.html