Package com.akamai.amp.analytics.adobeheartbeat

Class AdobeHeartbeat

java.lang.Object

com.akamai.amp.analytics.adobeheartbeat.AdobeHeartbeat

public class AdobeHeartbeat
extends java.lang.Object

This class is the Builder in charge of creating instances of the AmpAdobeHeartbeatAnalyticsTracker based on the info provided. It also provides extra functionality unrelated to each analytics session, as well as important constant values.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_AD_BREAK_NAME	Default ad break name
static java.lang.String	EXTERNAL_SDK	Name of the Third party Analytics
static java.lang.String	KEY_ASSET_NAME	Deprecated.
static java.lang.String	KEY_LIVE_STREAM	Key live stream.
static java.lang.String	KEY_MEDIA_FRIENDLY_NAME	Key media name
static java.lang.String	KEY_MEDIA_ID	Key media Id
static java.lang.String	KEY_VIDEO_ID	Deprecated.
static java.lang.String	VERSION	Current version of the player.

Constructor Summary

Constructors

Constructor	Description
AdobeHeartbeat()

Method Summary

Modifier and Type	Method	Description
static AmpAdobeHeartbeatAnalyticsTracker	create(HeartbeatData data)	Method builder used to create a new instance of the AmpAdobeHeartbeatAnalyticsTracker.
static AmpAdobeHeartbeatAnalyticsTracker	create(VideoPlayerView videoPlayerView, HeartbeatData data)	Method builder used to create a new instance of the AmpAdobeHeartbeatAnalyticsTracker.
static java.util.TimeZone	getTimeZone()	It provides the current timezone.
static void	setTimeZone(java.util.TimeZone tz)	This method sets the current timezone for the tracker to use when needed.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VERSION

public static final java.lang.String VERSION

Current version of the player.

See Also:

Constant Field Values

EXTERNAL_SDK

public static final java.lang.String EXTERNAL_SDK

Name of the Third party Analytics

See Also:

Constant Field Values

KEY_MEDIA_ID

public static final java.lang.String KEY_MEDIA_ID

Key media Id

See Also:

Constant Field Values

KEY_MEDIA_FRIENDLY_NAME

public static final java.lang.String KEY_MEDIA_FRIENDLY_NAME

Key media name

See Also:

Constant Field Values

KEY_VIDEO_ID

@Deprecated
public static final java.lang.String KEY_VIDEO_ID

Deprecated.

This attribute is deprecated, please use KEY_MEDIA_ID instead.

See Also:

Constant Field Values

KEY_ASSET_NAME

@Deprecated
public static final java.lang.String KEY_ASSET_NAME

Deprecated.

This attribute is deprecated, please use KEY_MEDIA_FRIENDLY_NAME instead.

See Also:

Constant Field Values

KEY_LIVE_STREAM

public static final java.lang.String KEY_LIVE_STREAM

Key live stream.

See Also:

Constant Field Values

DEFAULT_AD_BREAK_NAME

public static final java.lang.String DEFAULT_AD_BREAK_NAME

Default ad break name

See Also:

Constant Field Values

Constructor Details

AdobeHeartbeat

public AdobeHeartbeat()

Method Details

create

public static AmpAdobeHeartbeatAnalyticsTracker create(HeartbeatData data)

Method builder used to create a new instance of the AmpAdobeHeartbeatAnalyticsTracker.

Parameters:

data - an instance of the HeartbeatData needed to start the analytics session.

create

public static AmpAdobeHeartbeatAnalyticsTracker create(VideoPlayerView videoPlayerView,
HeartbeatData data)

Method builder used to create a new instance of the AmpAdobeHeartbeatAnalyticsTracker.

Parameters:

videoPlayerView - reference of the VideoPlayerView being used for the playback.

data - an instance of the HeartbeatData needed to start the analytics session.

getTimeZone

public static java.util.TimeZone getTimeZone()

It provides the current timezone.

Returns:

an instance of the current TimeZone

setTimeZone

public static void setTimeZone(java.util.TimeZone tz)

This method sets the current timezone for the tracker to use when needed.

Parameters:

tz - reference of the current TimeZone