com.appscend.overlaycontrollers

Class APSMediaPlayerTextOverlayController

java.lang.Object

com.appscend.overlaycontrollers.APSMediaPlayerOverlayController

com.appscend.overlaycontrollers.APSMediaPlayerTextOverlayController

All Implemented Interfaces:

KRAdapter

public class APSMediaPlayerTextOverlayController
extends APSMediaPlayerOverlayController

The APSMediaPlayerTextOverlayController allows the displaying text on top of video content.

Configuration

To create an APSMediaOverlay of text type:

• set the overlay object's type property to APSTextOverlay

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

  • kAPSTextOverlayString: the String to be rendered.
  • kAPSTextOverlayStringColor: Font color for the rendered text. Set this to a String containing the hex color representation. Defaults to [UIColor whiteColor].
  • kAPSTextOverlayStringFont: String indicating the font family to be used. Defaults to 'Helvetica'.
  • kAPSTextOverlayStringSize: Integer indicating the font size to be used. Defaults to 13.

Replacable Placeholders

The APSMediaPlayerTextOverlayController will replace the following string placeholders with dynamic information: - 'remaining' will be replaced with the remaining number of seconds from the current video clip being rendered.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APSTextOverlay
static java.lang.String	kAPSTextOverlayString
static java.lang.String	kAPSTextOverlayStringColor
static java.lang.String	kAPSTextOverlayStringFont
static java.lang.String	kAPSTextOverlayStringSize

Fields inherited from class com.appscend.overlaycontrollers.APSMediaPlayerOverlayController

overlay

Constructor Summary

Constructors

Constructor and Description
APSMediaPlayerTextOverlayController()

Method Summary

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

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

kAPSTextOverlayString

public static final java.lang.String kAPSTextOverlayString

See Also:

Constant Field Values

kAPSTextOverlayStringColor

public static final java.lang.String kAPSTextOverlayStringColor

See Also:

Constant Field Values

kAPSTextOverlayStringFont

public static final java.lang.String kAPSTextOverlayStringFont

See Also:

Constant Field Values

kAPSTextOverlayStringSize

public static final java.lang.String kAPSTextOverlayStringSize

See Also:

Constant Field Values

APSTextOverlay

public static final java.lang.String APSTextOverlay

See Also:

Constant Field Values

Constructor Detail

APSMediaPlayerTextOverlayController

public APSMediaPlayerTextOverlayController()

Method Detail

type

public java.lang.String type()

load

public void load(Context context)

Specified by:

load in class APSMediaPlayerOverlayController

addViewToContainer

public void addViewToContainer(ViewGroup viewGroup)

Specified by:

addViewToContainer in class APSMediaPlayerOverlayController

update

public void update(int duration,
                   int currentPlaybackTime)

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