The current index being downloaded.

If set true, then any query args attached to the manifest request will be added to all subsequent fragment requests. Default value is true.

Indicates whether or not an alternative audio stream switch is currently in progress. This property will return true while an audio stream switch has been requested and the switch has not yet been acknowledged and no switch failure has occurred. Once the switch request has been acknowledged or a failure occurs, the property will return false.

Activates the built-in Akamai Client Side Media Analytics (CSMA) plugin, by specifying the beacon path the plugin should track against. To turn-off the tracking after enabling it, pass the empty string ("") as the value. This property greatly simplifies integration with CSMA, by only requiring this single point of activation.

The beacon path is something you would obtain from your Akamai CSMA account manager after you have established a CSMA account.

The default value is true.

This function can be used to set an explicit instance of AnalyticsPluginLoader class which is created in the player. This is useful with the integrating of pre-roll advertisements.

Pan property of the media. Ranges from -1 (full pan left) to 1 (full pan right).

If the media does not have audio, then the pan property will be set to this value as soon as the media has audio.

Indicates whether the media starts playing right away after calling the play method and as soon as the media has been loaded. The default is true.

See also

Indicates whether media is returned to the beginning after playback completes. If true, when playback completes, the player displays the first frame of the media. If false, when playback completes, the last frame is displayed. The default is true. The autoRewind property is ignored if the loop property is set to true.

Returns the bandwidth estimate, in kbps, averaged over the last 2 segments. The bandwidth property gives the bandwidth estimated over the last downloaded fragment.

The estimated bandwidth, in kbps, over which the last fragment was downloaded. Only holds a meaningful value of the first fragment has been fully downloaded.

Value of the buffer length when live playback ends. This returns the amount of content still left in the buffer, when live streaming stops or in case the encoder ends abruptly.

Two different buffer profiles can be set:

• AkamaiBufferProfileTypes.LIVE_LOW_LATENCY - provides the lowest "hand-waving latency" possible.
• AkamaiBufferProfileTypes.LIVE_STABLE (default) - provides a more stable buffer.

See also

Indicates whether the media can be paused.

Indicates whether the media is seekable.

Sets the captionType on the streamController for intended captioning.

See also

Takes a URL to the supported caption format used for closed captioning. You can listen for the events TimelineMetadataEvent.MARKER_TIME_REACHED and TimelineMetadataEvent.MARKER_DURATION_REACHED dispatched from this class. The captionType is ideally set before setting the captionURL on the controller. Depending on the captionType and captionURL set, the appropriate captioning plugin is loaded by HDCore.

See also

The index of the alternative audio stream currently in use. Returns the 0-based index of the selected stream, or -1 if no stream is selected.

The currently rendered index.

Interval between the dispatch of the TimeEvent.CURRENT_TIME_CHANGE event in milliseconds.

The default is 250 milliseconds. A non-positive value disables the dispatch of the time change events.

[DEPRECATED] - this property is maintained only to ensure backwards compatibility. Use 'captionType' and 'captionURL' instead to set the type and URL for a caption. Takes a URL to the DFXP content file used for closed captioning. You can listen for the events TimelineMetadataEvent.MARKER_TIME_REACHED and TimelineMetadataEvent.MARKER_DURATION_REACHED dispatched from this class.

See also

Registers an instance of any display object with the NetStream. This property must be set before play is called against a resource that will implement player verification.

The ratio of the time it took to download the last fragment to the duration of video held within that fragment. Only holds a meaningful value of the first fragment has been fully downloaded.

Returns the end date for the playback window. Returns null if authentication hasn't taken place or if if hasDRM is false.

Returns the length of the playback window, in seconds. Returns NaN if authentication hasn't taken place or if hasDRM is false. Note that this property will generally be the difference between startDate and endDate, but is included as a property because there may be times where the duration is known up front, but the start or end dates are not (e.g. a one week rental).

Returns the start date for the playback window. Returns null if authentication hasn't taken place or if hasDRM is false.

The current state of the DRM for the media. The states are explained in the DRMState enumeration in the org.osmf.drm package. Returns DRMState.UNINITIALIZED if hasDRM is false.

Duration of the media's playback, in seconds.

Returns the current duration as an absolute value, the time in seconds since midnight UTC, Jan 1 1970. Note - this property only has meaning for live streams, or streams which were once live. The streambaseTime property must be >0 for this property to have meaning. A value of NaN will be returned if streambaseTime is 0.

