| Package | com.degrafa.utilities.external |
| Class | public class VideoStream |
| Inheritance | VideoStream DegrafaObject |
| Property | Defined 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 | ||
![]() | document : Object
The MXML document that created this object.
| DegrafaObject | |
| duration : Number [read-only]
| VideoStream | ||
![]() | enableEvents : 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 | ||
![]() | hasEventManager : Boolean
Tests to see if a EventDispatcher instance has been created for this object.
| DegrafaObject | |
![]() | id : String
The identifier used by document to refer to this object.
| DegrafaObject | |
![]() | isInitialized : 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 | ||
![]() | name : String
The name that refers to this object.
| DegrafaObject | |
![]() | objectBindings : Array | DegrafaObject | |
![]() | parent : 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 | ||
![]() | suppressEventProcessing : 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 | ||
| Property | Defined 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 | ||
![]() | eventDispatcher : 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 | ||
| Method | Defined by | ||
|---|---|---|---|
|
Constructor
VideoStream encapsulates the functionality required to support provision of video content in BitmapData format.
| VideoStream | ||
![]() |
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 | ||
![]() |
dispatchEvent(evt:Event):Boolean
Dispatches an event into the event flow.
| DegrafaObject | |
![]() |
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 | |
![]() |
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
| DegrafaObject | |
![]() |
initChange(property:String, oldValue:Object, newValue:Object, source:Object):void
Helper function for dispatching property changes
| DegrafaObject | |
![]() |
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 | ||
![]() |
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 | ||
![]() |
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 | |
| Method | Defined by | ||
|---|---|---|---|
|
clearAllCopyTargets():void
| VideoStream | ||
|
performSeek(to:Number):Boolean
private
a protected method for performing the actual seek on the netstream.
| VideoStream | ||
|
processDisposalQueue(e:TimerEvent):void
[static]
| VideoStream | ||
|
resetInternalState():void
| VideoStream | ||
|
updateErrorStatus(status:String, detail:String, sendEvent:Boolean = true):void
| VideoStream | ||
| Constant | Defined 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 | ||
| Constant | Defined 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 | ||
| audioCodec | property |
audioCodec:String [read-only]Implementation
public function get audioCodec():String
| _audioDelay | property |
protected var _audioDelay:Number = 0
| autoLoop | property |
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
| autoPlay | property |
autoPlay:Boolean [read-write]Implementation
public function get autoPlay():Boolean
public function set autoPlay(value:Boolean):void
| autoUnMute | property |
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.
public function get autoUnMute():Boolean
public function set autoUnMute(value:Boolean):void
See also
| _basePath | property |
protected var _basePath:String
| _bitmapAccessible | property |
protected var _bitmapAccessible:Boolean
| _bitmapAccessTested | property |
protected var _bitmapAccessTested:Boolean
| _bitmapData | property |
protected var _bitmapData:BitmapData
| bufferIndicator | property |
bufferIndicator:String [read-only]This property can be used as the source for data binding.
Implementation public function get bufferIndicator():String
| _bufferLength | property |
protected var _bufferLength:Number = 0
| bufferLength | property |
bufferLength:Number [read-only]This property can be used as the source for data binding.
Implementation public function get bufferLength():Number
| bufferRatio | property |
bufferRatio:Number [read-only]This property can be used as the source for data binding.
Implementation public function get bufferRatio():Number
| _bufferStatus | property |
protected var _bufferStatus:String = "bufferEmpty"
| bufferStatus | property |
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
| _bufferTime | property |
protected var _bufferTime:Number = 2
| bufferTime | property |
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
| _bufferTimeChange | property |
protected var _bufferTimeChange:Boolean
| _bytesLoaded | property |
protected var _bytesLoaded:Number
| bytesLoaded | property |
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
| _bytesTotal | property |
protected var _bytesTotal:Number
| bytesTotal | property |
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
| _checkLBLimit | property |
protected var _checkLBLimit:uint = 100
| _checkLetterBoxData | property |
protected var _checkLetterBoxData:BitmapData
| clientObj | property |
protected var clientObj:Object
| __connections | property |
protected static var __connections:Object
| content | property |
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.
public function get content():BitmapData
See also
| contentType | property |
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
| _copyTargetCount | property |
protected var _copyTargetCount:uint
| _copyTargets | property |
protected var _copyTargets:Dictionary
| _currentFPS | property |
protected var _currentFPS:Number = 0
| currentFPS | property |
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
| debugMode | property |
debugMode:Boolean [read-write]Implementation
public function get debugMode():Boolean
public function set debugMode(value:Boolean):void
| detectLetterBox | property |
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.
public function get detectLetterBox():Boolean
public function set detectLetterBox(value:Boolean):void
| _disposalQueue | property |
protected static var _disposalQueue:Array
| _disposalTimer | property |
protected static var _disposalTimer:Timer
| _duration | property |
protected var _duration:Number
| duration | property |
duration:Number [read-only]This property can be used as the source for data binding.
Implementation public function get duration():Number
| errorDetail | property |
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
| errorStatus | property |
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
| _forceUpdates | property |
protected var _forceUpdates:Boolean
| forceUpdates | property |
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.
protected function get forceUpdates():Boolean
protected function set forceUpdates(value:Boolean):void
| _height | property |
protected var _height:uint
| _httpCached | property |
protected var _httpCached:Boolean
| _httpConnected | property |
protected static var _httpConnected:Boolean
| _httpNC | property |
protected static var _httpNC:NetConnection
| _implicitLocation | property |
protected var _implicitLocation:LoadingLocation
| instances | property |
protected static var instances:Dictionary
| _invalidated | property |
protected var _invalidated:Boolean
| _isConnected | property |
protected var _isConnected:Boolean
| isLetterBoxed | property |
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
| _isPaused | property |
protected var _isPaused:Boolean = true
| isPaused | property |
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
| _isPlaying | property |
protected var _isPlaying:Boolean
| isPlaying | property |
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
| _isReady | property |
protected var _isReady:Boolean
| _isSeeking | property |
protected var _isSeeking:Boolean
| _latestImage | property |
protected var _latestImage:BitmapData
| _letterBoxChecked | property |
protected var _letterBoxChecked:Boolean
| _letterBoxContent | property |
protected var _letterBoxContent:Rectangle
| letterBoxContent | property |
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
| _letterBoxDetected | property |
protected var _letterBoxDetected:Boolean
| _letterBoxHelper | property |
protected var _letterBoxHelper:Rectangle
| _loadingLocation | property |
protected var _loadingLocation:LoadingLocation
| loadingLocation | property |
loadingLocation:LoadingLocation [read-write]Implementation
public function get loadingLocation():LoadingLocation
public function set loadingLocation(value:LoadingLocation):void
| _maxCurrentSeekablePosition | property |
protected var _maxCurrentSeekablePosition:Number = 0
| _metaData | property |
protected var _metaData:Object
| muted | property |
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
| _nc | property |
protected var _nc:NetConnection
| _ns | property |
protected var _ns:NetStream
| _pixelMargin | property |
protected var _pixelMargin:uint = 1
| pixelMargin | property |
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
| playheadTime | property |
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
| _playheadUpdateInterval | property |
protected var _playheadUpdateInterval:uint = 250
| playheadUpdateInterval | property |
playheadUpdateInterval:uint [read-write]Implementation
public function get playheadUpdateInterval():uint
public function set playheadUpdateInterval(value:uint):void
| _playStatus | property |
protected var _playStatus:String = "playStopped"
| _port | property |
protected var _port:String
| _position | property |
protected var _position:Number = 0
| _protocol | property |
protected var _protocol:String
| quality | property |
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.
public function get quality():String
public function set quality(value:String):void
| _relativeURL | property |
protected var _relativeURL:Boolean
| _requiresMetaData | property |
protected var _requiresMetaData:Boolean
| _reset | property |
protected var _reset:Boolean
| reverseOffset | property |
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.
public function get reverseOffset():Matrix
| _rtmp | property |
protected var _rtmp:Boolean
| _rtmpMonitor | property |
protected var _rtmpMonitor:Boolean
| _rtmpSeekCycle | property |
protected var _rtmpSeekCycle:Boolean
| _rtmpWait | property |
protected var _rtmpWait:Boolean
| seekableTo | property |
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)
public function get seekableTo():Number
| _seekQueue | property |
protected var _seekQueue:Array
| _seekStatus | property |
protected var _seekStatus:String = "seekNone"
| _seekTarget | property |
protected var _seekTarget:Number
| _seekTimer | property |
protected var _seekTimer:Timer
| _seekUpdateTimeFrame | property |
protected var _seekUpdateTimeFrame:uint = 30
| _setUrl | property |
protected var _setUrl:String
| _st | property |
protected var _st:SoundTransform
| _textData | property |
protected var _textData:String
| _updateSeekPos | property |
protected var _updateSeekPos:Boolean
| _updateTimer | property |
protected var _updateTimer:Timer
| url | property |
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
| _vid | property |
protected var _vid:Video
| _volume | property |
protected var _volume:Number = 0.5
| volume | property |
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.
public function get volume():Number
public function set volume(value:Number):void
See also
| _waitOneFrame | property |
protected var _waitOneFrame:Boolean
| _wasBitmapAccessible | property |
protected var _wasBitmapAccessible:Boolean
| _wasStreamingSeek | property |
protected var _wasStreamingSeek:Boolean
| _width | property |
protected var _width:uint
| _workingUrl | property |
protected var _workingUrl:String
| 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.
| 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():voidPauses the video at the current playheadTime.
| performSeek | () | method |
protected function performSeek(to:Number):Booleanprivate 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.
Parametersto:Number |
Boolean |
| play | () | method |
public function play():BooleanPlays or resumes play of a paused video.
ReturnsBoolean |
| processDisposalQueue | () | method |
protected static function processDisposalQueue(e:TimerEvent):voidParameters
e:TimerEvent |
| registerCopyTarget | () | method |
public function registerCopyTarget(target:BitmapData, colorTransform:ColorTransform = null):voidutility 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.
Parameterstarget: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
| resetInternalState | () | method |
protected function resetInternalState():void
| rewind | () | method |
public function rewind():voidRewinds 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) |
| AUDIO_STATUS_UPDATE | constant |
public static const AUDIO_STATUS_UPDATE:String = "audioStatusUpdate"
| BUFFER_BUFFERING | constant |
public static const BUFFER_BUFFERING:String = "bufferBuffering"
| BUFFER_DIMINISHED | constant |
public static const BUFFER_DIMINISHED:String = "bufferDiminished"
| BUFFER_EMPTY | constant |
public static const BUFFER_EMPTY:String = "bufferEmpty"
| BUFFER_FLUSHING | constant |
public static const BUFFER_FLUSHING:String = "bufferFlushing"
| BUFFER_FULL | constant |
public static const BUFFER_FULL:String = "bufferFull"
| BUFFER_STATUS_CHANGE | constant |
public static const BUFFER_STATUS_CHANGE:String = "bufferStatusChange"
| BUFFER_STATUS_UPDATE | constant |
public static const BUFFER_STATUS_UPDATE:String = "bufferStatusUpdate"
| BUFFER_TIME_CHANGED | constant |
public static const BUFFER_TIME_CHANGED:String = "bufferTimeChanged"
| CONNECT_APPSHUTDOWN | constant |
public static const CONNECT_APPSHUTDOWN:String = "NetConnection.Connect.AppShutDown"
| CONNECT_CLOSED | constant |
public static const CONNECT_CLOSED:String = "NetConnection.Connect.Closed"
| CONNECT_FAILED | constant |
public static const CONNECT_FAILED:String = "NetConnection.Connect.Failed"
| CONNECT_REJECTED | constant |
public static const CONNECT_REJECTED:String = "NetConnection.Connect.Rejected"
| CONNECT_SUCCESS | constant |
public static const CONNECT_SUCCESS:String = "NetConnection.Connect.Success"
| copyPoint | constant |
protected static const copyPoint:Point
| DISPOSAL_DEFERRAL | constant |
protected static const DISPOSAL_DEFERRAL:uint = 35
| ERROR_STATUS_CONNECTION_ACCESS | constant |
public static const ERROR_STATUS_CONNECTION_ACCESS:String = "errorConnectionAccess"
| ERROR_STATUS_CONTENT_ACCESS | constant |
public static const ERROR_STATUS_CONTENT_ACCESS:String = "errorDataAccess"
| ERROR_STATUS_DATA_ACCESS | constant |
public static const ERROR_STATUS_DATA_ACCESS:String = "errorDataAccess"
| ERROR_STATUS_NONE | constant |
public static const ERROR_STATUS_NONE:String = "errorNone"
| ERROR_STATUS_UPDATE | constant |
public static const ERROR_STATUS_UPDATE:String = "errorUpdate"
| _fileTypePrefixes | constant |
protected static const _fileTypePrefixes:Object
| HIGH | constant |
public static const HIGH:String = "high"
| LETTERBOX_UPDATE | constant |
public static const LETTERBOX_UPDATE:String = "letterBoxUpdate"
| LOAD_COMPLETE | constant |
public static const LOAD_COMPLETE:String = "loadComplete"
| LOAD_PROGRESS | constant |
public static const LOAD_PROGRESS:String = "loadProgress"
| LOAD_START | constant |
public static const LOAD_START:String = "loadStart"
| LOAD_UDPATE | constant |
public static const LOAD_UDPATE:String = "loadUpdate"
| LOW | constant |
public static const LOW:String = "low"
| MEDIUM | constant |
public static const MEDIUM:String = "medium"
| NONE | constant |
public static const NONE:String = "none"
| NON_STREAMING | constant |
public static const NON_STREAMING:String = "non-streaming"
| PLAY_PAUSED | constant |
public static const PLAY_PAUSED:String = "playPaused"
| PLAY_PLAYING | constant |
public static const PLAY_PLAYING:String = "playPlaying"
| PLAY_STATUS_CHANGED | constant |
public static const PLAY_STATUS_CHANGED:String = "playStatusChanged"
| PLAY_STATUS_COMPLETE | constant |
public static const PLAY_STATUS_COMPLETE:String = "playStatusComplete"
| PLAY_STATUS_FPS_UPDATE | constant |
public static const PLAY_STATUS_FPS_UPDATE:String = "playStatusFPSupdate"
| PLAY_STATUS_RESET | constant |
public static const PLAY_STATUS_RESET:String = "playStatusReset"
| PLAY_STATUS_UPDATE | constant |
public static const PLAY_STATUS_UPDATE:String = "playStatusUpdate"
| PLAY_STATUS_WAITING | constant |
public static const PLAY_STATUS_WAITING:String = "playStatusWaiting"
| PLAY_STOPPED | constant |
public static const PLAY_STOPPED:String = "playStopped"
| SEEK_NONE | constant |
public static const SEEK_NONE:String = "seekNone"
| SEEK_SEEKING | constant |
public static const SEEK_SEEKING:String = "seekSeeking"
| SEEK_STATUS_END | constant |
public static const SEEK_STATUS_END:String = "seekStatusEnd"
| STATUS_DATA_ERROR | constant |
public static const STATUS_DATA_ERROR:String = "itemDataError"
| STATUS_IDENTIFIED | constant |
public static const STATUS_IDENTIFIED:String = "itemIdentified"
| STATUS_INITIALIZING | constant |
public static const STATUS_INITIALIZING:String = "itemInitializing"
| STATUS_LOAD_ERROR | constant |
public static const STATUS_LOAD_ERROR:String = "itemLoadError"
| STATUS_PROGRESS | constant |
public static const STATUS_PROGRESS:String = "itemLoadProgress"
| STATUS_READY | constant |
public static const STATUS_READY:String = "itemReady"
| STATUS_REQUESTED | constant |
public static const STATUS_REQUESTED:String = "itemRequested"
| STATUS_SECURITY_ERROR | constant |
public static const STATUS_SECURITY_ERROR:String = "itemSecurityError"
| STATUS_STARTED | constant |
public static const STATUS_STARTED:String = "itemLoadStarted"
| STATUS_WAITING | constant |
public static const STATUS_WAITING:String = "itemWaiting"
| STREAMING | constant |
public static const STREAMING:String = "streaming"
| _streamingProtocols | constant |
protected static const _streamingProtocols:Array
| STREAM_STATUS_LOOPING | constant |
protected static const STREAM_STATUS_LOOPING:int = 1
| STREAM_STATUS_NORMAL | constant |
protected static const STREAM_STATUS_NORMAL:int = 0
| STREAM_STATUS_REWINDING | constant |
protected static const STREAM_STATUS_REWINDING:int = 2