Packagecom.akamai.rss
Classpublic class AkamaiBOSSParser
InheritanceAkamaiBOSSParser Inheritance ParserBase Inheritance flash.events.EventDispatcher



Public Properties
 PropertyDefined By
  appName : String
[read-only] The Akamai application name
AkamaiBOSSParser
  author : String
[read-only] The video author attribute.
AkamaiBOSSParser
  bufferTime : Number
[read-only] The buffer time designated for this stream
AkamaiBOSSParser
  clipBegin : String
[read-only] The designated clip start time.
AkamaiBOSSParser
  clipEnd : String
[read-only] The designated clip end time.
AkamaiBOSSParser
  connectAuthParams : String
[read-only] The auth parameter string (auth=xxxx&aifp=yyyy&slist=zzzzz) to be used at connection time.
AkamaiBOSSParser
  copyright : String
[read-only] The video copyright attribute.
AkamaiBOSSParser
  duration : String
[read-only] The stream duration.
AkamaiBOSSParser
  fallbackServerName : String
[read-only] The fallback server name.
AkamaiBOSSParser
  hostName : String
[read-only] The Akamai Hostname, a concatenation of the server and application names
AkamaiBOSSParser
 InheritedisBusy : Boolean
[read-only] Boolean parameter indicating whether the class is already busy loading a file.
ParserBase
  isLive : Boolean
[read-only] Boolean parameter indicating whether the stream is live or not
AkamaiBOSSParser
  keywords : String
[read-only] A list of comma separated keywords to be associated with the video.
AkamaiBOSSParser
  playAuthParams : String
[read-only] The auth parameter string(auth=xxxx&aifp=yyyy&slist=zzzzz) to be used at stream play time.
AkamaiBOSSParser
  protocol : String
[read-only] The requested protocol attribute.
AkamaiBOSSParser
 InheritedrawData : String
[read-only] The raw data string returned by the request.
ParserBase
  secondaryEncoderSrc : String
[read-only] A backup or secondary encoder source.
AkamaiBOSSParser
  serverName : String
[read-only] The Akamai hostname, in the form cpxxxxx.edgefcs.net
AkamaiBOSSParser
  source : String
[read-only] The video source attribute.
AkamaiBOSSParser
  streamName : String
[read-only] The stream name
AkamaiBOSSParser
  title : String
[read-only] The video title attribute.
AkamaiBOSSParser
  versionOfMetafile : String
[read-only] The classification of the metafile type, assuming it has been recognized by the class.
AkamaiBOSSParser
 Inheritedxml : XML
[read-only] The response data as an XML object.
ParserBase
Protected Properties
 PropertyDefined By
 Inherited_busy : Boolean
ParserBase
 Inherited_rawData : String
ParserBase
 Inherited_timeoutTimer : Timer
ParserBase
 Inherited_xml : XML
ParserBase
Public Methods
 MethodDefined By
 Inherited
load(src:String):Boolean
Loads a file and initiates the parsing process.
ParserBase
Events
 Event Summary Defined By
  Dispatched when an error condition has occurred.AkamaiBOSSParser
 InheritedDispatched when the response has been successfully loaded.ParserBase
  Dispatched when the BOSS xml response has been successfully parsed.AkamaiBOSSParser
Public Constants
 ConstantDefined By
  METAFILE_VERSION_I : String = METAFILE_VERSION_I
AkamaiBOSSParser
  METAFILE_VERSION_II : String = METAFILE_VERSION_II
AkamaiBOSSParser
  METAFILE_VERSION_IV : String = METAFILE_VERSION_IV
AkamaiBOSSParser
  VERSION : String = 2.0
AkamaiBOSSParser
Property Detail
appNameproperty
appName:String  [read-only]

The Akamai application name


Implementation
    public function get appName():String
authorproperty 
author:String  [read-only]

The video author attribute. This property is only available with metafile type IV.


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

The buffer time designated for this stream


Implementation
    public function get bufferTime():Number
