com.akamai.net.AkamaiHDNetStream

Public Properties

	Property		Defined By
		analyticsBeacon : String Activates the built-in Akamai Client Side Media Analytics plugin, by specifying the beacon path that the plugin should track against.	HDNetStream
		analyticsPluginLoaderInstance : AnalyticsPluginLoader Use this accessor instead of the analyticsBeacon accessor if you want to add multiple instances of the plugin in the same player.	HDNetStream
		autoRecoverFromTimeout : Boolean Specifies whether the class should automatically try to recover from a timeout.	HDNetStream
		autoSwitch : Boolean Defines whether the class should automatically switch between available bitrates.	HDNetStream
		averagePlaybackBitsPerSecond : Number [read-only] The smoothed and averaged playback bits per second.	HDNetStream
		bandwidthEstimationEnabled : Boolean [read-only] Returns a Boolean value representing whether bandwidth estimation for MBR content at startup is enabled.	HDNetStream
		bufferLength : Number [override] [read-only] Returns the buffer length in seconds	HDNetStream
		bufferTime : Number [override] [Setter is DEPRECATED] Returns the current target buffer time on the netstream.	HDNetStream
		bytesLoaded : uint [override] [read-only] Returns the bytes loaded since the last play request.	HDNetStream
		client : Object [override] Sets the client property of the NetStream.	HDNetStream
		considerDimensionsWhenSwitching : Boolean If enabled, the class will not switch up during multi-bitrate playback if the area that the video is being rendered at is smaller than the the native size of video.	HDNetStream
		cpu : Number [read-only] The system cpu as a percentage.	HDNetStream
		currentIndex : int The current index that is rendering for a MBR object source.	HDNetStream
		currentIndexBitrate : Number [read-only] The bitrate value of the current index,, in kbps.	HDNetStream
		disableAllArchivePlayback : Boolean If set true, this property will prohibit the class from playing back the archive portion of a live stream.	HDNetStream
		displayObject : DisplayObject A reference to any object that participates in the display stack and which has a access to the "stage" property.	HDNetStream
		downloadRatio : Number [read-only] The downloadRatio is the ratio of the rate at which bytes are being downloaded over the rate at which they are being rendered.	HDNetStream
		droppedFPS : Number [read-only] The estimated dropped-frame rate, expressed in Hz.	HDNetStream
		droppedFrames : uint [read-only] Returns the absolute count of dropped frames since the last play request	HDNetStream
		duration : Number [read-only] Returns the duration of the stream in seconds.	HDNetStream
		durationAsTimeCode : String [read-only] Returns the duration of the stream as HH:MM:SS timecode	HDNetStream
		dvrWindow : Number [read-only] Specifies the length of the DVR window, if implemented, in seconds.	HDNetStream
		edgeIP : String Returns the IP address of the Akamai Edge Server to which the client has connected.	HDNetStream
		edgeVersion : String Returns the version of the Akamai Edge Server to which the client has connected.	HDNetStream
		enableAlternateServerMapping : Boolean If there is an issue with the stream at startup or during playback it may be caused by a server condition.	HDNetStream
		enableEndUserMapping : Boolean If you enable this feature and enableAlternateServerMapping is not enabled - enableAlternateServerMapping will be enabled.	HDNetStream
		enableNetSessionDiscovery : Boolean Enables the class to discover the NetSession interface .	HDNetStream
		estimatedCurrentBandwidth : Number [read-only] The estimated current throughput between client and server, expressed in kilobits per second.	HDNetStream
		estimatedMaxbandwidth : Number [read-only] The estimated maximum throughput between client and server, expressed in kilobits per second.	HDNetStream
		estimatedRTT : Number [read-only] The estimated round-trip time between client and server, expressed in milliseconds.	HDNetStream
		isAsleep : Boolean [read-only] eturns whether the flash runtime is in sleep mode.	HDNetStream
		isComplete : Boolean [read-only] True if the stream has ended	HDNetStream
		isLiveStream : Boolean [read-only] Specifies whether the stream playing is "live".	HDNetStream
		isPausedWhileLive : Boolean [read-only] True if the stream has was paused while isPlayingLive was true.	HDNetStream
		isPlayingLive : Boolean [read-only] Specifies whether the the stream is playing at "true" live.	HDNetStream
		isSwitching : Boolean [read-only] Defines whether the class is currently executing a switch.	HDNetStream
		lastThrottleValue : Number [read-only] The last throttle value requested form the server.	HDNetStream
		liveDrift : Number [read-only] For live streams only, the estimated difference between the duration that the class is rendering and the latest duration that the server has, in seconds.	HDNetStream
		loop : Boolean If enabled, once the stream is complete it will loop back and begin playing from the start.	HDNetStream
		maxBufferLength : Number Specifies the maximum buffer length in seconds to allow when a) the class is paused b) single bitrate content is playing c) multi-bitrate content is playing at the highest rendition available.	HDNetStream
		maximizeSingleBitrateBuffers : Boolean Specifies wether the class should set the target buffer to a high value (default is 60s) for non-live single-bitrate content and for non-live multi-bitrate content where you are playing the highest available index.	HDNetStream
		maximumBitrateAllowed : Number When switching multi-bitrate content in auto-mode, this property specifies the maximum stream bitrate, in kbps, that the class is allowed to play.	HDNetStream
		maxIndexAvailable : Number [read-only] The highest index available for the current MBR object.	HDNetStream
		maxIndexAvailableBitrate : Number [read-only] The bitrate value of the highest index that is available, in kbps.	HDNetStream
		maxLiveDriftAllowed : Number [DEPRECATED] The maximum live drift value allowed, in seconds.	HDNetStream
		maxSecondsWithoutData : Number [read-only] The maximum number of seconds that the class has not received data while playing.	HDNetStream
		MBRObject : IMBRObject [read-only] The current IMBRObject instance that the class is playing MBR content, or else null for SBR.	HDNetStream
		netSessionAcceptedEULA : Boolean [read-only] Returns whether the Akamai NetStession client has had its EULA accepted.	HDNetStream
		netSessionClientAvailable : Boolean [read-only] Returns true if the Akamai NetSession client is installed on the client machine.	HDNetStream
		netSessionCpCode : String [write-only] Sets the CP code that the Akamai NetSession client will use.	HDNetStream
		nominalFPS : Number [read-only] The estimated frame rate of the video.	HDNetStream
		playbackKbps : Number [read-only] Returns the playback bitrate of the current stream, in kbps.	HDNetStream
		playerIP : String Returns the IP address of this player.	HDNetStream
		primaryToken : String [write-only] Sets the primaryToken for the class to use to perform EdgeAuthentication against the Akamai network.	HDNetStream
		qualityOfExperience : Number [read-only] 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.	HDNetStream
		reachedTargetBufferFull : Boolean [read-only] True if the stream has reached its target buffer after starting.	HDNetStream
		requiresEdgeAuth : Boolean [DEPRECATED] - this property is maintained only to ensure backwards compatibility.	HDNetStream
		resumeDVRAtLive : Boolean When set to false, if you pause a live stream, the stream will resume playing at the point at which it was paused.	HDNetStream
		secondsUntilBufferEmpties : Number [read-only] The estimated time in seconds until the buffer is empty.	HDNetStream
		soundTransform : SoundTransform [override] Sets the soundTransform object of the stream.	HDNetStream
		source : * [read-only] Returns the source object which the class is currently playing.	HDNetStream
		startingBitrate : Number Sets the max bitrate value you wish to use at startup in kbps.	HDNetStream
		startingBufferTime : Number Setting this value will effect the startup time of the stream.	HDNetStream
		startingIndex : Number The starting index to use when playing MBR content.	HDNetStream
		streamStartTime : Number [read-only] The real world start time of the stream, in milliseconds since midnight January 1, 1970, universal time.	HDNetStream
		streamType : int Returns in integer representing the type of stream content that is currently rendering.	HDNetStream
		time : Number [override] [read-only] Returns the playhead time of the stream in seconds.	HDNetStream
		timeAsTimeCode : String [read-only] Returns the playhead time of the stream as HH:MM:SS timecode	HDNetStream
		tokenService : ITokenService [write-only] Sets the token service that the class will use to request an EdgeAuth token.	HDNetStream
		trueBufferTime : Number [read-only] The raw bufferTime value of the underlying netstream class.	HDNetStream
		useFixedThrottleForSBR : Boolean For single-bite rate content, there can be minimal benefit in constant throttle commands being issued.	HDNetStream
		useVerboseGhostLogs : Boolean [write-only] Toggles use of verbose logging on GHost.	HDNetStream
		volume : Number Sets the volume of the stream.	HDNetStream

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		AkamaiHDNetStream(connection:NetConnection) Constructor	AkamaiHDNetStream
		checkForNetSessionClient():void Checks to see if the Akamai NetSessionClient is installed on this machine.	HDNetStream
		close():void [override] Closes the NeStream and stops all running timers	HDNetStream
		destroy():void Prepares the class instance for deletion by cleaning out objects that may be held in memory.	HDNetStream
		enableMBRIndexStableBuffer(enabled:Boolean = true, observationPeriod:Number, bufferIncrease:Number):void In version v2.5 a feature was added to help stabilize the buffer by increasing it by 10 seconds per index once the index has been playing without a switch for more than 25 seconds.	HDNetStream
		getQoSManager():HDN1QoSManager This is for unit testing only.	HDNetStream
		installNetSessionClient(filename:String = NetSessionInstaller, acceptedEula:Boolean = false, eulaVersion:String = Unknown EULA version):void Installs the Akamai NetSession client with a given filename and optional acceptance of the EULA and specificaiton of the EULA version.	HDNetStream
		isPlayingMBRcontent():Boolean Returns whether or not the class is playing multi-bitrate content.	HDNetStream
		makeTATrequest():void Triggers the class to make a request to the server for an updated TAT time.	HDNetStream
		netSessionAcceptEULA():void Sends a request to the Akamai NetSession client indicating that the user has accepted the EULA.	HDNetStream
		pause():void [override] Pauses the video.	HDNetStream
		play(... args):void [override] Commences playback of content through this netstream.	HDNetStream
		resume():void [override] Resumes playback of paused video.	HDNetStream
		secondsToTimeCode(value:Number):String A utility function for converting seconds into HH:MM:SS timecode.	HDNetStream
		seek(value:Number):void [override] Seek the stream.	HDNetStream
		sendUpdatedStats():void Triggers the class to dispatch an update its stats.	HDNetStream
		setBandwidthEstimationEnabled(enabled:Boolean, bandwidthEstimationPeriodInSeconds:Number = 1):void This method should only be used for MBR content and must be set before calling play.	HDNetStream
		setCurrentIndex(index:Number):void Sets the desired active index for multibitrate content.	HDNetStream
		setRenderedDimensions(valueWidth:Number, valueHeight:Number):void Tells the player what the dimensions of the rendered area for the video.	HDNetStream
		simulateFailbackToPrimaryTimerComplete():void For testing QOS alternate server mapping switch back to primary.	HDNetStream
		simulateForceTimerComplete():void For testing QOS Alternate server mapping force tag	HDNetStream
		updateCurrentRendition():void Triggers the class to dispatch a HDEvent.RENDITION_CHANGE event, which carries information about the current index that is rendering and the max index that is available.	HDNetStream

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
altservermapfailover	Dispatched when the class fails over to the alternate server map.	HDNetStream
archiveplaybackdisabled	Dispatched when the disableAllArchivePlayback property is set true, and the class detects that the user is trying to access a live stream (or a stream that was formerly live) at a point other than true live, which is defined as being within 10s of the latest TAT time returned by the server.	HDNetStream
bandwidth	Dispatched when a new estimate of the maximum bandwidth available between client and server is available from the class.	HDNetStream
complete	Dispatched when stream playback is complete.	HDNetStream
datamessage	Dispatched when the class receives a data message embedded in the stream.	HDNetStream
deadconnection	Dispatched when the class detects that no bytes have been received in 10s following a buffer empty event.	HDNetStream
debug	Contains a debug message.	HDNetStream
dvrwindow	Dispatched when the DVR window is detected or is changed.	HDNetStream
dvrwindowclosed	Dispatched when the player is paused on a live stream with dvr window enabled, and the player slides out of the available dvr window.	HDNetStream
error	Dispatched when this class receives an error from the server.	HDNetStream
failovertortmp	Dispatched when the server informs the client that it must disconnect from the HTTP network and fail-over to the RTMP network.	HDNetStream
failure	Dispatched when a failure event occurs in one of the sub-classes which this class invokes, specifically the HDPrimaryTokenService or the HDController.	HDNetStream
isbuffering	Dispatched when the buffering state of the class changes.	HDNetStream
isLiveStream	Dispatched when the state of the stream switches between live and archive.	HDNetStream
isPlayingLive	Dispatched when the state of the stream switches between playing live and not playing live.	HDNetStream
loop	Dispatched when the stream loops back and plays from the start after completing.	HDNetStream
metadata	Dispatched when a onMetaData callback has been received by the class.	HDNetStream
netsessionclient	Dispatched when the class detects a change in the presence of the Akamai NetSession client.	HDNetStream
netsessioneula	Dispatched when the class detects a change in the EULA status of the Akamai NetSession client.	HDNetStream
netstatus	Returns the NetStatus events.	HDNetStream
pause	Dispatched when the class has been given a pause command.	HDNetStream
play	Dispatched when the class receives a play request.	HDNetStream
progress	The progress event is an update event that is dispatched by the class at 100ms intervals.	HDNetStream
rebuffer	Dispatched after the stream has experienced an unexpected rebuffer event during playback and has successfully re-filled its buffer.	HDNetStream
renditionchange	Dispatched when there is a change in the rendition index that is being rendered.	HDNetStream
resume	Dispatched when the class has been given a resume command.	HDNetStream
rtt	Dispatched when a new estimate of the Round Trip Time between client and server is available from the class.	HDNetStream
seek	Dispatched when the class has been given a seek command.	HDNetStream
sessionid	Dispatched when the class receives a new session ID from the server Data object carries the sessionID as a string.	HDNetStream
sleepModeChange	Dispatched when the Flash Player's sleep mode has changed.	HDNetStream
streamnamechange	Dispatched when there is a change in the stream name being rendered.	HDNetStream
streamnotfound	Dispatched when the stream cannot be found on the server.	HDNetStream
streamnotfoundwhileplaying	Dispatched when the class receives a stream-not-found message from the server during the course of normal playback.	HDNetStream
streamstarttime	Dispatched when the class detects a change in the stream start time.	HDNetStream
streamtypechange	Dispatched when there is a change in the type of stream being rendered.	HDNetStream
switchcomplete	Dispatched when a switch has completed.	HDNetStream
switchfailure	Dispatched when a switch failure has been indicated by the server.	HDNetStream
switchstart	Dispatched when switch has commenced between multi-bitrate renditions.	HDNetStream
timeout	Dispatched when the server times-out the connection due to its being idle past the idle-threshold.	HDNetStream

HDCore Documentation	All Packages \| All Classes \| Index \| Frames No Frames
AkamaiHDNetStream	Properties \| Methods \| Events \| Constants

Package	com.akamai.net
Class	public class AkamaiHDNetStream
Inheritance	AkamaiHDNetStream HDNetStream flash.net.NetStream