com.appscend.overlaycontrollers

Class APSMediaPlayerImageOverlayController

java.lang.Object

com.appscend.overlaycontrollers.APSMediaPlayerOverlayController

com.appscend.overlaycontrollers.APSMediaPlayerClosableOverlayController

com.appscend.overlaycontrollers.APSMediaPlayerImageOverlayController

All Implemented Interfaces:

KRAdapter

public class APSMediaPlayerImageOverlayController
extends APSMediaPlayerClosableOverlayController

The APSMediaPlayerImageOverlayController allows placing an image on top of video content.

Configuration

To create an APSMediaOverlay of image type:

• set the overlay object's type property to APSImageOverlay

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

  • kAPSImageOverlayClickthrough: set this key to a String representing the URL that should be launched when the overlay is tapped.
  • kAPSImageOverlayClicktracking: set this key to a ArrayList of String objects that will be tracked by the player when the overlay is tapped (see [APSMediaPlayer trackforEvent:]). Note that the kAPSImageOverlayClickthrough key must also be set for tracking to happen.
  • kAPSImageOverlayViewtracking: set this key to a ArrayList of String objects that will be tracked by the player when the overlay is displayed (see [APSMediaPlayer trackforEvent:]).
  • kAPSImageOverlayResourceURL: String representing the image to be loaded.
  • kAPSImageOverlayErrorURLs: set this key to a ArrayList of String objects that will be tracked by the player when there is an error loading the image (see [APSMediaPlayer trackforEvent:]).
  • kAPSImageOverlayBackgroundColor: the background color of the overlay. Set this to a String containing the hex color representation. Defaults to [UIColor clearColor].

  • kAPSImageOverlayStretchMode: String representing the possible ways of scaling the image in the overlay surface. Possible values are:

    • “aspectFit”, that will set the overlay’s ScaleType to ScaleType.FIT_CENTER
    • “aspectFill”, that will set the overlay’s ScaleType to ScaleType.CENTER_CROP
    • “fill”, that will set the overlay’s ScaleType to ScaleType.FIT_XY
    • “bottom”, that will set the overlay’s ScaleType to ScaleType.MATRIX and will align the elements to the bottom
    • “top”, that will set the overlay’s ScaleType to ScaleType.MATRIX and will align the elements to the top
    • “left”, that will set the overlay’s ScaleType to ScaleType.MATRIX and will align the elements to the left
    • “right”, that will set the overlay’s ScaleType to ScaleType.MATRIX and will align the elements to the right

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APSMediaPlayerImageOverlayController.getImageAsync

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APSImageOverlay
static java.lang.String	kAPSImageOverlayBackgroundColor
static java.lang.String	kAPSImageOverlayClickthrough
static java.lang.String	kAPSImageOverlayClicktracking
static java.lang.String	kAPSImageOverlayErrorURLs
static java.lang.String	kAPSImageOverlayResourceURL
static java.lang.String	kAPSImageOverlayStretchMode
static java.lang.String	kAPSImageOverlayViewtracking
static java.lang.String	kAPSImageOverlayWebviewDismissAction

Fields inherited from class com.appscend.overlaycontrollers.APSMediaPlayerClosableOverlayController

kAPSCloseBackgroundColor, kAPSCloseFinalAlpha, kAPSCloseHidden, kAPSCloseImage, kAPSCloseInitialAlpha, kAPSCloseOffset, kAPSCloseOffsetX, kAPSCloseOffsetY, kAPSCloseProgressColor, kAPSCloseProgressTrackColor, kAPSCloseSize, kAPSCloseTrackingURLs, kAPSCloseXColor

Fields inherited from class com.appscend.overlaycontrollers.APSMediaPlayerOverlayController

overlay

Constructor Summary

Constructors

Constructor and Description
APSMediaPlayerImageOverlayController()

Method Summary

Modifier and Type	Method and Description
void	addViewToContainer(ViewGroup viewGroup)
float	getAlpha()
View	getView()
void	hideOverlay()
void	load(Context context)
void	preload()
java.lang.String	type()

Methods inherited from class com.appscend.overlaycontrollers.APSMediaPlayerClosableOverlayController

activateButton, removeCloseButton

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

kAPSImageOverlayClickthrough

public static final java.lang.String kAPSImageOverlayClickthrough

See Also:

Constant Field Values

kAPSImageOverlayClicktracking

public static final java.lang.String kAPSImageOverlayClicktracking

See Also:

Constant Field Values

kAPSImageOverlayViewtracking

public static final java.lang.String kAPSImageOverlayViewtracking

See Also:

Constant Field Values

kAPSImageOverlayResourceURL

public static final java.lang.String kAPSImageOverlayResourceURL

See Also:

Constant Field Values

kAPSImageOverlayErrorURLs

public static final java.lang.String kAPSImageOverlayErrorURLs

See Also:

Constant Field Values

kAPSImageOverlayBackgroundColor

public static final java.lang.String kAPSImageOverlayBackgroundColor

See Also:

Constant Field Values

kAPSImageOverlayStretchMode

public static final java.lang.String kAPSImageOverlayStretchMode

See Also:

Constant Field Values

kAPSImageOverlayWebviewDismissAction

public static final java.lang.String kAPSImageOverlayWebviewDismissAction

See Also:

Constant Field Values

APSImageOverlay

public static final java.lang.String APSImageOverlay

See Also:

Constant Field Values

Constructor Detail

APSMediaPlayerImageOverlayController

public APSMediaPlayerImageOverlayController()

Method Detail

type

public java.lang.String type()

Specified by:

type in interface KRAdapter

Overrides:

type in class APSMediaPlayerClosableOverlayController

load

public void load(Context context)

Overrides:

load in class APSMediaPlayerClosableOverlayController

addViewToContainer

public void addViewToContainer(ViewGroup viewGroup)

Overrides:

addViewToContainer in class APSMediaPlayerClosableOverlayController

getView

public View getView()

Overrides:

getView in class APSMediaPlayerClosableOverlayController

hideOverlay

public void hideOverlay()

Overrides:

hideOverlay in class APSMediaPlayerClosableOverlayController

getAlpha

public float getAlpha()

Overrides:

getAlpha in class APSMediaPlayerClosableOverlayController

preload

public void preload()