Packagetv.ustream.viewer.logic.media
Classpublic class Recorded
InheritanceRecorded Inheritance Media Inheritance Dispatcher Inheritance flash.events.EventDispatcher
Subclasses Channel

The base class of the streaming videos.



Public Properties
 PropertyDefined By
 Inheritedactive : Boolean
[read-only]
Dispatcher
  audio : Boolean
Set and get if the stream should receive audio.
Recorded
  autoPlay : Boolean
Recorded
 Inheritedbrand : String
[read-only] Returns the brand of the stream
Media
  brandId : String
[read-only]
Recorded
  buffer : Number
Recorded
  bufferLength : Number
[read-only]
Recorded
  bufferProgress : Number
[read-only]
Recorded
  bufferStart : Number
[read-only]
Recorded
  bufferTime : Number
[read-only]
Recorded
  duration : Number
[read-only] Returns the duration of the stream, if available.
Recorded
  hasKeyData : Boolean
[read-only]
Recorded
  highlightId : Number
[read-only]
Recorded
 Inheritedmedia : Sprite
[read-only] Returns the sprite that can be used for displaying the given media
Media
  mediaId : String
[read-only]
Recorded
  meta : Object
[read-only] Returns the meta tags of the stream, if available.
Recorded
 Inheritedmodules : ViewerModuleManager
[read-only] A reference to the ViewerModuleManager object.
Media
  muted : Boolean
Sets the muted state of the stream.
Recorded
  offset : Number
[read-only]
Recorded
 InheritedpageUrl : String
[read-only] Tries to extract the url of the page, where the swf has embeded.
Media
  playing : Boolean
A helper getter / setter method to play / pause the stream.
Recorded
  progress : Number
[read-only] Returns the current playing progress of the stream.
Recorded
  progressive : Boolean
[read-only]
Recorded
  seekTo : Number
[write-only] Seeks the stream to the received time.
Recorded
  sessionId : String
[read-only]
Recorded
  smooth : Boolean
Sets the smoothing of the stream.
Recorded
  streamBounds : Rectangle
[read-only]
Recorded
  streamRect : Rectangle
[read-only]
Recorded
  takeover : Boolean
Recorded
  time : Number
[read-only] Returns the current time of the stream.
Recorded
 Inheritedtitle : String
[read-only] Returns the title of the stream.
Media
  url : String
[override] [read-only]
Recorded
  video : Boolean
Set and get if the stream should receive video.
Recorded
  volume : Number
Sets the volume of the stream.
Recorded
Protected Properties
 PropertyDefined By
 Inherited_active : Boolean = true
Dispatcher
  application : String
Recorded
  _backupVolume : Number
Recorded
  _buffer : Number = 5
Recorded
  campaignId : String
Recorded
  _duration : Number
Recorded
  _hasKeyData : Boolean = false
Recorded
  _highlightId : Number
Recorded
  hostBrandId : String = null
Recorded
  idValidator : IdValidator
[static]
Recorded
  inplay : Generic_IP
Recorded
  keyBytes : Array
Recorded
  keyTimes : Array
Recorded
  layers : Sprite
Recorded
  _muted : Boolean = false
Recorded
  quantcast : Quantcast
Recorded
  reConnect : Boolean = false
Recorded
  rejected : Boolean = false
Recorded
  _sessionId : String
Recorded
  shared : Shared
Recorded
  snapActive : Boolean
[read-only]
Recorded
  stats : StreamStats
Recorded
  streamId : Number
Recorded
  streamOwner : Connection
Recorded
  streamStatus : String
Recorded
  _takeover : Boolean = false
Recorded
  _volume : Number = 1
Recorded
  w84keys : Boolean = false
Recorded
  w84ModulesLock : Boolean = false
Recorded
Public Methods
 MethodDefined By
  
Recorded(id:String, autoPlay:Boolean = true, password:String = null, sessionId:String = null, application:String = null, args:Object = null)
Recorded
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override]
Dispatcher
  