A string value denoting the dvr availability mode of the current stream. This can be one of the DVR_AVAILABILITY types found in AkamaiStreamType.

See also

Returns the effective bitrate of the last fragment loaded, in kbps. The effective bitrate represents the size of the last fragment divided by the play time it represents. For CBR encoded content, this should be close to the target bitrate for the current rendition. if it is different from the target bitrate bitrate, then it indicates that VBR encoding is being encountered. Note that the last fragment loaded is not the fragment currently playing. The two are separated by the current buffer length.

Enables an Akamai feature called Alternate Server Mapping which can provide improved performance when edge servers are slow to respond to fragment requests.

If enableBestEffortDownloadOnFragmentError is set to true, stream reconnect logic is initiated after unsuccessful attempts of fragment retry due to IOError or Data Gap. Best effort attempts are made to download the next valid fragment ahead of the current invalid fragment. Value: Boolean Default: True

Enables an Akamai feature called End User IP Mapping which can provide improved performance by mapping a user to the closest edge server possible.

If set true, then large buffer targets of 60s (for intermediate bitrates) and 300s (for max bitrates) are used for long form content, defined as any VOD stream having a duration longer than 10min.

Setting to true (the default value) allows Akamai to store data in a Flash Shared Object (a Flash cookie). Setting to false means Akamai will not read or write data from/to any Flash Shared Object.

The default value is true.

A log string is usually appended to each fragment request, allowing QoS stats to be collected on the server. If you are trying to cache the fragments within a network, then you can turn off the "als" query arg by setting this property to false.

The default value is true.

Returns true if the current stream is encrypted with Akamai Media Encryption

The number of times the class will retry a fragment when all client connectivity has been lost. The default is 60.

We measure the time it takes from the initial request until we receive the first byte of data per fragment download. If we exceed this value we consider it a timeout and move onto the retry logic for the fragment. If Alternate Server Mapping / End User IP Mapping is enabled, this value will only apply if playing on alternate server for fragment retry logic and will be overridden by the value delivered in the Ident.xml if playing on primary host. The default is 20 seconds. We suggest not setting this value below 5 seconds. Anything below 20 seconds is more aggressive and may result in more stream not found errors. A higher value may result in more rebuffers.

See also

Indicates whether the media has alternative audio streams or not.

Indicates whether the media has audio.

Returns true if the media is DRM protected.

Use this property to set the holdback value from live point for limited-DVR and unlimited DVR live streams with a LIVE_STABLE buffer profile. This value needs to be in the range of 10 - 60 secs. It defaults to 10 secs and will be reset to that value for No DVR streams.

If set true, the netstream is in a buffering state.

Returns true if the media is DVR-enabled and currently recording, false if the media is either not DVR-enabled, or is DVR-enabled but not currently recording.

Indicates whether the media consists of a dynamic stream.

Specifies whether the current stream is live or not

Returns true if the stream is paused and false if not.

Indicates whether the media is currently playing.

Specifies whether the stream is within bounds (60s) of the live point.

Indicates whether the media is currently seeking.

Indicates whether or not a dynamic stream switch is currently in progress. This property will return true while a switch has been requested and the switch has not yet been acknowledged and no switch failure has occurred. Once the switch request has been acknowledged or a failure occurs, the property will return false.

CR 3087291 By setting the limitMaxSwitchingIndexToPlayerDimensions boolean to true, the player can limit the maximum allowed index to a video height that does not exceed the player dimensions. Rendering content of a higher resolution usually requires downsizing to fit to player dimensions. This can sometimes introduce artifacts when the content has a lot of text, for example. By limiting stream index dimensions to the embedded player height, downsizing can be avoided, if preferred. If there was a previous maxAllowedIndex setting, it will still apply as the max value for an index chosen through this setting. Value: Boolean Default: False

Indicates whether the media should play again after playback has completed. The loop property takes precedence over the autoRewind property, so if loop is set to true, the autoRewind property is ignored.

The default is false.

Indicates whether or not the media will automatically switch between dynamic streams. If in manual mode the switchTo method can be used to manually switch to a specific stream.

The default is false.

The max allowed index in the current rendition set. Returns -1 if this property has not been set.

See also

