Packagecom.degrafa.utilities.external
Classpublic class VideoStream
InheritanceVideoStream Inheritance DegrafaObject

...



Public Properties
 PropertyDefined by
  audioCodec : String
[read-only]
VideoStream
  autoLoop : Boolean
Determines whether this video stream automatically loops back to the start at position zero.
VideoStream
  autoPlay : Boolean
VideoStream
  autoUnMute : Boolean
The autoUnMute property lets you determine whether unMuting will occur automatically if an adjustmet to the volume property is made.
Defaults to false.
VideoStream
  bufferIndicator : String
[read-only]
VideoStream
  bufferLength : Number
[read-only]
VideoStream
  bufferRatio : Number
[read-only]
VideoStream
  bufferStatus : String
[read-only] The bufferStatus property returns a string value indicating the current buffer status in the VideoStream.
VideoStream
  bufferTime : Number
VideoStream
  bytesLoaded : uint
[read-only] The bytesLoaded property lets you access the total amount of bytes already loaded if this VideoStream is playing a progressive download (http) video file.
VideoStream
  bytesTotal : uint
[read-only] The bytesTotal property lets you access the total amount of bytes to be loaded if this VideoStream is playing a progressive download (http) video file.
VideoStream
  content : BitmapData
[read-only] The content property provides access to the BitmapData that this VideoStream generates.
This should not usually be further manipulated directly but used as it is supplied.
VideoStream
  contentType : String
[read-only] The contentType property lets you access a string value that represents the type of the content.
VideoStream
  currentFPS : Number
[read-only] The currentFPS property lets you access the current frames per second decoding from this VideoStream.
VideoStream
  debugMode : Boolean
VideoStream
  detectLetterBox : Boolean
The detectLetterBox property lets you specify whether this VideoStream has letterbox detection enabled.
Defaults to false.
This is an experimental feature that is still under development.
When set to true, in the current (beta) implementation, the stream will perform a very simple analysis during the first 100 rendered frames after it has been enabled.
VideoStream
 Inheriteddocument : Object
The MXML document that created this object.
DegrafaObject
  duration : Number
[read-only]
VideoStream
 InheritedenableEvents : Boolean
Enable events for this object.
DegrafaObject
  errorDetail : String
[read-only] The errorStatus property lets you access a string value that represents a more descriptive explanation of an error that has occured, if one exists.
VideoStream
  errorStatus : String
[read-only] The errorStatus property lets you access a string value that represents the general type of error that has occured, if one exists.
VideoStream
 InheritedhasEventManager : Boolean
Tests to see if a EventDispatcher instance has been created for this object.
DegrafaObject
 Inheritedid : String
The identifier used by document to refer to this object.
DegrafaObject
 InheritedisInitialized : Boolean
DegrafaObject
  isLetterBoxed : Boolean
[read-only] The isLetterBoxed property lets you access the current frames per second decoding from this VideoStream.
VideoStream
  isPaused : Boolean
[read-only] The isPaused property returns a Boolean true if the VideoStream is currently paused or stopped.
VideoStream
  isPlaying : Boolean
[read-only] The isPlaying property returns a Boolean true if the VideoStream is currently playing.
VideoStream
  letterBoxContent : Rectangle
[read-only] The letterBoxContent property, if not null, provides a Rectangle instance that defines the VideoStream's letterboxed content.
VideoStream
  loadingLocation : LoadingLocation
VideoStream
  muted : Boolean
The muted property lets you set or access the muted state of the audio component of a VideoStream.
Defaults to false.
VideoStream
 Inheritedname : String
The name that refers to this object.
DegrafaObject
 InheritedobjectBindings : Array
DegrafaObject
 Inheritedparent : IDegrafaObject
The current degrafa object parent.
DegrafaObject
  pixelMargin : uint
Specifies an optional pixel padding around the bitmap that this VideoSource generates.
VideoStream
  playheadTime : Number
The playheadTime property represents the current time code in seconds for the playhead in this VideoStream
VideoStream
  playheadUpdateInterval : uint
VideoStream
  quality : String
The quality property lets you alter the rendering quality for this VideoStream at the basic content level.
Defaults to high.
This affects the quality of the rendered bitmapData, and may be reduced to lower CPU load slightly if rendering quality is not the highest priority.
VideoStream
  reverseOffset : Matrix
[read-only] The reverseOffset property provides access to a read-only correction Matrix for the content BitmapData generated by this VideoStream.
VideoStream
  seekableTo : Number
[read-only] The seekableTo property represents the calculated (known) or estimated current maximum seekable point within the stream.
VideoStream
 InheritedsuppressEventProcessing : Boolean
Temporarily suppress event processing for this object.
DegrafaObject
  url : String
the url of the external asset assignable as either a string representing a url relative to an associated LoadingLocation basePath or as a regular url For alternate domain loading use an associated LoadingLocation assigned via the loadingLocation property and make this url relative to the basePath defined in the LoadingLocation
VideoStream
  volume : Number
