com.adobe.primetime.va.simple

Class MediaHeartbeat

java.lang.Object

com.adobe.primetime.va.simple.MediaHeartbeat

public class MediaHeartbeat
extends java.lang.Object

MediaSDK public API class.

Version:

2.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaHeartbeat.AdMetadataKeys These constant strings define standard metadata keys for ads.
static class	MediaHeartbeat.AudioMetadataKeys These constant strings define standard metadata keys for audio content.
static class	MediaHeartbeat.Event These enumeration values define the type of a tracking event
static interface	MediaHeartbeat.MediaHeartbeatDelegate Interface defining protocol for fetching regular playhead updates and QoS values from media player.
static class	MediaHeartbeat.MediaObjectKey These constant strings define media/ad info keys used for MediaObject.
static class	MediaHeartbeat.MediaType These enumeration values define the type of media
static class	MediaHeartbeat.StreamType These constant strings define the stream type of the main content that is currently tracked.
static class	MediaHeartbeat.VideoMetadataKeys These constant strings define standard metadata keys for video content.

Constructor Summary

Constructors

Constructor and Description
MediaHeartbeat(MediaHeartbeat.MediaHeartbeatDelegate delegate, MediaHeartbeatConfig config) Creates an instance of MediaHeartbeat class with provided delegate

Method Summary

Modifier and Type	Method and Description
static MediaObject	createAdBreakObject(java.lang.String name, java.lang.Long position, java.lang.Double startTime) Creates an instance of the AdBreak info object
static MediaObject	createAdObject(java.lang.String name, java.lang.String adId, java.lang.Long position, java.lang.Double length) Creates an instance of the Ad info object
static MediaObject	createChapterObject(java.lang.String name, java.lang.Long position, java.lang.Double length, java.lang.Double startTime) Creates an instance of the Chapter info object
static MediaObject	createMediaObject(java.lang.String name, java.lang.String mediaId, java.lang.Double length, java.lang.String streamType) Deprecated. - Use createMediaObject(String, String, Double, String, MediaType) instead
static MediaObject	createMediaObject(java.lang.String name, java.lang.String mediaId, java.lang.Double length, java.lang.String streamType, MediaHeartbeat.MediaType mediaType) Creates an instance of the media info object for Audio or Video streams
static MediaObject	createQoSObject(java.lang.Long bitrate, java.lang.Double startupTime, java.lang.Double fps, java.lang.Long droppedFrames) Creates an instance of the QoS info object
static MediaObject	createTimedMetadataObject(java.lang.String metadata) Creates an instance of the Timed Metadata media object
void	trackComplete() Method to track completion of media.
void	trackError(java.lang.String errorId) Method to track Player Errors.
void	trackEvent(MediaHeartbeat.Event event, MediaObject info, java.util.Map<java.lang.String,java.lang.String> contextData) Method to track optional media events.
void	trackPause() Method to track media pause.
void	trackPlay() Method to track media play or resume after pause.
void	trackSessionEnd() Method to track the end of a viewing session.
void	trackSessionStart(MediaObject mediaInfo, java.util.Map<java.lang.String,java.lang.String> contextData) Method to track the start of viewing session.
static java.lang.String	version() Gets the version.

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaHeartbeat

public MediaHeartbeat(MediaHeartbeat.MediaHeartbeatDelegate delegate,
                      MediaHeartbeatConfig config)

Creates an instance of MediaHeartbeat class with provided delegate

Parameters:

delegate - MediaHeartbeatDelegate instance returning valid playhead and QoS updates

config - MediaHeartbeatConfig instance with valid config values

Method Detail

createMediaObject

public static MediaObject createMediaObject(java.lang.String name,
                                            java.lang.String mediaId,
                                            java.lang.Double length,
                                            java.lang.String streamType)

Deprecated. - Use createMediaObject(String, String, Double, String, MediaType) instead

Creates an instance of the video info object

Parameters:

name - The name of the media

mediaId - The unqiue identifier for the media

length - The length of the media in seconds

streamType - The stream type as a string. Use MediaHeartbeat.StreamType for predefined streams.

createMediaObject

public static MediaObject createMediaObject(java.lang.String name,
                                            java.lang.String mediaId,
                                            java.lang.Double length,
                                            java.lang.String streamType,
                                            MediaHeartbeat.MediaType mediaType)

Creates an instance of the media info object for Audio or Video streams

Parameters:

name - The name of the media

mediaId - The unqiue identifier for the media

length - The length of the media in seconds

streamType - The stream type as a string. Use MediaHeartbeat.StreamType for predefined streams.

mediaType - The media type

createAdBreakObject

public static MediaObject createAdBreakObject(java.lang.String name,
                                              java.lang.Long position,
                                              java.lang.Double startTime)

Creates an instance of the AdBreak info object

Parameters:

name - The name of the ad break

position - The position of the ad break in the content starting with 1

startTime - The start time of the ad break relative to the main media

createAdObject

public static MediaObject createAdObject(java.lang.String name,
                                         java.lang.String adId,
                                         java.lang.Long position,
                                         java.lang.Double length)

Creates an instance of the Ad info object

Parameters:

name - The name of the ad

adId - The unique id for the ad

position - The start position of the ad

length - The length of the ad in seconds

createChapterObject

public static MediaObject createChapterObject(java.lang.String name,
                                              java.lang.Long position,
                                              java.lang.Double length,
                                              java.lang.Double startTime)

Creates an instance of the Chapter info object

Parameters:

name - The name of the chapter

position - The position of the chapter

length - The length of the chapter in seconds

startTime - The start of the chapter relative to the main media

createQoSObject

public static MediaObject createQoSObject(java.lang.Long bitrate,
                                          java.lang.Double startupTime,
                                          java.lang.Double fps,
                                          java.lang.Long droppedFrames)

Creates an instance of the QoS info object

Parameters:

bitrate - The bitrate of media in bits per second

startupTime - The start up time of media in seconds

fps - The current frames per second information

droppedFrames - The number of dropped frames so far

createTimedMetadataObject

public static MediaObject createTimedMetadataObject(java.lang.String metadata)

Creates an instance of the Timed Metadata media object

Parameters:

metadata - The timed metadata string value

version

public static java.lang.String version()

Gets the version.

Returns:

a string containing the version value.

trackSessionStart

public void trackSessionStart(MediaObject mediaInfo,
                              java.util.Map<java.lang.String,java.lang.String> contextData)

Method to track the start of viewing session.

Parameters:

mediaInfo - A valid MediaObject instance created using createMediaObject(String, String, Double, String, MediaType).

contextData - An optional map containing the context data to be tracked.

trackPlay

public void trackPlay()

Method to track media play or resume after pause.

trackPause

public void trackPause()

Method to track media pause.

trackComplete

public void trackComplete()

Method to track completion of media.

trackSessionEnd

public void trackSessionEnd()

Method to track the end of a viewing session. This method must be called even if the user does not watch the video to completion.

trackError

public void trackError(java.lang.String errorId)

Method to track Player Errors. * @param errorId Error Id

trackEvent

public void trackEvent(MediaHeartbeat.Event event,
                       MediaObject info,
                       java.util.Map<java.lang.String,java.lang.String> contextData)

Method to track optional media events.

Parameters:

event - Event type.

info - A valid MediaObject instance containing event info for MediaHeartbeat.Event.AdBreakStart, MediaHeartbeat.Event.AdStart and MediaHeartbeat.Event.ChapterStart

contextData - An optional map containing context data to be tracked for MediaHeartbeat.Event.AdStart and MediaHeartbeat.Event.ChapterStart events.