com.atinternet.tracker.avinsights

Class Media

java.lang.Object

com.atinternet.tracker.RequiredPropertiesDataObject

com.atinternet.tracker.avinsights.Media

public class Media
extends RequiredPropertiesDataObject

Constructor Summary

Constructors

Constructor and Description
Media(Events events)
Media(Events events, int heartbeat, int bufferHeartbeat, java.lang.String sessionId)
Media(Events events, android.util.SparseIntArray heartbeat, android.util.SparseIntArray bufferHeartbeat, java.lang.String sessionId)

Method Summary

Modifier and Type	Method and Description
void	adClick(java.util.Map<java.lang.String,java.lang.Object> extraProps) Measuring media click (especially for ads).
void	adSkip(java.util.Map<java.lang.String,java.lang.Object> extraProps) Measuring media skip (especially for ads).
void	bufferHeartbeat(java.util.Map<java.lang.String,java.lang.Object> extraProps) Generate heartbeat event during buffering.
void	bufferStart(int cursorPosition, java.util.Map<java.lang.String,java.lang.Object> extraProps) Player buffering start to initiate the launch of the media.
void	close(java.util.Map<java.lang.String,java.lang.Object> extraProps) Measuring close action.
void	display(java.util.Map<java.lang.String,java.lang.Object> extraProps) Measuring reco or Ad display.
void	error(java.lang.String message, java.util.Map<java.lang.String,java.lang.Object> extraProps) Error measurement preventing reading from continuing.
void	fullscreenOff(java.util.Map<java.lang.String,java.lang.Object> extraProps) Measuring a full screen deactivation.
void	fullscreenOn(java.util.Map<java.lang.String,java.lang.Object> extraProps) Measuring a full-screen display.
java.lang.String	getSessionId() Get session
void	heartbeat(int cursorPosition, java.util.Map<java.lang.String,java.lang.Object> extraProps) Generate heartbeat event.
void	play(int cursorPosition, java.util.Map<java.lang.String,java.lang.Object> extraProps) Generate play event (play attempt).
void	playbackPaused(int cursorPosition, java.util.Map<java.lang.String,java.lang.Object> extraProps) Media playback paused.
void	playbackResumed(int cursorPosition, java.util.Map<java.lang.String,java.lang.Object> extraProps) Media playback restarted manually after a pause.
void	playbackStart(int cursorPosition, java.util.Map<java.lang.String,java.lang.Object> extraProps) Media playback start (first frame of the media).
void	playbackStopped(int cursorPosition, java.util.Map<java.lang.String,java.lang.Object> extraProps) Media playback stopped.
void	quality(java.util.Map<java.lang.String,java.lang.Object> extraProps) Measurement of a quality change action.
void	rebufferHeartbeat(java.util.Map<java.lang.String,java.lang.Object> extraProps) Generate heartbeat event during rebuffering.
void	seek(int oldCursorPosition, int newCursorPosition, java.util.Map<java.lang.String,java.lang.Object> extraProps) Measuring seek event.
void	seekBackward(int oldCursorPosition, int newCursorPosition, java.util.Map<java.lang.String,java.lang.Object> extraProps) Measuring seek backward.
void	seekForward(int oldCursorPosition, int newCursorPosition, java.util.Map<java.lang.String,java.lang.Object> extraProps) Measuring seek forward.
void	seekStart(int oldCursorPosition, java.util.Map<java.lang.String,java.lang.Object> extraProps) Measuring seek start.
void	setPlaybackSpeed(double playbackSpeed) Set a new playback speed and update session context
void	share(java.util.Map<java.lang.String,java.lang.Object> extraProps) Measurement of a sharing action.
void	speed(java.util.Map<java.lang.String,java.lang.Object> extraProps) Measurement of a speed change action.
void	subtitleOff(java.util.Map<java.lang.String,java.lang.Object> extraProps) Measurement of deactivated subtitles.
void	subtitleOn(java.util.Map<java.lang.String,java.lang.Object> extraProps) Measurement of activated subtitles.
void	track(java.lang.String event, java.util.Map<java.lang.String,java.lang.Object> options, java.util.Map<java.lang.String,java.lang.Object> extraProps)
void	volume(java.util.Map<java.lang.String,java.lang.Object> extraProps) Measurement of a volume change action.

Methods inherited from class com.atinternet.tracker.RequiredPropertiesDataObject

del, delProps, get, getAll, getProps, isEmpty, set, setAll, setProps

