| Package | tv.ustream.viewer.logic.media |
| Class | public class Channel |
| Inheritance | Channel  Recorded Media Dispatcher flash.events.EventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
 | active : Boolean [read-only] | Dispatcher | |
| audio : Boolean
Set and get if the stream should receive audio. | Recorded | |
| autoPlay : Boolean | Recorded | |
| brand : String [read-only]
Returns the brand of the stream
| Media | |
| brandId : String [read-only] | Recorded | |
| buffer : Number [override] | Channel | ||
| bufferLength : Number [read-only] | Recorded | |
| bufferProgress : Number [read-only] | Recorded | |
| bufferStart : Number [read-only] | Recorded | |
| bufferTime : Number [read-only] | Recorded | |
| cdngw : Boolean = true [static] | Channel | ||
| channels : Array [static] [read-only] | Channel | ||
| duration : Number [read-only]
Returns the duration of the stream, if available. | Recorded | |
| featured : Boolean [read-only] | Channel | ||
| hasKeyData : Boolean [read-only] | Recorded | |
| highlightId : Number [read-only] | Recorded | |
| media : 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 | |
| modules : ViewerModuleManager [read-only]
A reference to the ViewerModuleManager object. | Media | |
| muted : Boolean [override]
Mutes the channel, and every layers on it. | Channel | ||
| offset : Number [read-only] | Recorded | |
| online : Boolean [read-only] | Channel | ||
| pageUrl : String [read-only]
Tries to extract the url of the page, where the swf has embeded. | Media | |
| playing : Boolean [override]
Toggles the playing state of the stream and it's layers. | Channel | ||
| preferredCdn : String [static] | Channel | ||
| 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 | |
| title : String [read-only]
Returns the title of the stream. | Media | |
| url : String [override] [read-only]
Returns the channel's page url. | Channel | ||
| video : Boolean
Set and get if the stream should receive video. | Recorded | |
| volume : Number [override]
Sets the volume of the channel. | Channel | ||
| Property | Defined By | ||
|---|---|---|---|
| _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 | |
| p2pFallBack : Boolean = false | Channel | ||
| p2pForce : Boolean | Channel | ||
| p2pHash : String | Channel | ||
| 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 [override] | Channel | ||
| streamStatus : String [override] | Channel | ||
| _takeover : Boolean = false | Recorded | |
| _volume : Number = 1 | Recorded | |
| w84keys : Boolean = false | Recorded | |
| w84ModulesLock : Boolean = false | Recorded | |
| Method | Defined By | ||
|---|---|---|---|
Channel(id:String, autoPlay:Boolean = true, password:String = null, sessionId:String = null, application:String = null, args:Object = null)
Constructor. | Channel | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override] | Dispatcher | |
destroy(... e):* [override]
Destroys the current channel. | Channel | ||
| dispatchEvent(event:Event):Boolean [override] | Dispatcher | |
| eliminateEventListeners():void | Dispatcher | |
| pause(... e):void
Pauses the stream. | Recorded | |
play(... e):void [override]
Plays the stream. | Channel | ||
| 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 | |
| setEchoPrefix(str:String):void | Dispatcher | |
| toggleMuted():void
pauses or resumes playback of a stream
| Recorded | |
| togglePlaying():void
pauses or resumes playback of a stream
| Recorded | |
| Method | Defined By | ||
|---|---|---|---|
| addAlertToDisplayParent():void | Recorded | |
| comScoreBeacon():void | Recorded | |
connect():void [override] | Channel | ||
| createConviva():void | Recorded | |
createModules(... e):void [override] | Channel | ||
| dispatch(eventName:String, bubbles:Boolean = false, data:* = null):void
Dispatches the event, if the class is active. | Dispatcher | |
| echo(what:String):void | Dispatcher | |
| getSnapUrl():String | Recorded | |
| handleRejectAlert(d:*):void | Recorded | |
| jump(index:int):void | Recorded | |
| onAlertClick():void | Recorded | |
| onCreateMeta(... e):void | Recorded | |
| onEmbedLimitReached(... e):Boolean | Recorded | |
onFmsRejected(e:DynamicEvent):void [override] | Channel | ||
| onGwCallFailed(... e):void | Recorded | |
onGwResult(result:Object):void [override] | Channel | ||
| onLockerResize(... e):void [override] | Recorded | |
| onPassword(... e):void | Recorded | |
| onPlayTimer(evtX:TimerEvent):void | Recorded | |
onPostRollDone(... e):void [override] | Channel | ||
onPpvGoFree(e:Event = null):void [override] | Channel | ||
onPpvGoPaid(e:DynamicEvent):void [override] | Channel | ||
| onRejected(reason:*, rejectUrl:String = null):void | Recorded | |
| onStreamFinish(... e):void | Recorded | |
| onViewerLimitReached(... e):void | Recorded | |
ppvMergeGwResult():void [override] | Channel | ||
| resizeAd():void | Recorded | |
| streamInfo(info:Object):void | Recorded | |
| updateLogoPos(... e):void | Media | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| The stream's audio streaming property has changed. | Recorded | ||
| The stream has connected and playing. | Recorded | ||
| Dispatcher | |||
| Looking for the channel | Recorded | ||
| The stream has ended. | Recorded | ||
| The channel has been found | Recorded | ||
| This is a progressive flv file, not a real stream from a media server. | Recorded | ||
| The video has a highlighted moment | Recorded | ||
| The stream's muted property has changed. | Recorded | ||
| The channel is offline | Channel | |||
| The channel is online | Channel | |||
| The channel is password protected, and no password provided. | Channel | |||
| Recorded | |||
| The stream's video streaming property has changed. | Recorded | ||
| buffer | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesbuffer:Number[override] public function get buffer():Number public function set buffer(value:Number):void| cdngw | property |
public static var cdngw:Boolean = true| channels | property |
channels:Array [read-only] public static function get channels():Array| featured | property |
featured:Boolean [read-only] public function get featured():Boolean| muted | property |
muted:Boolean[override] Mutes the channel, and every layers on it.
public function get muted():Boolean public function set muted(value:Boolean):void| online | property |
online:Boolean [read-only] public function get online():Boolean| p2pFallBack | property |
protected var p2pFallBack:Boolean = false| p2pForce | property |
protected var p2pForce:Boolean| p2pHash | property |
protected var p2pHash:String| playing | property |
playing:Boolean[override] Toggles the playing state of the stream and it's layers.
public function get playing():Boolean public function set playing(value:Boolean):void| preferredCdn | property |
public static var preferredCdn:String| streamOwner | property |
streamOwner:Connection[override] protected function get streamOwner():Connection protected function set streamOwner(value:Connection):void| streamStatus | property |
streamStatus:String[override] protected function get streamStatus():String protected function set streamStatus(value:String):void| url | property |
url:String [read-only] [override] Returns the channel's page url.
public function get url():String| volume | property |
volume:Number[override] Sets the volume of the channel.
public function get volume():Number public function set volume(value:Number):void| Channel | () | Constructor |
public function Channel(id:String, autoPlay:Boolean = true, password:String = null, sessionId:String = null, application:String = null, args:Object = null)Constructor. Creates a channel for the given channel ID. If the autoPlay parameter set to false, the channel won't start, only show a snapshot. If the channel password protected, and password provided, it will connect with that password.
Parametersid:String | |
autoPlay:Boolean (default = true) | |
password:String (default = null) | |
sessionId:String (default = null) | |
application:String (default = null) | |
args:Object (default = null) |
| connect | () | method |
override protected function connect():void| createModules | () | method |
override protected function createModules(... e):voidParameters
... e |
| destroy | () | method |
override public function destroy(... e):*Destroys the current channel.
Parameters
... e |
* —
|
| onFmsRejected | () | method |
| onGwResult | () | method |
override protected function onGwResult(result:Object):voidParameters
result:Object |
| onPostRollDone | () | method |
override protected function onPostRollDone(... e):voidParameters
... e |
| onPpvGoFree | () | method |
override protected function onPpvGoFree(e:Event = null):voidParameters
e:Event (default = null) |
| onPpvGoPaid | () | method |
| play | () | method |
override public function play(... e):voidPlays the stream.
Parameters
... e |
| ppvMergeGwResult | () | method |
override protected function ppvMergeGwResult():void| offline | Event |
flash.events.EventThe channel is offline
| online | Event |
flash.events.EventThe channel is online
| password | Event |
flash.events.EventThe channel is password protected, and no password provided.