public class APSMediaOverlay extends APSMediaEvent implements java.lang.Cloneable
APSMediaPlayer instance needs to render during playback.| Modifier and Type | Class and Description |
|---|---|
static class |
APSMediaOverlay.APSMediaOverlayPosition
Describes the position the overlay should take when placed on-screen by the player.
|
APSMediaEvent.APSMediaEventState| 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.
|
dynamicPosition, loaded, preloadInterval, preloadPoint, timeouttrackingURLs| Modifier | Constructor and Description |
|---|---|
|
APSMediaOverlay() |
protected |
APSMediaOverlay(Parcel in) |
| 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) |
adjustForAbsoluteDuration, adjustRelativeToDuration, endPoint, getState, incrementStartAndEndPointsWithInterval, needsToBeAdjustedRelativeToDuration, preload, registerEventStateListener, registerTimeoutListener, setEndPoint, setStartPoint, startPoint, trigger, unload, unregisterEventStateListener, unregisterEventTimeoutListener, updateStatepublic static final java.lang.String kAPSMetadataType
public static final java.lang.String MetadataClickPosition
public java.lang.String type
public java.util.HashMap<java.lang.String,java.lang.Object> parameters
public APSMediaOverlay.APSMediaOverlayPosition position
Describes the position the overlay should take when placed on-screen by the player. APSMediaOverlayPosition for available values.
public APSMediaPlayerOverlayController controller
public int zIndex
public java.lang.String width
public java.lang.String height
public java.lang.String absoluteOffsetX
position parameter, while the positive direction is always toward the center of the player surface.public java.lang.String absoluteOffsetY
position parameter, while the positive direction is always toward the center of the player surface.public float fadeInDuration
public float repeatAfter
public APSMediaUnit parentUnit
After being added to a APSMediaUnit object, a reference to this parent can be found here.
public java.util.HashMap<java.lang.String,java.lang.Object> metadata
A HashMap containing the metadata associated with the overlay
public static final <any> CREATOR
public APSMediaOverlay()
protected APSMediaOverlay(Parcel in)
public APSMediaOverlay cloneOverlay()
public void onPreload()
APSMediaEventonPreload in class APSMediaEventpublic void onTrigger()
APSMediaEventonTrigger in class APSMediaEventpublic void onUnload()
APSMediaEventonUnload in class APSMediaEventpublic void onUpdate()
APSMediaEventonUpdate in class APSMediaEventpublic int describeContents()
describeContents in class APSMediaEventpublic void writeToParcel(Parcel dest,
int flags)
writeToParcel in class APSMediaEvent