destroy(... e):*
[override]
Recorded
 Inherited
dispatchEvent(event:Event):Boolean
[override]
Dispatcher
 Inherited
Dispatcher
  
pause(... e):void
Pauses the stream.
Recorded
  
play(... e):void
Plays the stream
Recorded
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override]
Dispatcher
  
seek(percent:Number, bufferOnly:Boolean = false, forceJump:Boolean = false):Boolean
Seeks to the received percent of the stream.
Recorded
 Inherited
setEchoPrefix(str:String):void
Dispatcher
  
pauses or resumes playback of a stream
Recorded
  
pauses or resumes playback of a stream
Recorded
Protected Methods
 MethodDefined By
  
Recorded
  
Recorded
  
connect():void
Recorded
  
Recorded
  
createModules(... e):void
Recorded
 Inherited
dispatch(eventName:String, bubbles:Boolean = false, data:* = null):void
Dispatches the event, if the class is active.
Dispatcher
 Inherited
echo(what:String):void
Dispatcher
  
getSnapUrl():String
Recorded
  
Recorded
  
jump(index:int):void
Recorded
  
Recorded
  
onCreateMeta(... e):void
Recorded
  
onEmbedLimitReached(... e):Boolean
Recorded
  
Recorded
  
onGwCallFailed(... e):void
Recorded
  
onLockerResize(... e):void
[override]
Recorded
  
onPassword(... e):void
Recorded
  
onPlayTimer(evtX:TimerEvent):void
Recorded
  
onPostRollDone(... e):void
Recorded
  
onPpvGoFree(e:Event = null):void
Recorded
  
Recorded
  
onRejected(reason:*, rejectUrl:String = null):void
Recorded
  
onStreamFinish(... e):void
Recorded
  
Recorded
  
Recorded
  
resizeAd():void
Recorded
  
streamInfo(info:Object):void
Recorded
 Inherited
updateLogoPos(... e):void
Media
Events
 Event Summary Defined By
  The stream's audio streaming property has changed.Recorded
  The stream has connected and playing.Recorded
 InheritedDispatcher
  Looking for the channelRecorded
  The stream has ended.Recorded
  The channel has been foundRecorded
  This is a progressive flv file, not a real stream from a media server.Recorded
  The video has a highlighted momentRecorded
  The stream's muted property has changed.Recorded
  Recorded
  The stream's video streaming property has changed.Recorded
Property Detail
_backupVolumeproperty
protected var _backupVolume:Number

_bufferproperty 
protected var _buffer:Number = 5

_durationproperty 
protected var _duration:Number

_hasKeyDataproperty 
protected var _hasKeyData:Boolean = false

_highlightIdproperty 
protected var _highlightId:Number

_mutedproperty 
protected var _muted:Boolean = false

_sessionIdproperty 
protected var _sessionId:String

_takeoverproperty 
protected var _takeover:Boolean = false

_volumeproperty 
protected var _volume:Number = 1

applicationproperty 
protected var application:String

audioproperty 
audio:Boolean

Set and get if the stream should receive audio.


Implementation
    public function get audio():Boolean
    public function set audio(value:Boolean):void
autoPlayproperty 
autoPlay:Boolean


Implementation
    public function get autoPlay():Boolean
    public function set autoPlay(value:Boolean):void
brandIdproperty 
brandId:String  [read-only]


Implementation
    public function get brandId():String
bufferproperty 
buffer:Number


Implementation
    public function get buffer():Number
    public function set buffer(value:Number):void
bufferLengthproperty 
bufferLength:Number  [read-only]


Implementation
    public function get bufferLength():Number
bufferProgressproperty 
bufferProgress:Number  [read-only]


Implementation
    public function get bufferProgress():Number
bufferStartproperty 
bufferStart:Number  [read-only]


Implementation
    public function get bufferStart():Number
bufferTimeproperty 
bufferTime:Number  [read-only]


Implementation
    public function get bufferTime():Number
campaignIdproperty 
protected var campaignId:String