When fragment download fails due to IOError or data gap, the fragment retry logic kicks in. Following maximum unsuccessful retry attempts, if enableBestEffortDownloadOnFragmentError is set to true, HDCore will try to download the next valid forward fragment, with this value representing the number of such attempts. The default value is 10.

When switching multi-bitrate content in auto switching mode, this property specifies the maximum stream bitrate in kbps the class is allowed to play. Even if the class finds a very high estimated bandwidth, it will only allow itself to play the highest rendition which is <= this value. If you set this property to a value lower than that currently playing, the class will switch down to satisfy this requirement. If you set it to a value that is lower than the lowest bitrate, it will still play that lowest bitrate.

Intrinsic height of the media, in pixels. The intrinsic height is the height of the media before any processing has been applied. The default if no Display Object is present, is NaN.

Intrinsic width of the media, in pixels. The intrinsic width is the width of the media before any processing has been applied. The default if no Display Object is present, is NaN.

When switching multi-bitrate content in auto switching mode, this property specifies the minimum stream bitrate in kbps for the content. NOTE: If setting this value along with the maximumBitrateAllowed setting, insure that this value is less than the maximum bitrate value by at least one index. For example: max bitrate = 2000 min bitrate = 1500 Make sure that the bitrate range includes a playable index. This is a one time setting that will prune the media items from the manifest that have bitrates less than the corresponding minimum index. These will not be available thereafter in the currently loaded stream.

Indicates whether the media is currently muted.

If the media does not have audio then the muted state will be set to this value as soon as the media has audio.

Sets the operation mode for NetSession (HDClient) interaction. The various modes are set via static string constants available in AkamaiNetSessionType.

Returns the current instance of the NetStream class. Use AkamaiHDSEvent.NETSTREAM_READY event listen to when the netstream is ready.

The total number of dynamic stream indices.

CR 3087291 This property operates only when the limitMaxSwitchingIndexToPlayerDimensions property is set to true. Set the player dimensions on the controller as an object. The object should have two member variables, "width" representing the width of the embedded player and "height" representing the height of the embedded player. This API should ideally be used on every resize event. This insures the right target switching index is chosen if the limitMaxSwitchingIndexToPlayerDimensions property is set. Example: var dimensions:Object = new Object(); dimensions.width = playerWidth; dimensions.height = playerHeight; //For HDCore: streamController.playerDimensions = dimensions; For AASP: (netStream as AkamaiHTTPNetStream).hdsproperties.playerDimensions = dimensions;

Set this to true if you know you are playing encrypted media and would like to start playback as fast as possible. Setting to true will bypass the need to wait for encryption to be detected and will automaticlly download the decryption.swf at startup.

The default value is false.

Jira HDCore-133 Jira HDCORE-128 If this property is set, the HDS DroppedFPSRule will not force an emergency switchdown in the requested fragments. Frame dropping is usually observed on switching between tabs. Setting this property on the stream controller will override a recommendation by the OSMF rules to switch down due to dropped frames.

The quality of experience metric is a single number (with a range of 0-100) which attempts to sum up the quality of the playback experience. It updates constantly throughout a playback session. Much like your GPA was used to represent your ability at school, so the QoE metric attempts to characterize the playback expereince which the user is receiving. It takes bandwidth, switching, rebuffers and framedrops in to account.

See also

Returns a URL of the media file. String is only valid after the play method has been called.

Used to determine how a resume is handled after a "Limited DVR" stream is paused beyond the DVR Window. If this property is false (the default value), the stream would resume at the start of DVR Window. If this property is true, the stream would resume at live. (Similar to No DVR). This can be used in cases where Limited DVR with very small DVR Window is used and you want the user to resume at live after a pause.

The rolling end offset, in seconds. This defines a rolling window of allowable play time behind the live point of a live stream.

Returns the bitrate of the stream in case of single bitrate stream. The value is in kbps.

Returns the server IP address once the stream is playing.

Sets the max bitrate value you wish to use at startup in kbps. The index chosen will be the largest index whose total bitrate is smaller than or equal to this value. This property must be set before play() is called. Note that the bitrate value used is the sum of the video and audio, so if a rendition is labeled as "_700" its true bandwidth may be 786kbps. It's generally good practice then to specify a starting bitrate a N kbps or so higher than the bitrate you intend to target, where N is the max audio bitrate you are using. If you set both startingIndex and startingBitrate, startingIndex will be used. Set it to NaN to turn it off after setting it.

