APSMediaOverlay

java.lang.Object
- com.appscend.media.APSMediaTrackableObject
- - com.appscend.media.events.APSMediaEvent
  - - com.appscend.media.events.APSMediaOverlay

All Implemented Interfaces:

java.lang.Cloneable
```
public class APSMediaOverlay
extends APSMediaEvent
implements java.lang.Cloneable
```
APSMediaOverlay describes any overlay that the APSMediaPlayer instance needs to render during playback.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`APSMediaOverlay.APSMediaOverlayPosition` Describes the position the overlay should take when placed on-screen by the player.

Nested classes/interfaces inherited from class com.appscend.media.events.APSMediaEvent
APSMediaEvent.APSMediaEventState

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`absoluteOffsetX` The overlay's absolute horizontal offset in pixels, relative to the current origin.
`java.lang.String`	`absoluteOffsetY` The overlay's absolute vertical offset in pixels, relative to the current origin.
`APSMediaPlayerOverlayController`	`controller` A refence to the overlay controller object.
`static <any>`	`CREATOR`
`float`	`fadeInDuration` The duration (in seconds) for the fade in effect of the overlay, when it is placed on and taken off screen.
`java.lang.String`	`height` The height of the overlay.
`static java.lang.String`	`kAPSMetadataType`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`metadata` A HashMap containing the metadata associated with the overlay
`static java.lang.String`	`MetadataClickPosition`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`parameters` Overlay parameters.
`APSMediaUnit`	`parentUnit` After being added to a `APSMediaUnit` object, a reference to this parent can be found here.
`APSMediaOverlay.APSMediaOverlayPosition`	`position` Describes the position the overlay should take when placed on-screen by the player.
`float`	`repeatAfter` If this parameter is greater than 0, then the overlay will be reshown by the media player after the specific time interval (in seconds).
`java.lang.String`	`type`
`java.lang.String`	`width` The width of the overlay.
`int`	`zIndex` The order of the overlay in the current view stack.

Fields inherited from class com.appscend.media.events.APSMediaEvent
dynamicPosition, loaded, preloadInterval, preloadPoint, timeout

Fields inherited from class com.appscend.media.APSMediaTrackableObject
trackingURLs

Constructor Summary

Constructors
Modifier Constructor and Description

APSMediaOverlay()

protected APSMediaOverlay(Parcel in)

Constructors
Modifier	Constructor and Description
	`APSMediaOverlay()`