Methods inherited from class java.lang.Object

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

Constructor Detail

Media

public Media(Events events)

Media

public Media(Events events,
             int heartbeat,
             int bufferHeartbeat,
             java.lang.String sessionId)

Media

public Media(Events events,
             android.util.SparseIntArray heartbeat,
             android.util.SparseIntArray bufferHeartbeat,
             java.lang.String sessionId)

Method Detail

getSessionId

public java.lang.String getSessionId()

Get session

Returns:

String

track

public void track(java.lang.String event,
                  java.util.Map<java.lang.String,java.lang.Object> options,
                  java.util.Map<java.lang.String,java.lang.Object> extraProps)

setPlaybackSpeed

public void setPlaybackSpeed(double playbackSpeed)

Set a new playback speed and update session context

Parameters:

playbackSpeed - double

heartbeat

public void heartbeat(int cursorPosition,
                      java.util.Map<java.lang.String,java.lang.Object> extraProps)

Generate heartbeat event.

bufferHeartbeat

public void bufferHeartbeat(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Generate heartbeat event during buffering.

rebufferHeartbeat

public void rebufferHeartbeat(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Generate heartbeat event during rebuffering.

play

public void play(int cursorPosition,
                 java.util.Map<java.lang.String,java.lang.Object> extraProps)

Generate play event (play attempt).

Parameters:

cursorPosition - Cursor position (milliseconds)

bufferStart

public void bufferStart(int cursorPosition,
                        java.util.Map<java.lang.String,java.lang.Object> extraProps)

Player buffering start to initiate the launch of the media.

Parameters:

cursorPosition - Cursor position (milliseconds)

playbackStart

public void playbackStart(int cursorPosition,
                          java.util.Map<java.lang.String,java.lang.Object> extraProps)

Media playback start (first frame of the media).

Parameters:

cursorPosition - Cursor position (milliseconds)

playbackResumed

public void playbackResumed(int cursorPosition,
                            java.util.Map<java.lang.String,java.lang.Object> extraProps)

Media playback restarted manually after a pause.

Parameters:

cursorPosition - Cursor position (milliseconds)

playbackPaused

public void playbackPaused(int cursorPosition,
                           java.util.Map<java.lang.String,java.lang.Object> extraProps)

Media playback paused.

Parameters:

cursorPosition - Cursor position (milliseconds)

playbackStopped

public void playbackStopped(int cursorPosition,
                            java.util.Map<java.lang.String,java.lang.Object> extraProps)

Media playback stopped.

Parameters:

cursorPosition - Cursor position (milliseconds)

seek

public void seek(int oldCursorPosition,
                 int newCursorPosition,
                 java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measuring seek event.

Parameters:

oldCursorPosition - Starting position (milliseconds)

newCursorPosition - Ending position (milliseconds)

seekBackward

public void seekBackward(int oldCursorPosition,
                         int newCursorPosition,
                         java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measuring seek backward.

Parameters:

oldCursorPosition - Starting position (milliseconds)

newCursorPosition - Ending position (milliseconds)

seekForward

public void seekForward(int oldCursorPosition,
                        int newCursorPosition,
                        java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measuring seek forward.

Parameters:

oldCursorPosition - Starting position (milliseconds)

newCursorPosition - Ending position (milliseconds)

seekStart

public void seekStart(int oldCursorPosition,
                      java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measuring seek start.

Parameters:

oldCursorPosition - Old Cursor position (milliseconds)

adClick

public void adClick(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measuring media click (especially for ads).

adSkip

public void adSkip(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measuring media skip (especially for ads).

error

public void error(java.lang.String message,
                  java.util.Map<java.lang.String,java.lang.Object> extraProps)

Error measurement preventing reading from continuing.

display

public void display(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measuring reco or Ad display.

close

public void close(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measuring close action.

volume

public void volume(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measurement of a volume change action.

subtitleOn

public void subtitleOn(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measurement of activated subtitles.

subtitleOff

public void subtitleOff(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measurement of deactivated subtitles.

fullscreenOn

public void fullscreenOn(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measuring a full-screen display.

fullscreenOff

public void fullscreenOff(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measuring a full screen deactivation.

quality

public void quality(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measurement of a quality change action.

speed

public void speed(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measurement of a speed change action.

share

public void share(java.util.Map<java.lang.String,java.lang.Object> extraProps)

Measurement of a sharing action.