| Package | com.akamai.hd |
| Class | public class HDMBRObject |
| Inheritance | HDMBRObject  Object |
| Implements | IMBRObject2 |
| Property | Defined By | ||
|---|---|---|---|
| clipBegin : Number
For sub-clip support, specifies in seconds
where playback should begin. | HDMBRObject | ||
| clipEnd : Number
For sub-clip support, specifies in seconds
when playback should end. | HDMBRObject | ||
| httpBase : String
The base component of the HTTP URL for each stream. | HDMBRObject | ||
| primaryToken : String
A primary token to be set in HDNetStream to
enable secure playback. | HDMBRObject | ||
| rtmpPlaybackBase : String
The URI pointing to the FMS application from which the player can playback the streams over rtmp
after it has been instructed to fail-over. | HDMBRObject | ||
| streamCount : int
The number of streams in the package. | HDMBRObject | ||
| streams : Array
Returns the array of stream/bitrate objects. | HDMBRObject | ||
| title : String
The title of the package
| HDMBRObject | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor for HDMBRObject
| HDMBRObject | ||
addStream(streamName:String, bitRate:Number, width:Number = 0, height:Number = 0):void
Adds a stream and bitrate pair to the DynamicStreamItem object
| HDMBRObject | ||
getHeightAt(index:Number):Number
Returns the height of a given index in pixels. | HDMBRObject | ||
getNameAt(index:Number):String
Returns the stream name at a given index. | HDMBRObject | ||
getRateAt(index:Number):Number
Returns the bitrate of a given index in kbps. | HDMBRObject | ||
getWidthAt(index:Number):Number
Returns the width of a given index in pixels. | HDMBRObject | ||
setDimensionsAt(index:Number, width:Number, height:Number):void
Used to associate width and height properties with a given index
| HDMBRObject | ||
| clipBegin | property |
clipBegin:NumberFor sub-clip support, specifies in seconds where playback should begin. This is an offset in seconds from the beginning of the stream.
public function get clipBegin():Number public function set clipBegin(value:Number):void| clipEnd | property |
clipEnd:Number
For sub-clip support, specifies in seconds
when playback should end. Supplying a value
of -1 will play the remainder
of the clip.
public function get clipEnd():Number public function set clipEnd(value:Number):void| httpBase | property |
httpBase:StringThe base component of the HTTP URL for each stream. It should always end with a trailing slash. An example would be
http://customer.edgesuite.net/
public function get httpBase():String public function set httpBase(value:String):void| primaryToken | property |
primaryToken:StringA primary token to be set in HDNetStream to enable secure playback.
public function get primaryToken():String public function set primaryToken(value:String):void| rtmpPlaybackBase | property |
rtmpPlaybackBase:StringThe URI pointing to the FMS application from which the player can playback the streams over rtmp after it has been instructed to fail-over. This property is not required unless you intend to build a player which can fail over to the same content on a RTMP network. An example would be:
rtmp://cp56789.live.edgefcs.net/live
public function get rtmpPlaybackBase():String public function set rtmpPlaybackBase(value:String):void| streamCount | property |
streamCount:intThe number of streams in the package. It is possible for a HDMBRObject to hold only one stream, in which case playback will be single-bitrate rather than multi-bitrate.
public function get streamCount():int public function set streamCount(value:int):void| streams | property |
streams:ArrayReturns the array of stream/bitrate objects. Each object has the following properties:
| Property name | Description |
|---|---|
| name | the name of the stream, for example event_angle_bitrate@12345 |
| bitrate | the bitrate of the rendition, in kbps. (not the bits per second as used in most SMIL files) |
| width | the native width of the stream in pixels if known, otherwise 0 |
| height | the native height of the stream in pixels if known, otherwise 0 |
public function get streams():Array public function set streams(value:Array):void| title | property |
title:StringThe title of the package
public function get title():String public function set title(value:String):void| HDMBRObject | () | Constructor |
public function HDMBRObject()Constructor for HDMBRObject
| addStream | () | method |
public function addStream(streamName:String, bitRate:Number, width:Number = 0, height:Number = 0):voidAdds a stream and bitrate pair to the DynamicStreamItem object
Parameters
streamName:String | |
bitRate:Number — in kbps
| |
width:Number (default = 0) | |
height:Number (default = 0) |
| getHeightAt | () | method |
public function getHeightAt(index:Number):NumberReturns the height of a given index in pixels. THis value needs to have been explicitly set via the setDimensionsAt() method. If the height is unknown, zero will be returned.
Parameters
index:Number |
Number |
| getNameAt | () | method |
public function getNameAt(index:Number):StringReturns the stream name at a given index.
Parameters
index:Number |
String |
| getRateAt | () | method |
public function getRateAt(index:Number):NumberReturns the bitrate of a given index in kbps.
Parameters
index:Number |
Number |
| getWidthAt | () | method |
public function getWidthAt(index:Number):NumberReturns the width of a given index in pixels. THis value needs to have been explicitly set via the setDimensionsAt() method. If the width is unknown, zero will be returned.
Parameters
index:Number |
Number |
| setDimensionsAt | () | method |
public function setDimensionsAt(index:Number, width:Number, height:Number):voidUsed to associate width and height properties with a given index
Parameters
index:Number | |
width:Number | |
height:Number |