| Package | com.adobe.rtc.collaboration |
| Class | public class ScreenShareSubscriber |
| Inheritance | ScreenShareSubscriber  mx.core.UIComponent |
| Implements | ISessionSubscriber |
| Subclasses | ScreenShareSubscriberComplex |
publisherID which restricts the screen share publisher that
can publish to this subscriber.
ScreenShareSubscriber is a basic screen share subscriber component, it does the minmum needed to subscribe to the screen share.
Use ScreenShareSubscriberComplex to enhance the feature with zoom and annotations.
Example:
_ssSubscriber = new ScreenShareSubscriber();
_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
| Property | Defined by | ||
|---|---|---|---|
| connectSession : IConnectSession
return the connectSession object
| ScreenShareSubscriber | ||
| fitToWidthPercent : Number [read-only]
| ScreenShareSubscriber | ||
| groupName : 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 | ||
| iAmPreparingToShare : Boolean [read-only]
returns true if you are preparing to share or if someone else is preparing
| ScreenShareSubscriber | ||
| iAmSharing : Boolean [read-only]
returns true if you or someone else is sharing
| ScreenShareSubscriber | ||
| isSynchronized : Boolean [read-only]
| ScreenShareSubscriber | ||
| publisherID : String
getting the publisher id for whom you like to view their screen share stream
| ScreenShareSubscriber | ||
| scaleToFitPercent : Number [read-only]
| ScreenShareSubscriber | ||
| sharedID : String
Defines the logical location of the component on the service; typically this assigns the
sharedID of the collectionNode
used by the component. | ScreenShareSubscriber | ||
| sharerUserID : String [read-only]
getting the publisher's id, this is the default streampublisher id
| ScreenShareSubscriber | ||
| showMouse : Boolean = true | ScreenShareSubscriber | ||
| showMyStream : Boolean | ScreenShareSubscriber | ||
| someoneElseIsPreparingToShare : Boolean [read-only]
returns true if you are preparing to share or if someone else is preparing
| ScreenShareSubscriber | ||
| someoneElseIsSharing : Boolean [read-only]
returns true if you are preparing to share or if someone else is sharing
| ScreenShareSubscriber | ||
| videoPercentage : Number [read-only]
| ScreenShareSubscriber | ||
| zoomMode : uint | ScreenShareSubscriber | ||
| Property | Defined by | ||
|---|---|---|---|
| _autoHideCursorTimer : Timer | ScreenShareSubscriber | ||
| _background : Canvas | ScreenShareSubscriber | ||
| _controlStreamID : String | ScreenShareSubscriber | ||
| _fitToWidthPercent : Number = 0 | ScreenShareSubscriber | ||
| _ignoreAutoScrollTimer : Timer | ScreenShareSubscriber | ||
| _invShowMyStream : Boolean = false | ScreenShareSubscriber | ||
| _lastCursorData : Object | ScreenShareSubscriber | ||
| _lastPositionSet : Boolean = false | ScreenShareSubscriber | ||
| _lastX : Number | ScreenShareSubscriber | ||
| _lastY : Number | ScreenShareSubscriber | ||
| _phase : uint = 0 | ScreenShareSubscriber | ||
| _publisherID : String | ScreenShareSubscriber | ||
| _requestStreamName : String | ScreenShareSubscriber | ||
| _scaleToFitPercent : Number = 0 | ScreenShareSubscriber | ||
| _screenShareDescriptor : StreamDescriptor | ScreenShareSubscriber | ||
| _screenShareNetStream : NetStream | ScreenShareSubscriber | ||
| _screenShareNet_streamIDchanged : Boolean = false | ScreenShareSubscriber | ||
| _shareCursor : ScreenShareSubscriberCursor | ScreenShareSubscriber | ||
| _shareCursorMove : Move | ScreenShareSubscriber | ||
| _sharerUserID : String | ScreenShareSubscriber | ||
| _showMyStream : Boolean = false | ScreenShareSubscriber | ||
| _streamID : String | ScreenShareSubscriber | ||
| _streamManager : StreamManager | ScreenShareSubscriber | ||
| _userManager : UserManager | ScreenShareSubscriber | ||
| _videoComponent : VideoComponent | ScreenShareSubscriber | ||
| _videoPercentage : Number | ScreenShareSubscriber | ||
| _zoomMode : uint = 1 | ScreenShareSubscriber | ||
| _zoomModeChanged : Boolean = true | ScreenShareSubscriber | ||
| Method | Defined by | ||
|---|---|---|---|
| ScreenShareSubscriber | |||
|
close():void
| ScreenShareSubscriber | ||
|
cursorData(p_x:Number, p_y:Number, p_type:Number, p_isDown:Boolean):void
| ScreenShareSubscriber | ||
|
cursorDataNull(p_x:Number, p_y:Number, p_type:Number, p_isDown:Boolean):void
| ScreenShareSubscriber | ||
|
subscribe():void
Subscribes to a particular stream.
| ScreenShareSubscriber | ||
| Method | Defined by | ||
|---|---|---|---|
|
calculateZoom(zoomType:Number, p_width:Number, p_height:Number, p_isAdvanceCalculate:Boolean = false):void
| ScreenShareSubscriber | ||
|
cleanUpVideo():void
| ScreenShareSubscriber | ||
|
doInitialSetup():void
| ScreenShareSubscriber | ||
|
onAutoHide(p_evt:TimerEvent):void
| ScreenShareSubscriber | ||
|
onBackgroundScroll(p_evt:ScrollEvent = null):void
| ScreenShareSubscriber | ||
|
onDimensionsChange(p_evt:StreamEvent):void
| ScreenShareSubscriber | ||
|
onStreamDelete(p_evt:StreamEvent):void
| ScreenShareSubscriber | ||
|
onStreamPause(p_evt:StreamEvent):void
| ScreenShareSubscriber | ||
|
onStreamReceive(p_evt:StreamEvent):void
| ScreenShareSubscriber | ||
|
onSynchronizationChange(p_evt:CollectionNodeEvent):void
| ScreenShareSubscriber | ||
|
setUpFromDescriptor(p_desc:StreamDescriptor):void
| ScreenShareSubscriber | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| ScreenShareSubscriber | ||||
| ScreenShareSubscriber | ||||
| ScreenShareSubscriber | ||||
| ScreenShareSubscriber | ||||
| ScreenShareSubscriber | ||||
| ScreenShareSubscriber | ||||
| 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 | |||
| ScreenShareSubscriber | ||||
| ScreenShareSubscriber | ||||
| Constant | Defined by | ||
|---|---|---|---|
| ACTUAL_SIZE : uint = 100 [static]
| ScreenShareSubscriber | ||
| FIT_TO_WIDTH : uint = 1 [static]
| ScreenShareSubscriber | ||
| RIGHT_MOUSE_DOWN : String = "rightMouseDown" [static]
| ScreenShareSubscriber | ||
| RIGHT_MOUSE_UP : String = "rightMouseUp" [static]
| ScreenShareSubscriber | ||
| SCALE_TO_FIT : uint = 0 [static]
| ScreenShareSubscriber | ||
| Constant | Defined by | ||
|---|---|---|---|
| displayInvalidator : Invalidator | ScreenShareSubscriber | ||
| PHASE_I_AM_PREPARING_TO_SHARE : uint = 1 | ScreenShareSubscriber | ||
| PHASE_I_AM_SHARING : uint = 2 | ScreenShareSubscriber | ||
| PHASE_IDLE : uint = 0 | ScreenShareSubscriber | ||
| PHASE_SOMEONE_ELSE_PREPARING : uint = 3 | ScreenShareSubscriber | ||
| PHASE_SOMEONE_ELSE_SHARING : uint = 4 | ScreenShareSubscriber | ||
| _autoHideCursorTimer | property |
protected var _autoHideCursorTimer:Timer
| _background | property |
protected var _background:Canvas
| connectSession | property |
connectSession:IConnectSession [read-write]return the connectSession object
Implementation public function get connectSession():IConnectSession
public function set connectSession(value:IConnectSession):void
| _controlStreamID | property |
protected var _controlStreamID:String
| _fitToWidthPercent | property |
protected var _fitToWidthPercent:Number = 0
| fitToWidthPercent | property |
fitToWidthPercent:Number [read-only]Implementation
public function get fitToWidthPercent():Number
| groupName | property |
groupName:String [read-write]
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). Groups are like separate
conversations within the room, but each conversation could employ one or more pods; for example, one
"conversation" may use a web camera, chat, and whiteboard pod, with each pod using different access
and publish models. Users are members of and can only see components within the group they are assigned.
Room hosts can see all the groups and all the members in those groups.
public function get groupName():String
public function set groupName(value:String):void
| iAmPreparingToShare | property |
iAmPreparingToShare:Boolean [read-only]returns true if you are preparing to share or if someone else is preparing
Implementation public function get iAmPreparingToShare():Boolean
| iAmSharing | property |
iAmSharing:Boolean [read-only]returns true if you or someone else is sharing
Implementation public function get iAmSharing():Boolean
| _ignoreAutoScrollTimer | property |
protected var _ignoreAutoScrollTimer:Timer
| _invShowMyStream | property |
protected var _invShowMyStream:Boolean = false
| isSynchronized | property |
isSynchronized:Boolean [read-only]This property can be used as the source for data binding.
Implementation public function get isSynchronized():Boolean
| _lastCursorData | property |
protected var _lastCursorData:Object
| _lastPositionSet | property |
protected var _lastPositionSet:Boolean = false
| _lastX | property |
protected var _lastX:Number
| _lastY | property |
protected var _lastY:Number
| _phase | property |
protected var _phase:uint = 0
| _publisherID | property |
protected var _publisherID:String
| publisherID | property |
publisherID:String [read-write]getting the publisher id for whom you like to view their screen share stream
Implementation public function get publisherID():String
public function set publisherID(value:String):void
| _requestStreamName | property |
protected var _requestStreamName:String
| _scaleToFitPercent | property |
protected var _scaleToFitPercent:Number = 0
| scaleToFitPercent | property |
scaleToFitPercent:Number [read-only]Implementation
public function get scaleToFitPercent():Number
| _screenShareDescriptor | property |
protected var _screenShareDescriptor:StreamDescriptor
| _screenShareNetStream | property |
protected var _screenShareNetStream:NetStream
| _screenShareNet_streamIDchanged | property |
protected var _screenShareNet_streamIDchanged:Boolean = false
| _shareCursor | property |
protected var _shareCursor:ScreenShareSubscriberCursor
| _shareCursorMove | property |
protected var _shareCursorMove:Move
| sharedID | property |
sharedID:String [read-write]
Defines the logical location of the component on the service; typically this assigns the sharedID of the collectionNode
used by the component. sharedIDs should be unique within a room if they're expressing two
unique locations. Note that this can only be assigned once before subscribe() is called. For components
with an id property, sharedID defaults to that value.
public function get sharedID():String
public function set sharedID(value:String):void
| _sharerUserID | property |
protected var _sharerUserID:String
| sharerUserID | property |
sharerUserID:String [read-only]getting the publisher's id, this is the default streampublisher id
Implementation public function get sharerUserID():String
| showMouse | property |
public var showMouse:Boolean = true
| _showMyStream | property |
protected var _showMyStream:Boolean = false
| showMyStream | property |
showMyStream:Boolean [read-write]Implementation
public function get showMyStream():Boolean
public function set showMyStream(value:Boolean):void
| someoneElseIsPreparingToShare | property |
someoneElseIsPreparingToShare:Boolean [read-only]returns true if you are preparing to share or if someone else is preparing
Implementation public function get someoneElseIsPreparingToShare():Boolean
| someoneElseIsSharing | property |
someoneElseIsSharing:Boolean [read-only]returns true if you are preparing to share or if someone else is sharing
Implementation public function get someoneElseIsSharing():Boolean
| _streamID | property |
protected var _streamID:String
| _streamManager | property |
protected var _streamManager:StreamManager
| _userManager | property |
protected var _userManager:UserManager
| _videoComponent | property |
protected var _videoComponent:VideoComponent
| _videoPercentage | property |
protected var _videoPercentage:Number
| videoPercentage | property |
videoPercentage:Number [read-only]Implementation
public function get videoPercentage():Number
| _zoomMode | property |
protected var _zoomMode:uint = 1
| zoomMode | property |
zoomMode:uint [read-write]Implementation
public function get zoomMode():uint
public function set zoomMode(value:uint):void
| _zoomModeChanged | property |
protected var _zoomModeChanged:Boolean = true
| ScreenShareSubscriber | () | constructor |
public function ScreenShareSubscriber()
| calculateZoom | () | method |
protected 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) |
| cleanUpVideo | () | method |
protected function cleanUpVideo():void
| close | () | method |
public function close():void
| cursorData | () | method |
public 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 |
| cursorDataNull | () | method |
public function cursorDataNull(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 |
| doInitialSetup | () | method |
protected function doInitialSetup():void
| onAutoHide | () | method |
protected function onAutoHide(p_evt:TimerEvent):voidParameters
p_evt:TimerEvent |
| onBackgroundScroll | () | method |
protected function onBackgroundScroll(p_evt:ScrollEvent = null):voidParameters
p_evt:ScrollEvent (default = null) |
| onDimensionsChange | () | method |
| onStreamDelete | () | method |
| onStreamPause | () | method |
| onStreamReceive | () | method |
| onSynchronizationChange | () | method |
protected function onSynchronizationChange(p_evt:CollectionNodeEvent):voidParameters
p_evt:CollectionNodeEvent |
| setUpFromDescriptor | () | method |
protected function setUpFromDescriptor(p_desc:StreamDescriptor):voidParameters
p_desc:StreamDescriptor |
| subscribe | () | method |
public function subscribe():voidSubscribes to a particular stream.
| controlStarted | event |
| controlStopped | event |
| screenSharePaused | event |
| screenShareStarted | event |
| screenShareStarting | event |
| screenShareStopped | event |
| synchronizationChange | event |
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.
| videoPercentageChange | event |
| videoSnapShot | event |
| ACTUAL_SIZE | constant |
public static const ACTUAL_SIZE:uint = 100
| displayInvalidator | constant |
protected const displayInvalidator:Invalidator
| FIT_TO_WIDTH | constant |
public static const FIT_TO_WIDTH:uint = 1
| PHASE_I_AM_PREPARING_TO_SHARE | constant |
protected const PHASE_I_AM_PREPARING_TO_SHARE:uint = 1
| PHASE_I_AM_SHARING | constant |
protected const PHASE_I_AM_SHARING:uint = 2
| PHASE_IDLE | constant |
protected const PHASE_IDLE:uint = 0
| PHASE_SOMEONE_ELSE_PREPARING | constant |
protected const PHASE_SOMEONE_ELSE_PREPARING:uint = 3
| PHASE_SOMEONE_ELSE_SHARING | constant |
protected const PHASE_SOMEONE_ELSE_SHARING:uint = 4
| RIGHT_MOUSE_DOWN | constant |
public static const RIGHT_MOUSE_DOWN:String = "rightMouseDown"
| RIGHT_MOUSE_UP | constant |
public static const RIGHT_MOUSE_UP:String = "rightMouseUp"
| SCALE_TO_FIT | constant |
public static const SCALE_TO_FIT:uint = 0
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/ScreenShareSubscriber.html