| Package | com.adobe.rtc.sharedManagers.descriptors |
| Class | public class StreamDescriptor |
| Implements | IValueObjectEncodable |
streamDescriptors
to users in the room. Collaboration components such as WebcamSubscriber or AudioSubscriber
use streamDescriptors to directly access the raw streams and may be thought
of as control metadata for indicating the presence and current state of streams in a room.
StreamDescriptors can be accessed through the StreamManager's methods, and StreamManager's
events will notify of any changes to the set of streamDescriptors.
See also
| Property | Defined by | ||
|---|---|---|---|
| finishPublishing : Boolean = false
Whether the stream has begun actually publishing (true) or whether the descriptor
is being sent for initial validation (false).
| StreamDescriptor | ||
| groupName : String
The group name which the stream descriptor belongs to
| StreamDescriptor | ||
| id : String
The unique stream ID.
| StreamDescriptor | ||
| initiatorID : String
The
userID of whomever requested this stream be initiated. | StreamDescriptor | ||
| kBps : Number = 0
Gets the stream's bandwidth setting.
| StreamDescriptor | ||
| mute : Boolean = false
The mute state for audio streams: true for muted, false for not
| StreamDescriptor | ||
| nativeHeight : Number = 0
Describes the video stream's original height.
| StreamDescriptor | ||
| nativeWidth : Number = 0
Describes the video stream's original width.
| StreamDescriptor | ||
| originalScreenPublisher : String
The userID of the user publishing their screen.
| StreamDescriptor | ||
| pause : Boolean = false
The video stream pause state: true for paused, false for not
| StreamDescriptor | ||
| recipientIDs : Array
Array of recipientIDs for this stream.
| StreamDescriptor | ||
| streamPublisherID : String
The stream publisher's
userID. | StreamDescriptor | ||
| type : String
The type of the stream: either StreamManager.AUDIO_STREAM or StreamManager.CAMERA_STREAM.
| StreamDescriptor | ||
| volume : Number = 0
The audio stream volume.
| StreamDescriptor | ||
| Method | Defined by | ||
|---|---|---|---|
|
createValueObject():Object
Creates a ValueObject representation of this descriptor.
| StreamDescriptor | ||
|
readValueObject(p_valueObject:Object):void
Takes in a
valueObject and structure the MessageItem according to the
values therein. | StreamDescriptor | ||
| finishPublishing | property |
public var finishPublishing:Boolean = falseWhether the stream has begun actually publishing (true) or whether the descriptor is being sent for initial validation (false).
| groupName | property |
public var groupName:StringThe group name which the stream descriptor belongs to
| id | property |
public var id:StringThe unique stream ID.
| initiatorID | property |
public var initiatorID:String
The userID of whomever requested this stream be initiated.
It is usually identical to the streamPublisherID, but in
"push sharing" cases, it will be the requester.
| kBps | property |
public var kBps:Number = 0Gets the stream's bandwidth setting.
| mute | property |
public var mute:Boolean = falseThe mute state for audio streams: true for muted, false for not
| nativeHeight | property |
public var nativeHeight:Number = 0Describes the video stream's original height.
| nativeWidth | property |
public var nativeWidth:Number = 0Describes the video stream's original width.
| originalScreenPublisher | property |
public var originalScreenPublisher:StringThe userID of the user publishing their screen. Note that for screensharing, the streamPublisherID will have to a "shadow" user ID which isn't available in the userManager - this represents the screen share addIn connection being used. To find the "real" userID of the publisher of a screen share, use this property.
| pause | property |
public var pause:Boolean = falseThe video stream pause state: true for paused, false for not
| recipientIDs | property |
public var recipientIDs:ArrayArray of recipientIDs for this stream. Default is null i.e. broadcast stream to everyone.
| streamPublisherID | property |
public var streamPublisherID:String
The stream publisher's userID.
| type | property |
public var type:StringThe type of the stream: either StreamManager.AUDIO_STREAM or StreamManager.CAMERA_STREAM.
| volume | property |
public var volume:Number = 0The audio stream volume.
| createValueObject | () | method |
public function createValueObject():ObjectCreates a ValueObject representation of this descriptor.
ReturnsObject |
| readValueObject | () | method |
public function readValueObject(p_valueObject:Object):void
Takes in a valueObject and structure the MessageItem according to the
values therein.
p_valueObject:Object — An Object which represents the non-default values for this MessageItem.
|
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/descriptors/StreamDescriptor.html