durationproperty 
duration:Number  [read-only]

Returns the duration of the stream, if available.


Implementation
    public function get duration():Number
hasKeyDataproperty 
hasKeyData:Boolean  [read-only]


Implementation
    public function get hasKeyData():Boolean
highlightIdproperty 
highlightId:Number  [read-only]


Implementation
    public function get highlightId():Number
hostBrandIdproperty 
protected var hostBrandId:String = null

idValidatorproperty 
protected static var idValidator:IdValidator

inplayproperty 
protected var inplay:Generic_IP

keyBytesproperty 
protected var keyBytes:Array

keyTimesproperty 
protected var keyTimes:Array

layersproperty 
protected var layers:Sprite

mediaIdproperty 
mediaId:String  [read-only]


Implementation
    public function get mediaId():String
metaproperty 
meta:Object  [read-only]

Returns the meta tags of the stream, if available.


Implementation
    public function get meta():Object
mutedproperty 
muted:Boolean

Sets the muted state of the stream.


Implementation
    public function get muted():Boolean
    public function set muted(value:Boolean):void
offsetproperty 
offset:Number  [read-only]


Implementation
    public function get offset():Number
playingproperty 
playing:Boolean

A helper getter / setter method to play / pause the stream. Through setting this property you can control the stream with only one method instead of two different methods.


Implementation
    public function get playing():Boolean
    public function set playing(value:Boolean):void
progressproperty 
progress:Number  [read-only]

Returns the current playing progress of the stream.


Implementation
    public function get progress():Number
progressiveproperty 
progressive:Boolean  [read-only]


Implementation
    public function get progressive():Boolean
quantcastproperty 
protected var quantcast:Quantcast

reConnectproperty 
protected var reConnect:Boolean = false

rejectedproperty 
protected var rejected:Boolean = false

seekToproperty 
seekTo:Number  [write-only]

Seeks the stream to the received time.


Implementation
    public function set seekTo(value:Number):void
sessionIdproperty 
sessionId:String  [read-only]


Implementation
    public function get sessionId():String
sharedproperty 
protected var shared:Shared

smoothproperty 
smooth:Boolean

Sets the smoothing of the stream.


Implementation
    public function get smooth():Boolean
    public function set smooth(value:Boolean):void
snapActiveproperty 
snapActive:Boolean  [read-only]


Implementation
    protected function get snapActive():Boolean
statsproperty 
protected var stats:StreamStats

streamBoundsproperty 
streamBounds:Rectangle  [read-only]


Implementation
    public function get streamBounds():Rectangle
streamIdproperty 
protected var streamId:Number

streamOwnerproperty 
streamOwner:Connection


Implementation
    protected function get streamOwner():Connection
    protected function set streamOwner(value:Connection):void
streamRectproperty 
streamRect:Rectangle  [read-only]


Implementation
    public function get streamRect():Rectangle
streamStatusproperty 
streamStatus:String


Implementation
    protected function get streamStatus():String
    protected function set streamStatus(value:String):void
takeoverproperty 
takeover:Boolean


Implementation
    public function get takeover():Boolean
    public function set takeover(value:Boolean):void
timeproperty 
time:Number  [read-only]

Returns the current time of the stream.


Implementation
    public function get time():Number
urlproperty 
url:String  [read-only] [override]


Implementation
    public function get url():String
videoproperty 
video:Boolean

Set and get if the stream should receive video.


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

Sets the volume of the stream.


Implementation
    public function get volume():Number
    public function set volume(value:Number):void
w84keysproperty 
protected var w84keys:Boolean = false

w84ModulesLockproperty 
protected var w84ModulesLock:Boolean = false

Constructor Detail
Recorded()Constructor
public function Recorded(id:String, autoPlay:Boolean = true, password:String = null, sessionId:String = null, application:String = null, args:Object = null)



Parameters
id:String
 
autoPlay:Boolean (default = true)
 
password:String (default = null)
 
sessionId:String (default = null)
 
application:String (default = null)
 