The starting index to use when playing multi-bitrate content. This index is zero-based.

Returns the type of the stream. This can be one of the AKAMAI_STREAM_TYPE_ in the AkamaiStreamType class

See also

Indicates whether the media is temporal. Temporal media supports a duration and a currentTime within that duration.

Current time of the playhead in seconds.

Returns the current playhead time as an absolute value, the time in seconds since midnight UTC, Jan 1 1970. Note - this property only has meaning for live streams, or streams which were once live. For Akamai version 1 manifest the streambaseTime property must be >0 for this property to have meaning. A value of NaN will be returned if streambaseTime is 0.

Returns the total number of alternative audio streams or 0 if there are no alternative audio streams present.

Returns true if the class is currently using NetSession to request fragments.

Returns an estimate of the degree of VBR (variable bitrate encoding) encountered in the current content. For CBR encoded content, this value should be 1. For VBR content with a floor of 30% and peak of 500% (where 100% represents the target bitrate), then this value should range from 0.3 to 5.0.

Volume of the media. Ranges from 0 (silent) to 1 (full volume).

Constructor.

Calls AnalyticsPluginLoader.setData with the key/value pair provided to the method. You can call this before or after calling the analyticsBeacon setter property. See the "Media Analytics Plug-in Integration Guide for Adobe Flash Players" for more information on the AnalyticsPluginLoader.setData method.

Parameters

See also

Authenticates the media. Can be used for both anonymous and credential-based authentication under Adobe Flash Access. Listen for the requiresUsernamePassword event to know if user/pass info is required for this content.

Parameters

Authenticates the media using an object which serves as a token. Can be used for both anonymous and credential-based authentication with Adobe Flash Access. Can be String or ByteArray. If a String is provided, the token will be automatically created at the proper time and set on the drmService. You can call this anytime before play is called with a String. If you are manually creating the token externally as an Object, you must not call this method until the event AkamaiHDSEvent.DRM_AUTHENTICATING has been dispatched.

Parameters

See also

Cleans up the class completely. A new instance of this class is required after calling this method. You should set your instance to null immediately after calling this method.

Returns the time in seconds since midnight UTC, Jan 1 1970, corresponding to the input number of relative seconds. The input should be a time value in seconds relative to the current start time and play duration boundaries (if any). This method is used to enable a scrub bar to show absolute time while being scrubbed. It should be used in conjunction with the timeAsUTC and durationAsUTC properties which give the playhead and max duration as UTC time respectively

Note - this property only has meaning for live streams, or streams which were once live.

Parameters

Obtains the alternative audio stream corresponding to the specified (0-based) index. Returns null if the index is -1.

Parameters

Gets the associated bitrate, in kilobytes for the specified dynamic stream index.

Parameters

Returns the name of a stream at the index value supplied only after play has been called and only if is dynamic stream, Otherwise it returns null.

Parameters

Pauses the media, if it is not already paused.

The play method initiates playback of a piece of media. Three arguments are supported:

1. source - required - a String resource pointing at a valid f4m manifest containing Adobe HTTP Dynamic Streaming content.
2. start time - optional - a Number indicating the desired start time of the clip in seconds. For example, if the duration of the media is 100s and a start time of 20 is supplied, the class will play a sub-clip of the original content, starting at time 20 and going to 100. The duration property for the class will show 80 and the playhead time will increase from 0 to 80. If the start time value supplied is > 1262304000, then it will be interpreted automatically as an absolute start request - i.e it should specify the start time as the time in seconds since midnight UTC, Jan 1 1970. Only live streams and archivesof live streams can support this type of absolute start time. Note that for any LIVE or ARCHIVED LIVE stream you should always specify the start time using a UTC value and not a relative one.
   The start time argument -1 is supported. It implies that a live stream only can be played. If -1 is supplied and the manifest turns out to represent recorded playback then the stream will immediately end.
   Note that use of startTime always creates a sub-clip. It is not possible to start a stream at 20 and still give the user access to the portion from 0-20. For that use case, you should call play(src) and then issue a seek(20) as soon as you receive the AkamaiHDSEvent.NETSTREAM_READY event or the isPlaying property returns true.