clipBeginproperty 
clipBegin:String  [read-only]

The designated clip start time. This property is only available with metafile type IV. Note that this value is a string, not a number and it may include the character "s" to indicate seconds e.g 30s.


Implementation
    public function get clipBegin():String
clipEndproperty 
clipEnd:String  [read-only]

The designated clip end time. This property is only available with metafile type IV. Note that this value is a string, not a number and it may include the character "s" to indicate seconds e.g 30s.


Implementation
    public function get clipEnd():String
connectAuthParamsproperty 
connectAuthParams:String  [read-only]


Implementation
    public function get connectAuthParams():String
copyrightproperty 
copyright:String  [read-only]

The video copyright attribute. This property is only available with metafile type IV.


Implementation
    public function get copyright():String
durationproperty 
duration:String  [read-only]

The stream duration. This property is only available with metafile type IV. Note that this value is a string, not a number and it may include the character "s" to indicate seconds e.g 30s.


Implementation
    public function get duration():String
fallbackServerNameproperty 
fallbackServerName:String  [read-only]

The fallback server name. This property is only available with metafile type I.


Implementation
    public function get fallbackServerName():String
hostNameproperty 
hostName:String  [read-only]

The Akamai Hostname, a concatenation of the server and application names


Implementation
    public function get hostName():String
isLiveproperty 
isLive:Boolean  [read-only]

Boolean parameter indicating whether the stream is live or not


Implementation
    public function get isLive():Boolean
keywordsproperty 
keywords:String  [read-only]

A list of comma separated keywords to be associated with the video. This property is only available with metafile type IV.


Implementation
    public function get keywords():String
playAuthParamsproperty 
playAuthParams:String  [read-only]


Implementation
    public function get playAuthParams():String
protocolproperty 
protocol:String  [read-only]

The requested protocol attribute. This property is only available with metafile type IV. Note that a protocol of "rtmp" is the default and implies that port/protocol negotiation should be performed to select the optimum protocol. A protocol value of "rtmpe" implies that the account can only accept "rtmpe" or "rtmpte" connections and any subsequent connection attempts should be limited to just those two protocols.


Implementation
    public function get protocol():String
secondaryEncoderSrcproperty 
secondaryEncoderSrc:String  [read-only]

A backup or secondary encoder source. This property is only available with metafile type IV when isLive is "1" and even then is not required to be present.


Implementation
    public function get secondaryEncoderSrc():String
serverNameproperty 
serverName:String  [read-only]

The Akamai hostname, in the form cpxxxxx.edgefcs.net


Implementation
    public function get serverName():String
sourceproperty 
source:String  [read-only]

The video source attribute. This property is only available with metafile type IV.


Implementation
    public function get source():String
streamNameproperty 
streamName:String  [read-only]

The stream name


Implementation
    public function get streamName():String
titleproperty 
title:String  [read-only]

The video title attribute. This property is only available with metafile type IV.


Implementation
    public function get title():String
versionOfMetafileproperty 
versionOfMetafile:String  [read-only]

The classification of the metafile type, assuming it has been recognized by the class. Possible values are the constants:


Implementation
    public function get versionOfMetafile():String
Event Detail
error Event
Event Object Type: org.openvideoplayer.events.OvpEvent

Dispatched when an error condition has occurred. The event provides an error number and a verbose description of each error.

See also

parsed Event  
Event Object Type: org.openvideoplayer.events.OvpEvent

Dispatched when the BOSS xml response has been successfully parsed.

See also

Constant Detail
METAFILE_VERSION_IConstant
public const METAFILE_VERSION_I:String = METAFILE_VERSION_I

METAFILE_VERSION_IIConstant 
public const METAFILE_VERSION_II:String = METAFILE_VERSION_II

METAFILE_VERSION_IVConstant 
public const METAFILE_VERSION_IV:String = METAFILE_VERSION_IV

VERSIONConstant 
public const VERSION:String = 2.0