args:Object (default = null)
Method Detail
addAlertToDisplayParent()method
protected function addAlertToDisplayParent():void

comScoreBeacon()method 
protected function comScoreBeacon():void

connect()method 
protected function connect():void

createConviva()method 
protected function createConviva():void

createModules()method 
protected function createModules(... e):void

Parameters

... e

destroy()method 
override public function destroy(... e):*

Parameters

... e

Returns
*
getSnapUrl()method 
protected function getSnapUrl():String

Returns
String
handleRejectAlert()method 
protected function handleRejectAlert(d:*):void

Parameters

d:*

jump()method 
protected function jump(index:int):void

Parameters

index:int

onAlertClick()method 
protected function onAlertClick():void

onCreateMeta()method 
protected function onCreateMeta(... e):void

Parameters

... e

onEmbedLimitReached()method 
protected function onEmbedLimitReached(... e):Boolean

Parameters

... e

Returns
Boolean
onFmsRejected()method 
protected function onFmsRejected(e:DynamicEvent):void

Parameters

e:DynamicEvent

onGwCallFailed()method 
protected function onGwCallFailed(... e):void

Parameters

... e

onLockerResize()method 
override protected function onLockerResize(... e):void

Parameters

... e

onPassword()method 
protected function onPassword(... e):void

Parameters

... e

onPlayTimer()method 
protected function onPlayTimer(evtX:TimerEvent):void

Parameters

evtX:TimerEvent

onPostRollDone()method 
protected function onPostRollDone(... e):void

Parameters

... e

onPpvGoFree()method 
protected function onPpvGoFree(e:Event = null):void

Parameters

e:Event (default = null)

onPpvGoPaid()method 
protected function onPpvGoPaid(e:DynamicEvent):void

Parameters

e:DynamicEvent

onRejected()method 
protected function onRejected(reason:*, rejectUrl:String = null):void

Parameters

reason:*
 
rejectUrl:String (default = null)

onStreamFinish()method 
protected function onStreamFinish(... e):void

Parameters

... e

onViewerLimitReached()method 
protected function onViewerLimitReached(... e):void

Parameters

... e

pause()method 
public function pause(... e):void

Pauses the stream.

Parameters

... e

play()method 
public function play(... e):void

Plays the stream

Parameters

... e

ppvMergeGwResult()method 
protected function ppvMergeGwResult():void

resizeAd()method 
protected function resizeAd():void

seek()method 
public function seek(percent:Number, bufferOnly:Boolean = false, forceJump:Boolean = false):Boolean

Seeks to the received percent of the stream.

Parameters

percent:Number
 
bufferOnly:Boolean (default = false)
 
forceJump:Boolean (default = false)

Returns
Boolean
streamInfo()method 
protected function streamInfo(info:Object):void

Parameters

info:Object

toggleMuted()method 
public function toggleMuted():void

pauses or resumes playback of a stream

togglePlaying()method 
public function togglePlaying():void

pauses or resumes playback of a stream

Event Detail
audio Event
Event Object Type: flash.events.Event

The stream's audio streaming property has changed. ( The broadcaster has enabled / disabled the audio )

createStream Event  
Event Object Type: flash.events.Event

The stream has connected and playing.

find Event  
Event Object Type: flash.events.Event

Looking for the channel

finish Event  
Event Object Type: flash.events.Event

The stream has ended.

found Event  
Event Object Type: flash.events.Event

The channel has been found

getProgressive Event  
Event Object Type: flash.events.Event

This is a progressive flv file, not a real stream from a media server.

hasHighlight Event  
Event Object Type: tv.ustream.tools.DynamicEvent

The video has a highlighted moment

muted Event  
Event Object Type: flash.events.Event

The stream's muted property has changed. ( The broadcaster muted / unmuted the stream )

progress Event  
Event Object Type: flash.events.ProgressEvent

video Event  
Event Object Type: flash.events.Event

The stream's video streaming property has changed. ( The broadcaster has enabled / disabled the video )