com.akamai.osmf.utils.AkamaiStrings

	Constant	Defined By
		AKAMAI_ADVANCED_STREAMING_PLUGIN_METADATA_NAMESPACE : String = http://www.akamai.com/advancedstreamingplugin/1.0 [static] The namespace for getting/setting metadata on the plug-in resource and/or a media resource.	AkamaiStrings
		AKAMAI_HDN_METADATA_KEY_DATA : String = akamaiMediaData [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_MEDIA_TYPE_AMD_LIVE : String = akamai-live-streaming [static] Akamai Media Delivery live streaming.	AkamaiStrings
		AKAMAI_MEDIA_TYPE_AMD_ONDEMAND : String = akamai-ondemand-streaming [static] Akamai Media Delivery on-demand streaming.	AkamaiStrings
		AKAMAI_MEDIA_TYPE_AMD_PROGRESSIVE : String = akamai-progressive [static] Akamai Media Delivery progressive download.	AkamaiStrings
		AKAMAI_MEDIA_TYPE_FMS_MBR : String = akamai-multi-bitrate [static] Adobe Flash Media Server multi-bitrate.	AkamaiStrings
		AKAMAI_MEDIA_TYPE_HDN_ADOBE_HTTP : String = akamai-hdn-adobe-http [static] Akamai HD Network Adobe HTTP Dynamic Streaming	AkamaiStrings
		AKAMAI_MEDIA_TYPE_HDN_MBR : String = akamai-hdn-multi-bitrate [static] Akamai HD Network multi-bitrate.	AkamaiStrings
		AKAMAI_MEDIA_TYPE_HDN_SBR : String = akamai-hdn-single-bitrate [static] Akamai HD Network single bitrate stream.	AkamaiStrings
		AKAMAI_MEDIA_TYPE_IGNORE : String = ignore [static] Ignore, meaning the Akamai plugin will ignore the resource and and not try to inspect it or load it.	AkamaiStrings
		AKAMAI_MEDIA_TYPE_UNKNOWN : String [static] Unknown, meaning the type of media cannot be determined.	AkamaiStrings
		AKAMAI_METADATA_KEY_ADD_MANIFEST_QUERY_ARGS_TO_FRAG_REQUESTS : String = addManifestQueryArgsToFragmentRequests [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_CONNECT_AUTH_PARAMS : String = connectAuthParams [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_DISPLAY_OBJECT : String = hdMBRDisplayObject [static] This is a key for a plug-in resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_ENABLE_BEST_EFFORT_DOWNLOAD_ON_FRAGMENT_ERROR : String = enableBestEffortDownloadOnFragmentError [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_ENABLE_LARGE_BUFFERS_FOR_LONG_FORM_CONTENT : String = enableLargeBuffersForLongFormContent [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_ENABLE_LOCAL_SHARED_OBJECT : String = enableLocalSharedObject [static] This is a key for a plugin resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_ENABLE_LOG_STRING_ON_FRAG_REQUESTS : String = enableLogStringOnFragments [static] This is a key for media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_ENABLE_NETSESSION_DISCOVERY : String = enableNetSessionDiscovery [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_FRAG_RETRY_ATTEMPTS : String = fragmentRetryAttemptsForLostConnectivity [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_GENERIC_NETSTREAM_PROPERTIES : String = genericNetStreamProperties [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_GENERIC_NETSTREAM_PROPERTY : String = genericNetStreamProperty [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_HDN1_FORCE_NO_SUBCLIP : String = hdn1ForceNoSubclip [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_HDN2_FORCE_NO_SUBCLIP : String = hdn2ForceNoSubclip [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_HDN2_PREVENT_SWITCHDOWN_ON_DROPPED_FRAMES : String = hdn2PreventSwitchDownOnDroppedFrames [static] Jira HDCORE-133 This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_HOLDBACK_FROM_LIVE : String = holdbackFromLive [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_ITOKEN_SERVICE : String = iTokenService [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_LIMIT_MAX_SWITCHING_INDEX_TO_PLAYER_DIMENSIONS : String = limitMaxSwitchingIndexToPlayerDimensions [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_LIVE_BUFFER_PROFILE : String = liveBufferProfile [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_LIVE_TIMEOUT : String = liveTimeout [static] This is a key for a plug-in resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_MAX_ALLOWED_BITRATE : String = maxAllowedBitrate [static] This is a key for media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_MAX_ALLOWED_INDEX : String = maxAllowedIndex [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_MAX_BUFFER_LENGTH : String = maxBufferLength [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_MBR_STARTING_BITRATE : String = MBRStartingBitrate [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_MBR_STARTING_INDEX : String = MBRStartingIndex [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_MEDIA_TYPE : String = akamaiMediaType [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_MIN_ALLOWED_BITRATE : String = minAllowedBitrate [static] This is a key for media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_NETSESSION_MODE : String = netSessionMode [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_PRELOAD_DECRYPTION_SWF : String = preloadDecryptionSWF [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_PRIMARY_TOKEN : String = primaryToken [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_REQUEST_AMD_LONG_TOKEN : String = requestAMDLongToken [static] Jira HDCORE-141 This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_RESUME_DVR_AT_LIVE : String = resumeDVRAtLive [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_RETRY_INTERVAL : String = retryInterval [static] This is a key for a plug-in resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_RETRY_LIVE : String = retryLive [static] This is a key for a plug-in resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_SET_BANDWIDTH_ESTIMATION_ENABLED : String = setBandwidthEstimationEnabled [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_STARTING_BUFFER_TIME : String = startingBufferTime [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METADATA_KEY_STREAM_AUTH_PARAMS : String = streamAuthParams [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METATDATA_KEY_ENABLE_ALTERNATE_SERVER_MAPPING : String = enableAlternateServerMapping [static] This is a key for a media resource metadata value.	AkamaiStrings
		AKAMAI_METATDATA_KEY_ENABLE_END_USER_MAPPING : String = enableEndUserMapping [static] This is a key for a media resource metadata value.	AkamaiStrings

Constant Detail

AKAMAI_ADVANCED_STREAMING_PLUGIN_METADATA_NAMESPACE

Constant

public static const AKAMAI_ADVANCED_STREAMING_PLUGIN_METADATA_NAMESPACE:String = http://www.akamai.com/advancedstreamingplugin/1.0

The namespace for getting/setting metadata on the plug-in resource and/or a media resource. Here is an example of setting resource metadata in an OSMF-based player:

         private function addMetadata(resource:URLResource):void
         {
                 var metadata:Metadata = resource.getMetadataValue(AkamaiStrings.AKAMAI_ADVANCED_STREAMING_PLUGIN_METADATA_NAMESPACE) as Metadata;
                 if (metadata == null)
                 {
                     metadata = new Metadata();
                 }
         
                 metadata.addValue(AkamaiStrings.AKAMAI_METADATA_KEY_MBR_STARTING_INDEX, 2);
                 resource.addMetadataValue(AkamaiStrings.AKAMAI_ADVANCED_STREAMING_PLUGIN_METADATA_NAMESPACE, metadata);
         }

AKAMAI_HDN_METADATA_KEY_DATA

Constant

public static const AKAMAI_HDN_METADATA_KEY_DATA:String = akamaiMediaData

This is a key for a media resource metadata value.

Use this key to add a data object to the resource as metadata.

AKAMAI_MEDIA_TYPE_AMD_LIVE

Constant

public static const AKAMAI_MEDIA_TYPE_AMD_LIVE:String = akamai-live-streaming

Akamai Media Delivery live streaming.

AKAMAI_MEDIA_TYPE_AMD_ONDEMAND

Constant

public static const AKAMAI_MEDIA_TYPE_AMD_ONDEMAND:String = akamai-ondemand-streaming

Akamai Media Delivery on-demand streaming.

AKAMAI_MEDIA_TYPE_AMD_PROGRESSIVE

Constant

public static const AKAMAI_MEDIA_TYPE_AMD_PROGRESSIVE:String = akamai-progressive

Akamai Media Delivery progressive download.

AKAMAI_MEDIA_TYPE_FMS_MBR

Constant

public static const AKAMAI_MEDIA_TYPE_FMS_MBR:String = akamai-multi-bitrate

Adobe Flash Media Server multi-bitrate.

AKAMAI_MEDIA_TYPE_HDN_ADOBE_HTTP

Constant

public static const AKAMAI_MEDIA_TYPE_HDN_ADOBE_HTTP:String = akamai-hdn-adobe-http

Akamai HD Network Adobe HTTP Dynamic Streaming

AKAMAI_MEDIA_TYPE_HDN_MBR

Constant

public static const AKAMAI_MEDIA_TYPE_HDN_MBR:String = akamai-hdn-multi-bitrate

Akamai HD Network multi-bitrate.

AKAMAI_MEDIA_TYPE_HDN_SBR

Constant

public static const AKAMAI_MEDIA_TYPE_HDN_SBR:String = akamai-hdn-single-bitrate

Akamai HD Network single bitrate stream.

AKAMAI_MEDIA_TYPE_IGNORE

Constant

public static const AKAMAI_MEDIA_TYPE_IGNORE:String = ignore

Ignore, meaning the Akamai plugin will ignore the resource and and not try to inspect it or load it.

AKAMAI_MEDIA_TYPE_UNKNOWN

Constant

public static const AKAMAI_MEDIA_TYPE_UNKNOWN:String

Unknown, meaning the type of media cannot be determined.

AKAMAI_METADATA_KEY_ADD_MANIFEST_QUERY_ARGS_TO_FRAG_REQUESTS

Constant

public static const AKAMAI_METADATA_KEY_ADD_MANIFEST_QUERY_ARGS_TO_FRAG_REQUESTS:String = addManifestQueryArgsToFragmentRequests

This is a key for a media resource metadata value.

This key is for HDS (HDN 2) streams only. The value should be a boolean set to true or false.

See also

com.akamai.net.f4f.AkamaiStreamController.addManifestQueryArgsToFragmentRequests

AKAMAI_METADATA_KEY_CONNECT_AUTH_PARAMS

Constant

public static const AKAMAI_METADATA_KEY_CONNECT_AUTH_PARAMS:String = connectAuthParams

This is a key for a media resource metadata value.

The name-value pairs required for invoking connection authorization services on the Akamai network for RTMP streaming. Typically these include the "auth","aifp" and "slist" parameters. These name-value pairs must be separated by a "&" and should not begin with a "?", "&" or "/". An example of a valid string would be:

auth=dxaEaxdNbCdQceb3aLd5a34hjkl3mabbydbbx-bfPxsv-b4toa-nmtE&aifp=babufp&slist=secure/babutest

This value must be set as content resource metadata, not plug-in resource metadata.

AKAMAI_METADATA_KEY_DISPLAY_OBJECT

Constant

public static const AKAMAI_METADATA_KEY_DISPLAY_OBJECT:String = hdMBRDisplayObject

This is a key for a plug-in resource metadata value.

Use this key to specify a display object in the player. The plug-in will set this display object in the HDCore library to enable player verification. This can be any sprite or movie clip in the player, most commonly the root level sprite, and must be added to the stage by the time you call play on the protected swf.

Here is an example, where pluginResource is simply the URLResource used to load the plugin, and root is the root level MovieClip or Sprite of the player:

         var metadata:Metadata = new Metadata();
         metadata.addValue(AkamaiStrings.AKAMAI_METADATA_KEY_DISPLAY_OBJECT, root);
         pluginResource.addMetadataValue(AkamaiStrings.AKAMAI_ADVANCED_STREAMING_PLUGIN_METADATA_NAMESPACE, metadata);

The simple requirement for the display object passed in is that it is any display class in the player for which the following condition is true:

         myobject.stage.loaderInfo.bytes != null

When trouble-shooting you could trace this out when setting this value to confirm you are passing a valid object reference.

Note: only the player SWF needs to be uploaded to your Akamai account, not the plugin SWF. The only exception to this is for RTMP streaming, since with FMS player verification, it's the code that calls NetConnection.connect() that needs to be uploaded, which would be the plugin SWF.

AKAMAI_METADATA_KEY_ENABLE_BEST_EFFORT_DOWNLOAD_ON_FRAGMENT_ERROR

Constant

public static const AKAMAI_METADATA_KEY_ENABLE_BEST_EFFORT_DOWNLOAD_ON_FRAGMENT_ERROR:String = enableBestEffortDownloadOnFragmentError

This is a key for a media resource metadata value.

This key is for HDS (HDN 2) streams only. The value should be typed as a Boolean.

AKAMAI_METADATA_KEY_ENABLE_LARGE_BUFFERS_FOR_LONG_FORM_CONTENT

Constant

public static const AKAMAI_METADATA_KEY_ENABLE_LARGE_BUFFERS_FOR_LONG_FORM_CONTENT:String = enableLargeBuffersForLongFormContent

This is a key for a media resource metadata value.

This key is for HDS (HDN 2) streams only. The value should be a boolean set to true or false.

See also

com.akamai.net.f4f.AkamaiStreamController.enableLargeBuffersForLongFormContent

AKAMAI_METADATA_KEY_ENABLE_LOCAL_SHARED_OBJECT

Constant

public static const AKAMAI_METADATA_KEY_ENABLE_LOCAL_SHARED_OBJECT:String = enableLocalSharedObject

This is a key for a plugin resource metadata value.

Use this key to specify that the plugin should not read or write Flash Shared Object data. The value should be a Boolean.

AKAMAI_METADATA_KEY_ENABLE_LOG_STRING_ON_FRAG_REQUESTS

Constant

public static const AKAMAI_METADATA_KEY_ENABLE_LOG_STRING_ON_FRAG_REQUESTS:String = enableLogStringOnFragments

This is a key for media resource metadata value.

This key is for HDS (HDN 2) streams only. The value should be a Boolean set to true or false.

See also

com.akamai.net.f4f.AkamaiStreamController.enableLogStringOnFragments

AKAMAI_METADATA_KEY_ENABLE_NETSESSION_DISCOVERY

Constant

public static const AKAMAI_METADATA_KEY_ENABLE_NETSESSION_DISCOVERY:String = enableNetSessionDiscovery

This is a key for a media resource metadata value.

For HDN 1 content only, use this key to enable/disable the discovery of the NetSession interface.

Value should be a Boolean.

AKAMAI_METADATA_KEY_FRAG_RETRY_ATTEMPTS

Constant

public static const AKAMAI_METADATA_KEY_FRAG_RETRY_ATTEMPTS:String = fragmentRetryAttemptsForLostConnectivity

This is a key for a media resource metadata value.

This key is for HDS (HDN 2) streams only. The value should be typed as a Number.

AKAMAI_METADATA_KEY_GENERIC_NETSTREAM_PROPERTIES

Constant

public static const AKAMAI_METADATA_KEY_GENERIC_NETSTREAM_PROPERTIES:String = genericNetStreamProperties

This is a key for a media resource metadata value.

This metadata key is similar to the AKAMAI_METADATA_KEY_GENERIC_NETSTREAM_PROPERTY except this key can be used to set multiple properties.

The value for this metadata key should be an Array of Objects with each Object instance containing the following properties:

propertyName:String - this specifies the property on the NetStream instance.
value:Object - this specifies the value that will be set.

See also

AKAMAI_METADATA_KEY_GENERIC_NETSTREAM_PROPERTY

Constant

public static const AKAMAI_METADATA_KEY_GENERIC_NETSTREAM_PROPERTY:String = genericNetStreamProperty

This is a key for a media resource metadata value.

This metadata key can be used to set a property in the HDCore AS3 library before playback begins. Since OSMF plugins by design do not have an API, this can be very useful for setting properties in the plugin (which is built on HDCore) that are not available via resource metadata. The property is set before the playback begins. The plugin will fail silently if the property does not exist in HDCore. Success or failure of this metadata key will appear in the debug log.

For HDN1 streams, the property will be set on the HDNetStream, see the API documentation for the properties available for HDN1.

for HDS (HDN2) streams, the property will be set on any number of classes within the code base responsible for HDS playback. The best reference for available properties is the AkamaiStreamController class. Most properties on that class should be available via this approach.

The value for this metadata key should be an Object with the following properties:

propertyName:String - this specifies the property on the NetStream instance.
value:Object - this specifies the value that will be set.

AKAMAI_METADATA_KEY_HDN1_FORCE_NO_SUBCLIP

Constant

public static const AKAMAI_METADATA_KEY_HDN1_FORCE_NO_SUBCLIP:String = hdn1ForceNoSubclip

This is a key for a media resource metadata value.

This key is for HDN 1 streams only.

If enabled, the HDNetStream class will not create a sub-clip despite the values it gets from the StreamingURLResource class. The result will be a stream that starts from the clipStartTime supplied to the StreamingURLResource but the entire stream will be seek-able.

The value for this metadata key should be a Boolean.

AKAMAI_METADATA_KEY_HDN2_FORCE_NO_SUBCLIP

Constant

public static const AKAMAI_METADATA_KEY_HDN2_FORCE_NO_SUBCLIP:String = hdn2ForceNoSubclip

This is a key for a media resource metadata value.

This key is for HDN 2 streams only.

If enabled, the AkamaiHTTPNetStream class will not create a sub-clip despite the values it gets from the StreamingURLResource class. The result will be a stream that starts from the clipStartTime supplied to the StreamingURLResource but the entire stream will be seekable.

The value for this metadata key should be a Boolean.

AKAMAI_METADATA_KEY_HDN2_PREVENT_SWITCHDOWN_ON_DROPPED_FRAMES

Constant

public static const AKAMAI_METADATA_KEY_HDN2_PREVENT_SWITCHDOWN_ON_DROPPED_FRAMES:String = hdn2PreventSwitchDownOnDroppedFrames

Jira HDCORE-133 This is a key for a media resource metadata value.

This key is for HDN 2 streams only.

If enabled, 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 metadata namespace will override a recommendation by the OSMF rules to switch down due to dropped frames.

The value for this metadata key should be a Boolean.

AKAMAI_METADATA_KEY_HOLDBACK_FROM_LIVE

Constant

public static const AKAMAI_METADATA_KEY_HOLDBACK_FROM_LIVE:String = holdbackFromLive

This is a key for a media resource metadata value.

For HDS (HDN 2) content only. Used to set the holdbackFromLive setting for limited and unlimited DVR live streams. This setting is valid from 10 secs. and 60 secs. If set outside this boundary, it will be limited to these values.

The value should be a Number.

AKAMAI_METADATA_KEY_ITOKEN_SERVICE

Constant

public static const AKAMAI_METADATA_KEY_ITOKEN_SERVICE:String = iTokenService

This is a key for a media resource metadata value.

Use this key to specify the ActionScript class that implements ITokenService. This is for Akamai HDN 1 content only and sets the token service that the plug-in will use to request an EdgeAuth token. This property is only required when playing content protected by EdgeAuth. The value must be set to a valid instance of an ITokenService before the media is played.

See the HDCore HDN1 token service sample for more information on how the token service works.

See also

com.akamai.hd.ITokenService

AKAMAI_METADATA_KEY_LIMIT_MAX_SWITCHING_INDEX_TO_PLAYER_DIMENSIONS

Constant

public static const AKAMAI_METADATA_KEY_LIMIT_MAX_SWITCHING_INDEX_TO_PLAYER_DIMENSIONS:String = limitMaxSwitchingIndexToPlayerDimensions

This is a key for a media resource metadata value.

This key is for HDS (HDN 2) streams only. The value should be typed as a Boolean.

AKAMAI_METADATA_KEY_LIVE_BUFFER_PROFILE

Constant

public static const AKAMAI_METADATA_KEY_LIVE_BUFFER_PROFILE:String = liveBufferProfile

This is a key for a media resource metadata value.

This key is for HDS (HDN 2) streams only. The value should be one of the constants in the AkamaiBufferProfileType class.

See also

com.akamai.net.f4f.AkamaiStreamController.bufferProfile

AKAMAI_METADATA_KEY_LIVE_TIMEOUT

Constant

public static const AKAMAI_METADATA_KEY_LIVE_TIMEOUT:String = liveTimeout

This is a key for a plug-in resource metadata value.

The RTMP live stream time out in seconds. If the live stream does not start playing within this time, a stream not found error is dispatched. This value overrides the default in AkamaiNetStream.

AKAMAI_METADATA_KEY_MAX_ALLOWED_BITRATE

Constant

public static const AKAMAI_METADATA_KEY_MAX_ALLOWED_BITRATE:String = maxAllowedBitrate

This is a key for media resource metadata value.

Use this key to specify the max allowed bitrate for multi-bitrate content.

The value should be a number in kbps.

AKAMAI_METADATA_KEY_MAX_ALLOWED_INDEX

Constant

public static const AKAMAI_METADATA_KEY_MAX_ALLOWED_INDEX:String = maxAllowedIndex

This is a key for a media resource metadata value.

Use this key to specify the max allowed index for multi-bitrate content.

The value should be an int.

AKAMAI_METADATA_KEY_MAX_BUFFER_LENGTH

Constant

public static const AKAMAI_METADATA_KEY_MAX_BUFFER_LENGTH:String = maxBufferLength

This is a key for a media resource metadata value.

This key is for HDN 1 streams only. The value should be typed as a Number.

AKAMAI_METADATA_KEY_MBR_STARTING_BITRATE

Constant

public static const AKAMAI_METADATA_KEY_MBR_STARTING_BITRATE:String = MBRStartingBitrate

This is a key for a media resource metadata value.

Use this key to specify the starting bitrate for multi-bitrate content. The value should be specified in kilobits per second as a Number.

AKAMAI_METADATA_KEY_MBR_STARTING_INDEX

Constant

public static const AKAMAI_METADATA_KEY_MBR_STARTING_INDEX:String = MBRStartingIndex

This is a key for a media resource metadata value.

Use this key to specify the starting index for multi-bitrate content.

The value should be an int.

AKAMAI_METADATA_KEY_MEDIA_TYPE

Constant

public static const AKAMAI_METADATA_KEY_MEDIA_TYPE:String = akamaiMediaType

This is a key for a media resource metadata value.

Use this key to specify the media type as resource metadata. The value should be one of the constants declared below starting with "AKAMAI_MEDIA_TYPE..." such as AKAMAI_MEDIA_TYPE_FMS_MBR.

AKAMAI_METADATA_KEY_MIN_ALLOWED_BITRATE

Constant

public static const AKAMAI_METADATA_KEY_MIN_ALLOWED_BITRATE:String = minAllowedBitrate

This is a key for media resource metadata value.

Use this key to specify the minimum allowed bitrate for multi-bitrate content.

The value should be a number in kbps.

AKAMAI_METADATA_KEY_NETSESSION_MODE

Constant

public static const AKAMAI_METADATA_KEY_NETSESSION_MODE:String = netSessionMode

This is a key for a media resource metadata value.

For HDS (HDN 2) content only, use this key to indicate the operation mode for NetSession (HDClient) interaction. The various modes are set via the following strings, the value should be one of these:

"opportunistic" - defines the default netsession usage mode whereby the client will try to use NetSession if it is available. This mode will start the stream playing without using NetSession. Once the first buffer.full event is reached, a discovery request will be made to see if NetSession is installed. If it is, then all subsequent requests will be made through NetSession. If it isn't, then normal playback will continue. Selecting this mode while playback is underway will cause the client to immediately test for NetSession. If NetSession is available, then it will start using it.

"never" - defines the netsession usage mode whereby the client will never use NetSession. Selecting this mode before playback starts will cause all requests to be directed directly to the edge server. Selecting this mode while playback is underway will cause the client to immediately stop using NetSession if it is using peer-assisted delivery.

AKAMAI_METADATA_KEY_PRELOAD_DECRYPTION_SWF

Constant

public static const AKAMAI_METADATA_KEY_PRELOAD_DECRYPTION_SWF:String = preloadDecryptionSWF

This is a key for a media resource metadata value.

For HDS (HDN 2) content only, use this key to pre-load the data swf with a metadata key. This sets the API preloadDecryptionSWF in the HDCore model.

The value should be a Boolean.

AKAMAI_METADATA_KEY_PRIMARY_TOKEN

Constant

public static const AKAMAI_METADATA_KEY_PRIMARY_TOKEN:String = primaryToken

This is a key for a media resource metadata value.

Sets the primaryToken for the plug-in to use to perform EdgeAuthentication against the Akamai network. This is for Akamai HDN 1 content only and should not be used with the AKAMAI_METADATA_KEY_ITOKENSERVICE metadata. See the ASDocs for HDCore for more information on how the primary token is used.

AKAMAI_METADATA_KEY_REQUEST_AMD_LONG_TOKEN

Constant

public static const AKAMAI_METADATA_KEY_REQUEST_AMD_LONG_TOKEN:String = requestAMDLongToken

Jira HDCORE-141 This is a key for a media resource metadata value.

This key is for HDN 2 streams only.

If enabled for HDS AMD VoD streams with Token Authentication (live streams not yet supported), HDCore will attempt a long token request for the short token provided as part of the manifest URL. This long token response will be used along with all subsequent fragment requests.

The value for this metadata key should be a String for the manifest URL.

AKAMAI_METADATA_KEY_RESUME_DVR_AT_LIVE

Constant

public static const AKAMAI_METADATA_KEY_RESUME_DVR_AT_LIVE:String = resumeDVRAtLive

This is a key for a media resource metadata value.

For HDS (HDN 2) content only. 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 value should be a Boolean.

AKAMAI_METADATA_KEY_RETRY_INTERVAL

Constant

public static const AKAMAI_METADATA_KEY_RETRY_INTERVAL:String = retryInterval

This is a key for a plug-in resource metadata value.

The RTMP live stream retry interval in seconds. This value overrides the default in AkamaiNetStream.

AKAMAI_METADATA_KEY_RETRY_LIVE

Constant

public static const AKAMAI_METADATA_KEY_RETRY_LIVE:String = retryLive

This is a key for a plug-in resource metadata value.

For RTMP live streams, if the primary and secondary encoders stop (crash), the plug-in will try to restart the stream every AKAMAI_METADATA_KEY_RETRY_INTERVAL seconds. This value overrides the default in AkamaiNetStream.

Valid values are true or false typed as a boolean.

AKAMAI_METADATA_KEY_SET_BANDWIDTH_ESTIMATION_ENABLED

Constant

public static const AKAMAI_METADATA_KEY_SET_BANDWIDTH_ESTIMATION_ENABLED:String = setBandwidthEstimationEnabled

This is a key for a media resource metadata value.

This key is for HDN 1 streams only.

If enabled, the HDNetStream class will make a bandwidth estimate before playback starts, allowing it to select an appropriate starting index. The longer the estimation period, the more accurate the result, but the greater the start delay. The default period is 1s.

The value for this metadata key should be an Object with the following properties:

enabled:Boolean - true to enable this feature, false to disable it.
bandwidthEstimationPeriodInSeconds:Number - Default value is 1 second. If you set this to NaN, the default will be used. Zero is invalid and will be ignored. Increase or decrease this value to change the accuracy of the test. The longer the test is the more accurate the test is. The downside of a longer test is a longer startup time for playback.

AKAMAI_METADATA_KEY_STARTING_BUFFER_TIME

Constant

public static const AKAMAI_METADATA_KEY_STARTING_BUFFER_TIME:String = startingBufferTime

This is a key for a media resource metadata value.

This key is for HDN 1 streams only. The value should be typed as a Number.

AKAMAI_METADATA_KEY_STREAM_AUTH_PARAMS

Constant

public static const AKAMAI_METADATA_KEY_STREAM_AUTH_PARAMS:String = streamAuthParams

This is a key for a media resource metadata value.

The name-value pairs required for invoking stream-level authorization services against streams on the Akamai network for RTMP streaming. Typically these include the "auth" and "aifp" parameters. These name-value pairs must be separated by a "&" and should not begin with a "?", "&" or "/". An example of a valid string would be:

auth=dxaEaxdNbCdQceb3aLd5a34hjkl3mabbydbbx-bfPxsv-b4toa-nmtE&aifp=babufp

This value must be set as content resource metadata, not plug-in resource metadata.

AKAMAI_METATDATA_KEY_ENABLE_ALTERNATE_SERVER_MAPPING

Constant

public static const AKAMAI_METATDATA_KEY_ENABLE_ALTERNATE_SERVER_MAPPING:String = enableAlternateServerMapping

This is a key for a media resource metadata value.

This key enables/disables Alternate Server Mapping for HDN 1 or HDS (HDN 2) content. For information on Alternate Server Mapping please contact your Akamai account representative.

The value should be a Boolean

AKAMAI_METATDATA_KEY_ENABLE_END_USER_MAPPING

Constant

public static const AKAMAI_METATDATA_KEY_ENABLE_END_USER_MAPPING:String = enableEndUserMapping

This is a key for a media resource metadata value.

This key enables/disables End User IP Mapping for HDN 1 or HDS (HDN 2) content. For information on End User IP Mapping please contact your Akamai account representative.

The value should be a Boolean

Fri May 6 2016, 10:06 AM +05:30

HDCore Documentation	All Packages \| All Classes \| Index \| Frames No Frames
AkamaiStrings	Constants

Package	com.akamai.osmf.utils
Class	public class AkamaiStrings
Inheritance	AkamaiStrings Object