com.atinternet.tracker

Class RichMedia

java.lang.Object

com.atinternet.tracker.BusinessObject

com.atinternet.tracker.RichMedia

Direct Known Subclasses:

Audio, LiveAudio, LiveMedium, LiveVideo, Medium, Video

public abstract class RichMedia
extends BusinessObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RichMedia.Action Enum with different action types
static class	RichMedia.BroadcastMode Enum with different broadcast mode

Method Summary

Modifier and Type	Method and Description
RichMedia.BroadcastMode	getBroadcastMode() Get broadcast mode
java.lang.String	getChapter1() Deprecated. please use getMediaTheme1() instead
java.lang.String	getChapter2() Deprecated. please use getMediaTheme2() instead
java.lang.String	getChapter3() Deprecated. please use getMediaTheme3() instead
int	getDuration() Get the duration
int	getLevel2() Deprecated. please use getMediaLevel2() instead
java.lang.String	getLinkedContent() Get linked content
java.lang.String	getMediaLabel() Get media label
int	getMediaLevel2() Get media level 2
java.lang.String	getMediaLevel2String() Get the level 2 string
java.lang.String	getMediaTheme1() Get first theme
java.lang.String	getMediaTheme2() Get second theme
java.lang.String	getMediaTheme3() Get third theme
java.lang.String	getMediaType() Get media type
java.lang.String	getName() Deprecated. please use getMediaLabel() instead
java.lang.String	getWebDomain() Get web domain
boolean	isBuffering() Deprecated. useless, property set when send called
boolean	isEmbedded() Get boolean "isEmbedded" value
void	sendDownload() Send a download action tracking
void	sendEmail() Send a email action tracking
void	sendFavor() Send a favor action tracking
void	sendInfo() Send a info action tracking
void	sendInfo(boolean isBuffering) Send a info action tracking
void	sendMove() Send a move action tracking
void	sendPause() Send a pause action tracking
void	sendPlay() Send a play action tracking.
void	sendPlay(boolean isBuffering) Send a play action tracking.
void	sendPlay(int refreshDuration) Deprecated. please use sendPlay(SparseIntArray) instead
void	sendPlay(android.util.SparseIntArray refreshDurations) /** Send play with a custom refresh duration
void	sendPlay(android.util.SparseIntArray refreshDurations, boolean isBuffering) /** Send play with a custom refresh duration
void	sendPlayWithoutRefresh() Send only one play hit
void	sendPlayWithoutRefresh(boolean isBuffering) Send only one play hit
void	sendResume() Resume playing media tracking
void	sendResume(boolean isBuffering) Resume playing media tracking
void	sendShare() Send a share action tracking
void	sendStop() Send a stop action tracking
RichMedia	setBroadcastMode(RichMedia.BroadcastMode mode) Set a new broadcast mode
RichMedia	setEmbedded(boolean isEmbedded) Change boolean "isEmbedded" value
RichMedia	setLinkedContent(java.lang.String linkedContent) Set a new linked content
RichMedia	setMediaLevel2(int mediaLevel2) Set a new media level2
RichMedia	setMediaLevel2(java.lang.String mediaLevel2) Set a new media level2
RichMedia	setMediaTheme1(java.lang.String mediaTheme1) Set a new first media theme
RichMedia	setMediaTheme2(java.lang.String mediaTheme2) Set a new second media theme
RichMedia	setMediaTheme3(java.lang.String mediaTheme3) Set a new third media theme
RichMedia	setWebDomain(java.lang.String webDomain) Set a new webdomain

Methods inherited from class com.atinternet.tracker.BusinessObject

getId, setTimestamp

Methods inherited from class java.lang.Object

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

Method Detail

getBroadcastMode

public RichMedia.BroadcastMode getBroadcastMode()

Get broadcast mode

Returns:

BroadcastMode

getDuration

public int getDuration()

Get the duration

Returns:

the duration

getMediaType

public java.lang.String getMediaType()

Get media type

Returns:

MediaType

getMediaLevel2

public int getMediaLevel2()

Get media level 2

Returns:

the media level 2

getMediaLevel2String

public java.lang.String getMediaLevel2String()

Get the level 2 string

Returns:

the level 2

isEmbedded

public boolean isEmbedded()

Get boolean "isEmbedded" value

Returns:

true if the media is embedded in app

getMediaLabel

public java.lang.String getMediaLabel()

Get media label

Returns:

the media label

getMediaTheme1

public java.lang.String getMediaTheme1()

Get first theme

Returns:

the first theme

getMediaTheme2

public java.lang.String getMediaTheme2()

Get second theme

Returns:

the second theme

getMediaTheme3

public java.lang.String getMediaTheme3()

Get third theme

Returns:

the third theme

getWebDomain

public java.lang.String getWebDomain()

Get web domain

Returns:

the web domain

getLinkedContent

public java.lang.String getLinkedContent()

Get linked content

Returns:

the linked content

setBroadcastMode

public RichMedia setBroadcastMode(RichMedia.BroadcastMode mode)

Set a new broadcast mode

Parameters:

mode - /

Returns:

the RichMedia instance

setMediaTheme1

public RichMedia setMediaTheme1(java.lang.String mediaTheme1)

Set a new first media theme

Parameters:

mediaTheme1 - /

Returns:

the RichMedia instance

setMediaTheme2

public RichMedia setMediaTheme2(java.lang.String mediaTheme2)

Set a new second media theme

Parameters:

mediaTheme2 - /

Returns:

the RichMedia instance

setMediaTheme3

public RichMedia setMediaTheme3(java.lang.String mediaTheme3)

Set a new third media theme

Parameters:

mediaTheme3 - /

Returns:

the RichMedia instance

setMediaLevel2

public RichMedia setMediaLevel2(int mediaLevel2)

Set a new media level2

Parameters:

mediaLevel2 - /

Returns:

RichMedia instance

setMediaLevel2

public RichMedia setMediaLevel2(java.lang.String mediaLevel2)

Set a new media level2

Parameters:

mediaLevel2 - /

Returns:

RichMedia instance

setEmbedded

public RichMedia setEmbedded(boolean isEmbedded)

Change boolean "isEmbedded" value

Parameters:

isEmbedded - /

Returns:

RichMedia instance

setWebDomain

public RichMedia setWebDomain(java.lang.String webDomain)

Set a new webdomain

Parameters:

webDomain - /

Returns:

RichMedia instance

setLinkedContent

public RichMedia setLinkedContent(java.lang.String linkedContent)

Set a new linked content

Parameters:

linkedContent - /

Returns:

RichMedia instance

sendPlay

public void sendPlay(boolean isBuffering)

Send a play action tracking. Refresh is enabled with default duration

Parameters:

isBuffering - /

sendPlay

public void sendPlay()

Send a play action tracking. Refresh is enabled with default duration

sendResume

public void sendResume(boolean isBuffering)

Resume playing media tracking

Parameters:

isBuffering - /

sendResume

public void sendResume()

Resume playing media tracking

sendPlayWithoutRefresh

public void sendPlayWithoutRefresh(boolean isBuffering)

Send only one play hit

Parameters:

isBuffering - /

sendPlayWithoutRefresh

public void sendPlayWithoutRefresh()

Send only one play hit

sendPlay

public void sendPlay(android.util.SparseIntArray refreshDurations,
                     boolean isBuffering)

/** Send play with a custom refresh duration

Parameters:

refreshDurations - SparseIntArray with (startingMinute,refreshDuration) ex: (0,5) will send one hit every five seconds during the first minute

isBuffering - /

sendPlay

public void sendPlay(android.util.SparseIntArray refreshDurations)

/** Send play with a custom refresh duration

Parameters:

refreshDurations - SparseIntArray with (startingMinute,refreshDuration) ex: (0,5) will send one hit every five seconds during the first minute

sendInfo

public void sendInfo()

Send a info action tracking

sendInfo

public void sendInfo(boolean isBuffering)

Send a info action tracking

Parameters:

isBuffering - /

sendPause

public void sendPause()

Send a pause action tracking

sendStop

public void sendStop()

Send a stop action tracking

sendShare

public void sendShare()

Send a share action tracking

sendEmail

public void sendEmail()

Send a email action tracking

sendFavor

public void sendFavor()

Send a favor action tracking

sendDownload

public void sendDownload()

Send a download action tracking

sendMove

public void sendMove()

Send a move action tracking

getLevel2

@Deprecated
public int getLevel2()

Deprecated. please use getMediaLevel2() instead

Get level 2

Returns:

the level 2

isBuffering

@Deprecated
public boolean isBuffering()

Deprecated. useless, property set when send called

Get boolean "isBuffering" value

Returns:

true if the media is buffering

getName

@Deprecated
public java.lang.String getName()

Deprecated. please use getMediaLabel() instead

Get media name

Returns:

the media name

getChapter1

@Deprecated
public java.lang.String getChapter1()

Deprecated. please use getMediaTheme1() instead

Get first chapter

Returns:

the first chapter

getChapter2

@Deprecated
public java.lang.String getChapter2()

Deprecated. please use getMediaTheme2() instead

Get second chapter

Returns:

the second chapter

getChapter3

@Deprecated
public java.lang.String getChapter3()

Deprecated. please use getMediaTheme3() instead

Get third chapter

Returns:

the third chapter

sendPlay

@Deprecated
public void sendPlay(int refreshDuration)

Deprecated. please use sendPlay(SparseIntArray) instead

Send play with a custom refresh duration

Parameters:

refreshDuration - refresh duration in second, must be higher than 5