The volume property lets you set or access the sound volume of the audio component of a VideoStream.
The range of values is 0.0 (no sound) through to 1.0 (full volume).
Defaults to 0.5 .
If the muted property is true then adjusting this value will not automatically unmute the sound, unless the autoUnMute property is set to true.
VideoStream
Protected Properties
 PropertyDefined by
  _audioDelay : Number = 0
VideoStream
  _basePath : String
VideoStream
  _bitmapAccessible : Boolean
VideoStream
  _bitmapAccessTested : Boolean
VideoStream
  _bitmapData : BitmapData
VideoStream
  _bufferLength : Number = 0
VideoStream
  _bufferStatus : String = "bufferEmpty"
VideoStream
  _bufferTime : Number = 2
VideoStream
  _bufferTimeChange : Boolean
VideoStream
  _bytesLoaded : Number
VideoStream
  _bytesTotal : Number
VideoStream
  _checkLBLimit : uint = 100
VideoStream
  _checkLetterBoxData : BitmapData
VideoStream
  clientObj : Object
VideoStream
  __connections : Object
[static]
VideoStream
  _copyTargetCount : uint
VideoStream
  _copyTargets : Dictionary
VideoStream
  _currentFPS : Number = 0
VideoStream
  _disposalQueue : Array
[static]
VideoStream
  _disposalTimer : Timer
[static]
VideoStream
  _duration : Number
VideoStream
 InheritedeventDispatcher : EventDispatcher
EventDispatcher instance for this object.
DegrafaObject
  _forceUpdates : Boolean
VideoStream
  forceUpdates : Boolean