3. play duration - optional - a Number indicating the desired play duration in seconds. For example if the parent stream is 100s long and the start parameter is 20 and the play duration parameter is 30, then a subclip of duration 30 will be created, containing content from time 20 to time 50 of the parent stream. The playhead time will start at 0 and will increase to 30 during playback. Play duration will also work in conjunction with absolute start times. For example, if you called play(src,1316132030,30), it would play the live stream (or live stream archive) identified by src, starting at unix time 1316132030, for 30 seconds.
   The negative argument -1 is supported. It means that the stream will play through to its normal end and is functionally equivalent to omitting this argument entirely.
   If a play duration of 0 is specified, it will cause the stream to seek to the time specified by the start time parameter and then stop, essentially creating a thumbnail at that time. This works with relative start times for VOD streams as well as absolute times for live streams. Note that the stop may not be immediate and the stream may render for a few seconds before stopping. This is due to the fact that there is no rendering event for the NetStream and we cannot be sure when an image is actually visible to the end-user. Therefore the class is conservative and allows it to play for a brief period of time in order to guarantee an image across all OS/browser combinations.

Parameters

Jira HDCORE-141 Set the requestAMDLongToken property to true if the HDS stream is of AMD VoD type and token authentication is activated in the SecureHD policy. AMD Live is currently not supported and may be supported in the future. Setting to true will create and make a request for the long token to be appended to future AMD fragment requests.

Parameters

Resumes the media from a paused state.

Instructs the playhead to jump to the specified time.

If time is NaN or negative, does not attempt to seek.

Parameters

Immediately halts playback and returns the playhead to the beginning of the media file.

Changes the current audio stream to the alternative audio stream specified by a 0-based index value. Passing -1 as the index value resets the current audio stream to the default audio stream. Note that if media playback is paused, the audio stream switch does not occur until after play resumes.

Parameters

Switch to a specific dynamic stream index. To switch up, use the currentIndex property.

Parameters

See also

A utility method which converts seconds into TimeCode.

Parameters

Unloads the media completely, requiring a new call to the play method.

Dispatched when the long token request for an AMD VoD stream returns with a valid response body.

Dispatched when a stream has played to completion.

Dispatched when a DRM protected stream requires a token to authenticate.

See also

Dispatched when an error which impacts the operation of media playback occurs. The data object contains an org.osmf.events.MediaError object.

Dispatched when the hasAlternativeAudio property has changed.

See also

Dispatched with the HTTP status code of each fragment before a complete/error. Contains following properties: - status : The HTTP status code - url : The URL of request

Dispatched when the buffering state of the media changes. The data object is a Boolean.

Dispatched after the stream has been loaded and determined to be a live stream.

Dispatched when the isPlayingLive property changes state.

Dispatched when the currentTime property of the MediaElement associated with this TimelineMetadata has reached the duration offset of one of the TimelineMarkers in this TimelineMetadata.

Dispatched when the currentTime property of the MediaElement associated with this TimelineMetadata has reached the time value of one of the TimelineMarkers in this TimelineMetadata.

Dispatched when the netStream property is ready for use (meaning it will return a non-null object). There is no payload with this event, it is simply a notifier event.

Dispatched during the life of the stream with an interval of 100ms. Like a heart-beat indicating the stream is active.

Dispatched when a DRM protected stream requires a username and password to authenticate.

     private function onRequiresPassword(event:Event):void
     {
             // Since the stream get's re-loaded after authentication, you will need to listen
             // for the AkamaiHDSEvent.NETSTREAM_READY event and re-attach the
             // NetStream object to the video object.
             streamController.addEventListener(AkamaiHDSEvent.NETSTREAM_READY, onNetStreamReady);
     
             // ... Prompt the user for username and password ...
             getUsernamePassword();
     
             // Authenticate
         streamController.authenticate(userInput.text, passwordInput.text);
     }
     

See also

Dispatched when stream duration has been determined. The data property will be the stream length.

For dynamic streaming, indicates the switch is complete and is visible to the user. The data object for the event will contain:

• data.renderingIndex; // the index of the switching profile that is currently rendering.
• data.renderingBitrate; // the bitrate of the currently rendering stream.

For dynamic streaming, dispatched when either a manual switch has been requested or a switching rule has requested a switch to a new index. The data object for the event will contain these items:

• data.targetIndex; // The index we are trying to switch to.
• data.streamName; // The stream name we are trying to switch to.
• data.firstPlay; // True if this is the initial play request for the dynamic streaming profile.