com.appscend.overlaycontrollers

Class APSMediaPlayerButtonOverlayController

java.lang.Object

com.appscend.overlaycontrollers.APSMediaPlayerOverlayController

com.appscend.overlaycontrollers.APSMediaPlayerButtonOverlayController

All Implemented Interfaces:

KRAdapter, APSMediaPlayerTrackingEventListener

public class APSMediaPlayerButtonOverlayController
extends APSMediaPlayerOverlayController
implements APSMediaPlayerTrackingEventListener

The APSMediaPlayerButtonOverlayController allows placing a transparent overlay in a specific area of the player surface, that can trigger the launch of a specific URL. The APSMediaPlayer instance will query the actionDelegate object to interpret and launch the specified URL. If the actionDelegate cannot respond to the URL, and the URL has a web scheme (http or https), it will be launched automatically in the in-app web browser.

Configuration

To create an APSMediaOverlay of button type:

• set the overlay object’s type property to APSButtonOverlay

• set the overlay object’s properties property to a HashMap that can have the following keys and values:

  • kAPSButtonOverlayClickthrough: set this key to a String representing the URL that should be launched when the overlay is tapped.
  • kAPSButtonOverlayClicktracking: set this key to a ArrayList of String objects that will be tracked by the player when the overlay is tapped (see [APSMediaPlayer track:forEvent:type:]). Note that the kAPSButtonOverlayClickthrough key must also be set for tracking to happen

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APSButtonOverlay
static java.lang.String	kAPSButtonOverlayClickthrough
static java.lang.String	kAPSButtonOverlayClicktracking
static java.lang.String	kAPSButtonOverlayWebviewDismissAction

Fields inherited from class com.appscend.overlaycontrollers.APSMediaPlayerOverlayController

overlay

Constructor Summary

Constructors

Constructor and Description
APSMediaPlayerButtonOverlayController()

Method Summary

Modifier and Type	Method and Description
void	addViewToContainer(ViewGroup viewGroup)
float	getAlpha()
View	getView()
void	hideOverlay()
void	load(Context context)
void	onDestroy()
void	onTrackingEventReceived(APSMediaTrackingEvents.MediaEventType type, Bundle additionalInfo) Called when a player emits an event.
java.lang.String	type()

Methods inherited from class com.appscend.overlaycontrollers.APSMediaPlayerOverlayController

refresh

Methods inherited from class java.lang.Object

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

Field Detail

kAPSButtonOverlayClickthrough

public static final java.lang.String kAPSButtonOverlayClickthrough

See Also:

Constant Field Values

kAPSButtonOverlayClicktracking

public static final java.lang.String kAPSButtonOverlayClicktracking

See Also:

Constant Field Values

APSButtonOverlay

public static final java.lang.String APSButtonOverlay

See Also:

Constant Field Values

kAPSButtonOverlayWebviewDismissAction

public static final java.lang.String kAPSButtonOverlayWebviewDismissAction

See Also:

Constant Field Values

Constructor Detail

APSMediaPlayerButtonOverlayController

public APSMediaPlayerButtonOverlayController()

Method Detail

type

public java.lang.String type()

Specified by:

type in interface KRAdapter

load

public void load(Context context)

Specified by:

load in class APSMediaPlayerOverlayController

addViewToContainer

public void addViewToContainer(ViewGroup viewGroup)

Specified by:

addViewToContainer in class APSMediaPlayerOverlayController

getView

public View getView()

Specified by:

getView in class APSMediaPlayerOverlayController

getAlpha

public float getAlpha()

Specified by:

getAlpha in class APSMediaPlayerOverlayController

hideOverlay

public void hideOverlay()

Specified by:

hideOverlay in class APSMediaPlayerOverlayController

onDestroy

public void onDestroy()

onTrackingEventReceived

public void onTrackingEventReceived(APSMediaTrackingEvents.MediaEventType type,
                                    Bundle additionalInfo)

Description copied from interface: APSMediaPlayerTrackingEventListener

Called when a player emits an event.

Specified by:

onTrackingEventReceived in interface APSMediaPlayerTrackingEventListener

Parameters:

type - The type of event getting fired

additionalInfo - A bundle of additional metadata, such as the current position in CLOCK_TICK events