The playheadUpdateInterval property specifies whether to dispatch propertyChange events for every frame update of the video content.
Defaults to false.
Setting this to true can be useful in some situations with VideoFill, but it is usually best (i.e.
VideoStream
  _height : uint
VideoStream
  _httpCached : Boolean
VideoStream
  _httpConnected : Boolean
[static]
VideoStream
  _httpNC : NetConnection
[static]
VideoStream
  _implicitLocation : LoadingLocation
VideoStream
  instances : Dictionary
[static]
VideoStream
  _invalidated : Boolean
VideoStream
  _isConnected : Boolean
VideoStream
  _isPaused : Boolean = true
VideoStream
  _isPlaying : Boolean
VideoStream
  _isReady : Boolean
VideoStream
  _isSeeking : Boolean
VideoStream
  _latestImage : BitmapData
VideoStream
  _letterBoxChecked : Boolean
VideoStream
  _letterBoxContent : Rectangle
VideoStream
  _letterBoxDetected : Boolean
VideoStream
  _letterBoxHelper : Rectangle
VideoStream
  _loadingLocation : LoadingLocation
VideoStream
  _maxCurrentSeekablePosition : Number = 0
VideoStream
  _metaData : Object
VideoStream
  _nc : NetConnection
VideoStream
  _ns : NetStream
VideoStream
  _pixelMargin : uint = 1
VideoStream
  _playheadUpdateInterval : uint = 250
VideoStream
  _playStatus : String = "playStopped"
VideoStream
  _port : String
VideoStream
  _position : Number = 0
VideoStream
  _protocol : String
VideoStream
  _relativeURL : Boolean
VideoStream
  _requiresMetaData : Boolean
VideoStream
  _reset : Boolean
VideoStream
  _rtmp : Boolean
VideoStream
  _rtmpMonitor : Boolean
VideoStream
  _rtmpSeekCycle : Boolean
VideoStream
  _rtmpWait : Boolean
VideoStream
  _seekQueue : Array
VideoStream
  _seekStatus : String = "seekNone"
VideoStream
  _seekTarget : Number
VideoStream
  _seekTimer : Timer
VideoStream
  _seekUpdateTimeFrame : uint = 30
VideoStream
  _setUrl : String
VideoStream
  _st : SoundTransform
VideoStream
  _textData : String
VideoStream
  _updateSeekPos : Boolean
VideoStream
  _updateTimer : Timer
VideoStream
  _vid : Video
VideoStream
  _volume : Number = 0.5
VideoStream
  _waitOneFrame : Boolean
VideoStream
  _wasBitmapAccessible : Boolean
VideoStream
  _wasStreamingSeek : Boolean
VideoStream
  _width : uint
VideoStream
  _workingUrl : String
VideoStream
Public Methods
 MethodDefined by
  
Constructor VideoStream encapsulates the functionality required to support provision of video content in BitmapData format.
VideoStream
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
DegrafaObject
  
deregisterCopyTarget(target:BitmapData, destroyTarget:Boolean = false):void
VideoStream
 Inherited
dispatchEvent(evt:Event):Boolean
Dispatches an event into the event flow.
DegrafaObject
 Inherited
dispatchPropertyChange(bubbles:Boolean = false, property:Object = null, oldValue:Object = null, newValue:Object = null, source:Object = null):Boolean
Dispatches an property change event into the event flow.
DegrafaObject
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
DegrafaObject
 Inherited
initChange(property:String, oldValue:Object, newValue:Object, source:Object):void
Helper function for dispatching property changes
DegrafaObject
 Inherited
initialized(document:Object, id:String):void
Called after the implementing object has been created and all component properties specified on the MXML tag have been initialized.
DegrafaObject
  
pause():void
Pauses the video at the current playheadTime.
VideoStream
  
play():Boolean
Plays or resumes play of a paused video.
VideoStream
  
registerCopyTarget(target:BitmapData, colorTransform:ColorTransform = null):void
utility support functions for updating additional bitmapdata copies.
VideoStream
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
DegrafaObject
  
The letterBoxContent property, if not null, provides a Rectangle instance that defines the VideoStream's letterboxed content.
VideoStream
  
rewind():void
Rewinds and stops the video at the start.
VideoStream
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
DegrafaObject
Protected Methods
 MethodDefined by
  
VideoStream
  
performSeek(to:Number):Boolean
private a protected method for performing the actual seek on the netstream.
VideoStream
  
processDisposalQueue(e:TimerEvent):void
[static]
VideoStream
  
VideoStream
  
updateErrorStatus(status:String, detail:String, sendEvent:Boolean = true):void
VideoStream
Events
 EventSummaryDefined by
 Inherited  DegrafaObject
 Inherited  DegrafaObject
Public Constants
 ConstantDefined by
  AUDIO_STATUS_UPDATE : String = "audioStatusUpdate"
[static]
VideoStream
  BUFFER_BUFFERING : String = "bufferBuffering"
[static]
VideoStream
  BUFFER_DIMINISHED : String = "bufferDiminished"
[static]
VideoStream
  BUFFER_EMPTY : String = "bufferEmpty"
[static]
VideoStream
  BUFFER_FLUSHING : String = "bufferFlushing"
[static]
VideoStream
  BUFFER_FULL : String = "bufferFull"
[static]
VideoStream
  BUFFER_STATUS_CHANGE : String = "bufferStatusChange"
[static]
VideoStream
  BUFFER_STATUS_UPDATE : String = "bufferStatusUpdate"
[static]
VideoStream
  BUFFER_TIME_CHANGED : String = "bufferTimeChanged"
[static]
VideoStream
  CONNECT_APPSHUTDOWN : String = "NetConnection.Connect.AppShutDown"
[static]
VideoStream
  CONNECT_CLOSED : String = "NetConnection.Connect.Closed"
[static]
VideoStream
  CONNECT_FAILED : String = "NetConnection.Connect.Failed"
[static]
VideoStream
  CONNECT_REJECTED : String = "NetConnection.Connect.Rejected"
[static]
VideoStream
  CONNECT_SUCCESS : String = "NetConnection.Connect.Success"
[static]
VideoStream
  ERROR_STATUS_CONNECTION_ACCESS : String = "errorConnectionAccess"
[static]
VideoStream
  ERROR_STATUS_CONTENT_ACCESS : String = "errorDataAccess"
[static]
VideoStream
  ERROR_STATUS_DATA_ACCESS : String = "errorDataAccess"
[static]
VideoStream
  ERROR_STATUS_NONE : String = "errorNone"
[static]
VideoStream
  ERROR_STATUS_UPDATE : String = "errorUpdate"
[static]
VideoStream
  HIGH : String = "high"
[static]
VideoStream
  LETTERBOX_UPDATE : String = "letterBoxUpdate"
[static]
VideoStream
  LOAD_COMPLETE : String = "loadComplete"
[static]
VideoStream
  LOAD_PROGRESS : String = "loadProgress"
[static]
VideoStream
  LOAD_START : String = "loadStart"
[static]
VideoStream
  LOAD_UDPATE : String = "loadUpdate"
[static]
VideoStream
  LOW : String = "low"
[static]
VideoStream
  MEDIUM : String = "medium"
[static]
VideoStream
  NONE : String = "none"
[static]
VideoStream
  NON_STREAMING : String = "non-streaming"
[static]
VideoStream
  PLAY_PAUSED : String = "playPaused"
[static]
VideoStream
  PLAY_PLAYING : String = "playPlaying"
[static]
VideoStream
  PLAY_STATUS_CHANGED : String = "playStatusChanged"
[static]
VideoStream
  PLAY_STATUS_COMPLETE : String = "playStatusComplete"
[static]
VideoStream
  PLAY_STATUS_FPS_UPDATE : String = "playStatusFPSupdate"
[static]
VideoStream
  PLAY_STATUS_RESET : String = "playStatusReset"
[static]
VideoStream
  PLAY_STATUS_UPDATE : String = "playStatusUpdate"
[static]
VideoStream
  PLAY_STATUS_WAITING : String = "playStatusWaiting"
[static]
VideoStream
  PLAY_STOPPED : String = "playStopped"
[static]
VideoStream
  SEEK_NONE : String = "seekNone"
[static]
VideoStream
  SEEK_SEEKING : String = "seekSeeking"
[static]
VideoStream
  SEEK_STATUS_END : String = "seekStatusEnd"
[static]
VideoStream
  STATUS_DATA_ERROR : String = "itemDataError"
[static]
VideoStream
  STATUS_IDENTIFIED : String = "itemIdentified"
[static]
VideoStream
  STATUS_INITIALIZING : String = "itemInitializing"
[static]
VideoStream
  STATUS_LOAD_ERROR : String = "itemLoadError"
[static]
VideoStream
  STATUS_PROGRESS : String = "itemLoadProgress"
[static]
VideoStream
  STATUS_READY : String = "itemReady"
[static]
VideoStream
  STATUS_REQUESTED : String = "itemRequested"
[static]
VideoStream
  STATUS_SECURITY_ERROR : String = "itemSecurityError"
[static]
VideoStream
  STATUS_STARTED : String = "itemLoadStarted"
[static]
VideoStream
  STATUS_WAITING : String = "itemWaiting"
[static]
VideoStream
  STREAMING : String = "streaming"
[static]
VideoStream
Protected Constants
 ConstantDefined by
  copyPoint : Point
[static]
VideoStream
  DISPOSAL_DEFERRAL : uint = 35
[static]
VideoStream
  _fileTypePrefixes : Object
[static]
VideoStream
  _streamingProtocols : Array
[static]
VideoStream
  STREAM_STATUS_LOOPING : int = 1
[static]
VideoStream
  STREAM_STATUS_NORMAL : int = 0
[static]
VideoStream
  STREAM_STATUS_REWINDING : int = 2
[static]
VideoStream
Property detail
audioCodecproperty
audioCodec:String  [read-only]Implementation
    public function get audioCodec():String
_audioDelayproperty 
protected var _audioDelay:Number = 0
autoLoopproperty 
autoLoop:Boolean  [read-write]

Determines whether this video stream automatically loops back to the start at position zero. Defaults to true.

Implementation
    public function get autoLoop():Boolean
    public function set autoLoop(value:Boolean):void
autoPlayproperty 
autoPlay:Boolean  [read-write]Implementation
    public function get autoPlay():Boolean
    public function set autoPlay(value:Boolean):void
autoUnMuteproperty 
autoUnMute:Boolean  [read-write]

The autoUnMute property lets you determine whether unMuting will occur automatically if an adjustmet to the volume property is made.
Defaults to false. When set to true, if the volume property is changed to a value other than zero while muted is true, then muted will be set to false. This permits easy configuration for the situation where manipulating the volume setting via a component is intended to switch off the muted state of the VideoStream.

Implementation
    public function get autoUnMute():Boolean
    public function set autoUnMute(value:Boolean):void

See also

volume
muted
_basePathproperty 
protected var _basePath:String
_bitmapAccessibleproperty 
protected var _bitmapAccessible:Boolean
_bitmapAccessTestedproperty 
protected var _bitmapAccessTested:Boolean
_bitmapDataproperty 
protected var _bitmapData:BitmapData
bufferIndicatorproperty 
bufferIndicator:String  [read-only]

This property can be used as the source for data binding.

Implementation
    public function get bufferIndicator():String
_bufferLengthproperty 
protected var _bufferLength:Number = 0
bufferLengthproperty 
bufferLength:Number  [read-only]

This property can be used as the source for data binding.

Implementation
    public function get bufferLength():Number
bufferRatioproperty 
bufferRatio:Number  [read-only]

This property can be used as the source for data binding.

Implementation
    public function get bufferRatio():Number
_bufferStatusproperty 
protected var _bufferStatus:String = "bufferEmpty"
bufferStatusproperty 
bufferStatus:String  [read-only]

The bufferStatus property returns a string value indicating the current buffer status in the VideoStream. possible values are bufferBuffering,bufferFull,bufferDiminished,bufferEmpty, and bufferFlushing

This property can be used as the source for data binding.

Implementation
    public function get bufferStatus():String
_bufferTimeproperty 
protected var _bufferTime:Number = 2
bufferTimeproperty 
bufferTime:Number  [read-write]

This property can be used as the source for data binding.

Implementation
    public function get bufferTime():Number
    public function set bufferTime(value:Number):void
_bufferTimeChangeproperty 
protected var _bufferTimeChange:Boolean
_bytesLoadedproperty 
protected var _bytesLoaded:Number
bytesLoadedproperty 
bytesLoaded:uint  [read-only]

The bytesLoaded property lets you access the total amount of bytes already loaded if this VideoStream is playing a progressive download (http) video file.

This property can be used as the source for data binding.

Implementation
    public function get bytesLoaded():uint
_bytesTotalproperty 
protected var _bytesTotal:Number
bytesTotalproperty 
bytesTotal:uint  [read-only]

The bytesTotal property lets you access the total amount of bytes to be loaded if this VideoStream is playing a progressive download (http) video file.

This property can be used as the source for data binding.

Implementation
    public function get bytesTotal():uint
_checkLBLimitproperty 
protected var _checkLBLimit:uint = 100
_checkLetterBoxDataproperty 
protected var _checkLetterBoxData:BitmapData
clientObjproperty 
protected var clientObj:Object
__connectionsproperty 
protected static var __connections:Object
contentproperty 
content:BitmapData  [read-only]

The content property provides access to the BitmapData that this VideoStream generates.
This should not usually be further manipulated directly but used as it is supplied. If this value is null, then the BitmapData is not currently available from the VideoStream. This property is intended to be used in situations where BitmapData is used as an input to drawing API functions.

Implementation
    public function get content():BitmapData

See also

flash.display.BitmapData
contentTypeproperty 
contentType:String  [read-only]

The contentType property lets you access a string value that represents the type of the content. Valid values are none,non-streaming,streaming (VideoFill.NONE,VideoFill.STREAMING,VideoFill.NON_STREAMING) This property is read-only.

This property can be used as the source for data binding.

Implementation
    public function get contentType():String
_copyTargetCountproperty 
protected var _copyTargetCount:uint
_copyTargetsproperty 
protected var _copyTargets:Dictionary
_currentFPSproperty 
protected var _currentFPS:Number = 0
currentFPSproperty 
currentFPS:Number  [read-only]

The currentFPS property lets you access the current frames per second decoding from this VideoStream. This is independent of the swf frame rate.

This property can be used as the source for data binding.

Implementation
    public function get currentFPS():Number
debugModeproperty 
debugMode:Boolean  [read-write]Implementation
    public function get debugMode():Boolean
    public function set debugMode(value:Boolean):void
detectLetterBoxproperty 
detectLetterBox:Boolean  [read-write]

The detectLetterBox property lets you specify whether this VideoStream has letterbox detection enabled.
Defaults to false.
This is an experimental feature that is still under development.
When set to true, in the current (beta) implementation, the stream will perform a very simple analysis during the first 100 rendered frames after it has been enabled. The detection algorithm is likely to change in the future and is likely to include sporadic monitoring throughout the stream rather than just a simple test during the first 100 frames after being enabled.
The current (beta) algorithm only looks for black letterboxing of content within a small tolerance range. Results may be inaccurate or undesirable for some content.

Implementation
    public function get detectLetterBox():Boolean
    public function set detectLetterBox(value:Boolean):void
_disposalQueueproperty 
protected static var _disposalQueue:Array
_disposalTimerproperty 
protected static var _disposalTimer:Timer
_durationproperty 
protected var _duration:Number
durationproperty 
duration:Number  [read-only]

This property can be used as the source for data binding.

Implementation
    public function get duration():Number
errorDetailproperty 
errorDetail:String  [read-only]

The errorStatus property lets you access a string value that represents a more descriptive explanation of an error that has occured, if one exists. If no error has occurred, the value remains as "none". This property is read-only.

This property can be used as the source for data binding.

Implementation
    public function get errorDetail():String
errorStatusproperty 
errorStatus:String  [read-only]

The errorStatus property lets you access a string value that represents the general type of error that has occured, if one exists. Valid values are errorNone,errorConnectionAccess,errorDataAccess,errorConnectionAccess (VideoFill.ERROR_STATUS_NONE,VideoFill.ERROR_STATUS_DATA_ACCESS,VideoFill.ERROR_STATUS_CONNECTION_ACCESS) This property is read-only.

This property can be used as the source for data binding.

Implementation
    public function get errorStatus():String
_forceUpdatesproperty 
protected var _forceUpdates:Boolean
forceUpdatesproperty 
forceUpdates:Boolean  [read-write]

The playheadUpdateInterval property specifies whether to dispatch propertyChange events for every frame update of the video content.
Defaults to false.
Setting this to true can be useful in some situations with VideoFill, but it is usually best (i.e. less cpu intensive) to structure the Degrafa composition in such a way that it is not necessary to have this set to true.
Situations to avoid are having filters or masking on the geometry that is being filled with video or in any of its parent hierarchy, including target displayobjects.

Implementation
    protected function get forceUpdates():Boolean
    protected function set forceUpdates(value:Boolean):void
_heightproperty 
protected var _height:uint
_httpCachedproperty 
protected var _httpCached:Boolean
_httpConnectedproperty 
protected static var _httpConnected:Boolean
_httpNCproperty 
protected static var _httpNC:NetConnection
_implicitLocationproperty 
protected var _implicitLocation:LoadingLocation
instancesproperty 
protected static var instances:Dictionary
_invalidatedproperty 
protected var _invalidated:Boolean
_isConnectedproperty 
protected var _isConnected:Boolean
isLetterBoxedproperty 
isLetterBoxed:Boolean  [read-only]

The isLetterBoxed property lets you access the current frames per second decoding from this VideoStream. This property is read-only.

This property can be used as the source for data binding.

Implementation
    public function get isLetterBoxed():Boolean
_isPausedproperty 
protected var _isPaused:Boolean = true
isPausedproperty 
isPaused:Boolean  [read-only]

The isPaused property returns a Boolean true if the VideoStream is currently paused or stopped.

This property can be used as the source for data binding.

Implementation
    public function get isPaused():Boolean
_isPlayingproperty 
protected var _isPlaying:Boolean
isPlayingproperty 
isPlaying:Boolean  [read-only]

The isPlaying property returns a Boolean true if the VideoStream is currently playing.

This property can be used as the source for data binding.

Implementation
    public function get isPlaying():Boolean
_isReadyproperty 
protected var _isReady:Boolean
_isSeekingproperty 
protected var _isSeeking:Boolean
_latestImageproperty 
protected var _latestImage:BitmapData
_letterBoxCheckedproperty 
protected var _letterBoxChecked:Boolean
_letterBoxContentproperty 
protected var _letterBoxContent:Rectangle
letterBoxContentproperty 
letterBoxContent:Rectangle  [read-only]

The letterBoxContent property, if not null, provides a Rectangle instance that defines the VideoStream's letterboxed content. This property is read-only.

This property can be used as the source for data binding.

Implementation
    public function get letterBoxContent():Rectangle

See also

flash.geom.Rectangle
_letterBoxDetectedproperty 
protected var _letterBoxDetected:Boolean
_letterBoxHelperproperty 
protected var _letterBoxHelper:Rectangle
_loadingLocationproperty 
protected var _loadingLocation:LoadingLocation
loadingLocationproperty 
loadingLocation:LoadingLocation  [read-write]Implementation
    public function get loadingLocation():LoadingLocation
    public function set loadingLocation(value:LoadingLocation):void
_maxCurrentSeekablePositionproperty 
protected var _maxCurrentSeekablePosition:Number = 0
_metaDataproperty 
protected var _metaData:Object
mutedproperty 
muted:Boolean  [read-write]

The muted property lets you set or access the muted state of the audio component of a VideoStream.
Defaults to false. A muted VideoStream has no audible sound, adjusting the volume.

This property can be used as the source for data binding.

Implementation
    public function get muted():Boolean
    public function set muted(value:Boolean):void

See also

volume
autoUnMute
_ncproperty 
protected var _nc:NetConnection
_nsproperty 
protected var _ns:NetStream
_pixelMarginproperty 
protected var _pixelMargin:uint = 1
pixelMarginproperty 
pixelMargin:uint  [read-write]

Specifies an optional pixel padding around the bitmap that this VideoSource generates. This is useful to prevent color bleeding under some circumstances when the repeat setting on the VideoFill is not set to repeat and the fill is rotated or scaled.

Implementation
    public function get pixelMargin():uint
    public function set pixelMargin(value:uint):void
playheadTimeproperty 
playheadTime:Number  [read-write]

The playheadTime property represents the current time code in seconds for the playhead in this VideoStream

This property can be used as the source for data binding.

Implementation
    public function get playheadTime():Number
    public function set playheadTime(value:Number):void
_playheadUpdateIntervalproperty 
protected var _playheadUpdateInterval:uint = 250
playheadUpdateIntervalproperty 
playheadUpdateInterval:uint  [read-write]Implementation
    public function get playheadUpdateInterval():uint
    public function set playheadUpdateInterval(value:uint):void
_playStatusproperty 
protected var _playStatus:String = "playStopped"
_portproperty 
protected var _port:String
_positionproperty 
protected var _position:Number = 0
_protocolproperty 
protected var _protocol:String
qualityproperty 
quality:String  [read-write]

The quality property lets you alter the rendering quality for this VideoStream at the basic content level.
Defaults to high.
This affects the quality of the rendered bitmapData, and may be reduced to lower CPU load slightly if rendering quality is not the highest priority.

The default value is high.

Implementation
    public function get quality():String
    public function set quality(value:String):void
_relativeURLproperty 
protected var _relativeURL:Boolean
_requiresMetaDataproperty 
protected var _requiresMetaData:Boolean
_resetproperty 
protected var _reset:Boolean
reverseOffsetproperty 
reverseOffset:Matrix  [read-only]

The reverseOffset property provides access to a read-only correction Matrix for the content BitmapData generated by this VideoStream. This matrix is the offset to the actual video content within the BitmapData.

Implementation
    public function get reverseOffset():Matrix
_rtmpproperty 
protected var _rtmp:Boolean
_rtmpMonitorproperty 
protected var _rtmpMonitor:Boolean
_rtmpSeekCycleproperty 
protected var _rtmpSeekCycle:Boolean
_rtmpWaitproperty 
protected var _rtmpWait:Boolean
seekableToproperty 
seekableTo:Number  [read-only]

The seekableTo property represents the calculated (known) or estimated current maximum seekable point within the stream. This differs between http progressive videos and streaming videos. for streaming video it covers the duration of the video, for progressive download video it includes the full video if the video has completely downloaded otherwise it is within the proportion of the video that has downloaded thus far (which may be an estimate in terms of the actual playing time this represents)

Implementation
    public function get seekableTo():Number
_seekQueueproperty 
protected var _seekQueue:Array
_seekStatusproperty 
protected var _seekStatus:String = "seekNone"
_seekTargetproperty 
protected var _seekTarget:Number
_seekTimerproperty 
protected var _seekTimer:Timer
_seekUpdateTimeFrameproperty 
protected var _seekUpdateTimeFrame:uint = 30
_setUrlproperty 
protected var _setUrl:String
_stproperty 
protected var _st:SoundTransform
_textDataproperty 
protected var _textData:String
_updateSeekPosproperty 
protected var _updateSeekPos:Boolean
_updateTimerproperty 
protected var _updateTimer:Timer
urlproperty 
url:String  [read-write]

the url of the external asset assignable as either a string representing a url relative to an associated LoadingLocation basePath or as a regular url For alternate domain loading use an associated LoadingLocation assigned via the loadingLocation property and make this url relative to the basePath defined in the LoadingLocation

Implementation
    public function get url():String
    public function set url(value:String):void
_vidproperty 
protected var _vid:Video
_volumeproperty 
protected var _volume:Number = 0.5
volumeproperty 
volume:Number  [read-write]

The volume property lets you set or access the sound volume of the audio component of a VideoStream.
The range of values is 0.0 (no sound) through to 1.0 (full volume).
Defaults to 0.5 .
If the muted property is true then adjusting this value will not automatically unmute the sound, unless the autoUnMute property is set to true.

Implementation
    public function get volume():Number
    public function set volume(value:Number):void

See also

autoUnMute
muted
_waitOneFrameproperty 
protected var _waitOneFrame:Boolean
_wasBitmapAccessibleproperty 
protected var _wasBitmapAccessible:Boolean
_wasStreamingSeekproperty 
protected var _wasStreamingSeek:Boolean
_widthproperty 
protected var _width:uint
_workingUrlproperty 
protected var _workingUrl:String
Constructor detail
VideoStream()constructor
public function VideoStream()

Constructor VideoStream encapsulates the functionality required to support provision of video content in BitmapData format. It provides support for both http progressive video and rtmp streamed video, subject to access permissions to the underlying bitmapdata.

Method detail
clearAllCopyTargets()method
protected function clearAllCopyTargets():void
deregisterCopyTarget()method 
public function deregisterCopyTarget(target:BitmapData, destroyTarget:Boolean = false):voidParameters
target:BitmapData
 
destroyTarget:Boolean (default = false)
pause()method 
public function pause():void

Pauses the video at the current playheadTime.

performSeek()method 
protected function performSeek(to:Number):Boolean

private a protected method for performing the actual seek on the netstream. This is deferred after seek requests to allow for consolidation of multiple seek requests within a short timeframe.

Parameters
to:Number

Returns
Boolean
play()method 
public function play():Boolean

Plays or resumes play of a paused video.

Returns
Boolean
processDisposalQueue()method 
protected static function processDisposalQueue(e:TimerEvent):voidParameters
e:TimerEvent
registerCopyTarget()method 
public function registerCopyTarget(target:BitmapData, colorTransform:ColorTransform = null):void

utility support functions for updating additional bitmapdata copies. Intended for use with alpha target copies. This VideoStream generates bitmapData without alpha channel by default for performance reasons so on2vp6 alpha channel video is currently not supported - will review this based on demand and/or provide a subclass for on2vp6 content with alpha. The original bitmapData can be used as a source for multiple alpha versions, but the bitmapdata frameupdating will become very cpu intensive for multiple simultaneous alpha versions of higher resolution video content or multiple VideoStreams with alpha requests etc. Use with a modicum of common sense.

Parameters
target:BitmapData
 
colorTransform:ColorTransform (default = null)
requestPausedBitmapdataUpdate()method 
public function requestPausedBitmapdataUpdate():void

The letterBoxContent property, if not null, provides a Rectangle instance that defines the VideoStream's letterboxed content. This property is read-only.

See also

flash.geom.Rectangle
resetInternalState()method 
protected function resetInternalState():void
rewind()method 
public function rewind():void

Rewinds and stops the video at the start.

updateErrorStatus()method 
protected function updateErrorStatus(status:String, detail:String, sendEvent:Boolean = true):voidParameters
status:String
 
detail:String
 
sendEvent:Boolean (default = true)
Constant detail
AUDIO_STATUS_UPDATEconstant
public static const AUDIO_STATUS_UPDATE:String = "audioStatusUpdate"
BUFFER_BUFFERINGconstant 
public static const BUFFER_BUFFERING:String = "bufferBuffering"
BUFFER_DIMINISHEDconstant 
public static const BUFFER_DIMINISHED:String = "bufferDiminished"
BUFFER_EMPTYconstant 
public static const BUFFER_EMPTY:String = "bufferEmpty"
BUFFER_FLUSHINGconstant 
public static const BUFFER_FLUSHING:String = "bufferFlushing"
BUFFER_FULLconstant 
public static const BUFFER_FULL:String = "bufferFull"
BUFFER_STATUS_CHANGEconstant 
public static const BUFFER_STATUS_CHANGE:String = "bufferStatusChange"
BUFFER_STATUS_UPDATEconstant 
public static const BUFFER_STATUS_UPDATE:String = "bufferStatusUpdate"
BUFFER_TIME_CHANGEDconstant 
public static const BUFFER_TIME_CHANGED:String = "bufferTimeChanged"
CONNECT_APPSHUTDOWNconstant 
public static const CONNECT_APPSHUTDOWN:String = "NetConnection.Connect.AppShutDown"
CONNECT_CLOSEDconstant 
public static const CONNECT_CLOSED:String = "NetConnection.Connect.Closed"
CONNECT_FAILEDconstant 
public static const CONNECT_FAILED:String = "NetConnection.Connect.Failed"
CONNECT_REJECTEDconstant 
public static const CONNECT_REJECTED:String = "NetConnection.Connect.Rejected"
CONNECT_SUCCESSconstant 
public static const CONNECT_SUCCESS:String = "NetConnection.Connect.Success"
copyPointconstant 
protected static const copyPoint:Point
DISPOSAL_DEFERRALconstant 
protected static const DISPOSAL_DEFERRAL:uint = 35
ERROR_STATUS_CONNECTION_ACCESSconstant 
public static const ERROR_STATUS_CONNECTION_ACCESS:String = "errorConnectionAccess"
ERROR_STATUS_CONTENT_ACCESSconstant 
public static const ERROR_STATUS_CONTENT_ACCESS:String = "errorDataAccess"
ERROR_STATUS_DATA_ACCESSconstant 
public static const ERROR_STATUS_DATA_ACCESS:String = "errorDataAccess"
ERROR_STATUS_NONEconstant 
public static const ERROR_STATUS_NONE:String = "errorNone"
ERROR_STATUS_UPDATEconstant 
public static const ERROR_STATUS_UPDATE:String = "errorUpdate"
_fileTypePrefixesconstant 
protected static const _fileTypePrefixes:Object
HIGHconstant 
public static const HIGH:String = "high"
LETTERBOX_UPDATEconstant 
public static const LETTERBOX_UPDATE:String = "letterBoxUpdate"
LOAD_COMPLETEconstant 
public static const LOAD_COMPLETE:String = "loadComplete"
LOAD_PROGRESSconstant 
public static const LOAD_PROGRESS:String = "loadProgress"
LOAD_STARTconstant 
public static const LOAD_START:String = "loadStart"
LOAD_UDPATEconstant 
public static const LOAD_UDPATE:String = "loadUpdate"
LOWconstant 
public static const LOW:String = "low"
MEDIUMconstant 
public static const MEDIUM:String = "medium"
NONEconstant 
public static const NONE:String = "none"
NON_STREAMINGconstant 
public static const NON_STREAMING:String = "non-streaming"
PLAY_PAUSEDconstant 
public static const PLAY_PAUSED:String = "playPaused"
PLAY_PLAYINGconstant 
public static const PLAY_PLAYING:String = "playPlaying"
PLAY_STATUS_CHANGEDconstant 
public static const PLAY_STATUS_CHANGED:String = "playStatusChanged"
PLAY_STATUS_COMPLETEconstant 
public static const PLAY_STATUS_COMPLETE:String = "playStatusComplete"
PLAY_STATUS_FPS_UPDATEconstant 
public static const PLAY_STATUS_FPS_UPDATE:String = "playStatusFPSupdate"
PLAY_STATUS_RESETconstant 
public static const PLAY_STATUS_RESET:String = "playStatusReset"
PLAY_STATUS_UPDATEconstant 
public static const PLAY_STATUS_UPDATE:String = "playStatusUpdate"
PLAY_STATUS_WAITINGconstant 
public static const PLAY_STATUS_WAITING:String = "playStatusWaiting"
PLAY_STOPPEDconstant 
public static const PLAY_STOPPED:String = "playStopped"
SEEK_NONEconstant 
public static const SEEK_NONE:String = "seekNone"
SEEK_SEEKINGconstant 
public static const SEEK_SEEKING:String = "seekSeeking"
SEEK_STATUS_ENDconstant 
public static const SEEK_STATUS_END:String = "seekStatusEnd"
STATUS_DATA_ERRORconstant 
public static const STATUS_DATA_ERROR:String = "itemDataError"
STATUS_IDENTIFIEDconstant 
public static const STATUS_IDENTIFIED:String = "itemIdentified"
STATUS_INITIALIZINGconstant 
public static const STATUS_INITIALIZING:String = "itemInitializing"
STATUS_LOAD_ERRORconstant 
public static const STATUS_LOAD_ERROR:String = "itemLoadError"
STATUS_PROGRESSconstant 
public static const STATUS_PROGRESS:String = "itemLoadProgress"
STATUS_READYconstant 
public static const STATUS_READY:String = "itemReady"
STATUS_REQUESTEDconstant 
public static const STATUS_REQUESTED:String = "itemRequested"
STATUS_SECURITY_ERRORconstant 
public static const STATUS_SECURITY_ERROR:String = "itemSecurityError"
STATUS_STARTEDconstant 
public static const STATUS_STARTED:String = "itemLoadStarted"
STATUS_WAITINGconstant 
public static const STATUS_WAITING:String = "itemWaiting"
STREAMINGconstant 
public static const STREAMING:String = "streaming"
_streamingProtocolsconstant 
protected static const _streamingProtocols:Array
STREAM_STATUS_LOOPINGconstant 
protected static const STREAM_STATUS_LOOPING:int = 1
STREAM_STATUS_NORMALconstant 
protected static const STREAM_STATUS_NORMAL:int = 0
STREAM_STATUS_REWINDINGconstant 
protected static const STREAM_STATUS_REWINDING:int = 2