`protected`	`APSMediaOverlay(Parcel in)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`APSMediaOverlay`	`cloneOverlay()` Creates a clone of the APSMediaOverlay object
`int`	`describeContents()`
`void`	`onPreload()` This method will be invoked on a different thread by the player, before the event start point, as set by the preTriggerInterval field.
`void`	`onTrigger()` This code will be executed once the event is triggered by the player.
`void`	`onUnload()` This method will be invoked by the player once the event has reached the end point and will be deallocated.
`void`	`onUpdate()` This method will be invoked by the player periodically, giving the event the opportunity to respond to updated playback information.
`void`	`writeToParcel(Parcel dest, int flags)`

Methods inherited from class com.appscend.media.events.APSMediaEvent
adjustForAbsoluteDuration, adjustRelativeToDuration, endPoint, getState, incrementStartAndEndPointsWithInterval, needsToBeAdjustedRelativeToDuration, preload, registerEventStateListener, registerTimeoutListener, setEndPoint, setStartPoint, startPoint, trigger, unload, unregisterEventStateListener, unregisterEventTimeoutListener, updateState

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - kAPSMetadataType
```
public static final java.lang.String kAPSMetadataType
```
    See Also:
    
    Constant Field Values
  - MetadataClickPosition
```
public static final java.lang.String MetadataClickPosition
```
    See Also:
    
    Constant Field Values
  - type
```
public java.lang.String type
```
  - parameters
```
public java.util.HashMap<java.lang.String,java.lang.Object> parameters
```
    Overlay parameters. Implementation-specific to overlay controllers.
  - position
```
public APSMediaOverlay.APSMediaOverlayPosition position
```
    Describes the position the overlay should take when placed on-screen by the player. APSMediaOverlayPosition for available values.
  - controller
```
public APSMediaPlayerOverlayController controller
```
    A refence to the overlay controller object. This is set by the player, on the overlay's initial render.
  - zIndex
```
public int zIndex
```
    The order of the overlay in the current view stack.
  - width
```
public java.lang.String width
```
    The width of the overlay. Supports pixels (e.g.: "320") or percentages, relative to the total width (e.g.: "50%").
  - height
```
public java.lang.String height
```
    The height of the overlay. Supports pixels (e.g.: "320") or percentages, relative to the total height (e.g.: "50%").
  - absoluteOffsetX
```
public java.lang.String absoluteOffsetX
```
    The overlay's absolute horizontal offset in pixels, relative to the current origin. The current origin is determined by the overlay's position parameter, while the positive direction is always toward the center of the player surface.
  - absoluteOffsetY
```
public java.lang.String absoluteOffsetY
```
    The overlay's absolute vertical offset in pixels, relative to the current origin. The current origin is determined by the overlay's position parameter, while the positive direction is always toward the center of the player surface.
  - fadeInDuration
```
public float fadeInDuration
```
    The duration (in seconds) for the fade in effect of the overlay, when it is placed on and taken off screen.
  - repeatAfter
```
public float repeatAfter
```
    If this parameter is greater than 0, then the overlay will be reshown by the media player after the specific time interval (in seconds).
  - parentUnit
```
public APSMediaUnit parentUnit
```
    After being added to a APSMediaUnit object, a reference to this parent can be found here.
  - metadata
```
public java.util.HashMap<java.lang.String,java.lang.Object> metadata
```
    A HashMap containing the metadata associated with the overlay
  - CREATOR
```
public static final <any> CREATOR
```
- Constructor Detail
  - APSMediaOverlay
```
public APSMediaOverlay()
```
  - APSMediaOverlay
```
protected APSMediaOverlay(Parcel in)
```
- Method Detail
  - cloneOverlay
```
public APSMediaOverlay cloneOverlay()
```
    Creates a clone of the APSMediaOverlay object
    
    Returns:
    
    A clone of the APSMediaOverlay object
  - onPreload
```
public void onPreload()
```
    Description copied from class: APSMediaEvent
    
    This method will be invoked on a different thread by the player, before the event start point, as set by the preTriggerInterval field.
    
    Specified by:
    
    onPreload in class APSMediaEvent
  - onTrigger
```
public void onTrigger()
```
    Description copied from class: APSMediaEvent
    
    This code will be executed once the event is triggered by the player.
    
    Specified by:
    
    onTrigger in class APSMediaEvent
  - onUnload
```
public void onUnload()
```
    Description copied from class: APSMediaEvent
    
    This method will be invoked by the player once the event has reached the end point and will be deallocated.
    
    Specified by:
    
    onUnload in class APSMediaEvent
  - onUpdate
```
public void onUpdate()
```
    Description copied from class: APSMediaEvent
    
    This method will be invoked by the player periodically, giving the event the opportunity to respond to updated playback information.
    
    Specified by:
    
    onUpdate in class APSMediaEvent
  - describeContents
```
public int describeContents()
```
    Overrides:
    
    describeContents in class APSMediaEvent
  - writeToParcel
```
public void writeToParcel(Parcel dest,
                          int flags)
```
    Overrides:
    
    writeToParcel in class APSMediaEvent

Class APSMediaOverlay

Nested Class Summary

Nested classes/interfaces inherited from class com.appscend.media.events.APSMediaEvent

Field Summary

Fields inherited from class com.appscend.media.events.APSMediaEvent

Fields inherited from class com.appscend.media.APSMediaTrackableObject

Constructor Summary

Method Summary

Methods inherited from class com.appscend.media.events.APSMediaEvent

Methods inherited from class java.lang.Object

Field Detail

kAPSMetadataType

MetadataClickPosition

type

parameters

position

controller

zIndex

width

height

absoluteOffsetX

absoluteOffsetY

fadeInDuration

repeatAfter

parentUnit

metadata

CREATOR

Constructor Detail

APSMediaOverlay

APSMediaOverlay

Method Detail

cloneOverlay

onPreload

onTrigger

onUnload

onUpdate

describeContents

writeToParcel